@zippendo/sdk 1.3.2 → 1.3.4

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.
Files changed (47) hide show
  1. package/dist/apis/ShipmentsApi.d.ts +20 -2
  2. package/dist/apis/ShipmentsApi.js +54 -2
  3. package/dist/esm/apis/ShipmentsApi.d.ts +20 -2
  4. package/dist/esm/apis/ShipmentsApi.js +54 -2
  5. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +7 -0
  6. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +7 -0
  7. package/dist/esm/models/CreateAddressRequest.d.ts +11 -5
  8. package/dist/esm/models/CreateAddressRequest.js +5 -5
  9. package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +9 -3
  10. package/dist/esm/models/ListAddresses200ResponseDataInner.js +4 -0
  11. package/dist/esm/models/ListApiTokens401Response.d.ts +7 -0
  12. package/dist/esm/models/ListApiTokens401Response.js +7 -0
  13. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
  14. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +4 -0
  15. package/dist/esm/models/SendShipment422Response.d.ts +7 -0
  16. package/dist/esm/models/SendShipment422Response.js +7 -0
  17. package/dist/esm/models/UpdateAddressRequest.d.ts +13 -7
  18. package/dist/esm/models/UpdateAddressRequest.js +5 -3
  19. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +7 -0
  20. package/dist/models/BatchSendShipments200ResponseResultsInner.js +7 -0
  21. package/dist/models/CreateAddressRequest.d.ts +11 -5
  22. package/dist/models/CreateAddressRequest.js +5 -5
  23. package/dist/models/ListAddresses200ResponseDataInner.d.ts +9 -3
  24. package/dist/models/ListAddresses200ResponseDataInner.js +4 -0
  25. package/dist/models/ListApiTokens401Response.d.ts +7 -0
  26. package/dist/models/ListApiTokens401Response.js +7 -0
  27. package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
  28. package/dist/models/ListShipments200ResponseDataInnerAddress.js +4 -0
  29. package/dist/models/SendShipment422Response.d.ts +7 -0
  30. package/dist/models/SendShipment422Response.js +7 -0
  31. package/dist/models/UpdateAddressRequest.d.ts +13 -7
  32. package/dist/models/UpdateAddressRequest.js +5 -3
  33. package/docs/AddressesApi.md +2 -2
  34. package/docs/CreateAddressRequest.md +4 -2
  35. package/docs/ListAddresses200ResponseDataInner.md +3 -1
  36. package/docs/ListShipments200ResponseDataInnerAddress.md +3 -1
  37. package/docs/ShipmentsApi.md +80 -1
  38. package/docs/UpdateAddressRequest.md +3 -1
  39. package/package.json +1 -1
  40. package/src/apis/ShipmentsApi.ts +70 -2
  41. package/src/models/BatchSendShipments200ResponseResultsInner.ts +7 -0
  42. package/src/models/CreateAddressRequest.ts +16 -9
  43. package/src/models/ListAddresses200ResponseDataInner.ts +12 -3
  44. package/src/models/ListApiTokens401Response.ts +7 -0
  45. package/src/models/ListShipments200ResponseDataInnerAddress.ts +12 -3
  46. package/src/models/SendShipment422Response.ts +7 -0
  47. package/src/models/UpdateAddressRequest.ts +18 -10
