From 8878471ff432500d44e79bdbc411cf389e959ffc Mon Sep 17 00:00:00 2001 From: Jacob Shilitz Date: Mon, 24 Apr 2023 15:07:24 -0400 Subject: [PATCH 1/8] Add remote_addr filter --- karrio/graphql/types.ts | 1 + src/components/filters/logs-filter.tsx | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/karrio/graphql/types.ts b/karrio/graphql/types.ts index 8b05470ce..be9dbfcaf 100644 --- a/karrio/graphql/types.ts +++ b/karrio/graphql/types.ts @@ -6093,6 +6093,7 @@ export interface LogFilter { offset?: number | null; first?: number | null; api_endpoint?: string | null; + remote_addr?: string | null; date_after?: any | null; date_before?: any | null; entity_id?: string | null; diff --git a/src/components/filters/logs-filter.tsx b/src/components/filters/logs-filter.tsx index 7db1db730..94697084a 100644 --- a/src/components/filters/logs-filter.tsx +++ b/src/components/filters/logs-filter.tsx @@ -160,6 +160,26 @@ const LogsFilter: React.FC = ({ context }) => { + {/* Remote Address */} +
+ + + Remote Address + + + {!isNone(filters?.remote_addr) &&
+ +
} + +
+ {/* Entity ID */}
From cffb20ac7a50c62cc0dcf696eaf35adfc89a8bf5 Mon Sep 17 00:00:00 2001 From: Daniel K Date: Mon, 8 May 2023 14:59:42 -0700 Subject: [PATCH 2/8] (fix) metadata fetching for authenticated users for address autocomplete --- src/context/api-metadata.tsx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/context/api-metadata.tsx b/src/context/api-metadata.tsx index 90c6b6f3e..466031ea1 100644 --- a/src/context/api-metadata.tsx +++ b/src/context/api-metadata.tsx @@ -4,6 +4,7 @@ import { onError, url$ } from '@/lib/helper'; import React, { useContext } from 'react'; import getConfig from 'next/config'; import axios from 'axios'; +import { useSyncedSession } from './session'; const { publicRuntimeConfig } = getConfig(); type APIMeta = { @@ -14,6 +15,7 @@ type APIMeta = { const APIMetadata = React.createContext({} as any); const APIMetadataProvider: React.FC<{ metadata: Metadata }> = ({ children, metadata }) => { + const { query: { data: session } } = useSyncedSession(); const context = { metadata: (metadata || {}) as Metadata, get host() { @@ -25,10 +27,12 @@ const APIMetadataProvider: React.FC<{ metadata: Metadata }> = ({ children, metad }; const { data: references } = useQuery({ - queryKey: ['references'], + queryKey: ['references', session?.accessToken], queryFn: () => ( axios - .get(url$`${context.host}/v1/references?reduced=false`) + .get(url$`${context.host}/v1/references?reduced=false`, (!!session?.accessToken ? { + headers: { 'authorization': `Bearer ${session?.accessToken}` } + } : {})) .then(({ data }) => data) ), staleTime: 5000, From 7635ea281076d5f8878108be0cded247a92f0d86 Mon Sep 17 00:00:00 2001 From: Daniel K Date: Thu, 18 May 2023 00:45:33 -0700 Subject: [PATCH 3/8] (update) generated API types --- bin/generate-pship-client | 2 +- karrio/rest/generated/api.ts | 1469 ++++++++++++--------- karrio/rest/generated/base.ts | 6 +- karrio/rest/generated/common.ts | 5 +- karrio/rest/generated/configuration.ts | 4 +- karrio/rest/generated/index.ts | 4 +- src/components/connect-provider-modal.tsx | 2 +- 7 files changed, 847 insertions(+), 645 deletions(-) diff --git a/bin/generate-pship-client b/bin/generate-pship-client index b3be4e89e..33842a650 100755 --- a/bin/generate-pship-client +++ b/bin/generate-pship-client @@ -7,7 +7,7 @@ docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \ -o /local/karrio/rest/generated \ --additional-properties=typescriptThreePlus=true \ --additional-properties=modelPropertyNaming=snake_case \ - --additional-properties=useSingleRequestParameter=True + --additional-properties=useSingleRequestParameter=true rm -rf karrio/rest/generated/.openapi-generator/ \ karrio/rest/generated/.openapi-generator-ignore \ diff --git a/karrio/rest/generated/api.ts b/karrio/rest/generated/api.ts index ae0b4cb23..ea89e2db7 100644 --- a/karrio/rest/generated/api.ts +++ b/karrio/rest/generated/api.ts @@ -2,9 +2,9 @@ /* eslint-disable */ /** * Karrio API - * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. + * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. * - * The version of the OpenAPI document: 2023.4 + * The version of the OpenAPI document: 2023.4.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -13308,12 +13308,12 @@ export const APIApiFactory = function (configuration?: Configuration, basePath?: /** * Authenticate the user and return a token pair * @summary Obtain auth token pair - * @param {TokenObtainPair} tokenObtainPair + * @param {APIApiAuthenticateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - authenticate(tokenObtainPair: TokenObtainPair, options?: any): AxiosPromise { - return localVarFp.authenticate(tokenObtainPair, options).then((request) => request(axios, basePath)); + authenticate(requestParameters: APIApiAuthenticateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.authenticate(requestParameters.tokenObtainPair, options).then((request) => request(axios, basePath)); }, /** * @@ -13321,18 +13321,18 @@ export const APIApiFactory = function (configuration?: Configuration, basePath?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - data(options?: any): AxiosPromise<{ [key: string]: any; }> { + data(options?: AxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { return localVarFp.data(options).then((request) => request(axios, basePath)); }, /** * Get a verified JWT token pair by submitting a Two-Factor authentication code. * @summary Get verified JWT token - * @param {VerifiedTokenObtainPair} verifiedTokenObtainPair + * @param {APIApiGetVerifiedTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getVerifiedToken(verifiedTokenObtainPair: VerifiedTokenObtainPair, options?: any): AxiosPromise { - return localVarFp.getVerifiedToken(verifiedTokenObtainPair, options).then((request) => request(axios, basePath)); + getVerifiedToken(requestParameters: APIApiGetVerifiedTokenRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getVerifiedToken(requestParameters.verifiedTokenObtainPair, options).then((request) => request(axios, basePath)); }, /** * @@ -13340,28 +13340,28 @@ export const APIApiFactory = function (configuration?: Configuration, basePath?: * @param {*} [options] Override http request option. * @throws {RequiredError} */ - ping(options?: any): AxiosPromise<{ [key: string]: any; }> { + ping(options?: AxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { return localVarFp.ping(options).then((request) => request(axios, basePath)); }, /** * Authenticate the user and return a token pair * @summary Refresh auth token - * @param {TokenRefresh} tokenRefresh + * @param {APIApiRefreshTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - refreshToken(tokenRefresh: TokenRefresh, options?: any): AxiosPromise { - return localVarFp.refreshToken(tokenRefresh, options).then((request) => request(axios, basePath)); + refreshToken(requestParameters: APIApiRefreshTokenRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.refreshToken(requestParameters.tokenRefresh, options).then((request) => request(axios, basePath)); }, /** * Verify an existent authentication token * @summary Verify token - * @param {TokenVerify} tokenVerify + * @param {APIApiVerifyTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - verifyToken(tokenVerify: TokenVerify, options?: any): AxiosPromise<{ [key: string]: any; }> { - return localVarFp.verifyToken(tokenVerify, options).then((request) => request(axios, basePath)); + verifyToken(requestParameters: APIApiVerifyTokenRequest, options?: AxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { + return localVarFp.verifyToken(requestParameters.tokenVerify, options).then((request) => request(axios, basePath)); }, }; }; @@ -13501,6 +13501,7 @@ export class APIApi extends BaseAPI { } + /** * AddressesApi - axios parameter creator * @export @@ -13529,20 +13530,20 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -13580,20 +13581,20 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13624,20 +13625,20 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13672,20 +13673,20 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13721,20 +13722,20 @@ export const AddressesApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -13827,22 +13828,22 @@ export const AddressesApiFactory = function (configuration?: Configuration, base /** * Create a new address. * @summary Create an address - * @param {AddressData} addressData + * @param {AddressesApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(addressData: AddressData, options?: any): AxiosPromise
{ - return localVarFp.create(addressData, options).then((request) => request(axios, basePath)); + create(requestParameters: AddressesApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise
{ + return localVarFp.create(requestParameters.addressData, options).then((request) => request(axios, basePath)); }, /** * Discard an address. * @summary Discard an address - * @param {string} id + * @param {AddressesApiDiscardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - discard(id: string, options?: any): AxiosPromise
{ - return localVarFp.discard(id, options).then((request) => request(axios, basePath)); + discard(requestParameters: AddressesApiDiscardRequest, options?: AxiosRequestConfig): AxiosPromise
{ + return localVarFp.discard(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Retrieve all addresses. @@ -13850,29 +13851,28 @@ export const AddressesApiFactory = function (configuration?: Configuration, base * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve an address. * @summary Retrieve an address - * @param {string} id + * @param {AddressesApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise
{ - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: AddressesApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise
{ + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * update an address. * @summary Update an address - * @param {string} id - * @param {PatchedAddressData} [patchedAddressData] + * @param {AddressesApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, patchedAddressData?: PatchedAddressData, options?: any): AxiosPromise
{ - return localVarFp.update(id, patchedAddressData, options).then((request) => request(axios, basePath)); + update(requestParameters: AddressesApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise
{ + return localVarFp.update(requestParameters.id, requestParameters.patchedAddressData, options).then((request) => request(axios, basePath)); }, }; }; @@ -14008,6 +14008,7 @@ export class AddressesApi extends BaseAPI { } + /** * BatchesApi - axios parameter creator * @export @@ -14036,20 +14037,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -14086,20 +14087,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -14136,20 +14137,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -14169,14 +14170,14 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati * @summary Import data files * @param {File} [dataFile] * @param {string} [dataTemplate] A data template slug to use for the import.<br/> **When nothing is specified, the system default headers are expected.** - * @param {'billing' | 'order' | 'shipment' | 'trackers'} [resourceType] The type of the resource to import + * @param {ImportFileResourceTypeEnum} [resourceType] The type of the resource to import * @param {string} [resourceType2] * @param {string} [dataTemplate2] * @param {File} [dataFile2] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - importFile: async (dataFile?: File, dataTemplate?: string, resourceType?: 'billing' | 'order' | 'shipment' | 'trackers', resourceType2?: string, dataTemplate2?: string, dataFile2?: File, options: AxiosRequestConfig = {}): Promise => { + importFile: async (dataFile?: File, dataTemplate?: string, resourceType?: ImportFileResourceTypeEnum, resourceType2?: string, dataTemplate2?: string, dataFile2?: File, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/v1/batches/data/import`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -14190,20 +14191,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarQueryParameter = {} as any; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (dataFile !== undefined) { localVarQueryParameter['data_file'] = dataFile; } @@ -14261,20 +14262,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -14309,20 +14310,20 @@ export const BatchesApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -14382,14 +14383,14 @@ export const BatchesApiFp = function(configuration?: Configuration) { * @summary Import data files * @param {File} [dataFile] * @param {string} [dataTemplate] A data template slug to use for the import.<br/> **When nothing is specified, the system default headers are expected.** - * @param {'billing' | 'order' | 'shipment' | 'trackers'} [resourceType] The type of the resource to import + * @param {ImportFileResourceTypeEnum} [resourceType] The type of the resource to import * @param {string} [resourceType2] * @param {string} [dataTemplate2] * @param {File} [dataFile2] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async importFile(dataFile?: File, dataTemplate?: string, resourceType?: 'billing' | 'order' | 'shipment' | 'trackers', resourceType2?: string, dataTemplate2?: string, dataFile2?: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async importFile(dataFile?: File, dataTemplate?: string, resourceType?: ImportFileResourceTypeEnum, resourceType2?: string, dataTemplate2?: string, dataFile2?: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.importFile(dataFile, dataTemplate, resourceType, resourceType2, dataTemplate2, dataFile2, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -14427,47 +14428,42 @@ export const BatchesApiFactory = function (configuration?: Configuration, basePa /** * Create multiple orders in a single batch. `Beta` * @summary Create orders - * @param {BatchOrderData} batchOrderData + * @param {BatchesApiCreateOrdersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createOrders(batchOrderData: BatchOrderData, options?: any): AxiosPromise { - return localVarFp.createOrders(batchOrderData, options).then((request) => request(axios, basePath)); + createOrders(requestParameters: BatchesApiCreateOrdersRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createOrders(requestParameters.batchOrderData, options).then((request) => request(axios, basePath)); }, /** * Create multiple shipments in a single batch. `Beta` * @summary Create shipments - * @param {BatchShipmentData} batchShipmentData + * @param {BatchesApiCreateShipmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createShipments(batchShipmentData: BatchShipmentData, options?: any): AxiosPromise { - return localVarFp.createShipments(batchShipmentData, options).then((request) => request(axios, basePath)); + createShipments(requestParameters: BatchesApiCreateShipmentsRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createShipments(requestParameters.batchShipmentData, options).then((request) => request(axios, basePath)); }, /** * Create multiple trackers in a single batch. `Beta` * @summary Create trackers - * @param {BatchTrackerData} batchTrackerData + * @param {BatchesApiCreateTrackersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createTrackers(batchTrackerData: BatchTrackerData, options?: any): AxiosPromise { - return localVarFp.createTrackers(batchTrackerData, options).then((request) => request(axios, basePath)); + createTrackers(requestParameters: BatchesApiCreateTrackersRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.createTrackers(requestParameters.batchTrackerData, options).then((request) => request(axios, basePath)); }, /** * Import csv, xls and xlsx data files for: `Beta`
- trackers data - orders data - shipments data - billing data (soon)

**This operation will return a batch operation that you can poll to follow the import progression.** * @summary Import data files - * @param {File} [dataFile] - * @param {string} [dataTemplate] A data template slug to use for the import.<br/> **When nothing is specified, the system default headers are expected.** - * @param {'billing' | 'order' | 'shipment' | 'trackers'} [resourceType] The type of the resource to import - * @param {string} [resourceType2] - * @param {string} [dataTemplate2] - * @param {File} [dataFile2] + * @param {BatchesApiImportFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - importFile(dataFile?: File, dataTemplate?: string, resourceType?: 'billing' | 'order' | 'shipment' | 'trackers', resourceType2?: string, dataTemplate2?: string, dataFile2?: File, options?: any): AxiosPromise { - return localVarFp.importFile(dataFile, dataTemplate, resourceType, resourceType2, dataTemplate2, dataFile2, options).then((request) => request(axios, basePath)); + importFile(requestParameters: BatchesApiImportFileRequest = {}, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.importFile(requestParameters.dataFile, requestParameters.dataTemplate, requestParameters.resourceType, requestParameters.resourceType2, requestParameters.dataTemplate2, requestParameters.dataFile2, options).then((request) => request(axios, basePath)); }, /** * Retrieve all batch operations. `Beta` @@ -14475,18 +14471,18 @@ export const BatchesApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve a batch operation. `Beta` * @summary Retrieve a batch operation - * @param {string} id + * @param {BatchesApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: BatchesApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, }; }; @@ -14558,7 +14554,7 @@ export interface BatchesApiImportFileRequest { * @type {'billing' | 'order' | 'shipment' | 'trackers'} * @memberof BatchesApiImportFile */ - readonly resourceType?: 'billing' | 'order' | 'shipment' | 'trackers' + readonly resourceType?: ImportFileResourceTypeEnum /** * @@ -14675,6 +14671,17 @@ export class BatchesApi extends BaseAPI { } } +/** + * @export + */ +export const ImportFileResourceTypeEnum = { + Billing: 'billing', + Order: 'order', + Shipment: 'shipment', + Trackers: 'trackers' +} as const; +export type ImportFileResourceTypeEnum = typeof ImportFileResourceTypeEnum[keyof typeof ImportFileResourceTypeEnum]; + /** * CarriersApi - axios parameter creator @@ -14685,11 +14692,11 @@ export const CarriersApiAxiosParamCreator = function (configuration?: Configurat /** * Retrieve a carrier\'s services * @summary Get carrier services - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {string} carrierName The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getServices: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', options: AxiosRequestConfig = {}): Promise => { + getServices: async (carrierName: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('getServices', 'carrierName', carrierName) const localVarPath = `/v1/carriers/{carrier_name}/services` @@ -14705,20 +14712,20 @@ export const CarriersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -14752,20 +14759,20 @@ export const CarriersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (active !== undefined) { localVarQueryParameter['active'] = active; } @@ -14802,11 +14809,11 @@ export const CarriersApiFp = function(configuration?: Configuration) { /** * Retrieve a carrier\'s services * @summary Get carrier services - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {string} carrierName The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getServices(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> { + async getServices(carrierName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getServices(carrierName, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -14836,24 +14843,22 @@ export const CarriersApiFactory = function (configuration?: Configuration, baseP /** * Retrieve a carrier\'s services * @summary Get carrier services - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {CarriersApiGetServicesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getServices(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', options?: any): AxiosPromise<{ [key: string]: any; }> { - return localVarFp.getServices(carrierName, options).then((request) => request(axios, basePath)); + getServices(requestParameters: CarriersApiGetServicesRequest, options?: AxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { + return localVarFp.getServices(requestParameters.carrierName, options).then((request) => request(axios, basePath)); }, /** * Returns the list of configured carriers * @summary List all carriers - * @param {boolean} [active] - * @param {string} [carrierName] The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` - * @param {boolean} [systemOnly] + * @param {CarriersApiListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(active?: boolean, carrierName?: string, systemOnly?: boolean, options?: any): AxiosPromise { - return localVarFp.list(active, carrierName, systemOnly, options).then((request) => request(axios, basePath)); + list(requestParameters: CarriersApiListRequest = {}, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.list(requestParameters.active, requestParameters.carrierName, requestParameters.systemOnly, options).then((request) => request(axios, basePath)); }, }; }; @@ -14865,11 +14870,11 @@ export const CarriersApiFactory = function (configuration?: Configuration, baseP */ export interface CarriersApiGetServicesRequest { /** - * - * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} + * The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` + * @type {string} * @memberof CarriersApiGetServices */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: string } /** @@ -14933,6 +14938,7 @@ export class CarriersApi extends BaseAPI { } + /** * CustomsApi - axios parameter creator * @export @@ -14961,20 +14967,20 @@ export const CustomsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -15012,20 +15018,20 @@ export const CustomsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15056,20 +15062,20 @@ export const CustomsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15104,20 +15110,20 @@ export const CustomsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15153,20 +15159,20 @@ export const CustomsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -15259,22 +15265,22 @@ export const CustomsApiFactory = function (configuration?: Configuration, basePa /** * Create a new customs declaration. * @summary Create a customs info - * @param {CustomsData} customsData + * @param {CustomsApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(customsData: CustomsData, options?: any): AxiosPromise { - return localVarFp.create(customsData, options).then((request) => request(axios, basePath)); + create(requestParameters: CustomsApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.customsData, options).then((request) => request(axios, basePath)); }, /** * Discard a customs declaration. * @summary Discard a customs info - * @param {string} id + * @param {CustomsApiDiscardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - discard(id: string, options?: any): AxiosPromise { - return localVarFp.discard(id, options).then((request) => request(axios, basePath)); + discard(requestParameters: CustomsApiDiscardRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.discard(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Retrieve all stored customs declarations. @@ -15282,29 +15288,28 @@ export const CustomsApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve customs declaration. * @summary Retrieve a customs info - * @param {string} id + * @param {CustomsApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: CustomsApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * modify an existing customs declaration. * @summary Update a customs info - * @param {string} id - * @param {PatchedCustomsData} [patchedCustomsData] + * @param {CustomsApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, patchedCustomsData?: PatchedCustomsData, options?: any): AxiosPromise { - return localVarFp.update(id, patchedCustomsData, options).then((request) => request(axios, basePath)); + update(requestParameters: CustomsApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.patchedCustomsData, options).then((request) => request(axios, basePath)); }, }; }; @@ -15440,6 +15445,7 @@ export class CustomsApi extends BaseAPI { } + /** * DocumentsApi - axios parameter creator * @export @@ -15468,20 +15474,20 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (createdAfter !== undefined) { localVarQueryParameter['created_after'] = (createdAfter as any instanceof Date) ? (createdAfter as any).toISOString() : @@ -15532,20 +15538,20 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15579,20 +15585,20 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -15665,34 +15671,32 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base /** * Retrieve all shipping document upload records. * @summary List all upload records - * @param {string} [createdAfter] - * @param {string} [createdBefore] - * @param {string} [shipmentId] + * @param {DocumentsApiListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(createdAfter?: string, createdBefore?: string, shipmentId?: string, options?: any): AxiosPromise { - return localVarFp.list(createdAfter, createdBefore, shipmentId, options).then((request) => request(axios, basePath)); + list(requestParameters: DocumentsApiListRequest = {}, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.list(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentId, options).then((request) => request(axios, basePath)); }, /** * Retrieve a shipping document upload record. * @summary Retrieve an upload record - * @param {string} id + * @param {DocumentsApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: DocumentsApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Upload a shipping document. * @summary Upload documents - * @param {DocumentUploadData} documentUploadData + * @param {DocumentsApiUploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - upload(documentUploadData: DocumentUploadData, options?: any): AxiosPromise { - return localVarFp.upload(documentUploadData, options).then((request) => request(axios, basePath)); + upload(requestParameters: DocumentsApiUploadRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.upload(requestParameters.documentUploadData, options).then((request) => request(axios, basePath)); }, }; }; @@ -15798,6 +15802,7 @@ export class DocumentsApi extends BaseAPI { } + /** * OrdersApi - axios parameter creator * @export @@ -15827,20 +15832,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15874,20 +15879,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -15926,20 +15931,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -15970,20 +15975,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16018,20 +16023,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16067,20 +16072,20 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -16185,33 +16190,33 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat /** * Cancel an order. * @summary Cancel an order - * @param {string} id + * @param {OrdersApiCancelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancel(id: string, options?: any): AxiosPromise { - return localVarFp.cancel(id, options).then((request) => request(axios, basePath)); + cancel(requestParameters: OrdersApiCancelRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.cancel(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Create a new order object. * @summary Create an order - * @param {OrderData} orderData + * @param {OrdersApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(orderData: OrderData, options?: any): AxiosPromise { - return localVarFp.create(orderData, options).then((request) => request(axios, basePath)); + create(requestParameters: OrdersApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.orderData, options).then((request) => request(axios, basePath)); }, /** * Dismiss an order from fulfillment. * @summary Dismiss an order - * @param {string} id + * @param {OrdersApiDismissRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - dismiss(id: string, options?: any): AxiosPromise { - return localVarFp.dismiss(id, options).then((request) => request(axios, basePath)); + dismiss(requestParameters: OrdersApiDismissRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.dismiss(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Retrieve all orders. @@ -16219,29 +16224,28 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve an order. * @summary Retrieve an order - * @param {string} id + * @param {OrdersApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: OrdersApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * This operation allows for updating properties of an order including `options` and `metadata`. It is not for editing the line items of an order. * @summary Update an order - * @param {string} id - * @param {OrderUpdateData} [orderUpdateData] + * @param {OrdersApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, orderUpdateData?: OrderUpdateData, options?: any): AxiosPromise { - return localVarFp.update(id, orderUpdateData, options).then((request) => request(axios, basePath)); + update(requestParameters: OrdersApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.orderUpdateData, options).then((request) => request(axios, basePath)); }, }; }; @@ -16404,6 +16408,7 @@ export class OrdersApi extends BaseAPI { } + /** * ParcelsApi - axios parameter creator * @export @@ -16432,20 +16437,20 @@ export const ParcelsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -16483,20 +16488,20 @@ export const ParcelsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16527,20 +16532,20 @@ export const ParcelsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16575,20 +16580,20 @@ export const ParcelsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16624,20 +16629,20 @@ export const ParcelsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -16730,22 +16735,22 @@ export const ParcelsApiFactory = function (configuration?: Configuration, basePa /** * Create a new parcel. * @summary Create a parcel - * @param {ParcelData} parcelData + * @param {ParcelsApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(parcelData: ParcelData, options?: any): AxiosPromise { - return localVarFp.create(parcelData, options).then((request) => request(axios, basePath)); + create(requestParameters: ParcelsApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.parcelData, options).then((request) => request(axios, basePath)); }, /** * Remove a parcel. * @summary Remove a parcel - * @param {string} id + * @param {ParcelsApiDiscardRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - discard(id: string, options?: any): AxiosPromise { - return localVarFp.discard(id, options).then((request) => request(axios, basePath)); + discard(requestParameters: ParcelsApiDiscardRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.discard(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Retrieve all stored parcels. @@ -16753,29 +16758,28 @@ export const ParcelsApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve a parcel. * @summary Retrieve a parcel - * @param {string} id + * @param {ParcelsApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: ParcelsApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * modify an existing parcel\'s details. * @summary Update a parcel - * @param {string} id - * @param {PatchedParcelData} [patchedParcelData] + * @param {ParcelsApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, patchedParcelData?: PatchedParcelData, options?: any): AxiosPromise { - return localVarFp.update(id, patchedParcelData, options).then((request) => request(axios, basePath)); + update(requestParameters: ParcelsApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.patchedParcelData, options).then((request) => request(axios, basePath)); }, }; }; @@ -16911,6 +16915,7 @@ export class ParcelsApi extends BaseAPI { } + /** * PickupsApi - axios parameter creator * @export @@ -16941,20 +16946,20 @@ export const PickupsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -16988,20 +16993,20 @@ export const PickupsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17036,20 +17041,20 @@ export const PickupsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17087,20 +17092,20 @@ export const PickupsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17141,20 +17146,20 @@ export const PickupsApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17249,13 +17254,12 @@ export const PickupsApiFactory = function (configuration?: Configuration, basePa /** * Cancel a pickup of one or more shipments. * @summary Cancel a pickup - * @param {string} id - * @param {PickupCancelData} [pickupCancelData] + * @param {PickupsApiCancelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancel(id: string, pickupCancelData?: PickupCancelData, options?: any): AxiosPromise { - return localVarFp.cancel(id, pickupCancelData, options).then((request) => request(axios, basePath)); + cancel(requestParameters: PickupsApiCancelRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.cancel(requestParameters.id, requestParameters.pickupCancelData, options).then((request) => request(axios, basePath)); }, /** * Retrieve all scheduled pickups. @@ -17263,40 +17267,38 @@ export const PickupsApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Retrieve a scheduled pickup. * @summary Retrieve a pickup - * @param {string} id + * @param {PickupsApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: PickupsApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Schedule a pickup for one or many shipments with labels already purchased. * @summary Schedule a pickup - * @param {string} carrierName - * @param {PickupData} pickupData + * @param {PickupsApiScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - schedule(carrierName: string, pickupData: PickupData, options?: any): AxiosPromise { - return localVarFp.schedule(carrierName, pickupData, options).then((request) => request(axios, basePath)); + schedule(requestParameters: PickupsApiScheduleRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.schedule(requestParameters.carrierName, requestParameters.pickupData, options).then((request) => request(axios, basePath)); }, /** * Modify a pickup for one or many shipments with labels already purchased. * @summary Update a pickup - * @param {string} id - * @param {PickupUpdateData} pickupUpdateData + * @param {PickupsApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, pickupUpdateData: PickupUpdateData, options?: any): AxiosPromise { - return localVarFp.update(id, pickupUpdateData, options).then((request) => request(axios, basePath)); + update(requestParameters: PickupsApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.pickupUpdateData, options).then((request) => request(axios, basePath)); }, }; }; @@ -17446,6 +17448,7 @@ export class PickupsApi extends BaseAPI { } + /** * ProxyApi - axios parameter creator * @export @@ -17474,20 +17477,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17505,12 +17508,12 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration /** * Cancel a pickup previously scheduled * @summary Cancel a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {CancelPickupCarrierNameEnum} carrierName * @param {PickupCancelRequest} pickupCancelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelPickup: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupCancelRequest: PickupCancelRequest, options: AxiosRequestConfig = {}): Promise => { + cancelPickup: async (carrierName: CancelPickupCarrierNameEnum, pickupCancelRequest: PickupCancelRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('cancelPickup', 'carrierName', carrierName) // verify required parameter 'pickupCancelRequest' is not null or undefined @@ -17528,20 +17531,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17578,20 +17581,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17629,20 +17632,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (hub !== undefined) { localVarQueryParameter['hub'] = hub; } @@ -17664,12 +17667,12 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration /** * Schedule one or many parcels pickup * @summary Schedule a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {SchedulePickupCarrierNameEnum} carrierName * @param {PickupRequest} pickupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - schedulePickup: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupRequest: PickupRequest, options: AxiosRequestConfig = {}): Promise => { + schedulePickup: async (carrierName: SchedulePickupCarrierNameEnum, pickupRequest: PickupRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('schedulePickup', 'carrierName', carrierName) // verify required parameter 'pickupRequest' is not null or undefined @@ -17687,20 +17690,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17718,14 +17721,14 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration /** * You can track a shipment by specifying the carrier and the shipment tracking number. * @summary Track a shipment - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {TrackShipmentCarrierNameEnum} carrierName * @param {string} trackingNumber * @param {string} [hub] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - trackShipment: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options: AxiosRequestConfig = {}): Promise => { + trackShipment: async (carrierName: TrackShipmentCarrierNameEnum, trackingNumber: string, hub?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('trackShipment', 'carrierName', carrierName) // verify required parameter 'trackingNumber' is not null or undefined @@ -17744,20 +17747,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (hub !== undefined) { localVarQueryParameter['hub'] = hub; } @@ -17776,12 +17779,12 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration /** * Modify a scheduled pickup * @summary Update a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {UpdatePickupCarrierNameEnum} carrierName * @param {PickupUpdateRequest} pickupUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updatePickup: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupUpdateRequest: PickupUpdateRequest, options: AxiosRequestConfig = {}): Promise => { + updatePickup: async (carrierName: UpdatePickupCarrierNameEnum, pickupUpdateRequest: PickupUpdateRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('updatePickup', 'carrierName', carrierName) // verify required parameter 'pickupUpdateRequest' is not null or undefined @@ -17799,20 +17802,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17830,12 +17833,12 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration /** * Cancel a shipment and the label previously created * @summary Void a shipment label - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {VoidLabelCarrierNameEnum} carrierName * @param {ShipmentCancelRequest} shipmentCancelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - voidLabel: async (carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', shipmentCancelRequest: ShipmentCancelRequest, options: AxiosRequestConfig = {}): Promise => { + voidLabel: async (carrierName: VoidLabelCarrierNameEnum, shipmentCancelRequest: ShipmentCancelRequest, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('voidLabel', 'carrierName', carrierName) // verify required parameter 'shipmentCancelRequest' is not null or undefined @@ -17853,20 +17856,20 @@ export const ProxyApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -17905,12 +17908,12 @@ export const ProxyApiFp = function(configuration?: Configuration) { /** * Cancel a pickup previously scheduled * @summary Cancel a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {CancelPickupCarrierNameEnum} carrierName * @param {PickupCancelRequest} pickupCancelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cancelPickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupCancelRequest: PickupCancelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async cancelPickup(carrierName: CancelPickupCarrierNameEnum, pickupCancelRequest: PickupCancelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.cancelPickup(carrierName, pickupCancelRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -17940,50 +17943,50 @@ export const ProxyApiFp = function(configuration?: Configuration) { /** * Schedule one or many parcels pickup * @summary Schedule a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {SchedulePickupCarrierNameEnum} carrierName * @param {PickupRequest} pickupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async schedulePickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupRequest: PickupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async schedulePickup(carrierName: SchedulePickupCarrierNameEnum, pickupRequest: PickupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.schedulePickup(carrierName, pickupRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * You can track a shipment by specifying the carrier and the shipment tracking number. * @summary Track a shipment - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {TrackShipmentCarrierNameEnum} carrierName * @param {string} trackingNumber * @param {string} [hub] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - async trackShipment(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async trackShipment(carrierName: TrackShipmentCarrierNameEnum, trackingNumber: string, hub?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.trackShipment(carrierName, trackingNumber, hub, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Modify a scheduled pickup * @summary Update a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {UpdatePickupCarrierNameEnum} carrierName * @param {PickupUpdateRequest} pickupUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updatePickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupUpdateRequest: PickupUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async updatePickup(carrierName: UpdatePickupCarrierNameEnum, pickupUpdateRequest: PickupUpdateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updatePickup(carrierName, pickupUpdateRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Cancel a shipment and the label previously created * @summary Void a shipment label - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName + * @param {VoidLabelCarrierNameEnum} carrierName * @param {ShipmentCancelRequest} shipmentCancelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async voidLabel(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', shipmentCancelRequest: ShipmentCancelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async voidLabel(carrierName: VoidLabelCarrierNameEnum, shipmentCancelRequest: ShipmentCancelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.voidLabel(carrierName, shipmentCancelRequest, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -18000,90 +18003,83 @@ export const ProxyApiFactory = function (configuration?: Configuration, basePath /** * Once the shipping rates are retrieved, provide the required info to submit the shipment by specifying your preferred rate. * @summary Buy a shipment label - * @param {ShippingRequest} shippingRequest + * @param {ProxyApiBuyLabelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - buyLabel(shippingRequest: ShippingRequest, options?: any): AxiosPromise { - return localVarFp.buyLabel(shippingRequest, options).then((request) => request(axios, basePath)); + buyLabel(requestParameters: ProxyApiBuyLabelRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.buyLabel(requestParameters.shippingRequest, options).then((request) => request(axios, basePath)); }, /** * Cancel a pickup previously scheduled * @summary Cancel a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName - * @param {PickupCancelRequest} pickupCancelRequest + * @param {ProxyApiCancelPickupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelPickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupCancelRequest: PickupCancelRequest, options?: any): AxiosPromise { - return localVarFp.cancelPickup(carrierName, pickupCancelRequest, options).then((request) => request(axios, basePath)); + cancelPickup(requestParameters: ProxyApiCancelPickupRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.cancelPickup(requestParameters.carrierName, requestParameters.pickupCancelRequest, options).then((request) => request(axios, basePath)); }, /** * The Shipping process begins by fetching rates for your shipment. Use this service to fetch a shipping rates available. * @summary Fetch shipment rates - * @param {RateRequest} rateRequest + * @param {ProxyApiFetchRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchRates(rateRequest: RateRequest, options?: any): AxiosPromise { - return localVarFp.fetchRates(rateRequest, options).then((request) => request(axios, basePath)); + fetchRates(requestParameters: ProxyApiFetchRatesRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.fetchRates(requestParameters.rateRequest, options).then((request) => request(axios, basePath)); }, /** * You can track a shipment by specifying the carrier and the shipment tracking number. * @summary Get tracking details - * @param {TrackingData} trackingData - * @param {string} [hub] + * @param {ProxyApiGetTrackingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTracking(trackingData: TrackingData, hub?: string, options?: any): AxiosPromise { - return localVarFp.getTracking(trackingData, hub, options).then((request) => request(axios, basePath)); + getTracking(requestParameters: ProxyApiGetTrackingRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.getTracking(requestParameters.trackingData, requestParameters.hub, options).then((request) => request(axios, basePath)); }, /** * Schedule one or many parcels pickup * @summary Schedule a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName - * @param {PickupRequest} pickupRequest + * @param {ProxyApiSchedulePickupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - schedulePickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupRequest: PickupRequest, options?: any): AxiosPromise { - return localVarFp.schedulePickup(carrierName, pickupRequest, options).then((request) => request(axios, basePath)); + schedulePickup(requestParameters: ProxyApiSchedulePickupRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.schedulePickup(requestParameters.carrierName, requestParameters.pickupRequest, options).then((request) => request(axios, basePath)); }, /** * You can track a shipment by specifying the carrier and the shipment tracking number. * @summary Track a shipment - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName - * @param {string} trackingNumber - * @param {string} [hub] + * @param {ProxyApiTrackShipmentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - trackShipment(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options?: any): AxiosPromise { - return localVarFp.trackShipment(carrierName, trackingNumber, hub, options).then((request) => request(axios, basePath)); + trackShipment(requestParameters: ProxyApiTrackShipmentRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.trackShipment(requestParameters.carrierName, requestParameters.trackingNumber, requestParameters.hub, options).then((request) => request(axios, basePath)); }, /** * Modify a scheduled pickup * @summary Update a pickup - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName - * @param {PickupUpdateRequest} pickupUpdateRequest + * @param {ProxyApiUpdatePickupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updatePickup(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', pickupUpdateRequest: PickupUpdateRequest, options?: any): AxiosPromise { - return localVarFp.updatePickup(carrierName, pickupUpdateRequest, options).then((request) => request(axios, basePath)); + updatePickup(requestParameters: ProxyApiUpdatePickupRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.updatePickup(requestParameters.carrierName, requestParameters.pickupUpdateRequest, options).then((request) => request(axios, basePath)); }, /** * Cancel a shipment and the label previously created * @summary Void a shipment label - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName - * @param {ShipmentCancelRequest} shipmentCancelRequest + * @param {ProxyApiVoidLabelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - voidLabel(carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', shipmentCancelRequest: ShipmentCancelRequest, options?: any): AxiosPromise { - return localVarFp.voidLabel(carrierName, shipmentCancelRequest, options).then((request) => request(axios, basePath)); + voidLabel(requestParameters: ProxyApiVoidLabelRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.voidLabel(requestParameters.carrierName, requestParameters.shipmentCancelRequest, options).then((request) => request(axios, basePath)); }, }; }; @@ -18113,7 +18109,7 @@ export interface ProxyApiCancelPickupRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof ProxyApiCancelPickup */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: CancelPickupCarrierNameEnum /** * @@ -18169,7 +18165,7 @@ export interface ProxyApiSchedulePickupRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof ProxyApiSchedulePickup */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: SchedulePickupCarrierNameEnum /** * @@ -18190,7 +18186,7 @@ export interface ProxyApiTrackShipmentRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof ProxyApiTrackShipment */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: TrackShipmentCarrierNameEnum /** * @@ -18218,7 +18214,7 @@ export interface ProxyApiUpdatePickupRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof ProxyApiUpdatePickup */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: UpdatePickupCarrierNameEnum /** * @@ -18239,7 +18235,7 @@ export interface ProxyApiVoidLabelRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof ProxyApiVoidLabel */ - readonly carrierName: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName: VoidLabelCarrierNameEnum /** * @@ -18354,97 +18350,290 @@ export class ProxyApi extends BaseAPI { } } - /** - * ShipmentsApi - axios parameter creator * @export */ -export const ShipmentsApiAxiosParamCreator = function (configuration?: Configuration) { - return { - /** - * Void a shipment with the associated label. - * @summary Cancel a shipment - * @param {string} id - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - cancel: async (id: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('cancel', 'id', id) - const localVarPath = `/v1/shipments/{id}/cancel` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - // authentication OAuth2 required - // oauth required - await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - - // authentication Token required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - - // authentication TokenBasic required - // http basic authentication required - setBasicAuthToObject(localVarRequestOptions, configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Create a new shipment instance. - * @summary Create a shipment - * @param {ShipmentData} shipmentData - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - create: async (shipmentData: ShipmentData, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'shipmentData' is not null or undefined - assertParamExists('create', 'shipmentData', shipmentData) - const localVarPath = `/v1/shipments`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) +export const CancelPickupCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Easypost: 'easypost', + Eshipper: 'eshipper', + Fedex: 'fedex', + Freightcom: 'freightcom', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type CancelPickupCarrierNameEnum = typeof CancelPickupCarrierNameEnum[keyof typeof CancelPickupCarrierNameEnum]; +/** + * @export + */ +export const SchedulePickupCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Easypost: 'easypost', + Eshipper: 'eshipper', + Fedex: 'fedex', + Freightcom: 'freightcom', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type SchedulePickupCarrierNameEnum = typeof SchedulePickupCarrierNameEnum[keyof typeof SchedulePickupCarrierNameEnum]; +/** + * @export + */ +export const TrackShipmentCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Fedex: 'fedex', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type TrackShipmentCarrierNameEnum = typeof TrackShipmentCarrierNameEnum[keyof typeof TrackShipmentCarrierNameEnum]; +/** + * @export + */ +export const UpdatePickupCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Easypost: 'easypost', + Eshipper: 'eshipper', + Fedex: 'fedex', + Freightcom: 'freightcom', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type UpdatePickupCarrierNameEnum = typeof UpdatePickupCarrierNameEnum[keyof typeof UpdatePickupCarrierNameEnum]; +/** + * @export + */ +export const VoidLabelCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Easypost: 'easypost', + Eshipper: 'eshipper', + Fedex: 'fedex', + Freightcom: 'freightcom', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type VoidLabelCarrierNameEnum = typeof VoidLabelCarrierNameEnum[keyof typeof VoidLabelCarrierNameEnum]; + + +/** + * ShipmentsApi - axios parameter creator + * @export + */ +export const ShipmentsApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Void a shipment with the associated label. + * @summary Cancel a shipment + * @param {string} id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + cancel: async (id: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('cancel', 'id', id) + const localVarPath = `/v1/shipments/{id}/cancel` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) + // authentication JWT required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + // authentication TokenBasic required + // http basic authentication required + setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Create a new shipment instance. + * @summary Create a shipment + * @param {ShipmentData} shipmentData + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + create: async (shipmentData: ShipmentData, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'shipmentData' is not null or undefined + assertParamExists('create', 'shipmentData', shipmentData) + const localVarPath = `/v1/shipments`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication OAuth2 required + // oauth required + await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) + + // authentication JWT required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -18463,7 +18652,7 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura * Retrieve all shipments. * @summary List all shipments * @param {string} [address] - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] + * @param {string} [carrierName] The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {string} [createdAfter] * @param {string} [createdBefore] * @param {string} [keyword] @@ -18473,12 +18662,12 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura * @param {string} [optionValue] * @param {string} [reference] * @param {string} [service] - * @param {'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped'} [status] + * @param {string} [status] Valid shipment status. <br/>Values: `draft`, `purchased`, `cancelled`, `shipped`, `in_transit`, `delivered`, `needs_attention`, `out_for_delivery`, `delivery_failed` * @param {string} [trackingNumber] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list: async (address?: string, carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, keyword?: string, metadataKey?: string, metadataValue?: string, optionKey?: string, optionValue?: string, reference?: string, service?: string, status?: 'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped', trackingNumber?: string, options: AxiosRequestConfig = {}): Promise => { + list: async (address?: string, carrierName?: string, createdAfter?: string, createdBefore?: string, keyword?: string, metadataKey?: string, metadataValue?: string, optionKey?: string, optionValue?: string, reference?: string, service?: string, status?: string, trackingNumber?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/v1/shipments`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -18491,20 +18680,20 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (address !== undefined) { localVarQueryParameter['address'] = address; } @@ -18598,20 +18787,20 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -18650,20 +18839,20 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -18701,20 +18890,20 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18750,20 +18939,20 @@ export const ShipmentsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -18814,7 +19003,7 @@ export const ShipmentsApiFp = function(configuration?: Configuration) { * Retrieve all shipments. * @summary List all shipments * @param {string} [address] - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] + * @param {string} [carrierName] The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {string} [createdAfter] * @param {string} [createdBefore] * @param {string} [keyword] @@ -18824,12 +19013,12 @@ export const ShipmentsApiFp = function(configuration?: Configuration) { * @param {string} [optionValue] * @param {string} [reference] * @param {string} [service] - * @param {'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped'} [status] + * @param {string} [status] Valid shipment status. <br/>Values: `draft`, `purchased`, `cancelled`, `shipped`, `in_transit`, `delivered`, `needs_attention`, `out_for_delivery`, `delivery_failed` * @param {string} [trackingNumber] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async list(address?: string, carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, keyword?: string, metadataKey?: string, metadataValue?: string, optionKey?: string, optionValue?: string, reference?: string, service?: string, status?: 'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped', trackingNumber?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async list(address?: string, carrierName?: string, createdAfter?: string, createdBefore?: string, keyword?: string, metadataKey?: string, metadataValue?: string, optionKey?: string, optionValue?: string, reference?: string, service?: string, status?: string, trackingNumber?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.list(address, carrierName, createdAfter, createdBefore, keyword, metadataKey, metadataValue, optionKey, optionValue, reference, service, status, trackingNumber, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -18893,87 +19082,72 @@ export const ShipmentsApiFactory = function (configuration?: Configuration, base /** * Void a shipment with the associated label. * @summary Cancel a shipment - * @param {string} id + * @param {ShipmentsApiCancelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancel(id: string, options?: any): AxiosPromise { - return localVarFp.cancel(id, options).then((request) => request(axios, basePath)); + cancel(requestParameters: ShipmentsApiCancelRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.cancel(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Create a new shipment instance. * @summary Create a shipment - * @param {ShipmentData} shipmentData + * @param {ShipmentsApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(shipmentData: ShipmentData, options?: any): AxiosPromise { - return localVarFp.create(shipmentData, options).then((request) => request(axios, basePath)); + create(requestParameters: ShipmentsApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.shipmentData, options).then((request) => request(axios, basePath)); }, /** * Retrieve all shipments. * @summary List all shipments - * @param {string} [address] - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] - * @param {string} [createdAfter] - * @param {string} [createdBefore] - * @param {string} [keyword] - * @param {string} [metadataKey] - * @param {string} [metadataValue] - * @param {string} [optionKey] - * @param {string} [optionValue] - * @param {string} [reference] - * @param {string} [service] - * @param {'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped'} [status] - * @param {string} [trackingNumber] + * @param {ShipmentsApiListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(address?: string, carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, keyword?: string, metadataKey?: string, metadataValue?: string, optionKey?: string, optionValue?: string, reference?: string, service?: string, status?: 'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped', trackingNumber?: string, options?: any): AxiosPromise { - return localVarFp.list(address, carrierName, createdAfter, createdBefore, keyword, metadataKey, metadataValue, optionKey, optionValue, reference, service, status, trackingNumber, options).then((request) => request(axios, basePath)); + list(requestParameters: ShipmentsApiListRequest = {}, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.list(requestParameters.address, requestParameters.carrierName, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.keyword, requestParameters.metadataKey, requestParameters.metadataValue, requestParameters.optionKey, requestParameters.optionValue, requestParameters.reference, requestParameters.service, requestParameters.status, requestParameters.trackingNumber, options).then((request) => request(axios, basePath)); }, /** * Select your preferred rates to buy a shipment label. * @summary Buy a shipment label - * @param {string} id - * @param {ShipmentPurchaseData} shipmentPurchaseData + * @param {ShipmentsApiPurchaseRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - purchase(id: string, shipmentPurchaseData: ShipmentPurchaseData, options?: any): AxiosPromise { - return localVarFp.purchase(id, shipmentPurchaseData, options).then((request) => request(axios, basePath)); + purchase(requestParameters: ShipmentsApiPurchaseRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.purchase(requestParameters.id, requestParameters.shipmentPurchaseData, options).then((request) => request(axios, basePath)); }, /** * Refresh the list of the shipment rates * @summary Fetch new shipment rates - * @param {string} id - * @param {ShipmentRateData} [shipmentRateData] + * @param {ShipmentsApiRatesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - rates(id: string, shipmentRateData?: ShipmentRateData, options?: any): AxiosPromise { - return localVarFp.rates(id, shipmentRateData, options).then((request) => request(axios, basePath)); + rates(requestParameters: ShipmentsApiRatesRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.rates(requestParameters.id, requestParameters.shipmentRateData, options).then((request) => request(axios, basePath)); }, /** * Retrieve a shipment. * @summary Retrieve a shipment - * @param {string} id + * @param {ShipmentsApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: ShipmentsApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * This operation allows for updating properties of a shipment including `label_type`, `reference`, `payment`, `options` and `metadata`. It is not for editing the parcels of a shipment. * @summary Update a shipment - * @param {string} id - * @param {ShipmentUpdateData} [shipmentUpdateData] + * @param {ShipmentsApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, shipmentUpdateData?: ShipmentUpdateData, options?: any): AxiosPromise { - return localVarFp.update(id, shipmentUpdateData, options).then((request) => request(axios, basePath)); + update(requestParameters: ShipmentsApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.shipmentUpdateData, options).then((request) => request(axios, basePath)); }, }; }; @@ -19020,11 +19194,11 @@ export interface ShipmentsApiListRequest { readonly address?: string /** - * - * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} + * The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` + * @type {string} * @memberof ShipmentsApiList */ - readonly carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName?: string /** * @@ -19090,11 +19264,11 @@ export interface ShipmentsApiListRequest { readonly service?: string /** - * - * @type {'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped'} + * Valid shipment status. <br/>Values: `draft`, `purchased`, `cancelled`, `shipped`, `in_transit`, `delivered`, `needs_attention`, `out_for_delivery`, `delivery_failed` + * @type {string} * @memberof ShipmentsApiList */ - readonly status?: 'cancelled' | 'delivered' | 'delivery_failed' | 'draft' | 'in_transit' | 'needs_attention' | 'out_for_delivery' | 'purchased' | 'shipped' + readonly status?: string /** * @@ -19274,6 +19448,7 @@ export class ShipmentsApi extends BaseAPI { } + /** * TrackersApi - axios parameter creator * @export @@ -19304,20 +19479,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (hub !== undefined) { localVarQueryParameter['hub'] = hub; } @@ -19344,14 +19519,14 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat * This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress. * @summary Create a package tracker * @param {string} carrierName - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName2 + * @param {CreateCarrierNameEnum} carrierName2 * @param {string} trackingNumber * @param {string} [hub] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - create: async (carrierName: string, carrierName2: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options: AxiosRequestConfig = {}): Promise => { + create: async (carrierName: string, carrierName2: CreateCarrierNameEnum, trackingNumber: string, hub?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'carrierName' is not null or undefined assertParamExists('create', 'carrierName', carrierName) // verify required parameter 'carrierName2' is not null or undefined @@ -19372,20 +19547,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (carrierName2 !== undefined) { localVarQueryParameter['carrier_name'] = carrierName2; } @@ -19408,15 +19583,15 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat /** * Retrieve all shipment trackers. * @summary List all package trackers - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] + * @param {string} [carrierName] The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {string} [createdAfter] * @param {string} [createdBefore] - * @param {'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown'} [status] + * @param {string} [status] Valid tracker status. <br/>Values: `pending`, `unknown`, `delivered`, `on_hold`, `in_transit`, `delivery_delayed`, `out_for_delivery`, `ready_for_pickup`, `delivery_failed` * @param {string} [trackingNumber] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list: async (carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, status?: 'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown', trackingNumber?: string, options: AxiosRequestConfig = {}): Promise => { + list: async (carrierName?: string, createdAfter?: string, createdBefore?: string, status?: string, trackingNumber?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/v1/trackers`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -19429,20 +19604,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (carrierName !== undefined) { localVarQueryParameter['carrier_name'] = carrierName; } @@ -19501,20 +19676,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -19549,20 +19724,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -19598,20 +19773,20 @@ export const TrackersApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -19653,29 +19828,29 @@ export const TrackersApiFp = function(configuration?: Configuration) { * This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress. * @summary Create a package tracker * @param {string} carrierName - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName2 + * @param {CreateCarrierNameEnum} carrierName2 * @param {string} trackingNumber * @param {string} [hub] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - async create(carrierName: string, carrierName2: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async create(carrierName: string, carrierName2: CreateCarrierNameEnum, trackingNumber: string, hub?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.create(carrierName, carrierName2, trackingNumber, hub, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Retrieve all shipment trackers. * @summary List all package trackers - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] + * @param {string} [carrierName] The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` * @param {string} [createdAfter] * @param {string} [createdBefore] - * @param {'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown'} [status] + * @param {string} [status] Valid tracker status. <br/>Values: `pending`, `unknown`, `delivered`, `on_hold`, `in_transit`, `delivery_delayed`, `out_for_delivery`, `ready_for_pickup`, `delivery_failed` * @param {string} [trackingNumber] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async list(carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, status?: 'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown', trackingNumber?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async list(carrierName?: string, createdAfter?: string, createdBefore?: string, status?: string, trackingNumber?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.list(carrierName, createdAfter, createdBefore, status, trackingNumber, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, @@ -19726,73 +19901,63 @@ export const TrackersApiFactory = function (configuration?: Configuration, baseP /** * This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress. * @summary Add a package tracker - * @param {TrackingData} trackingData - * @param {string} [hub] - * @param {boolean} [pendingPickup] Add this flag to add the tracker whether the tracking info exist or not.When the package is eventually picked up, the tracker with capture real time updates. + * @param {TrackersApiAddRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - add(trackingData: TrackingData, hub?: string, pendingPickup?: boolean, options?: any): AxiosPromise { - return localVarFp.add(trackingData, hub, pendingPickup, options).then((request) => request(axios, basePath)); + add(requestParameters: TrackersApiAddRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.add(requestParameters.trackingData, requestParameters.hub, requestParameters.pendingPickup, options).then((request) => request(axios, basePath)); }, /** * This API creates or retrieves (if existent) a tracking status object containing the details and events of a shipping in progress. * @summary Create a package tracker - * @param {string} carrierName - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} carrierName2 - * @param {string} trackingNumber - * @param {string} [hub] + * @param {TrackersApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - create(carrierName: string, carrierName2: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', trackingNumber: string, hub?: string, options?: any): AxiosPromise { - return localVarFp.create(carrierName, carrierName2, trackingNumber, hub, options).then((request) => request(axios, basePath)); + create(requestParameters: TrackersApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.carrierName, requestParameters.carrierName2, requestParameters.trackingNumber, requestParameters.hub, options).then((request) => request(axios, basePath)); }, /** * Retrieve all shipment trackers. * @summary List all package trackers - * @param {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} [carrierName] - * @param {string} [createdAfter] - * @param {string} [createdBefore] - * @param {'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown'} [status] - * @param {string} [trackingNumber] + * @param {TrackersApiListRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress', createdAfter?: string, createdBefore?: string, status?: 'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown', trackingNumber?: string, options?: any): AxiosPromise { - return localVarFp.list(carrierName, createdAfter, createdBefore, status, trackingNumber, options).then((request) => request(axios, basePath)); + list(requestParameters: TrackersApiListRequest = {}, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.list(requestParameters.carrierName, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.status, requestParameters.trackingNumber, options).then((request) => request(axios, basePath)); }, /** * Discard a package tracker. * @summary Discard a package tracker - * @param {string} idOrTrackingNumber + * @param {TrackersApiRemoveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - remove(idOrTrackingNumber: string, options?: any): AxiosPromise { - return localVarFp.remove(idOrTrackingNumber, options).then((request) => request(axios, basePath)); + remove(requestParameters: TrackersApiRemoveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.remove(requestParameters.idOrTrackingNumber, options).then((request) => request(axios, basePath)); }, /** * Retrieve a package tracker * @summary Retrieves a package tracker - * @param {string} idOrTrackingNumber + * @param {TrackersApiRetrievesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieves(idOrTrackingNumber: string, options?: any): AxiosPromise { - return localVarFp.retrieves(idOrTrackingNumber, options).then((request) => request(axios, basePath)); + retrieves(requestParameters: TrackersApiRetrievesRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieves(requestParameters.idOrTrackingNumber, options).then((request) => request(axios, basePath)); }, /** * Mixin to log requests * @summary Update tracker data - * @param {string} idOrTrackingNumber - * @param {TrackerUpdateData} [trackerUpdateData] + * @param {TrackersApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(idOrTrackingNumber: string, trackerUpdateData?: TrackerUpdateData, options?: any): AxiosPromise { - return localVarFp.update(idOrTrackingNumber, trackerUpdateData, options).then((request) => request(axios, basePath)); + update(requestParameters: TrackersApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.idOrTrackingNumber, requestParameters.trackerUpdateData, options).then((request) => request(axios, basePath)); }, }; }; @@ -19843,7 +20008,7 @@ export interface TrackersApiCreateRequest { * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} * @memberof TrackersApiCreate */ - readonly carrierName2: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'fedex' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName2: CreateCarrierNameEnum /** * @@ -19867,11 +20032,11 @@ export interface TrackersApiCreateRequest { */ export interface TrackersApiListRequest { /** - * - * @type {'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress'} + * The unique carrier slug. <br/>Values: `amazon_mws`, `aramex`, `australiapost`, `boxknight`, `canadapost`, `canpar`, `chronopost`, `dhl_express`, `dhl_poland`, `dhl_universal`, `dicom`, `dpd`, `dpdhl`, `easypost`, `eshipper`, `fedex`, `freightcom`, `generic`, `geodis`, `laposte`, `nationex`, `purolator`, `roadie`, `royalmail`, `sendle`, `sf_express`, `tnt`, `ups`, `ups_freight`, `usps`, `usps_international`, `yanwen`, `yunexpress` + * @type {string} * @memberof TrackersApiList */ - readonly carrierName?: 'amazon_mws' | 'aramex' | 'australiapost' | 'boxknight' | 'canadapost' | 'canpar' | 'chronopost' | 'dhl_express' | 'dhl_poland' | 'dhl_universal' | 'dicom' | 'dpd' | 'dpdhl' | 'easypost' | 'eshipper' | 'fedex' | 'freightcom' | 'generic' | 'geodis' | 'laposte' | 'nationex' | 'purolator' | 'roadie' | 'royalmail' | 'sendle' | 'sf_express' | 'tnt' | 'ups' | 'ups_freight' | 'usps' | 'usps_international' | 'yanwen' | 'yunexpress' + readonly carrierName?: string /** * @@ -19888,11 +20053,11 @@ export interface TrackersApiListRequest { readonly createdBefore?: string /** - * - * @type {'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown'} + * Valid tracker status. <br/>Values: `pending`, `unknown`, `delivered`, `on_hold`, `in_transit`, `delivery_delayed`, `out_for_delivery`, `ready_for_pickup`, `delivery_failed` + * @type {string} * @memberof TrackersApiList */ - readonly status?: 'delivered' | 'delivery_delayed' | 'delivery_failed' | 'in_transit' | 'on_hold' | 'out_for_delivery' | 'pending' | 'ready_for_pickup' | 'unknown' + readonly status?: string /** * @@ -20032,6 +20197,43 @@ export class TrackersApi extends BaseAPI { } } +/** + * @export + */ +export const CreateCarrierNameEnum = { + AmazonMws: 'amazon_mws', + Aramex: 'aramex', + Australiapost: 'australiapost', + Boxknight: 'boxknight', + Canadapost: 'canadapost', + Canpar: 'canpar', + Chronopost: 'chronopost', + DhlExpress: 'dhl_express', + DhlPoland: 'dhl_poland', + DhlUniversal: 'dhl_universal', + Dicom: 'dicom', + Dpd: 'dpd', + Dpdhl: 'dpdhl', + Fedex: 'fedex', + Generic: 'generic', + Geodis: 'geodis', + Laposte: 'laposte', + Nationex: 'nationex', + Purolator: 'purolator', + Roadie: 'roadie', + Royalmail: 'royalmail', + Sendle: 'sendle', + SfExpress: 'sf_express', + Tnt: 'tnt', + Ups: 'ups', + UpsFreight: 'ups_freight', + Usps: 'usps', + UspsInternational: 'usps_international', + Yanwen: 'yanwen', + Yunexpress: 'yunexpress' +} as const; +export type CreateCarrierNameEnum = typeof CreateCarrierNameEnum[keyof typeof CreateCarrierNameEnum]; + /** * WebhooksApi - axios parameter creator @@ -20061,20 +20263,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -20108,20 +20310,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -20156,20 +20358,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -20204,20 +20406,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -20255,20 +20457,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -20307,20 +20509,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - // authentication JWT required - await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - // authentication OAuth2 required // oauth required await setOAuthToObject(localVarHeaderParameter, "OAuth2", [], configuration) - // authentication Token required + // authentication JWT required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) // authentication TokenBasic required // http basic authentication required setBasicAuthToObject(localVarRequestOptions, configuration) + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -20425,12 +20627,12 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP /** * Create a new webhook. * @summary Create a webhook - * @param {WebhookData} webhookData + * @param {WebhooksApiCreateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - create(webhookData: WebhookData, options?: any): AxiosPromise { - return localVarFp.create(webhookData, options).then((request) => request(axios, basePath)); + create(requestParameters: WebhooksApiCreateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.create(requestParameters.webhookData, options).then((request) => request(axios, basePath)); }, /** * Retrieve all webhooks. @@ -20438,50 +20640,48 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - list(options?: any): AxiosPromise { + list(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.list(options).then((request) => request(axios, basePath)); }, /** * Remove a webhook. * @summary Remove a webhook - * @param {string} id + * @param {WebhooksApiRemoveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - remove(id: string, options?: any): AxiosPromise { - return localVarFp.remove(id, options).then((request) => request(axios, basePath)); + remove(requestParameters: WebhooksApiRemoveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.remove(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * Retrieve a webhook. * @summary Retrieve a webhook - * @param {string} id + * @param {WebhooksApiRetrieveRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - retrieve(id: string, options?: any): AxiosPromise { - return localVarFp.retrieve(id, options).then((request) => request(axios, basePath)); + retrieve(requestParameters: WebhooksApiRetrieveRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.retrieve(requestParameters.id, options).then((request) => request(axios, basePath)); }, /** * test a webhook. * @summary Test a webhook - * @param {string} id - * @param {WebhookTestRequest} webhookTestRequest + * @param {WebhooksApiTestRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - test(id: string, webhookTestRequest: WebhookTestRequest, options?: any): AxiosPromise { - return localVarFp.test(id, webhookTestRequest, options).then((request) => request(axios, basePath)); + test(requestParameters: WebhooksApiTestRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.test(requestParameters.id, requestParameters.webhookTestRequest, options).then((request) => request(axios, basePath)); }, /** * update a webhook. * @summary Update a webhook - * @param {string} id - * @param {PatchedWebhookData} [patchedWebhookData] + * @param {WebhooksApiUpdateRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - update(id: string, patchedWebhookData?: PatchedWebhookData, options?: any): AxiosPromise { - return localVarFp.update(id, patchedWebhookData, options).then((request) => request(axios, basePath)); + update(requestParameters: WebhooksApiUpdateRequest, options?: AxiosRequestConfig): AxiosPromise { + return localVarFp.update(requestParameters.id, requestParameters.patchedWebhookData, options).then((request) => request(axios, basePath)); }, }; }; @@ -20650,3 +20850,4 @@ export class WebhooksApi extends BaseAPI { } + diff --git a/karrio/rest/generated/base.ts b/karrio/rest/generated/base.ts index c63b4907f..47bd8bf15 100644 --- a/karrio/rest/generated/base.ts +++ b/karrio/rest/generated/base.ts @@ -2,9 +2,9 @@ /* eslint-disable */ /** * Karrio API - * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. + * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. * - * The version of the OpenAPI document: 2023.4 + * The version of the OpenAPI document: 2023.4.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -65,8 +65,8 @@ export class BaseAPI { * @extends {Error} */ export class RequiredError extends Error { - name: "RequiredError" = "RequiredError"; constructor(public field: string, msg?: string) { super(msg); + this.name = "RequiredError" } } diff --git a/karrio/rest/generated/common.ts b/karrio/rest/generated/common.ts index b905d5a49..014280bfd 100644 --- a/karrio/rest/generated/common.ts +++ b/karrio/rest/generated/common.ts @@ -2,9 +2,9 @@ /* eslint-disable */ /** * Karrio API - * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. + * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. * - * The version of the OpenAPI document: 2023.4 + * The version of the OpenAPI document: 2023.4.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -85,6 +85,7 @@ export const setOAuthToObject = async function (object: any, name: string, scope } function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void { + if (parameter == null) return; if (typeof parameter === "object") { if (Array.isArray(parameter)) { (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key)); diff --git a/karrio/rest/generated/configuration.ts b/karrio/rest/generated/configuration.ts index a1a264d98..fc689e820 100644 --- a/karrio/rest/generated/configuration.ts +++ b/karrio/rest/generated/configuration.ts @@ -2,9 +2,9 @@ /* eslint-disable */ /** * Karrio API - * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. + * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. * - * The version of the OpenAPI document: 2023.4 + * The version of the OpenAPI document: 2023.4.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/karrio/rest/generated/index.ts b/karrio/rest/generated/index.ts index ff4f50b37..83ec6037e 100644 --- a/karrio/rest/generated/index.ts +++ b/karrio/rest/generated/index.ts @@ -2,9 +2,9 @@ /* eslint-disable */ /** * Karrio API - * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. + * ## API Reference Karrio is an open source multi-carrier shipping API that simplifies the integration of logistic carrier services. The Karrio API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Karrio API differs for every account as we release new versions. These docs are customized to your version of the API. ## Versioning When backwards-incompatible changes are made to the API, a new, dated version is released. The current version is `2023.4.4`. Read our API changelog and to learn more about backwards compatibility. As a precaution, use API versioning to check a new API version before committing to an upgrade. ## Environments The Karrio API offer the possibility to create and retrieve certain objects in `test_mode`. In development, it is therefore possible to add carrier connections, get live rates, buy labels, create trackers and schedule pickups in `test_mode`. ## Pagination All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list addresses, list shipments, and list trackers. These list API methods share a common structure, taking at least these two parameters: limit, and offset. Karrio utilizes offset-based pagination via the offset and limit parameters. Both parameters take a number as value (see below) and return objects in reverse chronological order. The offset parameter returns objects listed after an index. The limit parameter take a limit on the number of objects to be returned from 1 to 100. ```json { \"count\": 100, \"next\": \"/v1/shipments?limit=25&offset=50\", \"previous\": \"/v1/shipments?limit=25&offset=25\", \"results\": [ { ... }, ] } ``` ## Metadata Updateable Karrio objects—including Shipment and Order—have a metadata parameter. You can use this parameter to attach key-value data to these Karrio objects. Metadata is useful for storing additional, structured information on an object. As an example, you could store your user\'s full name and corresponding unique identifier from your system on a Karrio Order object. Do not store any sensitive information as metadata. ## Authentication API keys are used to authenticate requests. You can view and manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your API token as the basic auth username value. You do not need to provide a password. ```shell $ curl https://instance.api.com/v1/shipments \\ -u key_xxxxxx: # The colon prevents curl from asking for a password. ``` If you need to authenticate via bearer auth (e.g., for a cross-origin request), use `-H \"Authorization: Token key_xxxxxx\"` instead of `-u key_xxxxxx`. All API requests must be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). API requests without authentication will also fail. * - * The version of the OpenAPI document: 2023.4 + * The version of the OpenAPI document: 2023.4.4 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/src/components/connect-provider-modal.tsx b/src/components/connect-provider-modal.tsx index 440c0e539..652544580 100644 --- a/src/components/connect-provider-modal.tsx +++ b/src/components/connect-provider-modal.tsx @@ -677,7 +677,7 @@ const ConnectProviderModal: React.FC = ({ childre ) } -function fieldState(carrier_name: CarrierSettingsCarrierNameEnum | NoneEnum, property: string) { +function fieldState(carrier_name: CarrierNameType, property: string) { const field = ( ({ [CarrierSettingsCarrierNameEnum.AmazonMws]: [["carrier_id", true], ["seller_id", true], ["developer_id", true], ["mws_auth_token", true], ["aws_region"]], From 904e552db1ac075a8b96a8f1608340fc45677118 Mon Sep 17 00:00:00 2001 From: Daniel K Date: Thu, 18 May 2023 02:49:59 -0700 Subject: [PATCH 4/8] (reintroduced) parsed error message on shipment forms --- src/components/descriptions/messages-description.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/descriptions/messages-description.tsx b/src/components/descriptions/messages-description.tsx index 8b72bdaa8..69c688f58 100644 --- a/src/components/descriptions/messages-description.tsx +++ b/src/components/descriptions/messages-description.tsx @@ -9,7 +9,7 @@ interface MessagesDescriptionComponent { const MessagesDescription: React.FC = ({ messages }) => { return ( <> - {JSON.stringify(messages, null, 2)} + {formatMessage(messages as any)} ); }; From cc4e1fc0dc88f9b7041c18f53d280965a4f2a48f Mon Sep 17 00:00:00 2001 From: Daniel K Date: Thu, 18 May 2023 02:53:19 -0700 Subject: [PATCH 5/8] (fix) package value currency addon --- src/modules/Orders/create_shipment.tsx | 13 ++++--------- src/modules/Shipments/create_label.tsx | 12 ++++-------- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/src/modules/Orders/create_shipment.tsx b/src/modules/Orders/create_shipment.tsx index d0d06c7eb..746deb2f4 100644 --- a/src/modules/Orders/create_shipment.tsx +++ b/src/modules/Orders/create_shipment.tsx @@ -1,5 +1,5 @@ -import { formatRef, formatWeight, getShipmentCommodities, isNone, isNoneOrEmpty, toSingleItem, useLocation } from '@/lib/helper'; import { AddressType, CommodityType, CURRENCY_OPTIONS, CustomsType, NotificationType, OrderType, ShipmentType } from '@/lib/types'; +import { formatRef, formatWeight, getShipmentCommodities, isNone, isNoneOrEmpty, toSingleItem, useLocation } from '@/lib/helper'; import { AddressModalEditor, CustomsModalEditor, ParcelModalEditor } from '@/components/form-parts/form-modals'; import CommodityEditModalProvider, { CommodityStateContext } from '@/components/commodity-edit-modal'; import CustomsInfoDescription from '@/components/descriptions/customs-info-description'; @@ -560,18 +560,13 @@ export default function CreateShipmentPage(pageProps: any) { label="Package value" type="number" min={0} step="any" className="is-small" - controlClass="has-icons-left has-icons-right" + controlClass="has-icons-right" fieldClass="column mb-0 is-4 px-1 py-2" value={shipment.options?.declared_value} required={!isNone(shipment.options?.declared_value)} onChange={e => onChange({ options: { ...shipment.options, declared_value: parseFloat(e.target.value) } })} - > - - - - {shipment.options?.currency} - - + addonRight={{shipment.options?.currency}} + />
diff --git a/src/modules/Shipments/create_label.tsx b/src/modules/Shipments/create_label.tsx index 4047cf29e..402d5cfb1 100644 --- a/src/modules/Shipments/create_label.tsx +++ b/src/modules/Shipments/create_label.tsx @@ -1,7 +1,7 @@ import { AddressType, CommodityType, CURRENCY_OPTIONS, CustomsType, NotificationType, OrderType, ShipmentType } from '@/lib/types'; +import { get_orders_orders_edges, LabelTypeEnum, MetadataObjectTypeEnum, PaidByEnum, ShipmentStatusEnum } from 'karrio/graphql'; import { formatRef, formatWeight, getShipmentCommodities, isNone, isNoneOrEmpty, useLocation } from '@/lib/helper'; import { AddressModalEditor, CustomsModalEditor, ParcelModalEditor } from '@/components/form-parts/form-modals'; -import { get_orders_orders_edges, LabelTypeEnum, MetadataObjectTypeEnum, PaidByEnum, ShipmentStatusEnum } from 'karrio/graphql'; import CommodityEditModalProvider, { CommodityStateContext } from '@/components/commodity-edit-modal'; import CustomsInfoDescription from '@/components/descriptions/customs-info-description'; import MetadataEditor, { MetadataEditorContext } from '@/components/metadata-editor'; @@ -528,17 +528,13 @@ export default function CreateLabelPage(pageProps: any) { label="Package value" type="number" min={0} step="any" className="is-small" - controlClass="has-icons-left has-icons-right" + controlClass="has-icons-right" fieldClass="column mb-0 is-4 px-1 py-2" value={shipment.options?.declared_value} required={!isNone(shipment.options?.declared_value)} onChange={e => onChange({ options: { ...shipment.options, declared_value: parseFloat(e.target.value) } })} - > - - - - {shipment.options?.currency} - + addonRight={{shipment.options?.currency}} + /> From 1362026d2c2e3cd735cc72ecaaa2c21e6ea05acd Mon Sep 17 00:00:00 2001 From: Daniel K Date: Sat, 20 May 2023 02:40:19 -0700 Subject: [PATCH 6/8] (add) initial support for dynamic carrier shipping options forms --- karrio/graphql/queries.ts | 1 + src/components/user-carrier-list.tsx | 2 +- src/context/carrier-connections.ts | 20 +++++++++ src/modules/Orders/create_shipment.tsx | 60 ++++++++++++++++++++++++++ src/modules/Shipments/create_label.tsx | 52 +++++++++++++++++++++- src/modules/Trackers/index.tsx | 6 +-- 6 files changed, 136 insertions(+), 5 deletions(-) create mode 100644 src/context/carrier-connections.ts diff --git a/karrio/graphql/queries.ts b/karrio/graphql/queries.ts index d970e96f9..7f6799788 100644 --- a/karrio/graphql/queries.ts +++ b/karrio/graphql/queries.ts @@ -1893,6 +1893,7 @@ export const GET_USER_CONNECTIONS = gql`query get_user_connections { zt_id zt_password account_number + config services { id active diff --git a/src/components/user-carrier-list.tsx b/src/components/user-carrier-list.tsx index 9ed45f9a4..0cee7166b 100644 --- a/src/components/user-carrier-list.tsx +++ b/src/components/user-carrier-list.tsx @@ -6,12 +6,12 @@ import { useRateSheetModal } from '@/components/rate-sheet-edit-modal'; import { ConfirmModalContext } from '@/components/confirm-modal'; import CarrierNameBadge from '@/components/carrier-name-badge'; import CopiableLink from '@/components/copiable-link'; +import { isNone, isNoneOrEmpty } from '@/lib/helper'; import React, { useContext, useEffect } from 'react'; import { useRouter } from 'next/dist/client/router'; import { Notify } from '@/components/notifier'; import { NotificationType } from '@/lib/types'; import { Loading } from '@/components/loader'; -import { isNone, isNoneOrEmpty } from '@/lib/helper'; import Spinner from '@/components/spinner'; type ConnectionUpdateType = Partial & { id: string, carrier_name: string }; diff --git a/src/context/carrier-connections.ts b/src/context/carrier-connections.ts new file mode 100644 index 000000000..95d8f75c7 --- /dev/null +++ b/src/context/carrier-connections.ts @@ -0,0 +1,20 @@ +import { useCarrierConnections } from "@/context/user-connection"; +import React from 'react'; + +export function useConnections() { + const [carrierOptions, setCarrierOptions] = React.useState([]); + const { query: { data: { user_connections = []} = {} } } = useCarrierConnections(); + + React.useEffect(() => { + const _options: string[][] = (user_connections || []).map( + (_: any) => (_.active ? _.config?.shipping_options || [] : []) as string[], + [], + ); + + setCarrierOptions(([] as string[]).concat(..._options)); + }, [user_connections]); + + return { + carrierOptions + }; +} diff --git a/src/modules/Orders/create_shipment.tsx b/src/modules/Orders/create_shipment.tsx index 746deb2f4..96f452928 100644 --- a/src/modules/Orders/create_shipment.tsx +++ b/src/modules/Orders/create_shipment.tsx @@ -17,6 +17,7 @@ import RateDescription from '@/components/descriptions/rate-description'; import { useDefaultTemplates } from '@/context/default-template'; import CheckBoxField from '@/components/generic/checkbox-field'; import LineItemSelector from '@/components/line-item-selector'; +import { useConnections } from '@/context/carrier-connections'; import AuthenticatedPage from '@/layouts/authenticated-page'; import ButtonField from '@/components/generic/button-field'; import SelectField from '@/components/generic/select-field'; @@ -30,6 +31,7 @@ import React, { useEffect, useState } from 'react'; import { bundleContexts } from '@/context/utils'; import { useLoader } from '@/components/loader'; import { useAppMode } from '@/context/app-mode'; +import { Disclosure } from '@headlessui/react'; import { useOrders } from '@/context/order'; import Spinner from '@/components/spinner'; import Head from 'next/head'; @@ -47,6 +49,7 @@ export default function CreateShipmentPage(pageProps: any) { const loader = useLoader(); const notifier = useNotifier(); const { basePath } = useAppMode(); + const { carrierOptions } = useConnections(); const { query: templates } = useDefaultTemplates(); const { addUrlParam, ...router } = useLocation(); const [ready, setReady] = useState(false); @@ -579,8 +582,65 @@ export default function CreateShipmentPage(pageProps: any) { Paperless trade + + {/* hold at location */} + onChange({ options: { ...shipment.options, hold_at_location: e.target.checked } })} + > + Hold at location + + + {/* CARRIER OPTIONS SECTION */} + {carrierOptions.length > 0 &&
+ + + {({ open }) => ( +
+ +
CARRIER SPECIFIC OPTIONS
+ + {open ? : } + + + + + {(carrierOptions.includes("dpdhl_packstation")) && <> + {/* dpdhl packstation */} + onChange({ options: { ...shipment.options, dpdhl_packstation: e.target.checked === true ? "" : null } })} + > + Packstation + + +
+ + onChange({ options: { ...shipment.options, dpdhl_packstation: e.target.value } })} + /> +
+ } + + +
+ )} + + +
} +
diff --git a/src/modules/Shipments/create_label.tsx b/src/modules/Shipments/create_label.tsx index 402d5cfb1..5fa332e55 100644 --- a/src/modules/Shipments/create_label.tsx +++ b/src/modules/Shipments/create_label.tsx @@ -17,6 +17,7 @@ import RateDescription from '@/components/descriptions/rate-description'; import { useDefaultTemplates } from '@/context/default-template'; import CheckBoxField from '@/components/generic/checkbox-field'; import LineItemSelector from '@/components/line-item-selector'; +import { useConnections } from '@/context/carrier-connections'; import AuthenticatedPage from '@/layouts/authenticated-page'; import ButtonField from '@/components/generic/button-field'; import SelectField from '@/components/generic/select-field'; @@ -32,6 +33,7 @@ import { useAppMode } from '@/context/app-mode'; import { useOrders } from '@/context/order'; import Spinner from '@/components/spinner'; import Head from 'next/head'; +import { Disclosure } from '@headlessui/react'; export { getServerSideProps } from "@/lib/data-fetching"; @@ -46,6 +48,7 @@ export default function CreateLabelPage(pageProps: any) { const Component: React.FC = () => { const notifier = useNotifier(); const { basePath } = useAppMode(); + const { carrierOptions } = useConnections(); const { addUrlParam, ...router } = useLocation(); const { query: templates } = useDefaultTemplates(); const { shipment_id = 'new' } = router.query as { shipment_id: string }; @@ -550,6 +553,53 @@ export default function CreateLabelPage(pageProps: any) {
+ {/* CARRIER OPTIONS SECTION */} + {carrierOptions.length > 0 &&
+ + + {({ open }) => ( +
+ +
CARRIER SPECIFIC OPTIONS
+ + {open ? : } + + + + + {(carrierOptions.includes("dpdhl_packstation")) && <> + {/* dpdhl packstation */} + onChange({ options: { ...shipment.options, dpdhl_packstation: e.target.checked === true ? "" : null } })} + > + Packstation + + +
+ + onChange({ options: { ...shipment.options, dpdhl_packstation: e.target.value } })} + /> +
+ } + + +
+ )} + + +
} +
@@ -557,7 +607,7 @@ export default function CreateLabelPage(pageProps: any) { mutation.updateShipment({ reference: e.target.value })} + onChange={e => mutation.updateShipment({ reference: (e.target.value as string) })} placeholder="shipment reference" className="is-small" autoComplete="off" diff --git a/src/modules/Trackers/index.tsx b/src/modules/Trackers/index.tsx index 470aef7bb..4e48dcde5 100644 --- a/src/modules/Trackers/index.tsx +++ b/src/modules/Trackers/index.tsx @@ -73,13 +73,13 @@ export default function TrackersPage(pageProps: any) { !isNone(filter?.status) && updateFilter({ status: null, offset: 0 })}>all
  • - !filter?.status?.includes('in_transit') && updateFilter({ status: ['on_hold', 'in_transit', 'out_for_delivery', 'ready_for_pickup'], offset: 0 })}>in-transit + !filter?.status?.includes('in_transit') && updateFilter({ status: ['in_transit', 'on_hold', 'out_for_delivery', 'ready_for_pickup'], offset: 0 })}>in-transit
  • !filter?.status?.includes('pending') && updateFilter({ status: ['pending'], offset: 0 })}>pending
    • -
  • - !filter?.status?.includes('on_hold') && updateFilter({ status: ['on_hold', 'delivery_delayed', 'delivery_failed'], offset: 0 })}>exception +
  • + !filter?.status?.includes('delivery_delayed') && updateFilter({ status: ['delivery_delayed', 'delivery_failed', 'on_hold'], offset: 0 })}>exception
  • !filter?.status?.includes('delivered') && updateFilter({ status: ['delivered'], offset: 0 })}>delivered From ff3a36764f34110a88cc3dd8b7ded69e18fc5f41 Mon Sep 17 00:00:00 2001 From: Daniel K Date: Sat, 20 May 2023 03:29:20 -0700 Subject: [PATCH 7/8] (fix) shipments default filters --- src/modules/Shipments/index.tsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/modules/Shipments/index.tsx b/src/modules/Shipments/index.tsx index 93fe41a27..cb74e075c 100644 --- a/src/modules/Shipments/index.tsx +++ b/src/modules/Shipments/index.tsx @@ -27,7 +27,7 @@ export default function ShipmentsPage(pageProps: any) { const [initialized, setInitialized] = React.useState(false); const { previewShipment } = useContext(ShipmentPreviewContext); const context = useShipments({ - status: ['purchased', 'delivered', 'in_transit', 'cancelled'] as any, + status: ['purchased', 'delivered', 'in_transit', 'cancelled', 'needs_attention', 'out_for_delivery', 'delivery_failed'] as any, setVariablesToURL: true, }); const { query: { data: { shipments } = {}, ...query }, filter, setFilter } = context; @@ -68,8 +68,8 @@ export default function ShipmentsPage(pageProps: any) {
  • updateFilter({ status: ['purchased', 'delivered', 'in_transit', 'cancelled', 'needs_attention', 'out_for_delivery', 'delivery_failed'], offset: 0 })}>all
    • -
  • - updateFilter({ status: ['purchased', 'in_transit', 'out_for_delivery', 'ready_for_pickup'], offset: 0 })}>purchased +
  • + updateFilter({ status: ['purchased', 'in_transit', 'out_for_delivery'], offset: 0 })}>purchased
  • updateFilter({ status: ['delivered'], offset: 0 })}>delivered From 9380b23c2103ddb442edcfc0afbf196cff8d8e42 Mon Sep 17 00:00:00 2001 From: Daniel K Date: Sat, 20 May 2023 03:41:04 -0700 Subject: [PATCH 8/8] (add) service_suffix config for dpdhl connection settings --- src/components/connect-provider-modal.tsx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/components/connect-provider-modal.tsx b/src/components/connect-provider-modal.tsx index 652544580..42c57120f 100644 --- a/src/components/connect-provider-modal.tsx +++ b/src/components/connect-provider-modal.tsx @@ -590,6 +590,15 @@ const ConnectProviderModal: React.FC = ({ childre
    • } + {"service_suffix" in connection_configs[carrier_name.toString()] && + } + {"shipping_services" in connection_configs[carrier_name.toString()] &&