@zippendo/sdk 1.3.2 → 1.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -45,6 +45,10 @@ export interface DeleteShipmentRequest {
45
45
  orgId: string;
46
46
  shipmentId: string;
47
47
  }
48
+ export interface FetchShipmentLabelRequest {
49
+ orgId: string;
50
+ shipmentId: string;
51
+ }
48
52
  export interface GetShipmentRequest {
49
53
  orgId: string;
50
54
  shipmentId: string;
@@ -127,12 +131,12 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
127
131
  */
128
132
  createReturnShipmentRequestOpts(requestParameters: CreateReturnShipmentRequest): Promise<runtime.RequestOpts>;
129
133
  /**
130
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
134
+ * 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`.
131
135
  * Create return shipment
132
136
  */
133
137
  createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
134
138
  /**
135
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
139
+ * 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`.
136
140
  * Create return shipment
137
141
  */
138
142
  createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
@@ -164,6 +168,20 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
164
168
  * Delete shipment
165
169
  */
166
170
  deleteShipment(requestParameters: DeleteShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeApiToken200Response>;
171
+ /**
172
+ * Creates request options for fetchShipmentLabel without sending the request
173
+ */
174
+ fetchShipmentLabelRequestOpts(requestParameters: FetchShipmentLabelRequest): Promise<runtime.RequestOpts>;
175
+ /**
176
+ * 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.
177
+ * Fetch missing label
178
+ */
179
+ fetchShipmentLabelRaw(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
180
+ /**
181
+ * 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.
182
+ * Fetch missing label
183
+ */
184
+ fetchShipmentLabel(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
167
185
  /**
168
186
  * Creates request options for getShipment without sending the request
169
187
  */
@@ -184,7 +184,7 @@ class ShipmentsApi extends runtime.BaseAPI {
184
184
  });
185
185
  }
186
186
  /**
187
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
187
+ * 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`.
188
188
  * Create return shipment
189
189
  */
190
190
  createReturnShipmentRaw(requestParameters, initOverrides) {
@@ -195,7 +195,7 @@ class ShipmentsApi extends runtime.BaseAPI {
195
195
  });
196
196
  }
197
197
  /**
198
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
198
+ * 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`.
199
199
  * Create return shipment
200
200
  */
201
201
  createReturnShipment(requestParameters, initOverrides) {
@@ -309,6 +309,58 @@ class ShipmentsApi extends runtime.BaseAPI {
309
309
  return yield response.value();
310
310
  });
311
311
  }
312
+ /**
313
+ * Creates request options for fetchShipmentLabel without sending the request
314
+ */
315
+ fetchShipmentLabelRequestOpts(requestParameters) {
316
+ return __awaiter(this, void 0, void 0, function* () {
317
+ if (requestParameters['orgId'] == null) {
318
+ throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling fetchShipmentLabel().');
319
+ }
320
+ if (requestParameters['shipmentId'] == null) {
321
+ throw new runtime.RequiredError('shipmentId', 'Required parameter "shipmentId" was null or undefined when calling fetchShipmentLabel().');
322
+ }
323
+ const queryParameters = {};
324
+ const headerParameters = {};
325
+ if (this.configuration && this.configuration.accessToken) {
326
+ const token = this.configuration.accessToken;
327
+ const tokenString = yield token("bearerAuth", []);
328
+ if (tokenString) {
329
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
330
+ }
331
+ }
332
+ let urlPath = `/orgs/{orgId}/shipments/{shipmentId}/fetch-label`;
333
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
334
+ urlPath = urlPath.replace('{shipmentId}', encodeURIComponent(String(requestParameters['shipmentId'])));
335
+ return {
336
+ path: urlPath,
337
+ method: 'POST',
338
+ headers: headerParameters,
339
+ query: queryParameters,
340
+ };
341
+ });
342
+ }
343
+ /**
344
+ * 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.
345
+ * Fetch missing label
346
+ */
347
+ fetchShipmentLabelRaw(requestParameters, initOverrides) {
348
+ return __awaiter(this, void 0, void 0, function* () {
349
+ const requestOptions = yield this.fetchShipmentLabelRequestOpts(requestParameters);
350
+ const response = yield this.request(requestOptions, initOverrides);
351
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateShipment201Response_1.CreateShipment201ResponseFromJSON)(jsonValue));
352
+ });
353
+ }
354
+ /**
355
+ * 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.
356
+ * Fetch missing label
357
+ */
358
+ fetchShipmentLabel(requestParameters, initOverrides) {
359
+ return __awaiter(this, void 0, void 0, function* () {
360
+ const response = yield this.fetchShipmentLabelRaw(requestParameters, initOverrides);
361
+ return yield response.value();
362
+ });
363
+ }
312
364
  /**
313
365
  * Creates request options for getShipment without sending the request
314
366
  */
@@ -45,6 +45,10 @@ export interface DeleteShipmentRequest {
45
45
  orgId: string;
46
46
  shipmentId: string;
47
47
  }
48
+ export interface FetchShipmentLabelRequest {
49
+ orgId: string;
50
+ shipmentId: string;
51
+ }
48
52
  export interface GetShipmentRequest {
49
53
  orgId: string;
50
54
  shipmentId: string;
@@ -127,12 +131,12 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
127
131
  */
128
132
  createReturnShipmentRequestOpts(requestParameters: CreateReturnShipmentRequest): Promise<runtime.RequestOpts>;
129
133
  /**
130
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
134
+ * 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`.
131
135
  * Create return shipment
132
136
  */
133
137
  createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
134
138
  /**
135
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
139
+ * 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`.
136
140
  * Create return shipment
137
141
  */
138
142
  createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
@@ -164,6 +168,20 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
164
168
  * Delete shipment
165
169
  */
166
170
  deleteShipment(requestParameters: DeleteShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeApiToken200Response>;
171
+ /**
172
+ * Creates request options for fetchShipmentLabel without sending the request
173
+ */
174
+ fetchShipmentLabelRequestOpts(requestParameters: FetchShipmentLabelRequest): Promise<runtime.RequestOpts>;
175
+ /**
176
+ * 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.
177
+ * Fetch missing label
178
+ */
179
+ fetchShipmentLabelRaw(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
180
+ /**
181
+ * 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.
182
+ * Fetch missing label
183
+ */
184
+ fetchShipmentLabel(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
167
185
  /**
168
186
  * Creates request options for getShipment without sending the request
169
187
  */
@@ -181,7 +181,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
181
181
  });
182
182
  }
183
183
  /**
184
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
184
+ * 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`.
185
185
  * Create return shipment
186
186
  */
187
187
  createReturnShipmentRaw(requestParameters, initOverrides) {
@@ -192,7 +192,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
192
192
  });
193
193
  }
194
194
  /**
195
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
195
+ * 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`.
196
196
  * Create return shipment
197
197
  */
198
198
  createReturnShipment(requestParameters, initOverrides) {
@@ -306,6 +306,58 @@ export class ShipmentsApi extends runtime.BaseAPI {
306
306
  return yield response.value();
307
307
  });
308
308
  }
309
+ /**
310
+ * Creates request options for fetchShipmentLabel without sending the request
311
+ */
312
+ fetchShipmentLabelRequestOpts(requestParameters) {
313
+ return __awaiter(this, void 0, void 0, function* () {
314
+ if (requestParameters['orgId'] == null) {
315
+ throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling fetchShipmentLabel().');
316
+ }
317
+ if (requestParameters['shipmentId'] == null) {
318
+ throw new runtime.RequiredError('shipmentId', 'Required parameter "shipmentId" was null or undefined when calling fetchShipmentLabel().');
319
+ }
320
+ const queryParameters = {};
321
+ const headerParameters = {};
322
+ if (this.configuration && this.configuration.accessToken) {
323
+ const token = this.configuration.accessToken;
324
+ const tokenString = yield token("bearerAuth", []);
325
+ if (tokenString) {
326
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
327
+ }
328
+ }
329
+ let urlPath = `/orgs/{orgId}/shipments/{shipmentId}/fetch-label`;
330
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
331
+ urlPath = urlPath.replace('{shipmentId}', encodeURIComponent(String(requestParameters['shipmentId'])));
332
+ return {
333
+ path: urlPath,
334
+ method: 'POST',
335
+ headers: headerParameters,
336
+ query: queryParameters,
337
+ };
338
+ });
339
+ }
340
+ /**
341
+ * 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.
342
+ * Fetch missing label
343
+ */
344
+ fetchShipmentLabelRaw(requestParameters, initOverrides) {
345
+ return __awaiter(this, void 0, void 0, function* () {
346
+ const requestOptions = yield this.fetchShipmentLabelRequestOpts(requestParameters);
347
+ const response = yield this.request(requestOptions, initOverrides);
348
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateShipment201ResponseFromJSON(jsonValue));
349
+ });
350
+ }
351
+ /**
352
+ * 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.
353
+ * Fetch missing label
354
+ */
355
+ fetchShipmentLabel(requestParameters, initOverrides) {
356
+ return __awaiter(this, void 0, void 0, function* () {
357
+ const response = yield this.fetchShipmentLabelRaw(requestParameters, initOverrides);
358
+ return yield response.value();
359
+ });
360
+ }
309
361
  /**
310
362
  * Creates request options for getShipment without sending the request
311
363
  */
@@ -142,6 +142,10 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
142
142
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
143
143
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
144
144
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
145
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
146
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
147
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
148
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
145
149
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
146
150
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
147
151
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -149,6 +153,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
149
153
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
150
154
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
151
155
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
156
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
157
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
158
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
152
159
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
153
160
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
154
161
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -106,6 +106,10 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
106
106
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
107
107
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
108
108
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
109
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
110
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
111
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
112
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
109
113
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
110
114
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
111
115
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -113,6 +117,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
113
117
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
114
118
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
115
119
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
120
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
121
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
122
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
116
123
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
117
124
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
118
125
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -120,6 +120,10 @@ export declare const ListApiTokens401ResponseCodeEnum: {
120
120
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
121
121
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
122
122
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
123
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
124
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
125
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
126
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
123
127
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
124
128
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
125
129
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -127,6 +131,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
127
131
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
128
132
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
129
133
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
134
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
135
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
136
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
130
137
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
131
138
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
132
139
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -97,6 +97,10 @@ export const ListApiTokens401ResponseCodeEnum = {
97
97
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
98
98
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
99
99
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
100
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
101
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
102
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
103
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
100
104
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
101
105
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
102
106
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -104,6 +108,9 @@ export const ListApiTokens401ResponseCodeEnum = {
104
108
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
105
109
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
106
110
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
111
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
112
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
113
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
107
114
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
108
115
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
109
116
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -127,6 +127,10 @@ export declare const SendShipment422ResponseCodeEnum: {
127
127
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
128
128
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
129
129
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
130
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
131
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
132
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
133
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
130
134
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
131
135
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
132
136
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -134,6 +138,9 @@ export declare const SendShipment422ResponseCodeEnum: {
134
138
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
135
139
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
136
140
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
141
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
142
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
143
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
137
144
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
138
145
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
139
146
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -98,6 +98,10 @@ export const SendShipment422ResponseCodeEnum = {
98
98
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
99
99
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
100
100
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
101
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
102
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
103
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
104
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
101
105
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
102
106
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
103
107
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -105,6 +109,9 @@ export const SendShipment422ResponseCodeEnum = {
105
109
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
106
110
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
107
111
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
112
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
113
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
114
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
108
115
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
109
116
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
110
117
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -142,6 +142,10 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
142
142
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
143
143
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
144
144
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
145
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
146
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
147
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
148
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
145
149
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
146
150
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
147
151
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -149,6 +153,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
149
153
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
150
154
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
151
155
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
156
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
157
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
158
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
152
159
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
153
160
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
154
161
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -114,6 +114,10 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
114
114
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
115
115
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
116
116
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
117
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
118
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
119
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
120
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
117
121
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
118
122
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
119
123
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -121,6 +125,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
121
125
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
122
126
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
123
127
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
128
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
129
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
130
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
124
131
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
125
132
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
126
133
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -120,6 +120,10 @@ export declare const ListApiTokens401ResponseCodeEnum: {
120
120
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
121
121
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
122
122
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
123
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
124
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
125
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
126
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
123
127
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
124
128
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
125
129
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -127,6 +131,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
127
131
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
128
132
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
129
133
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
134
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
135
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
136
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
130
137
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
131
138
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
132
139
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -105,6 +105,10 @@ exports.ListApiTokens401ResponseCodeEnum = {
105
105
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
106
106
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
107
107
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
108
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
109
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
110
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
111
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
108
112
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
109
113
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
110
114
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -112,6 +116,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
112
116
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
113
117
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
114
118
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
119
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
120
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
121
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
115
122
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
116
123
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
117
124
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -127,6 +127,10 @@ export declare const SendShipment422ResponseCodeEnum: {
127
127
  readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
128
128
  readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
129
129
  readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
130
+ readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
131
+ readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
132
+ readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
133
+ readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
130
134
  readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
131
135
  readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
132
136
  readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -134,6 +138,9 @@ export declare const SendShipment422ResponseCodeEnum: {
134
138
  readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
135
139
  readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
136
140
  readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
141
+ readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
142
+ readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
143
+ readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
137
144
  readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
138
145
  readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
139
146
  readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -106,6 +106,10 @@ exports.SendShipment422ResponseCodeEnum = {
106
106
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
107
107
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
108
108
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
109
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
110
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
111
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
112
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
109
113
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
110
114
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
111
115
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -113,6 +117,9 @@ exports.SendShipment422ResponseCodeEnum = {
113
117
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
114
118
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
115
119
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
120
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
121
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
122
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
116
123
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
117
124
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
118
125
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.zippendo.com*
9
9
  | [**createReturnShipment**](ShipmentsApi.md#createreturnshipment) | **POST** /orgs/{orgId}/shipments/{shipmentId}/create-return | Create return shipment |
10
10
  | [**createShipment**](ShipmentsApi.md#createshipmentoperation) | **POST** /orgs/{orgId}/shipments | Create shipment |
11
11
  | [**deleteShipment**](ShipmentsApi.md#deleteshipment) | **DELETE** /orgs/{orgId}/shipments/{shipmentId} | Delete shipment |
12
+ | [**fetchShipmentLabel**](ShipmentsApi.md#fetchshipmentlabel) | **POST** /orgs/{orgId}/shipments/{shipmentId}/fetch-label | Fetch missing label |
12
13
  | [**getShipment**](ShipmentsApi.md#getshipment) | **GET** /orgs/{orgId}/shipments/{shipmentId} | Get shipment |
13
14
  | [**getShipmentDocumentContent**](ShipmentsApi.md#getshipmentdocumentcontent) | **GET** /orgs/{orgId}/shipments/{shipmentId}/documents/{documentId}/content | Download shipment document |
14
15
  | [**listShipments**](ShipmentsApi.md#listshipments) | **GET** /orgs/{orgId}/shipments | List shipments |
@@ -182,7 +183,7 @@ example().catch(console.error);
182
183
 
183
184
  Create return shipment
184
185
 
185
- Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
186
+ 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: &#x60;dispatched&#x60;, or &#x60;error&#x60; with the carrier\&#39;s reasons in &#x60;errors&#x60;.
186
187
 
187
188
  ### Example
188
189
 
@@ -407,6 +408,84 @@ example().catch(console.error);
407
408
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
408
409
 
409
410
 
411
+ ## fetchShipmentLabel
412
+
413
+ > CreateShipment201Response fetchShipmentLabel(orgId, shipmentId)
414
+
415
+ Fetch missing label
416
+
417
+ 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.
418
+
419
+ ### Example
420
+
421
+ ```ts
422
+ import {
423
+ Configuration,
424
+ ShipmentsApi,
425
+ } from '@zippendo/sdk';
426
+ import type { FetchShipmentLabelRequest } from '@zippendo/sdk';
427
+
428
+ async function example() {
429
+ console.log("🚀 Testing @zippendo/sdk SDK...");
430
+ const config = new Configuration({
431
+ // Configure HTTP bearer authorization: bearerAuth
432
+ accessToken: "YOUR BEARER TOKEN",
433
+ });
434
+ const api = new ShipmentsApi(config);
435
+
436
+ const body = {
437
+ // string | Organization identifier.
438
+ orgId: org_1a2b3c4d,
439
+ // string | Shipment identifier.
440
+ shipmentId: shp_4d9e7a2f,
441
+ } satisfies FetchShipmentLabelRequest;
442
+
443
+ try {
444
+ const data = await api.fetchShipmentLabel(body);
445
+ console.log(data);
446
+ } catch (error) {
447
+ console.error(error);
448
+ }
449
+ }
450
+
451
+ // Run the test
452
+ example().catch(console.error);
453
+ ```
454
+
455
+ ### Parameters
456
+
457
+
458
+ | Name | Type | Description | Notes |
459
+ |------------- | ------------- | ------------- | -------------|
460
+ | **orgId** | `string` | Organization identifier. | [Defaults to `undefined`] |
461
+ | **shipmentId** | `string` | Shipment identifier. | [Defaults to `undefined`] |
462
+
463
+ ### Return type
464
+
465
+ [**CreateShipment201Response**](CreateShipment201Response.md)
466
+
467
+ ### Authorization
468
+
469
+ [bearerAuth](../README.md#bearerAuth)
470
+
471
+ ### HTTP request headers
472
+
473
+ - **Content-Type**: Not defined
474
+ - **Accept**: `application/json`
475
+
476
+
477
+ ### HTTP response details
478
+ | Status code | Description | Response headers |
479
+ |-------------|-------------|------------------|
480
+ | **200** | Default Response | - |
481
+ | **403** | Default Response | - |
482
+ | **404** | Default Response | - |
483
+ | **409** | Default Response | - |
484
+ | **422** | Default Response | - |
485
+
486
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
487
+
488
+
410
489
  ## getShipment
411
490
 
412
491
  > CreateShipment201Response getShipment(orgId, shipmentId)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.2",
3
+ "version": "1.3.3",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -120,6 +120,11 @@ export interface DeleteShipmentRequest {
120
120
  shipmentId: string;
121
121
  }
122
122
 
123
+ export interface FetchShipmentLabelRequest {
124
+ orgId: string;
125
+ shipmentId: string;
126
+ }
127
+
123
128
  export interface GetShipmentRequest {
124
129
  orgId: string;
125
130
  shipmentId: string;
@@ -360,7 +365,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
360
365
  }
361
366
 
362
367
  /**
363
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
368
+ * 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`.
364
369
  * Create return shipment
365
370
  */
366
371
  async createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
@@ -371,7 +376,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
371
376
  }
372
377
 
373
378
  /**
374
- * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
379
+ * 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`.
375
380
  * Create return shipment
376
381
  */
377
382
  async createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
@@ -507,6 +512,69 @@ export class ShipmentsApi extends runtime.BaseAPI {
507
512
  return await response.value();
508
513
  }
509
514
 
515
+ /**
516
+ * Creates request options for fetchShipmentLabel without sending the request
517
+ */
518
+ async fetchShipmentLabelRequestOpts(requestParameters: FetchShipmentLabelRequest): Promise<runtime.RequestOpts> {
519
+ if (requestParameters['orgId'] == null) {
520
+ throw new runtime.RequiredError(
521
+ 'orgId',
522
+ 'Required parameter "orgId" was null or undefined when calling fetchShipmentLabel().'
523
+ );
524
+ }
525
+
526
+ if (requestParameters['shipmentId'] == null) {
527
+ throw new runtime.RequiredError(
528
+ 'shipmentId',
529
+ 'Required parameter "shipmentId" was null or undefined when calling fetchShipmentLabel().'
530
+ );
531
+ }
532
+
533
+ const queryParameters: any = {};
534
+
535
+ const headerParameters: runtime.HTTPHeaders = {};
536
+
537
+ if (this.configuration && this.configuration.accessToken) {
538
+ const token = this.configuration.accessToken;
539
+ const tokenString = await token("bearerAuth", []);
540
+
541
+ if (tokenString) {
542
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
543
+ }
544
+ }
545
+
546
+ let urlPath = `/orgs/{orgId}/shipments/{shipmentId}/fetch-label`;
547
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
548
+ urlPath = urlPath.replace('{shipmentId}', encodeURIComponent(String(requestParameters['shipmentId'])));
549
+
550
+ return {
551
+ path: urlPath,
552
+ method: 'POST',
553
+ headers: headerParameters,
554
+ query: queryParameters,
555
+ };
556
+ }
557
+
558
+ /**
559
+ * 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.
560
+ * Fetch missing label
561
+ */
562
+ async fetchShipmentLabelRaw(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
563
+ const requestOptions = await this.fetchShipmentLabelRequestOpts(requestParameters);
564
+ const response = await this.request(requestOptions, initOverrides);
565
+
566
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateShipment201ResponseFromJSON(jsonValue));
567
+ }
568
+
569
+ /**
570
+ * 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.
571
+ * Fetch missing label
572
+ */
573
+ async fetchShipmentLabel(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
574
+ const response = await this.fetchShipmentLabelRaw(requestParameters, initOverrides);
575
+ return await response.value();
576
+ }
577
+
510
578
  /**
511
579
  * Creates request options for getShipment without sending the request
512
580
  */
@@ -156,6 +156,10 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
156
156
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
157
157
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
158
158
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
159
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
160
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
161
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
162
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
159
163
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
160
164
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
161
165
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -163,6 +167,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
163
167
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
164
168
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
165
169
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
170
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
171
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
172
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
166
173
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
167
174
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
168
175
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -126,6 +126,10 @@ export const ListApiTokens401ResponseCodeEnum = {
126
126
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
127
127
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
128
128
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
129
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
130
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
131
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
132
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
129
133
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
130
134
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
131
135
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -133,6 +137,9 @@ export const ListApiTokens401ResponseCodeEnum = {
133
137
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
134
138
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
135
139
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
140
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
141
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
142
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
136
143
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
137
144
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
138
145
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -140,6 +140,10 @@ export const SendShipment422ResponseCodeEnum = {
140
140
  CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
141
141
  CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
142
142
  CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
143
+ CarrierUnreachable: 'CARRIER_UNREACHABLE',
144
+ CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
145
+ LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
146
+ CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
143
147
  CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
144
148
  CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
145
149
  CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -147,6 +151,9 @@ export const SendShipment422ResponseCodeEnum = {
147
151
  CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
148
152
  CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
149
153
  CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
154
+ CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
155
+ CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
156
+ CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
150
157
  CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
151
158
  CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
152
159
  CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',