@zippendo/sdk 1.2.0 → 1.2.1
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.
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +5 -3
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +3 -1
- package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +8 -2
- package/dist/esm/models/BatchSendShipments200ResponseSummary.js +4 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/esm/models/ListApiTokens401Response.js +1 -0
- package/dist/esm/models/SendShipment422Response.d.ts +1 -0
- package/dist/esm/models/SendShipment422Response.js +1 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +5 -3
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +3 -1
- package/dist/models/BatchSendShipments200ResponseSummary.d.ts +8 -2
- package/dist/models/BatchSendShipments200ResponseSummary.js +4 -0
- package/dist/models/ListApiTokens401Response.d.ts +1 -0
- package/dist/models/ListApiTokens401Response.js +1 -0
- package/dist/models/SendShipment422Response.d.ts +1 -0
- package/dist/models/SendShipment422Response.js +1 -0
- package/docs/BatchSendShipments200ResponseSummary.md +2 -0
- package/package.json +1 -1
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +6 -4
- package/src/models/BatchSendShipments200ResponseSummary.ts +11 -2
- package/src/models/ListApiTokens401Response.ts +1 -0
- package/src/models/SendShipment422Response.ts +1 -0
|
@@ -23,19 +23,19 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
23
23
|
*/
|
|
24
24
|
shipmentId: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
|
|
27
27
|
* @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
|
|
28
28
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
29
29
|
*/
|
|
30
30
|
status: BatchSendShipments200ResponseResultsInnerStatusEnum;
|
|
31
31
|
/**
|
|
32
|
-
* Canonical machine-readable error code, present when `status` is `failed`.
|
|
32
|
+
* Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
|
|
33
33
|
* @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
|
|
34
34
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
35
35
|
*/
|
|
36
36
|
code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
|
|
37
37
|
/**
|
|
38
|
-
* Human-readable
|
|
38
|
+
* Human-readable detail, present when `status` is `failed` or `skipped`.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
41
41
|
*/
|
|
@@ -53,6 +53,7 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
53
53
|
export declare const BatchSendShipments200ResponseResultsInnerStatusEnum: {
|
|
54
54
|
readonly Sent: "sent";
|
|
55
55
|
readonly Failed: "failed";
|
|
56
|
+
readonly Skipped: "skipped";
|
|
56
57
|
};
|
|
57
58
|
export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
|
|
58
59
|
/**
|
|
@@ -124,6 +125,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
|
|
|
124
125
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
125
126
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
126
127
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
128
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
127
129
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
128
130
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
129
131
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -17,7 +17,8 @@ import { SendShipment422ResponseErrorsInnerFromJSON, SendShipment422ResponseErro
|
|
|
17
17
|
*/
|
|
18
18
|
export const BatchSendShipments200ResponseResultsInnerStatusEnum = {
|
|
19
19
|
Sent: 'sent',
|
|
20
|
-
Failed: 'failed'
|
|
20
|
+
Failed: 'failed',
|
|
21
|
+
Skipped: 'skipped'
|
|
21
22
|
};
|
|
22
23
|
/**
|
|
23
24
|
* @export
|
|
@@ -88,6 +89,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
88
89
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
89
90
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
90
91
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
92
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
91
93
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
92
94
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
93
95
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface BatchSendShipments200ResponseSummary {
|
|
18
18
|
/**
|
|
19
|
-
* Number of unique shipments
|
|
19
|
+
* Number of unique shipments requested.
|
|
20
20
|
* @type {number}
|
|
21
21
|
* @memberof BatchSendShipments200ResponseSummary
|
|
22
22
|
*/
|
|
@@ -28,11 +28,17 @@ export interface BatchSendShipments200ResponseSummary {
|
|
|
28
28
|
*/
|
|
29
29
|
sent: number;
|
|
30
30
|
/**
|
|
31
|
-
* How many
|
|
31
|
+
* How many the carrier or Zippendo rejected.
|
|
32
32
|
* @type {number}
|
|
33
33
|
* @memberof BatchSendShipments200ResponseSummary
|
|
34
34
|
*/
|
|
35
35
|
failed: number;
|
|
36
|
+
/**
|
|
37
|
+
* How many the batch ran out of time to attempt. Submit these again.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof BatchSendShipments200ResponseSummary
|
|
40
|
+
*/
|
|
41
|
+
skipped: number;
|
|
36
42
|
}
|
|
37
43
|
/**
|
|
38
44
|
* Check if a given object implements the BatchSendShipments200ResponseSummary interface.
|
|
@@ -21,6 +21,8 @@ export function instanceOfBatchSendShipments200ResponseSummary(value) {
|
|
|
21
21
|
return false;
|
|
22
22
|
if (!('failed' in value) || value['failed'] === undefined)
|
|
23
23
|
return false;
|
|
24
|
+
if (!('skipped' in value) || value['skipped'] === undefined)
|
|
25
|
+
return false;
|
|
24
26
|
return true;
|
|
25
27
|
}
|
|
26
28
|
export function BatchSendShipments200ResponseSummaryFromJSON(json) {
|
|
@@ -34,6 +36,7 @@ export function BatchSendShipments200ResponseSummaryFromJSONTyped(json, ignoreDi
|
|
|
34
36
|
'total': json['total'],
|
|
35
37
|
'sent': json['sent'],
|
|
36
38
|
'failed': json['failed'],
|
|
39
|
+
'skipped': json['skipped'],
|
|
37
40
|
};
|
|
38
41
|
}
|
|
39
42
|
export function BatchSendShipments200ResponseSummaryToJSON(json) {
|
|
@@ -47,5 +50,6 @@ export function BatchSendShipments200ResponseSummaryToJSONTyped(value, ignoreDis
|
|
|
47
50
|
'total': value['total'],
|
|
48
51
|
'sent': value['sent'],
|
|
49
52
|
'failed': value['failed'],
|
|
53
|
+
'skipped': value['skipped'],
|
|
50
54
|
};
|
|
51
55
|
}
|
|
@@ -103,6 +103,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
103
103
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
104
104
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
105
105
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
106
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
106
107
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
107
108
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
108
109
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -80,6 +80,7 @@ export const ListApiTokens401ResponseCodeEnum = {
|
|
|
80
80
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
81
81
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
82
82
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
83
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
83
84
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
84
85
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
85
86
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -110,6 +110,7 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
110
110
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
111
111
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
112
112
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
113
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
113
114
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
114
115
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
115
116
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -81,6 +81,7 @@ export const SendShipment422ResponseCodeEnum = {
|
|
|
81
81
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
82
82
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
83
83
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
84
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
84
85
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
85
86
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
86
87
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -23,19 +23,19 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
23
23
|
*/
|
|
24
24
|
shipmentId: string;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
|
|
27
27
|
* @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
|
|
28
28
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
29
29
|
*/
|
|
30
30
|
status: BatchSendShipments200ResponseResultsInnerStatusEnum;
|
|
31
31
|
/**
|
|
32
|
-
* Canonical machine-readable error code, present when `status` is `failed`.
|
|
32
|
+
* Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
|
|
33
33
|
* @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
|
|
34
34
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
35
35
|
*/
|
|
36
36
|
code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
|
|
37
37
|
/**
|
|
38
|
-
* Human-readable
|
|
38
|
+
* Human-readable detail, present when `status` is `failed` or `skipped`.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
41
41
|
*/
|
|
@@ -53,6 +53,7 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
53
53
|
export declare const BatchSendShipments200ResponseResultsInnerStatusEnum: {
|
|
54
54
|
readonly Sent: "sent";
|
|
55
55
|
readonly Failed: "failed";
|
|
56
|
+
readonly Skipped: "skipped";
|
|
56
57
|
};
|
|
57
58
|
export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
|
|
58
59
|
/**
|
|
@@ -124,6 +125,7 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
|
|
|
124
125
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
125
126
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
126
127
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
128
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
127
129
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
128
130
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
129
131
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -25,7 +25,8 @@ const SendShipment422ResponseErrorsInner_1 = require("./SendShipment422ResponseE
|
|
|
25
25
|
*/
|
|
26
26
|
exports.BatchSendShipments200ResponseResultsInnerStatusEnum = {
|
|
27
27
|
Sent: 'sent',
|
|
28
|
-
Failed: 'failed'
|
|
28
|
+
Failed: 'failed',
|
|
29
|
+
Skipped: 'skipped'
|
|
29
30
|
};
|
|
30
31
|
/**
|
|
31
32
|
* @export
|
|
@@ -96,6 +97,7 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
96
97
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
97
98
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
98
99
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
100
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
99
101
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
100
102
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
101
103
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface BatchSendShipments200ResponseSummary {
|
|
18
18
|
/**
|
|
19
|
-
* Number of unique shipments
|
|
19
|
+
* Number of unique shipments requested.
|
|
20
20
|
* @type {number}
|
|
21
21
|
* @memberof BatchSendShipments200ResponseSummary
|
|
22
22
|
*/
|
|
@@ -28,11 +28,17 @@ export interface BatchSendShipments200ResponseSummary {
|
|
|
28
28
|
*/
|
|
29
29
|
sent: number;
|
|
30
30
|
/**
|
|
31
|
-
* How many
|
|
31
|
+
* How many the carrier or Zippendo rejected.
|
|
32
32
|
* @type {number}
|
|
33
33
|
* @memberof BatchSendShipments200ResponseSummary
|
|
34
34
|
*/
|
|
35
35
|
failed: number;
|
|
36
|
+
/**
|
|
37
|
+
* How many the batch ran out of time to attempt. Submit these again.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof BatchSendShipments200ResponseSummary
|
|
40
|
+
*/
|
|
41
|
+
skipped: number;
|
|
36
42
|
}
|
|
37
43
|
/**
|
|
38
44
|
* Check if a given object implements the BatchSendShipments200ResponseSummary interface.
|
|
@@ -28,6 +28,8 @@ function instanceOfBatchSendShipments200ResponseSummary(value) {
|
|
|
28
28
|
return false;
|
|
29
29
|
if (!('failed' in value) || value['failed'] === undefined)
|
|
30
30
|
return false;
|
|
31
|
+
if (!('skipped' in value) || value['skipped'] === undefined)
|
|
32
|
+
return false;
|
|
31
33
|
return true;
|
|
32
34
|
}
|
|
33
35
|
function BatchSendShipments200ResponseSummaryFromJSON(json) {
|
|
@@ -41,6 +43,7 @@ function BatchSendShipments200ResponseSummaryFromJSONTyped(json, ignoreDiscrimin
|
|
|
41
43
|
'total': json['total'],
|
|
42
44
|
'sent': json['sent'],
|
|
43
45
|
'failed': json['failed'],
|
|
46
|
+
'skipped': json['skipped'],
|
|
44
47
|
};
|
|
45
48
|
}
|
|
46
49
|
function BatchSendShipments200ResponseSummaryToJSON(json) {
|
|
@@ -54,5 +57,6 @@ function BatchSendShipments200ResponseSummaryToJSONTyped(value, ignoreDiscrimina
|
|
|
54
57
|
'total': value['total'],
|
|
55
58
|
'sent': value['sent'],
|
|
56
59
|
'failed': value['failed'],
|
|
60
|
+
'skipped': value['skipped'],
|
|
57
61
|
};
|
|
58
62
|
}
|
|
@@ -103,6 +103,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
103
103
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
104
104
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
105
105
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
106
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
106
107
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
107
108
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
108
109
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -88,6 +88,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
|
|
|
88
88
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
89
89
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
90
90
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
91
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
91
92
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
92
93
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
93
94
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -110,6 +110,7 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
110
110
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
111
111
|
readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
|
|
112
112
|
readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
|
|
113
|
+
readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
|
|
113
114
|
readonly ParcelNotFound: "PARCEL_NOT_FOUND";
|
|
114
115
|
readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
|
|
115
116
|
readonly PickupNotFound: "PICKUP_NOT_FOUND";
|
|
@@ -89,6 +89,7 @@ exports.SendShipment422ResponseCodeEnum = {
|
|
|
89
89
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
90
90
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
91
91
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
92
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
92
93
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
93
94
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
94
95
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`total` | number
|
|
11
11
|
`sent` | number
|
|
12
12
|
`failed` | number
|
|
13
|
+
`skipped` | number
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -21,6 +22,7 @@ const example = {
|
|
|
21
22
|
"total": 3,
|
|
22
23
|
"sent": 2,
|
|
23
24
|
"failed": 1,
|
|
25
|
+
"skipped": 0,
|
|
24
26
|
} satisfies BatchSendShipments200ResponseSummary
|
|
25
27
|
|
|
26
28
|
console.log(example)
|
package/package.json
CHANGED
|
@@ -34,19 +34,19 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
34
34
|
*/
|
|
35
35
|
shipmentId: string;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
|
|
38
38
|
* @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
|
|
39
39
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
40
40
|
*/
|
|
41
41
|
status: BatchSendShipments200ResponseResultsInnerStatusEnum;
|
|
42
42
|
/**
|
|
43
|
-
* Canonical machine-readable error code, present when `status` is `failed`.
|
|
43
|
+
* Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
|
|
44
44
|
* @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
|
|
45
45
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
46
46
|
*/
|
|
47
47
|
code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
|
|
48
48
|
/**
|
|
49
|
-
* Human-readable
|
|
49
|
+
* Human-readable detail, present when `status` is `failed` or `skipped`.
|
|
50
50
|
* @type {string}
|
|
51
51
|
* @memberof BatchSendShipments200ResponseResultsInner
|
|
52
52
|
*/
|
|
@@ -65,7 +65,8 @@ export interface BatchSendShipments200ResponseResultsInner {
|
|
|
65
65
|
*/
|
|
66
66
|
export const BatchSendShipments200ResponseResultsInnerStatusEnum = {
|
|
67
67
|
Sent: 'sent',
|
|
68
|
-
Failed: 'failed'
|
|
68
|
+
Failed: 'failed',
|
|
69
|
+
Skipped: 'skipped'
|
|
69
70
|
} as const;
|
|
70
71
|
export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
|
|
71
72
|
|
|
@@ -138,6 +139,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
138
139
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
139
140
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
140
141
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
142
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
141
143
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
142
144
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
143
145
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface BatchSendShipments200ResponseSummary {
|
|
22
22
|
/**
|
|
23
|
-
* Number of unique shipments
|
|
23
|
+
* Number of unique shipments requested.
|
|
24
24
|
* @type {number}
|
|
25
25
|
* @memberof BatchSendShipments200ResponseSummary
|
|
26
26
|
*/
|
|
@@ -32,11 +32,17 @@ export interface BatchSendShipments200ResponseSummary {
|
|
|
32
32
|
*/
|
|
33
33
|
sent: number;
|
|
34
34
|
/**
|
|
35
|
-
* How many
|
|
35
|
+
* How many the carrier or Zippendo rejected.
|
|
36
36
|
* @type {number}
|
|
37
37
|
* @memberof BatchSendShipments200ResponseSummary
|
|
38
38
|
*/
|
|
39
39
|
failed: number;
|
|
40
|
+
/**
|
|
41
|
+
* How many the batch ran out of time to attempt. Submit these again.
|
|
42
|
+
* @type {number}
|
|
43
|
+
* @memberof BatchSendShipments200ResponseSummary
|
|
44
|
+
*/
|
|
45
|
+
skipped: number;
|
|
40
46
|
}
|
|
41
47
|
|
|
42
48
|
/**
|
|
@@ -46,6 +52,7 @@ export function instanceOfBatchSendShipments200ResponseSummary(value: object): v
|
|
|
46
52
|
if (!('total' in value) || value['total'] === undefined) return false;
|
|
47
53
|
if (!('sent' in value) || value['sent'] === undefined) return false;
|
|
48
54
|
if (!('failed' in value) || value['failed'] === undefined) return false;
|
|
55
|
+
if (!('skipped' in value) || value['skipped'] === undefined) return false;
|
|
49
56
|
return true;
|
|
50
57
|
}
|
|
51
58
|
|
|
@@ -62,6 +69,7 @@ export function BatchSendShipments200ResponseSummaryFromJSONTyped(json: any, ign
|
|
|
62
69
|
'total': json['total'],
|
|
63
70
|
'sent': json['sent'],
|
|
64
71
|
'failed': json['failed'],
|
|
72
|
+
'skipped': json['skipped'],
|
|
65
73
|
};
|
|
66
74
|
}
|
|
67
75
|
|
|
@@ -79,6 +87,7 @@ export function BatchSendShipments200ResponseSummaryToJSONTyped(value?: BatchSen
|
|
|
79
87
|
'total': value['total'],
|
|
80
88
|
'sent': value['sent'],
|
|
81
89
|
'failed': value['failed'],
|
|
90
|
+
'skipped': value['skipped'],
|
|
82
91
|
};
|
|
83
92
|
}
|
|
84
93
|
|
|
@@ -109,6 +109,7 @@ export const ListApiTokens401ResponseCodeEnum = {
|
|
|
109
109
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
110
110
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
111
111
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
112
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
112
113
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
113
114
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
114
115
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|
|
@@ -123,6 +123,7 @@ export const SendShipment422ResponseCodeEnum = {
|
|
|
123
123
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
124
124
|
ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
|
|
125
125
|
ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
|
|
126
|
+
ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
|
|
126
127
|
ParcelNotFound: 'PARCEL_NOT_FOUND',
|
|
127
128
|
ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
|
|
128
129
|
PickupNotFound: 'PICKUP_NOT_FOUND',
|