@zippendo/sdk 1.3.3 → 1.3.5
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 +3 -0
- package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +3 -0
- package/dist/esm/models/CreateAddressRequest.d.ts +11 -5
- package/dist/esm/models/CreateAddressRequest.js +5 -5
- package/dist/esm/models/GetBillingUsage200Response.d.ts +3 -3
- package/dist/esm/models/GetBillingUsage200Response.js +3 -3
- package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
- package/dist/esm/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +16 -8
- package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +9 -3
- package/dist/esm/models/ListAddresses200ResponseDataInner.js +4 -0
- package/dist/esm/models/ListApiTokens401Response.d.ts +3 -0
- package/dist/esm/models/ListApiTokens401Response.js +3 -0
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
- package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +4 -0
- package/dist/esm/models/SendShipment422Response.d.ts +3 -0
- package/dist/esm/models/SendShipment422Response.js +3 -0
- package/dist/esm/models/UpdateAddressRequest.d.ts +13 -7
- package/dist/esm/models/UpdateAddressRequest.js +5 -3
- package/dist/esm/models/index.d.ts +1 -1
- package/dist/esm/models/index.js +1 -1
- package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +3 -0
- package/dist/models/BatchSendShipments200ResponseResultsInner.js +3 -0
- package/dist/models/CreateAddressRequest.d.ts +11 -5
- package/dist/models/CreateAddressRequest.js +5 -5
- package/dist/models/GetBillingUsage200Response.d.ts +3 -3
- package/dist/models/GetBillingUsage200Response.js +3 -3
- package/dist/models/{GetBillingUsage200ResponseZippyMessages.d.ts → GetBillingUsage200ResponseZippyCredits.d.ts} +27 -15
- package/dist/models/{GetBillingUsage200ResponseZippyMessages.js → GetBillingUsage200ResponseZippyCredits.js} +21 -13
- package/dist/models/ListAddresses200ResponseDataInner.d.ts +9 -3
- package/dist/models/ListAddresses200ResponseDataInner.js +4 -0
- package/dist/models/ListApiTokens401Response.d.ts +3 -0
- package/dist/models/ListApiTokens401Response.js +3 -0
- package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +9 -3
- package/dist/models/ListShipments200ResponseDataInnerAddress.js +4 -0
- package/dist/models/SendShipment422Response.d.ts +3 -0
- package/dist/models/SendShipment422Response.js +3 -0
- package/dist/models/UpdateAddressRequest.d.ts +13 -7
- package/dist/models/UpdateAddressRequest.js +5 -3
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/docs/AddressesApi.md +2 -2
- package/docs/CreateAddressRequest.md +4 -2
- package/docs/GetBillingUsage200Response.md +2 -2
- package/docs/{GetBillingUsage200ResponseZippyMessages.md → GetBillingUsage200ResponseZippyCredits.md} +11 -7
- package/docs/ListAddresses200ResponseDataInner.md +3 -1
- package/docs/ListShipments200ResponseDataInnerAddress.md +3 -1
- package/docs/OrgsApi.md +1 -0
- package/docs/UpdateAddressRequest.md +3 -1
- package/package.json +1 -1
- package/src/models/BatchSendShipments200ResponseResultsInner.ts +3 -0
- package/src/models/CreateAddressRequest.ts +16 -9
- package/src/models/GetBillingUsage200Response.ts +11 -11
- package/src/models/{GetBillingUsage200ResponseZippyMessages.ts → GetBillingUsage200ResponseZippyCredits.ts} +35 -17
- package/src/models/ListAddresses200ResponseDataInner.ts +12 -3
- package/src/models/ListApiTokens401Response.ts +3 -0
- package/src/models/ListShipments200ResponseDataInnerAddress.ts +12 -3
- package/src/models/SendShipment422Response.ts +3 -0
- package/src/models/UpdateAddressRequest.ts +18 -10
- package/src/models/index.ts +1 -1
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import type { GetBillingUsage200ResponseZippyMessages } from './GetBillingUsage200ResponseZippyMessages';
|
|
13
12
|
import type { GetBillingUsage200ResponseAddOnsInner } from './GetBillingUsage200ResponseAddOnsInner';
|
|
14
13
|
import type { GetBillingUsage200ResponseShipments } from './GetBillingUsage200ResponseShipments';
|
|
14
|
+
import type { GetBillingUsage200ResponseZippyCredits } from './GetBillingUsage200ResponseZippyCredits';
|
|
15
15
|
import type { GetBillingUsage200ResponseCurrentPeriod } from './GetBillingUsage200ResponseCurrentPeriod';
|
|
16
16
|
import type { GetBillingUsage200ResponseLimits } from './GetBillingUsage200ResponseLimits';
|
|
17
17
|
/**
|
|
@@ -46,10 +46,10 @@ export interface GetBillingUsage200Response {
|
|
|
46
46
|
addOns: Array<GetBillingUsage200ResponseAddOnsInner>;
|
|
47
47
|
/**
|
|
48
48
|
*
|
|
49
|
-
* @type {
|
|
49
|
+
* @type {GetBillingUsage200ResponseZippyCredits}
|
|
50
50
|
* @memberof GetBillingUsage200Response
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
zippyCredits?: GetBillingUsage200ResponseZippyCredits;
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
55
|
* Check if a given object implements the GetBillingUsage200Response interface.
|
|
@@ -18,9 +18,9 @@ exports.GetBillingUsage200ResponseFromJSON = GetBillingUsage200ResponseFromJSON;
|
|
|
18
18
|
exports.GetBillingUsage200ResponseFromJSONTyped = GetBillingUsage200ResponseFromJSONTyped;
|
|
19
19
|
exports.GetBillingUsage200ResponseToJSON = GetBillingUsage200ResponseToJSON;
|
|
20
20
|
exports.GetBillingUsage200ResponseToJSONTyped = GetBillingUsage200ResponseToJSONTyped;
|
|
21
|
-
const GetBillingUsage200ResponseZippyMessages_1 = require("./GetBillingUsage200ResponseZippyMessages");
|
|
22
21
|
const GetBillingUsage200ResponseAddOnsInner_1 = require("./GetBillingUsage200ResponseAddOnsInner");
|
|
23
22
|
const GetBillingUsage200ResponseShipments_1 = require("./GetBillingUsage200ResponseShipments");
|
|
23
|
+
const GetBillingUsage200ResponseZippyCredits_1 = require("./GetBillingUsage200ResponseZippyCredits");
|
|
24
24
|
const GetBillingUsage200ResponseCurrentPeriod_1 = require("./GetBillingUsage200ResponseCurrentPeriod");
|
|
25
25
|
const GetBillingUsage200ResponseLimits_1 = require("./GetBillingUsage200ResponseLimits");
|
|
26
26
|
/**
|
|
@@ -49,7 +49,7 @@ function GetBillingUsage200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
49
|
'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsFromJSON)(json['shipments']),
|
|
50
50
|
'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsFromJSON)(json['limits']),
|
|
51
51
|
'addOns': (json['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerFromJSON)),
|
|
52
|
-
'
|
|
52
|
+
'zippyCredits': json['zippyCredits'] == null ? undefined : (0, GetBillingUsage200ResponseZippyCredits_1.GetBillingUsage200ResponseZippyCreditsFromJSON)(json['zippyCredits']),
|
|
53
53
|
};
|
|
54
54
|
}
|
|
55
55
|
function GetBillingUsage200ResponseToJSON(json) {
|
|
@@ -64,6 +64,6 @@ function GetBillingUsage200ResponseToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
64
64
|
'shipments': (0, GetBillingUsage200ResponseShipments_1.GetBillingUsage200ResponseShipmentsToJSON)(value['shipments']),
|
|
65
65
|
'limits': (0, GetBillingUsage200ResponseLimits_1.GetBillingUsage200ResponseLimitsToJSON)(value['limits']),
|
|
66
66
|
'addOns': (value['addOns'].map(GetBillingUsage200ResponseAddOnsInner_1.GetBillingUsage200ResponseAddOnsInnerToJSON)),
|
|
67
|
-
'
|
|
67
|
+
'zippyCredits': (0, GetBillingUsage200ResponseZippyCredits_1.GetBillingUsage200ResponseZippyCreditsToJSON)(value['zippyCredits']),
|
|
68
68
|
};
|
|
69
69
|
}
|
|
@@ -10,35 +10,47 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Zippy AI
|
|
13
|
+
* Zippy AI credit usage this period (present when the Zippy add-on is enabled)
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface GetBillingUsage200ResponseZippyCredits
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface GetBillingUsage200ResponseZippyCredits {
|
|
18
18
|
/**
|
|
19
|
-
* Zippy
|
|
19
|
+
* Zippy credits used this period, included bundle and metered alike
|
|
20
20
|
* @type {number}
|
|
21
|
-
* @memberof
|
|
21
|
+
* @memberof GetBillingUsage200ResponseZippyCredits
|
|
22
22
|
*/
|
|
23
23
|
used: number;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Credits included in the add-on bundle this period
|
|
26
26
|
* @type {number}
|
|
27
|
-
* @memberof
|
|
27
|
+
* @memberof GetBillingUsage200ResponseZippyCredits
|
|
28
|
+
*/
|
|
29
|
+
included: number;
|
|
30
|
+
/**
|
|
31
|
+
* Credits beyond the bundle, metered this period
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof GetBillingUsage200ResponseZippyCredits
|
|
34
|
+
*/
|
|
35
|
+
billed: number;
|
|
36
|
+
/**
|
|
37
|
+
* Metered credit charges so far, in øre (whole packs)
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof GetBillingUsage200ResponseZippyCredits
|
|
28
40
|
*/
|
|
29
41
|
charges: number;
|
|
30
42
|
/**
|
|
31
|
-
* Maximum Zippy
|
|
43
|
+
* Maximum Zippy credits per month (-1 for unlimited)
|
|
32
44
|
* @type {number}
|
|
33
|
-
* @memberof
|
|
45
|
+
* @memberof GetBillingUsage200ResponseZippyCredits
|
|
34
46
|
*/
|
|
35
47
|
limit: number;
|
|
36
48
|
}
|
|
37
49
|
/**
|
|
38
|
-
* Check if a given object implements the
|
|
50
|
+
* Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
|
|
39
51
|
*/
|
|
40
|
-
export declare function
|
|
41
|
-
export declare function
|
|
42
|
-
export declare function
|
|
43
|
-
export declare function
|
|
44
|
-
export declare function
|
|
52
|
+
export declare function instanceOfGetBillingUsage200ResponseZippyCredits(value: object): value is GetBillingUsage200ResponseZippyCredits;
|
|
53
|
+
export declare function GetBillingUsage200ResponseZippyCreditsFromJSON(json: any): GetBillingUsage200ResponseZippyCredits;
|
|
54
|
+
export declare function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetBillingUsage200ResponseZippyCredits;
|
|
55
|
+
export declare function GetBillingUsage200ResponseZippyCreditsToJSON(json: any): GetBillingUsage200ResponseZippyCredits;
|
|
56
|
+
export declare function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value?: GetBillingUsage200ResponseZippyCredits | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -13,45 +13,53 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.
|
|
17
|
-
exports.
|
|
18
|
-
exports.
|
|
19
|
-
exports.
|
|
20
|
-
exports.
|
|
16
|
+
exports.instanceOfGetBillingUsage200ResponseZippyCredits = instanceOfGetBillingUsage200ResponseZippyCredits;
|
|
17
|
+
exports.GetBillingUsage200ResponseZippyCreditsFromJSON = GetBillingUsage200ResponseZippyCreditsFromJSON;
|
|
18
|
+
exports.GetBillingUsage200ResponseZippyCreditsFromJSONTyped = GetBillingUsage200ResponseZippyCreditsFromJSONTyped;
|
|
19
|
+
exports.GetBillingUsage200ResponseZippyCreditsToJSON = GetBillingUsage200ResponseZippyCreditsToJSON;
|
|
20
|
+
exports.GetBillingUsage200ResponseZippyCreditsToJSONTyped = GetBillingUsage200ResponseZippyCreditsToJSONTyped;
|
|
21
21
|
/**
|
|
22
|
-
* Check if a given object implements the
|
|
22
|
+
* Check if a given object implements the GetBillingUsage200ResponseZippyCredits interface.
|
|
23
23
|
*/
|
|
24
|
-
function
|
|
24
|
+
function instanceOfGetBillingUsage200ResponseZippyCredits(value) {
|
|
25
25
|
if (!('used' in value) || value['used'] === undefined)
|
|
26
26
|
return false;
|
|
27
|
+
if (!('included' in value) || value['included'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('billed' in value) || value['billed'] === undefined)
|
|
30
|
+
return false;
|
|
27
31
|
if (!('charges' in value) || value['charges'] === undefined)
|
|
28
32
|
return false;
|
|
29
33
|
if (!('limit' in value) || value['limit'] === undefined)
|
|
30
34
|
return false;
|
|
31
35
|
return true;
|
|
32
36
|
}
|
|
33
|
-
function
|
|
34
|
-
return
|
|
37
|
+
function GetBillingUsage200ResponseZippyCreditsFromJSON(json) {
|
|
38
|
+
return GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, false);
|
|
35
39
|
}
|
|
36
|
-
function
|
|
40
|
+
function GetBillingUsage200ResponseZippyCreditsFromJSONTyped(json, ignoreDiscriminator) {
|
|
37
41
|
if (json == null) {
|
|
38
42
|
return json;
|
|
39
43
|
}
|
|
40
44
|
return {
|
|
41
45
|
'used': json['used'],
|
|
46
|
+
'included': json['included'],
|
|
47
|
+
'billed': json['billed'],
|
|
42
48
|
'charges': json['charges'],
|
|
43
49
|
'limit': json['limit'],
|
|
44
50
|
};
|
|
45
51
|
}
|
|
46
|
-
function
|
|
47
|
-
return
|
|
52
|
+
function GetBillingUsage200ResponseZippyCreditsToJSON(json) {
|
|
53
|
+
return GetBillingUsage200ResponseZippyCreditsToJSONTyped(json, false);
|
|
48
54
|
}
|
|
49
|
-
function
|
|
55
|
+
function GetBillingUsage200ResponseZippyCreditsToJSONTyped(value, ignoreDiscriminator = false) {
|
|
50
56
|
if (value == null) {
|
|
51
57
|
return value;
|
|
52
58
|
}
|
|
53
59
|
return {
|
|
54
60
|
'used': value['used'],
|
|
61
|
+
'included': value['included'],
|
|
62
|
+
'billed': value['billed'],
|
|
55
63
|
'charges': value['charges'],
|
|
56
64
|
'limit': value['limit'],
|
|
57
65
|
};
|
|
@@ -22,17 +22,23 @@ export interface ListAddresses200ResponseDataInner {
|
|
|
22
22
|
*/
|
|
23
23
|
id: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
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
|
-
*
|
|
31
|
+
* Internal label for this address; never printed or sent to a carrier
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ListAddresses200ResponseDataInner
|
|
34
34
|
*/
|
|
35
|
-
|
|
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'],
|
|
@@ -102,6 +102,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
|
|
|
102
102
|
readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
|
|
103
103
|
readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
|
|
104
104
|
readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
|
|
105
|
+
readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
|
|
106
|
+
readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
|
|
107
|
+
readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
|
|
105
108
|
readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
|
|
106
109
|
readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
|
|
107
110
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
@@ -87,6 +87,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
|
|
|
87
87
|
BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
|
|
88
88
|
ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
|
|
89
89
|
ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
|
|
90
|
+
ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
|
|
91
|
+
ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
|
|
92
|
+
ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
|
|
90
93
|
ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
|
|
91
94
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
92
95
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
@@ -22,17 +22,23 @@ export interface ListShipments200ResponseDataInnerAddress {
|
|
|
22
22
|
*/
|
|
23
23
|
id: string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
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
|
-
*
|
|
31
|
+
* Internal label for this address; never printed or sent to a carrier
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ListShipments200ResponseDataInnerAddress
|
|
34
34
|
*/
|
|
35
|
-
|
|
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'],
|
|
@@ -109,6 +109,9 @@ export declare const SendShipment422ResponseCodeEnum: {
|
|
|
109
109
|
readonly BillingCheckoutRequired: "BILLING_CHECKOUT_REQUIRED";
|
|
110
110
|
readonly ZippyAddonRequired: "ZIPPY_ADDON_REQUIRED";
|
|
111
111
|
readonly ZippyMessageLimitReached: "ZIPPY_MESSAGE_LIMIT_REACHED";
|
|
112
|
+
readonly ZippyNotActivated: "ZIPPY_NOT_ACTIVATED";
|
|
113
|
+
readonly ZippyIncludedCreditsExhausted: "ZIPPY_INCLUDED_CREDITS_EXHAUSTED";
|
|
114
|
+
readonly ZippyDailyLimitReached: "ZIPPY_DAILY_LIMIT_REACHED";
|
|
112
115
|
readonly ShipmentNotFound: "SHIPMENT_NOT_FOUND";
|
|
113
116
|
readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
|
|
114
117
|
readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
|
|
@@ -88,6 +88,9 @@ exports.SendShipment422ResponseCodeEnum = {
|
|
|
88
88
|
BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
|
|
89
89
|
ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
|
|
90
90
|
ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
|
|
91
|
+
ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
|
|
92
|
+
ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
|
|
93
|
+
ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
|
|
91
94
|
ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
|
|
92
95
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
93
96
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|
|
@@ -16,17 +16,23 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface UpdateAddressRequest {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
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
|
-
*
|
|
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
|
-
|
|
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
|
-
'
|
|
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']
|
|
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']
|
|
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'],
|
package/dist/models/index.d.ts
CHANGED
|
@@ -71,7 +71,7 @@ export * from './GetBillingUsage200ResponseCurrentPeriod';
|
|
|
71
71
|
export * from './GetBillingUsage200ResponseLimits';
|
|
72
72
|
export * from './GetBillingUsage200ResponseLimitsTeamMembers';
|
|
73
73
|
export * from './GetBillingUsage200ResponseShipments';
|
|
74
|
-
export * from './
|
|
74
|
+
export * from './GetBillingUsage200ResponseZippyCredits';
|
|
75
75
|
export * from './GetOrder200Response';
|
|
76
76
|
export * from './GetOrder200ResponseOrderLinesInner';
|
|
77
77
|
export * from './GetOrder200ResponseShipmentsInner';
|
package/dist/models/index.js
CHANGED
|
@@ -89,7 +89,7 @@ __exportStar(require("./GetBillingUsage200ResponseCurrentPeriod"), exports);
|
|
|
89
89
|
__exportStar(require("./GetBillingUsage200ResponseLimits"), exports);
|
|
90
90
|
__exportStar(require("./GetBillingUsage200ResponseLimitsTeamMembers"), exports);
|
|
91
91
|
__exportStar(require("./GetBillingUsage200ResponseShipments"), exports);
|
|
92
|
-
__exportStar(require("./
|
|
92
|
+
__exportStar(require("./GetBillingUsage200ResponseZippyCredits"), exports);
|
|
93
93
|
__exportStar(require("./GetOrder200Response"), exports);
|
|
94
94
|
__exportStar(require("./GetOrder200ResponseOrderLinesInner"), exports);
|
|
95
95
|
__exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
|
package/docs/AddressesApi.md
CHANGED
|
@@ -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
|
|
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
|
|
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":
|
|
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"],
|
|
@@ -10,7 +10,7 @@ Name | Type
|
|
|
10
10
|
`shipments` | [GetBillingUsage200ResponseShipments](GetBillingUsage200ResponseShipments.md)
|
|
11
11
|
`limits` | [GetBillingUsage200ResponseLimits](GetBillingUsage200ResponseLimits.md)
|
|
12
12
|
`addOns` | [Array<GetBillingUsage200ResponseAddOnsInner>](GetBillingUsage200ResponseAddOnsInner.md)
|
|
13
|
-
`
|
|
13
|
+
`zippyCredits` | [GetBillingUsage200ResponseZippyCredits](GetBillingUsage200ResponseZippyCredits.md)
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -23,7 +23,7 @@ const example = {
|
|
|
23
23
|
"shipments": null,
|
|
24
24
|
"limits": null,
|
|
25
25
|
"addOns": [],
|
|
26
|
-
"
|
|
26
|
+
"zippyCredits": null,
|
|
27
27
|
} satisfies GetBillingUsage200Response
|
|
28
28
|
|
|
29
29
|
console.log(example)
|
|
@@ -1,27 +1,31 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# GetBillingUsage200ResponseZippyCredits
|
|
3
3
|
|
|
4
|
-
Zippy AI
|
|
4
|
+
Zippy AI credit usage this period (present when the Zippy add-on is enabled)
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`used` | number
|
|
11
|
+
`included` | number
|
|
12
|
+
`billed` | number
|
|
11
13
|
`charges` | number
|
|
12
14
|
`limit` | number
|
|
13
15
|
|
|
14
16
|
## Example
|
|
15
17
|
|
|
16
18
|
```typescript
|
|
17
|
-
import type {
|
|
19
|
+
import type { GetBillingUsage200ResponseZippyCredits } from '@zippendo/sdk'
|
|
18
20
|
|
|
19
21
|
// TODO: Update the object below with actual values
|
|
20
22
|
const example = {
|
|
21
|
-
"used":
|
|
22
|
-
"
|
|
23
|
+
"used": 2640,
|
|
24
|
+
"included": 2500,
|
|
25
|
+
"billed": 140,
|
|
26
|
+
"charges": 1000,
|
|
23
27
|
"limit": -1,
|
|
24
|
-
} satisfies
|
|
28
|
+
} satisfies GetBillingUsage200ResponseZippyCredits
|
|
25
29
|
|
|
26
30
|
console.log(example)
|
|
27
31
|
|
|
@@ -30,7 +34,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
30
34
|
console.log(exampleJSON)
|
|
31
35
|
|
|
32
36
|
// Parse the JSON string back to an object
|
|
33
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetBillingUsage200ResponseZippyCredits
|
|
34
38
|
console.log(exampleParsed)
|
|
35
39
|
```
|
|
36
40
|
|
|
@@ -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":
|
|
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":
|
|
36
|
+
"name": Zippendo ApS,
|
|
37
|
+
"description": Main warehouse, Copenhagen,
|
|
36
38
|
"attContact": Mette Hansen,
|
|
37
39
|
"address1": Vesterbrogade 1,
|
|
38
40
|
"address2": 2. sal,
|
package/docs/OrgsApi.md
CHANGED
|
@@ -372,6 +372,7 @@ example().catch(console.error);
|
|
|
372
372
|
| Status code | Description | Response headers |
|
|
373
373
|
|-------------|-------------|------------------|
|
|
374
374
|
| **200** | Default Response | - |
|
|
375
|
+
| **400** | Default Response | - |
|
|
375
376
|
| **404** | Default Response | - |
|
|
376
377
|
|
|
377
378
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
@@ -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":
|
|
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
|
@@ -138,6 +138,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
|
|
|
138
138
|
BillingCheckoutRequired: 'BILLING_CHECKOUT_REQUIRED',
|
|
139
139
|
ZippyAddonRequired: 'ZIPPY_ADDON_REQUIRED',
|
|
140
140
|
ZippyMessageLimitReached: 'ZIPPY_MESSAGE_LIMIT_REACHED',
|
|
141
|
+
ZippyNotActivated: 'ZIPPY_NOT_ACTIVATED',
|
|
142
|
+
ZippyIncludedCreditsExhausted: 'ZIPPY_INCLUDED_CREDITS_EXHAUSTED',
|
|
143
|
+
ZippyDailyLimitReached: 'ZIPPY_DAILY_LIMIT_REACHED',
|
|
141
144
|
ShipmentNotFound: 'SHIPMENT_NOT_FOUND',
|
|
142
145
|
ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
|
|
143
146
|
ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
|