@zippendo/sdk 1.3.2 → 1.3.4

package/src/apis/ShipmentsApi.ts

@@ -120,6 +120,11 @@ export interface DeleteShipmentRequest {
     shipmentId: string;
 }
 
+export interface FetchShipmentLabelRequest {
+    orgId: string;
+    shipmentId: string;
+}
+
 export interface GetShipmentRequest {
     orgId: string;
     shipmentId: string;
@@ -360,7 +365,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
      * Create return shipment
      */
     async createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
@@ -371,7 +376,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
      * Create return shipment
      */
     async createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
@@ -507,6 +512,69 @@ export class ShipmentsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for fetchShipmentLabel without sending the request
+     */
+    async fetchShipmentLabelRequestOpts(requestParameters: FetchShipmentLabelRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling fetchShipmentLabel().'
+            );
+        }
+
+        if (requestParameters['shipmentId'] == null) {
+            throw new runtime.RequiredError(
+                'shipmentId',
+                'Required parameter "shipmentId" was null or undefined when calling fetchShipmentLabel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/shipments/{shipmentId}/fetch-label`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+        urlPath = urlPath.replace('{shipmentId}', encodeURIComponent(String(requestParameters['shipmentId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
+     * Fetch missing label
+     */
+    async fetchShipmentLabelRaw(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
+        const requestOptions = await this.fetchShipmentLabelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateShipment201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
+     * Fetch missing label
+     */
+    async fetchShipmentLabel(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
+        const response = await this.fetchShipmentLabelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getShipment without sending the request
      */

package/src/models/BatchSendShipments200ResponseResultsInner.ts

@@ -156,6 +156,10 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -163,6 +167,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',

package/src/models/CreateAddressRequest.ts

@@ -20,17 +20,23 @@ import { mapValues } from '../runtime';
  */
 export interface CreateAddressRequest {
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof CreateAddressRequest
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    attContact: string;
+    description?: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    attContact?: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -42,7 +48,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -72,7 +78,7 @@ export interface CreateAddressRequest {
      * @type {string}
      * @memberof CreateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}
@@ -116,7 +122,6 @@ export type CreateAddressRequestAddressTypesEnum = typeof CreateAddressRequestAd
  */
 export function instanceOfCreateAddressRequest(value: object): value is CreateAddressRequest {
     if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('zipcode' in value) || value['zipcode'] === undefined) return false;
     if (!('city' in value) || value['city'] === undefined) return false;
@@ -137,14 +142,15 @@ export function CreateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'name': json['name'],
-        'attContact': json['attContact'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
         'address1': json['address1'],
-        'address2': json['address2'] == null ? undefined : json['address2'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
         'zipcode': json['zipcode'],
         'city': json['city'],
         'phone': json['phone'],
         'countryCode': json['countryCode'],
-        'state': json['state'] == null ? undefined : json['state'],
+        'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
         'email': json['email'],
         'customs': json['customs'] == null ? undefined : json['customs'],
         'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -164,6 +170,7 @@ export function CreateAddressRequestToJSONTyped(value?: CreateAddressRequest | n
     return {
         
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/ListAddresses200ResponseDataInner.ts

@@ -26,17 +26,23 @@ export interface ListAddresses200ResponseDataInner {
      */
     id: string;
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof ListAddresses200ResponseDataInner
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof ListAddresses200ResponseDataInner
      */
-    attContact: string;
+    description: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof ListAddresses200ResponseDataInner
+     */
+    attContact: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -141,6 +147,7 @@ export type ListAddresses200ResponseDataInnerAddressTypesEnum = typeof ListAddre
 export function instanceOfListAddresses200ResponseDataInner(value: object): value is ListAddresses200ResponseDataInner {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
     if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('address2' in value) || value['address2'] === undefined) return false;
@@ -170,6 +177,7 @@ export function ListAddresses200ResponseDataInnerFromJSONTyped(json: any, ignore
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -201,6 +209,7 @@ export function ListAddresses200ResponseDataInnerToJSONTyped(value?: ListAddress
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/ListApiTokens401Response.ts

@@ -126,6 +126,10 @@ export const ListApiTokens401ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -133,6 +137,9 @@ export const ListApiTokens401ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',

package/src/models/ListShipments200ResponseDataInnerAddress.ts

@@ -26,17 +26,23 @@ export interface ListShipments200ResponseDataInnerAddress {
      */
     id: string;
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof ListShipments200ResponseDataInnerAddress
      */
     name: string;
     /**
-     * Attention contact person
+     * Internal label for this address; never printed or sent to a carrier
      * @type {string}
      * @memberof ListShipments200ResponseDataInnerAddress
      */
-    attContact: string;
+    description: string | null;
+    /**
+     * Contact person at this address, printed as the att. line
+     * @type {string}
+     * @memberof ListShipments200ResponseDataInnerAddress
+     */
+    attContact: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -141,6 +147,7 @@ export type ListShipments200ResponseDataInnerAddressAddressTypesEnum = typeof Li
 export function instanceOfListShipments200ResponseDataInnerAddress(value: object): value is ListShipments200ResponseDataInnerAddress {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
     if (!('attContact' in value) || value['attContact'] === undefined) return false;
     if (!('address1' in value) || value['address1'] === undefined) return false;
     if (!('address2' in value) || value['address2'] === undefined) return false;
@@ -170,6 +177,7 @@ export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json: any,
         
         'id': json['id'],
         'name': json['name'],
+        'description': json['description'],
         'attContact': json['attContact'],
         'address1': json['address1'],
         'address2': json['address2'],
@@ -201,6 +209,7 @@ export function ListShipments200ResponseDataInnerAddressToJSONTyped(value?: List
         
         'id': value['id'],
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],

package/src/models/SendShipment422Response.ts

@@ -140,6 +140,10 @@ export const SendShipment422ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -147,6 +151,9 @@ export const SendShipment422ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',

package/src/models/UpdateAddressRequest.ts

@@ -20,17 +20,23 @@ import { mapValues } from '../runtime';
  */
 export interface UpdateAddressRequest {
     /**
-     * Name of the address
+     * Company or person the parcel is sent from, printed on labels
      * @type {string}
      * @memberof UpdateAddressRequest
      */
     name?: string;
     /**
-     * Attention contact person
+     * Internal label for this address; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    attContact?: string;
+    description?: string | null;
+    /**
+     * Contact person at this address; send null or an empty string to clear it
+     * @type {string}
+     * @memberof UpdateAddressRequest
+     */
+    attContact?: string | null;
     /**
      * Address line 1
      * @type {string}
@@ -38,11 +44,11 @@ export interface UpdateAddressRequest {
      */
     address1?: string;
     /**
-     * Address line 2
+     * Address line 2; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    address2?: string;
+    address2?: string | null;
     /**
      * Postal/ZIP code
      * @type {string}
@@ -68,11 +74,11 @@ export interface UpdateAddressRequest {
      */
     countryCode?: string;
     /**
-     * State/Province
+     * State/Province; send null or an empty string to clear it
      * @type {string}
      * @memberof UpdateAddressRequest
      */
-    state?: string;
+    state?: string | null;
     /**
      * Email address
      * @type {string}
@@ -129,14 +135,15 @@ export function UpdateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'name': json['name'] == null ? undefined : json['name'],
-        'attContact': json['attContact'] == null ? undefined : json['attContact'],
+        'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
+        'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
         'address1': json['address1'] == null ? undefined : json['address1'],
-        'address2': json['address2'] == null ? undefined : json['address2'],
+        'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
         'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
         'city': json['city'] == null ? undefined : json['city'],
         'phone': json['phone'] == null ? undefined : json['phone'],
         'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
-        'state': json['state'] == null ? undefined : json['state'],
+        'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
         'email': json['email'] == null ? undefined : json['email'],
         'customs': json['customs'] == null ? undefined : json['customs'],
         'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -156,6 +163,7 @@ export function UpdateAddressRequestToJSONTyped(value?: UpdateAddressRequest | n
     return {
         
         'name': value['name'],
+        'description': value['description'],
         'attContact': value['attContact'],
         'address1': value['address1'],
         'address2': value['address2'],