@@ -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',
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface CreateAddressRequest {
18
18
  /**
19
- * Name of the address
19
+ * Company or person the parcel is sent from, printed on labels
20
20
  * @type {string}
21
21
  * @memberof CreateAddressRequest
22
22
  */
23
23
  name: string;
24
24
  /**
25
- * Attention contact person
25
+ * Internal label for this address; never printed or sent to a carrier
26
26
  * @type {string}
27
27
  * @memberof CreateAddressRequest
28
28
  */
29
- attContact: string;
29
+ description?: string | null;
30
+ /**
31
+ * Contact person at this address, printed as the att. line
32
+ * @type {string}
33
+ * @memberof CreateAddressRequest
34
+ */
35
+ attContact?: string | null;
30
36
  /**
31
37
  * Address line 1
32
38
  * @type {string}
@@ -38,7 +44,7 @@ export interface CreateAddressRequest {
38
44
  * @type {string}
39
45
  * @memberof CreateAddressRequest
40
46
  */
41
- address2?: string;
47
+ address2?: string | null;
42
48
  /**
43
49
  * Postal/ZIP code
44
50
  * @type {string}
@@ -68,7 +74,7 @@ export interface CreateAddressRequest {
68
74
  * @type {string}
69
75
  * @memberof CreateAddressRequest
70
76
  */
71
- state?: string;
77
+ state?: string | null;
72
78
  /**
73
79
  * Email address
74
80
  * @type {string}
@@ -25,8 +25,6 @@ export const CreateAddressRequestAddressTypesEnum = {
25
25
  export function instanceOfCreateAddressRequest(value) {
26
26
  if (!('name' in value) || value['name'] === undefined)
27
27
  return false;
28
- if (!('attContact' in value) || value['attContact'] === undefined)
29
- return false;
30
28
  if (!('address1' in value) || value['address1'] === undefined)
31
29
  return false;
32
30
  if (!('zipcode' in value) || value['zipcode'] === undefined)
@@ -50,14 +48,15 @@ export function CreateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
50
48
  }
51
49
  return {
52
50
  'name': json['name'],
53
- 'attContact': json['attContact'],
51
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
52
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
54
53
  'address1': json['address1'],
55
- 'address2': json['address2'] == null ? undefined : json['address2'],
54
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
56
55
  'zipcode': json['zipcode'],
57
56
  'city': json['city'],
58
57
  'phone': json['phone'],
59
58
  'countryCode': json['countryCode'],
60
- 'state': json['state'] == null ? undefined : json['state'],
59
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
61
60
  'email': json['email'],
62
61
  'customs': json['customs'] == null ? undefined : json['customs'],
63
62
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -73,6 +72,7 @@ export function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
73
72
  }
74
73
  return {
75
74
  'name': value['name'],
75
+ 'description': value['description'],
76
76
  'attContact': value['attContact'],
77
77
  'address1': value['address1'],
78
78
  'address2': value['address2'],
@@ -22,17 +22,23 @@ export interface ListAddresses200ResponseDataInner {
22
22
  */
23
23
  id: string;
24
24
  /**
25
- * Name of the address
25
+ * Company or person the parcel is sent from, printed on labels
26
26
  * @type {string}
27
27
  * @memberof ListAddresses200ResponseDataInner
28
28
  */
29
29
  name: string;
30
30
  /**
31
- * Attention contact person
31
+ * Internal label for this address; never printed or sent to a carrier
32
32
  * @type {string}
33
33
  * @memberof ListAddresses200ResponseDataInner
34
34
  */
35
- attContact: string;
35
+ description: string | null;
36
+ /**
37
+ * Contact person at this address, printed as the att. line
38
+ * @type {string}
39
+ * @memberof ListAddresses200ResponseDataInner
40
+ */
41
+ attContact: string | null;
36
42
  /**
37
43
  * Address line 1
38
44
  * @type {string}
@@ -27,6 +27,8 @@ export function instanceOfListAddresses200ResponseDataInner(value) {
27
27
  return false;
28
28
  if (!('name' in value) || value['name'] === undefined)
29
29
  return false;
30
+ if (!('description' in value) || value['description'] === undefined)
31
+ return false;
30
32
  if (!('attContact' in value) || value['attContact'] === undefined)
31
33
  return false;
32
34
  if (!('address1' in value) || value['address1'] === undefined)
@@ -67,6 +69,7 @@ export function ListAddresses200ResponseDataInnerFromJSONTyped(json, ignoreDiscr
67
69
  return {
68
70
  'id': json['id'],
69
71
  'name': json['name'],
72
+ 'description': json['description'],
70
73
  'attContact': json['attContact'],
71
74
  'address1': json['address1'],
72
75
  'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListAddresses200ResponseDataInnerToJSONTyped(value, ignoreDiscri
94
97
  return {
95
98
  'id': value['id'],
96
99
  'name': value['name'],
100
+ 'description': value['description'],
97
101
  'attContact': value['attContact'],
98
102
  'address1': value['address1'],
99
103
  'address2': value['address2'],
@@ -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',
@@ -22,17 +22,23 @@ export interface ListShipments200ResponseDataInnerAddress {
22
22
  */
23
23
  id: string;
24
24
  /**
25
- * Name of the address
25
+ * Company or person the parcel is sent from, printed on labels
26
26
  * @type {string}
27
27
  * @memberof ListShipments200ResponseDataInnerAddress
28
28
  */
29
29
  name: string;
30
30
  /**
31
- * Attention contact person
31
+ * Internal label for this address; never printed or sent to a carrier
32
32
  * @type {string}
33
33
  * @memberof ListShipments200ResponseDataInnerAddress
34
34
  */
35
- attContact: string;
35
+ description: string | null;
36
+ /**
37
+ * Contact person at this address, printed as the att. line
38
+ * @type {string}
39
+ * @memberof ListShipments200ResponseDataInnerAddress
40
+ */
41
+ attContact: string | null;
36
42
  /**
37
43
  * Address line 1
38
44
  * @type {string}
@@ -27,6 +27,8 @@ export function instanceOfListShipments200ResponseDataInnerAddress(value) {
27
27
  return false;
28
28
  if (!('name' in value) || value['name'] === undefined)
29
29
  return false;
30
+ if (!('description' in value) || value['description'] === undefined)
31
+ return false;
30
32
  if (!('attContact' in value) || value['attContact'] === undefined)
31
33
  return false;
32
34
  if (!('address1' in value) || value['address1'] === undefined)
@@ -67,6 +69,7 @@ export function ListShipments200ResponseDataInnerAddressFromJSONTyped(json, igno
67
69
  return {
68
70
  'id': json['id'],
69
71
  'name': json['name'],
72
+ 'description': json['description'],
70
73
  'attContact': json['attContact'],
71
74
  'address1': json['address1'],
72
75
  'address2': json['address2'],
@@ -94,6 +97,7 @@ export function ListShipments200ResponseDataInnerAddressToJSONTyped(value, ignor
94
97
  return {
95
98
  'id': value['id'],
96
99
  'name': value['name'],
100
+ 'description': value['description'],
97
101
  'attContact': value['attContact'],
98
102
  'address1': value['address1'],
99
103
  'address2': value['address2'],
@@ -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',
@@ -16,17 +16,23 @@
16
16
  */
17
17
  export interface UpdateAddressRequest {
18
18
  /**
19
- * Name of the address
19
+ * Company or person the parcel is sent from, printed on labels
20
20
  * @type {string}
21
21
  * @memberof UpdateAddressRequest
22
22
  */
23
23
  name?: string;
24
24
  /**
25
- * Attention contact person
25
+ * Internal label for this address; send null or an empty string to clear it
26
26
  * @type {string}
27
27
  * @memberof UpdateAddressRequest
28
28
  */
29
- attContact?: string;
29
+ description?: string | null;
30
+ /**
31
+ * Contact person at this address; send null or an empty string to clear it
32
+ * @type {string}
33
+ * @memberof UpdateAddressRequest
34
+ */
35
+ attContact?: string | null;
30
36
  /**
31
37
  * Address line 1
32
38
  * @type {string}
@@ -34,11 +40,11 @@ export interface UpdateAddressRequest {
34
40
  */
35
41
  address1?: string;
36
42
  /**
37
- * Address line 2
43
+ * Address line 2; send null or an empty string to clear it
38
44
  * @type {string}
39
45
  * @memberof UpdateAddressRequest
40
46
  */
41
- address2?: string;
47
+ address2?: string | null;
42
48
  /**
43
49
  * Postal/ZIP code
44
50
  * @type {string}
@@ -64,11 +70,11 @@ export interface UpdateAddressRequest {
64
70
  */
65
71
  countryCode?: string;
66
72
  /**
67
- * State/Province
73
+ * State/Province; send null or an empty string to clear it
68
74
  * @type {string}
69
75
  * @memberof UpdateAddressRequest
70
76
  */
71
- state?: string;
77
+ state?: string | null;
72
78
  /**
73
79
  * Email address
74
80
  * @type {string}