@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
@@ -34,14 +34,15 @@ export function UpdateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
34
34
  }
35
35
  return {
36
36
  'name': json['name'] == null ? undefined : json['name'],
37
- 'attContact': json['attContact'] == null ? undefined : json['attContact'],
37
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
38
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
38
39
  'address1': json['address1'] == null ? undefined : json['address1'],
39
- 'address2': json['address2'] == null ? undefined : json['address2'],
40
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
40
41
  'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
41
42
  'city': json['city'] == null ? undefined : json['city'],
42
43
  'phone': json['phone'] == null ? undefined : json['phone'],
43
44
  'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
44
- 'state': json['state'] == null ? undefined : json['state'],
45
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
45
46
  'email': json['email'] == null ? undefined : json['email'],
46
47
  'customs': json['customs'] == null ? undefined : json['customs'],
47
48
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -57,6 +58,7 @@ export function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = fal
57
58
  }
58
59
  return {
59
60
  'name': value['name'],
61
+ 'description': value['description'],
60
62
  'attContact': value['attContact'],
61
63
  'address1': value['address1'],
62
64
  'address2': value['address2'],
@@ -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',
@@ -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}
@@ -33,8 +33,6 @@ exports.CreateAddressRequestAddressTypesEnum = {
33
33
  function instanceOfCreateAddressRequest(value) {
34
34
  if (!('name' in value) || value['name'] === undefined)
35
35
  return false;
36
- if (!('attContact' in value) || value['attContact'] === undefined)
37
- return false;
38
36
  if (!('address1' in value) || value['address1'] === undefined)
39
37
  return false;
40
38
  if (!('zipcode' in value) || value['zipcode'] === undefined)
@@ -58,14 +56,15 @@ function CreateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
58
56
  }
59
57
  return {
60
58
  'name': json['name'],
61
- 'attContact': json['attContact'],
59
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
60
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
62
61
  'address1': json['address1'],
63
- 'address2': json['address2'] == null ? undefined : json['address2'],
62
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
64
63
  'zipcode': json['zipcode'],
65
64
  'city': json['city'],
66
65
  'phone': json['phone'],
67
66
  'countryCode': json['countryCode'],
68
- 'state': json['state'] == null ? undefined : json['state'],
67
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
69
68
  'email': json['email'],
70
69
  'customs': json['customs'] == null ? undefined : json['customs'],
71
70
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -81,6 +80,7 @@ function CreateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
81
80
  }
82
81
  return {
83
82
  'name': value['name'],
83
+ 'description': value['description'],
84
84
  'attContact': value['attContact'],
85
85
  'address1': value['address1'],
86
86
  '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}
@@ -35,6 +35,8 @@ function instanceOfListAddresses200ResponseDataInner(value) {
35
35
  return false;
36
36
  if (!('name' in value) || value['name'] === undefined)
37
37
  return false;
38
+ if (!('description' in value) || value['description'] === undefined)
39
+ return false;
38
40
  if (!('attContact' in value) || value['attContact'] === undefined)
39
41
  return false;
40
42
  if (!('address1' in value) || value['address1'] === undefined)
@@ -75,6 +77,7 @@ function ListAddresses200ResponseDataInnerFromJSONTyped(json, ignoreDiscriminato
75
77
  return {
76
78
  'id': json['id'],
77
79
  'name': json['name'],
80
+ 'description': json['description'],
78
81
  'attContact': json['attContact'],
79
82
  'address1': json['address1'],
80
83
  'address2': json['address2'],
@@ -102,6 +105,7 @@ function ListAddresses200ResponseDataInnerToJSONTyped(value, ignoreDiscriminator
102
105
  return {
103
106
  'id': value['id'],
104
107
  'name': value['name'],
108
+ 'description': value['description'],
105
109
  'attContact': value['attContact'],
106
110
  'address1': value['address1'],
107
111
  '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";
@@ -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',
@@ -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}
@@ -35,6 +35,8 @@ function instanceOfListShipments200ResponseDataInnerAddress(value) {
35
35
  return false;
36
36
  if (!('name' in value) || value['name'] === undefined)
37
37
  return false;
38
+ if (!('description' in value) || value['description'] === undefined)
39
+ return false;
38
40
  if (!('attContact' in value) || value['attContact'] === undefined)
39
41
  return false;
40
42
  if (!('address1' in value) || value['address1'] === undefined)
@@ -75,6 +77,7 @@ function ListShipments200ResponseDataInnerAddressFromJSONTyped(json, ignoreDiscr
75
77
  return {
76
78
  'id': json['id'],
77
79
  'name': json['name'],
80
+ 'description': json['description'],
78
81
  'attContact': json['attContact'],
79
82
  'address1': json['address1'],
80
83
  'address2': json['address2'],
@@ -102,6 +105,7 @@ function ListShipments200ResponseDataInnerAddressToJSONTyped(value, ignoreDiscri
102
105
  return {
103
106
  'id': value['id'],
104
107
  'name': value['name'],
108
+ 'description': value['description'],
105
109
  'attContact': value['attContact'],
106
110
  'address1': value['address1'],
107
111
  '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";
@@ -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',
@@ -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}
@@ -42,14 +42,15 @@ function UpdateAddressRequestFromJSONTyped(json, ignoreDiscriminator) {
42
42
  }
43
43
  return {
44
44
  'name': json['name'] == null ? undefined : json['name'],
45
- 'attContact': json['attContact'] == null ? undefined : json['attContact'],
45
+ 'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
46
+ 'attContact': json['attContact'] === undefined ? undefined : json['attContact'] === null ? null : json['attContact'],
46
47
  'address1': json['address1'] == null ? undefined : json['address1'],
47
- 'address2': json['address2'] == null ? undefined : json['address2'],
48
+ 'address2': json['address2'] === undefined ? undefined : json['address2'] === null ? null : json['address2'],
48
49
  'zipcode': json['zipcode'] == null ? undefined : json['zipcode'],
49
50
  'city': json['city'] == null ? undefined : json['city'],
50
51
  'phone': json['phone'] == null ? undefined : json['phone'],
51
52
  'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
52
- 'state': json['state'] == null ? undefined : json['state'],
53
+ 'state': json['state'] === undefined ? undefined : json['state'] === null ? null : json['state'],
53
54
  'email': json['email'] == null ? undefined : json['email'],
54
55
  'customs': json['customs'] == null ? undefined : json['customs'],
55
56
  'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
@@ -65,6 +66,7 @@ function UpdateAddressRequestToJSONTyped(value, ignoreDiscriminator = false) {
65
66
  }
66
67
  return {
67
68
  'name': value['name'],
69
+ 'description': value['description'],
68
70
  'attContact': value['attContact'],
69
71
  'address1': value['address1'],
70
72
  'address2': value['address2'],
@@ -277,7 +277,7 @@ async function example() {
277
277
  type: sender,
278
278
  // string | Filter by ISO 3166-1 alpha-2 country code. (optional)
279
279
  countryCode: DK,
280
- // string | Search by address name, contact or city. (optional)
280
+ // string | Search by company name, description, contact or city. (optional)
281
281
  search: Copenhagen,
282
282
  // string | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. (optional)
283
283
  brandId: brnd_8f3kd92ld0,
@@ -307,7 +307,7 @@ example().catch(console.error);
307
307
  | **limit** | `number` | Items per page (max 100) | [Optional] [Defaults to `20`] |
308
308
  | **type** | `sender`, `pickup`, `return` | Filter by address type (sender, pickup, return) | [Optional] [Defaults to `undefined`] [Enum: sender, pickup, return] |
309
309
  | **countryCode** | `string` | Filter by ISO 3166-1 alpha-2 country code. | [Optional] [Defaults to `undefined`] |
310
- | **search** | `string` | Search by address name, contact or city. | [Optional] [Defaults to `undefined`] |
310
+ | **search** | `string` | Search by company name, description, contact or city. | [Optional] [Defaults to `undefined`] |
311
311
  | **brandId** | `string` | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [Optional] [Defaults to `undefined`] |
312
312
  | **brandScope** | `own`, `shared`, `both` | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [Optional] [Defaults to `undefined`] [Enum: own, shared, both] |
313
313
 
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `name` | string
10
+ `description` | string
10
11
  `attContact` | string
11
12
  `address1` | string
12
13
  `address2` | string
@@ -27,7 +28,8 @@ import type { CreateAddressRequest } from '@zippendo/sdk'
27
28
 
28
29
  // TODO: Update the object below with actual values
29
30
  const example = {
30
- "name": Hovedlager,
31
+ "name": Zippendo ApS,
32
+ "description": Main warehouse, Copenhagen,
31
33
  "attContact": Mette Hansen,
32
34
  "address1": Vesterbrogade 1,
33
35
  "address2": 2. sal,
@@ -35,7 +37,7 @@ const example = {
35
37
  "city": København,
36
38
  "phone": +4533123456,
37
39
  "countryCode": DK,
38
- "state": ,
40
+ "state": Hovedstaden,
39
41
  "email": lager@example.dk,
40
42
  "customs": {"eori":"DK12345678"},
41
43
  "addressTypes": ["sender"],
@@ -8,6 +8,7 @@ Name | Type
8
8
  ------------ | -------------
9
9
  `id` | string
10
10
  `name` | string
11
+ `description` | string
11
12
  `attContact` | string
12
13
  `address1` | string
13
14
  `address2` | string
@@ -32,7 +33,8 @@ import type { ListAddresses200ResponseDataInner } from '@zippendo/sdk'
32
33
  // TODO: Update the object below with actual values
33
34
  const example = {
34
35
  "id": addr_01HZX9K2QF,
35
- "name": Hovedlager,
36
+ "name": Zippendo ApS,
37
+ "description": Main warehouse, Copenhagen,
36
38
  "attContact": Mette Hansen,
37
39
  "address1": Vesterbrogade 1,
38
40
  "address2": 2. sal,
@@ -8,6 +8,7 @@ Name | Type
8
8
  ------------ | -------------
9
9
  `id` | string
10
10
  `name` | string
11
+ `description` | string
11
12
  `attContact` | string
12
13
  `address1` | string
13
14
  `address2` | string
@@ -32,7 +33,8 @@ import type { ListShipments200ResponseDataInnerAddress } from '@zippendo/sdk'
32
33
  // TODO: Update the object below with actual values
33
34
  const example = {
34
35
  "id": addr_01HZX9K2QF,
35
- "name": Hovedlager,
36
+ "name": Zippendo ApS,
37
+ "description": Main warehouse, Copenhagen,
36
38
  "attContact": Mette Hansen,
37
39
  "address1": Vesterbrogade 1,
38
40
  "address2": 2. sal,
@@ -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: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
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)
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `name` | string
10
+ `description` | string
10
11
  `attContact` | string
11
12
  `address1` | string
12
13
  `address2` | string
@@ -27,7 +28,8 @@ import type { UpdateAddressRequest } from '@zippendo/sdk'
27
28
 
28
29
  // TODO: Update the object below with actual values
29
30
  const example = {
30
- "name": Hovedlager,
31
+ "name": Zippendo ApS,
32
+ "description": Main warehouse, Copenhagen,
31
33
  "attContact": Mette Hansen,
32
34
  "address1": Vesterbrogade 1,
33
35
  "address2": 2. sal,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.2",
3
+ "version": "1.3.4",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {