@zippendo/sdk 1.2.4 → 1.2.6

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 (128) hide show
  1. package/dist/apis/OrderChannelsApi.d.ts +195 -0
  2. package/dist/apis/OrderChannelsApi.js +496 -0
  3. package/dist/apis/index.d.ts +1 -0
  4. package/dist/apis/index.js +1 -0
  5. package/dist/esm/apis/OrderChannelsApi.d.ts +195 -0
  6. package/dist/esm/apis/OrderChannelsApi.js +492 -0
  7. package/dist/esm/apis/index.d.ts +1 -0
  8. package/dist/esm/apis/index.js +1 -0
  9. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -0
  10. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +4 -0
  11. package/dist/esm/models/CreateOrderChannelRequest.d.ts +65 -0
  12. package/dist/esm/models/CreateOrderChannelRequest.js +61 -0
  13. package/dist/esm/models/CreateOrderChannelRequestSettings.d.ts +105 -0
  14. package/dist/esm/models/CreateOrderChannelRequestSettings.js +66 -0
  15. package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +52 -0
  16. package/dist/esm/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.js +56 -0
  17. package/dist/esm/models/CreateOrderChannelWebhookSecret201Response.d.ts +44 -0
  18. package/dist/esm/models/CreateOrderChannelWebhookSecret201Response.js +51 -0
  19. package/dist/esm/models/CreateOrderRequest.d.ts +12 -0
  20. package/dist/esm/models/CreateOrderRequest.js +4 -0
  21. package/dist/esm/models/GetOrderChannelWebhookStatus200Response.d.ts +45 -0
  22. package/dist/esm/models/GetOrderChannelWebhookStatus200Response.js +52 -0
  23. package/dist/esm/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts +62 -0
  24. package/dist/esm/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js +59 -0
  25. package/dist/esm/models/ListApiTokens401Response.d.ts +4 -0
  26. package/dist/esm/models/ListApiTokens401Response.js +4 -0
  27. package/dist/esm/models/ListOrderChannels200Response.d.ts +57 -0
  28. package/dist/esm/models/ListOrderChannels200Response.js +60 -0
  29. package/dist/esm/models/ListOrderChannels200ResponseDataInner.d.ts +121 -0
  30. package/dist/esm/models/ListOrderChannels200ResponseDataInner.js +97 -0
  31. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettings.d.ts +129 -0
  32. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettings.js +86 -0
  33. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +52 -0
  34. package/dist/esm/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js +56 -0
  35. package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -0
  36. package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js +2 -1
  37. package/dist/esm/models/RevokeOrderChannelWebhookSecret200Response.d.ts +32 -0
  38. package/dist/esm/models/RevokeOrderChannelWebhookSecret200Response.js +43 -0
  39. package/dist/esm/models/SendShipment422Response.d.ts +4 -0
  40. package/dist/esm/models/SendShipment422Response.js +4 -0
  41. package/dist/esm/models/UpdateOrderChannelRequest.d.ts +65 -0
  42. package/dist/esm/models/UpdateOrderChannelRequest.js +52 -0
  43. package/dist/esm/models/UpdateOrderChannelRequestSettings.d.ts +105 -0
  44. package/dist/esm/models/UpdateOrderChannelRequestSettings.js +66 -0
  45. package/dist/esm/models/UpdateOrgRequest.d.ts +0 -6
  46. package/dist/esm/models/UpdateOrgRequest.js +0 -2
  47. package/dist/esm/models/index.d.ts +13 -0
  48. package/dist/esm/models/index.js +13 -0
  49. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +4 -0
  50. package/dist/models/BatchSendShipments200ResponseResultsInner.js +4 -0
  51. package/dist/models/CreateOrderChannelRequest.d.ts +65 -0
  52. package/dist/models/CreateOrderChannelRequest.js +69 -0
  53. package/dist/models/CreateOrderChannelRequestSettings.d.ts +105 -0
  54. package/dist/models/CreateOrderChannelRequestSettings.js +73 -0
  55. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +52 -0
  56. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.js +64 -0
  57. package/dist/models/CreateOrderChannelWebhookSecret201Response.d.ts +44 -0
  58. package/dist/models/CreateOrderChannelWebhookSecret201Response.js +58 -0
  59. package/dist/models/CreateOrderRequest.d.ts +12 -0
  60. package/dist/models/CreateOrderRequest.js +4 -0
  61. package/dist/models/GetOrderChannelWebhookStatus200Response.d.ts +45 -0
  62. package/dist/models/GetOrderChannelWebhookStatus200Response.js +59 -0
  63. package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts +62 -0
  64. package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js +66 -0
  65. package/dist/models/ListApiTokens401Response.d.ts +4 -0
  66. package/dist/models/ListApiTokens401Response.js +4 -0
  67. package/dist/models/ListOrderChannels200Response.d.ts +57 -0
  68. package/dist/models/ListOrderChannels200Response.js +67 -0
  69. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +121 -0
  70. package/dist/models/ListOrderChannels200ResponseDataInner.js +105 -0
  71. package/dist/models/ListOrderChannels200ResponseDataInnerSettings.d.ts +129 -0
  72. package/dist/models/ListOrderChannels200ResponseDataInnerSettings.js +93 -0
  73. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +52 -0
  74. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js +64 -0
  75. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -0
  76. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +2 -1
  77. package/dist/models/RevokeOrderChannelWebhookSecret200Response.d.ts +32 -0
  78. package/dist/models/RevokeOrderChannelWebhookSecret200Response.js +50 -0
  79. package/dist/models/SendShipment422Response.d.ts +4 -0
  80. package/dist/models/SendShipment422Response.js +4 -0
  81. package/dist/models/UpdateOrderChannelRequest.d.ts +65 -0
  82. package/dist/models/UpdateOrderChannelRequest.js +59 -0
  83. package/dist/models/UpdateOrderChannelRequestSettings.d.ts +105 -0
  84. package/dist/models/UpdateOrderChannelRequestSettings.js +73 -0
  85. package/dist/models/UpdateOrgRequest.d.ts +0 -6
  86. package/dist/models/UpdateOrgRequest.js +0 -2
  87. package/dist/models/index.d.ts +13 -0
  88. package/dist/models/index.js +13 -0
  89. package/docs/CreateOrderChannelRequest.md +42 -0
  90. package/docs/CreateOrderChannelRequestSettings.md +58 -0
  91. package/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md +38 -0
  92. package/docs/CreateOrderChannelWebhookSecret201Response.md +38 -0
  93. package/docs/CreateOrderRequest.md +4 -0
  94. package/docs/GetOrderChannelWebhookStatus200Response.md +38 -0
  95. package/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md +44 -0
  96. package/docs/ListOrderChannels200Response.md +42 -0
  97. package/docs/ListOrderChannels200ResponseDataInner.md +60 -0
  98. package/docs/ListOrderChannels200ResponseDataInnerSettings.md +67 -0
  99. package/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md +38 -0
  100. package/docs/OrderChannelsApi.md +650 -0
  101. package/docs/OrdersApi.md +1 -0
  102. package/docs/RevokeOrderChannelWebhookSecret200Response.md +34 -0
  103. package/docs/UpdateOrderChannelRequest.md +44 -0
  104. package/docs/UpdateOrderChannelRequestSettings.md +59 -0
  105. package/docs/UpdateOrgRequest.md +0 -2
  106. package/package.json +1 -1
  107. package/src/apis/OrderChannelsApi.ts +670 -0
  108. package/src/apis/index.ts +1 -0
  109. package/src/models/BatchSendShipments200ResponseResultsInner.ts +4 -0
  110. package/src/models/CreateOrderChannelRequest.ts +118 -0
  111. package/src/models/CreateOrderChannelRequestSettings.ts +169 -0
  112. package/src/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.ts +94 -0
  113. package/src/models/CreateOrderChannelWebhookSecret201Response.ts +84 -0
  114. package/src/models/CreateOrderRequest.ts +16 -0
  115. package/src/models/GetOrderChannelWebhookStatus200Response.ts +92 -0
  116. package/src/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.ts +109 -0
  117. package/src/models/ListApiTokens401Response.ts +4 -0
  118. package/src/models/ListOrderChannels200Response.ts +110 -0
  119. package/src/models/ListOrderChannels200ResponseDataInner.ts +200 -0
  120. package/src/models/ListOrderChannels200ResponseDataInnerSettings.ts +207 -0
  121. package/src/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.ts +94 -0
  122. package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +2 -1
  123. package/src/models/RevokeOrderChannelWebhookSecret200Response.ts +66 -0
  124. package/src/models/SendShipment422Response.ts +4 -0
  125. package/src/models/UpdateOrderChannelRequest.ts +113 -0
  126. package/src/models/UpdateOrderChannelRequestSettings.ts +169 -0
  127. package/src/models/UpdateOrgRequest.ts +0 -8
  128. package/src/models/index.ts +13 -0
@@ -0,0 +1,64 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum = void 0;
17
+ exports.instanceOfCreateOrderChannelRequestSettingsShippingMethodMappingsInner = instanceOfCreateOrderChannelRequestSettingsShippingMethodMappingsInner;
18
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON = CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON;
19
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped = CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped;
20
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON = CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON;
21
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped = CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.CreateOrderChannelRequestSettingsShippingMethodMappingsInnerServicePointSelectionEnum = {
26
+ Nearest: 'nearest',
27
+ Manual: 'manual'
28
+ };
29
+ /**
30
+ * Check if a given object implements the CreateOrderChannelRequestSettingsShippingMethodMappingsInner interface.
31
+ */
32
+ function instanceOfCreateOrderChannelRequestSettingsShippingMethodMappingsInner(value) {
33
+ if (!('match' in value) || value['match'] === undefined)
34
+ return false;
35
+ if (!('shippingRuleId' in value) || value['shippingRuleId'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSON(json) {
40
+ return CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped(json, false);
41
+ }
42
+ function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'match': json['match'],
48
+ 'shippingRuleId': json['shippingRuleId'],
49
+ 'servicePointSelection': json['servicePointSelection'] == null ? undefined : json['servicePointSelection'],
50
+ };
51
+ }
52
+ function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSON(json) {
53
+ return CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped(json, false);
54
+ }
55
+ function CreateOrderChannelRequestSettingsShippingMethodMappingsInnerToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ 'match': value['match'],
61
+ 'shippingRuleId': value['shippingRuleId'],
62
+ 'servicePointSelection': value['servicePointSelection'],
63
+ };
64
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * Zippendo Public API
3
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@zippendo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreateOrderChannelWebhookSecret201Response
16
+ */
17
+ export interface CreateOrderChannelWebhookSecret201Response {
18
+ /**
19
+ * The webhook signing secret. Returned only once — store it in your system; every push to the ingest URL must carry an HMAC-SHA256 hex signature of the raw body computed with it.
20
+ * @type {string}
21
+ * @memberof CreateOrderChannelWebhookSecret201Response
22
+ */
23
+ secret: string;
24
+ /**
25
+ * The ingest URL your system pushes signed order events to.
26
+ * @type {string}
27
+ * @memberof CreateOrderChannelWebhookSecret201Response
28
+ */
29
+ webhookUrl: string;
30
+ /**
31
+ * When this secret was issued (ISO 8601).
32
+ * @type {Date}
33
+ * @memberof CreateOrderChannelWebhookSecret201Response
34
+ */
35
+ createdAt: Date;
36
+ }
37
+ /**
38
+ * Check if a given object implements the CreateOrderChannelWebhookSecret201Response interface.
39
+ */
40
+ export declare function instanceOfCreateOrderChannelWebhookSecret201Response(value: object): value is CreateOrderChannelWebhookSecret201Response;
41
+ export declare function CreateOrderChannelWebhookSecret201ResponseFromJSON(json: any): CreateOrderChannelWebhookSecret201Response;
42
+ export declare function CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderChannelWebhookSecret201Response;
43
+ export declare function CreateOrderChannelWebhookSecret201ResponseToJSON(json: any): CreateOrderChannelWebhookSecret201Response;
44
+ export declare function CreateOrderChannelWebhookSecret201ResponseToJSONTyped(value?: CreateOrderChannelWebhookSecret201Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,58 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfCreateOrderChannelWebhookSecret201Response = instanceOfCreateOrderChannelWebhookSecret201Response;
17
+ exports.CreateOrderChannelWebhookSecret201ResponseFromJSON = CreateOrderChannelWebhookSecret201ResponseFromJSON;
18
+ exports.CreateOrderChannelWebhookSecret201ResponseFromJSONTyped = CreateOrderChannelWebhookSecret201ResponseFromJSONTyped;
19
+ exports.CreateOrderChannelWebhookSecret201ResponseToJSON = CreateOrderChannelWebhookSecret201ResponseToJSON;
20
+ exports.CreateOrderChannelWebhookSecret201ResponseToJSONTyped = CreateOrderChannelWebhookSecret201ResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the CreateOrderChannelWebhookSecret201Response interface.
23
+ */
24
+ function instanceOfCreateOrderChannelWebhookSecret201Response(value) {
25
+ if (!('secret' in value) || value['secret'] === undefined)
26
+ return false;
27
+ if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
28
+ return false;
29
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
30
+ return false;
31
+ return true;
32
+ }
33
+ function CreateOrderChannelWebhookSecret201ResponseFromJSON(json) {
34
+ return CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json, false);
35
+ }
36
+ function CreateOrderChannelWebhookSecret201ResponseFromJSONTyped(json, ignoreDiscriminator) {
37
+ if (json == null) {
38
+ return json;
39
+ }
40
+ return {
41
+ 'secret': json['secret'],
42
+ 'webhookUrl': json['webhookUrl'],
43
+ 'createdAt': (new Date(json['createdAt'])),
44
+ };
45
+ }
46
+ function CreateOrderChannelWebhookSecret201ResponseToJSON(json) {
47
+ return CreateOrderChannelWebhookSecret201ResponseToJSONTyped(json, false);
48
+ }
49
+ function CreateOrderChannelWebhookSecret201ResponseToJSONTyped(value, ignoreDiscriminator = false) {
50
+ if (value == null) {
51
+ return value;
52
+ }
53
+ return {
54
+ 'secret': value['secret'],
55
+ 'webhookUrl': value['webhookUrl'],
56
+ 'createdAt': value['createdAt'].toISOString(),
57
+ };
58
+ }
@@ -83,6 +83,18 @@ export interface CreateOrderRequest {
83
83
  * @memberof CreateOrderRequest
84
84
  */
85
85
  notes?: string | null;
86
+ /**
87
+ * Shipping rule to ship this order with. When set, a shipment is created immediately (and dispatched if the channel has autoShipOnCreate enabled).
88
+ * @type {string}
89
+ * @memberof CreateOrderRequest
90
+ */
91
+ shippingRuleId?: string | null;
92
+ /**
93
+ * Shipping-method title from the source checkout; matched against the order channel's shipping-method mappings to pick a shipping rule.
94
+ * @type {string}
95
+ * @memberof CreateOrderRequest
96
+ */
97
+ shippingMethodTitle?: string | null;
86
98
  /**
87
99
  * Raw platform-specific payload for reference.
88
100
  * @type {{ [key: string]: any; }}
@@ -51,6 +51,8 @@ function CreateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
51
51
  'totalAmount': json['totalAmount'] === undefined ? undefined : json['totalAmount'] === null ? null : json['totalAmount'],
52
52
  'currency': json['currency'] === undefined ? undefined : json['currency'] === null ? null : json['currency'],
53
53
  'notes': json['notes'] === undefined ? undefined : json['notes'] === null ? null : json['notes'],
54
+ 'shippingRuleId': json['shippingRuleId'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
55
+ 'shippingMethodTitle': json['shippingMethodTitle'] === undefined ? undefined : json['shippingMethodTitle'] === null ? null : json['shippingMethodTitle'],
54
56
  'externalData': json['externalData'] === undefined ? undefined : json['externalData'] === null ? null : json['externalData'],
55
57
  };
56
58
  }
@@ -73,6 +75,8 @@ function CreateOrderRequestToJSONTyped(value, ignoreDiscriminator = false) {
73
75
  'totalAmount': value['totalAmount'],
74
76
  'currency': value['currency'],
75
77
  'notes': value['notes'],
78
+ 'shippingRuleId': value['shippingRuleId'],
79
+ 'shippingMethodTitle': value['shippingMethodTitle'],
76
80
  'externalData': value['externalData'],
77
81
  };
78
82
  }
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Zippendo Public API
3
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@zippendo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { GetOrderChannelWebhookStatus200ResponseWebhooksInner } from './GetOrderChannelWebhookStatus200ResponseWebhooksInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetOrderChannelWebhookStatus200Response
17
+ */
18
+ export interface GetOrderChannelWebhookStatus200Response {
19
+ /**
20
+ * Whether webhooks are enabled for the channel.
21
+ * @type {boolean}
22
+ * @memberof GetOrderChannelWebhookStatus200Response
23
+ */
24
+ enabled: boolean;
25
+ /**
26
+ * Expected callback URL for this channel.
27
+ * @type {string}
28
+ * @memberof GetOrderChannelWebhookStatus200Response
29
+ */
30
+ webhookUrl: string;
31
+ /**
32
+ * Webhooks registered for this channel's callback URL.
33
+ * @type {Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>}
34
+ * @memberof GetOrderChannelWebhookStatus200Response
35
+ */
36
+ webhooks: Array<GetOrderChannelWebhookStatus200ResponseWebhooksInner>;
37
+ }
38
+ /**
39
+ * Check if a given object implements the GetOrderChannelWebhookStatus200Response interface.
40
+ */
41
+ export declare function instanceOfGetOrderChannelWebhookStatus200Response(value: object): value is GetOrderChannelWebhookStatus200Response;
42
+ export declare function GetOrderChannelWebhookStatus200ResponseFromJSON(json: any): GetOrderChannelWebhookStatus200Response;
43
+ export declare function GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrderChannelWebhookStatus200Response;
44
+ export declare function GetOrderChannelWebhookStatus200ResponseToJSON(json: any): GetOrderChannelWebhookStatus200Response;
45
+ export declare function GetOrderChannelWebhookStatus200ResponseToJSONTyped(value?: GetOrderChannelWebhookStatus200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfGetOrderChannelWebhookStatus200Response = instanceOfGetOrderChannelWebhookStatus200Response;
17
+ exports.GetOrderChannelWebhookStatus200ResponseFromJSON = GetOrderChannelWebhookStatus200ResponseFromJSON;
18
+ exports.GetOrderChannelWebhookStatus200ResponseFromJSONTyped = GetOrderChannelWebhookStatus200ResponseFromJSONTyped;
19
+ exports.GetOrderChannelWebhookStatus200ResponseToJSON = GetOrderChannelWebhookStatus200ResponseToJSON;
20
+ exports.GetOrderChannelWebhookStatus200ResponseToJSONTyped = GetOrderChannelWebhookStatus200ResponseToJSONTyped;
21
+ const GetOrderChannelWebhookStatus200ResponseWebhooksInner_1 = require("./GetOrderChannelWebhookStatus200ResponseWebhooksInner");
22
+ /**
23
+ * Check if a given object implements the GetOrderChannelWebhookStatus200Response interface.
24
+ */
25
+ function instanceOfGetOrderChannelWebhookStatus200Response(value) {
26
+ if (!('enabled' in value) || value['enabled'] === undefined)
27
+ return false;
28
+ if (!('webhookUrl' in value) || value['webhookUrl'] === undefined)
29
+ return false;
30
+ if (!('webhooks' in value) || value['webhooks'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ function GetOrderChannelWebhookStatus200ResponseFromJSON(json) {
35
+ return GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, false);
36
+ }
37
+ function GetOrderChannelWebhookStatus200ResponseFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'enabled': json['enabled'],
43
+ 'webhookUrl': json['webhookUrl'],
44
+ 'webhooks': (json['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInner_1.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON)),
45
+ };
46
+ }
47
+ function GetOrderChannelWebhookStatus200ResponseToJSON(json) {
48
+ return GetOrderChannelWebhookStatus200ResponseToJSONTyped(json, false);
49
+ }
50
+ function GetOrderChannelWebhookStatus200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
51
+ if (value == null) {
52
+ return value;
53
+ }
54
+ return {
55
+ 'enabled': value['enabled'],
56
+ 'webhookUrl': value['webhookUrl'],
57
+ 'webhooks': (value['webhooks'].map(GetOrderChannelWebhookStatus200ResponseWebhooksInner_1.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON)),
58
+ };
59
+ }
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Zippendo Public API
3
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@zippendo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface GetOrderChannelWebhookStatus200ResponseWebhooksInner
16
+ */
17
+ export interface GetOrderChannelWebhookStatus200ResponseWebhooksInner {
18
+ /**
19
+ * Platform webhook ID.
20
+ * @type {number}
21
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
22
+ */
23
+ id: number;
24
+ /**
25
+ * Webhook event topic.
26
+ * @type {string}
27
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
28
+ */
29
+ topic: string;
30
+ /**
31
+ * Registered callback address.
32
+ * @type {string}
33
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
34
+ */
35
+ address: string;
36
+ /**
37
+ * Webhook creation timestamp.
38
+ * @type {string}
39
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
40
+ */
41
+ createdAt: string;
42
+ /**
43
+ * WooCommerce delivery URL (same as `address`; present for WooCommerce channels).
44
+ * @type {string}
45
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
46
+ */
47
+ deliveryUrl?: string;
48
+ /**
49
+ * WooCommerce webhook status. A value other than `active` means WooCommerce disabled the webhook (e.g. after repeated delivery failures).
50
+ * @type {string}
51
+ * @memberof GetOrderChannelWebhookStatus200ResponseWebhooksInner
52
+ */
53
+ status?: string;
54
+ }
55
+ /**
56
+ * Check if a given object implements the GetOrderChannelWebhookStatus200ResponseWebhooksInner interface.
57
+ */
58
+ export declare function instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner(value: object): value is GetOrderChannelWebhookStatus200ResponseWebhooksInner;
59
+ export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON(json: any): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
60
+ export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
61
+ export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON(json: any): GetOrderChannelWebhookStatus200ResponseWebhooksInner;
62
+ export declare function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(value?: GetOrderChannelWebhookStatus200ResponseWebhooksInner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner = instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner;
17
+ exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON = GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON;
18
+ exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped = GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped;
19
+ exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON = GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON;
20
+ exports.GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped = GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the GetOrderChannelWebhookStatus200ResponseWebhooksInner interface.
23
+ */
24
+ function instanceOfGetOrderChannelWebhookStatus200ResponseWebhooksInner(value) {
25
+ if (!('id' in value) || value['id'] === undefined)
26
+ return false;
27
+ if (!('topic' in value) || value['topic'] === undefined)
28
+ return false;
29
+ if (!('address' in value) || value['address'] === undefined)
30
+ return false;
31
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
32
+ return false;
33
+ return true;
34
+ }
35
+ function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSON(json) {
36
+ return GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json, false);
37
+ }
38
+ function GetOrderChannelWebhookStatus200ResponseWebhooksInnerFromJSONTyped(json, ignoreDiscriminator) {
39
+ if (json == null) {
40
+ return json;
41
+ }
42
+ return {
43
+ 'id': json['id'],
44
+ 'topic': json['topic'],
45
+ 'address': json['address'],
46
+ 'createdAt': json['createdAt'],
47
+ 'deliveryUrl': json['deliveryUrl'] == null ? undefined : json['deliveryUrl'],
48
+ 'status': json['status'] == null ? undefined : json['status'],
49
+ };
50
+ }
51
+ function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSON(json) {
52
+ return GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(json, false);
53
+ }
54
+ function GetOrderChannelWebhookStatus200ResponseWebhooksInnerToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'id': value['id'],
60
+ 'topic': value['topic'],
61
+ 'address': value['address'],
62
+ 'createdAt': value['createdAt'],
63
+ 'deliveryUrl': value['deliveryUrl'],
64
+ 'status': value['status'],
65
+ };
66
+ }
@@ -61,6 +61,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
61
61
  readonly AuthMfaRequired: "AUTH_MFA_REQUIRED";
62
62
  readonly AuthMfaInvalidCode: "AUTH_MFA_INVALID_CODE";
63
63
  readonly AuthMfaAlreadyEnabled: "AUTH_MFA_ALREADY_ENABLED";
64
+ readonly CaptchaFailed: "CAPTCHA_FAILED";
65
+ readonly EmailDomainBlocked: "EMAIL_DOMAIN_BLOCKED";
66
+ readonly VatInvalid: "VAT_INVALID";
64
67
  readonly AuthMfaNotEnabled: "AUTH_MFA_NOT_ENABLED";
65
68
  readonly SessionRequired: "SESSION_REQUIRED";
66
69
  readonly OrgNotFound: "ORG_NOT_FOUND";
@@ -133,6 +136,7 @@ export declare const ListApiTokens401ResponseCodeEnum: {
133
136
  readonly ShippingRuleInvalid: "SHIPPING_RULE_INVALID";
134
137
  readonly AddressNotFound: "ADDRESS_NOT_FOUND";
135
138
  readonly OrderNotFound: "ORDER_NOT_FOUND";
139
+ readonly OrderExists: "ORDER_EXISTS";
136
140
  readonly OrderChannelNotFound: "ORDER_CHANNEL_NOT_FOUND";
137
141
  readonly OrderChannelConfigInvalid: "ORDER_CHANNEL_CONFIG_INVALID";
138
142
  readonly IntegrationNotConfigured: "INTEGRATION_NOT_CONFIGURED";
@@ -46,6 +46,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
46
46
  AuthMfaRequired: 'AUTH_MFA_REQUIRED',
47
47
  AuthMfaInvalidCode: 'AUTH_MFA_INVALID_CODE',
48
48
  AuthMfaAlreadyEnabled: 'AUTH_MFA_ALREADY_ENABLED',
49
+ CaptchaFailed: 'CAPTCHA_FAILED',
50
+ EmailDomainBlocked: 'EMAIL_DOMAIN_BLOCKED',
51
+ VatInvalid: 'VAT_INVALID',
49
52
  AuthMfaNotEnabled: 'AUTH_MFA_NOT_ENABLED',
50
53
  SessionRequired: 'SESSION_REQUIRED',
51
54
  OrgNotFound: 'ORG_NOT_FOUND',
@@ -118,6 +121,7 @@ exports.ListApiTokens401ResponseCodeEnum = {
118
121
  ShippingRuleInvalid: 'SHIPPING_RULE_INVALID',
119
122
  AddressNotFound: 'ADDRESS_NOT_FOUND',
120
123
  OrderNotFound: 'ORDER_NOT_FOUND',
124
+ OrderExists: 'ORDER_EXISTS',
121
125
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
122
126
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
123
127
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',
@@ -0,0 +1,57 @@
1
+ /**
2
+ * Zippendo Public API
3
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@zippendo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ListOrderChannels200ResponseDataInner } from './ListOrderChannels200ResponseDataInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListOrderChannels200Response
17
+ */
18
+ export interface ListOrderChannels200Response {
19
+ /**
20
+ * Page of results
21
+ * @type {Array<ListOrderChannels200ResponseDataInner>}
22
+ * @memberof ListOrderChannels200Response
23
+ */
24
+ data: Array<ListOrderChannels200ResponseDataInner>;
25
+ /**
26
+ * Total matching items across all pages
27
+ * @type {number}
28
+ * @memberof ListOrderChannels200Response
29
+ */
30
+ total: number;
31
+ /**
32
+ * Current page number (1-based)
33
+ * @type {number}
34
+ * @memberof ListOrderChannels200Response
35
+ */
36
+ page: number;
37
+ /**
38
+ * Items per page
39
+ * @type {number}
40
+ * @memberof ListOrderChannels200Response
41
+ */
42
+ limit: number;
43
+ /**
44
+ * Total number of pages
45
+ * @type {number}
46
+ * @memberof ListOrderChannels200Response
47
+ */
48
+ totalPages: number;
49
+ }
50
+ /**
51
+ * Check if a given object implements the ListOrderChannels200Response interface.
52
+ */
53
+ export declare function instanceOfListOrderChannels200Response(value: object): value is ListOrderChannels200Response;
54
+ export declare function ListOrderChannels200ResponseFromJSON(json: any): ListOrderChannels200Response;
55
+ export declare function ListOrderChannels200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOrderChannels200Response;
56
+ export declare function ListOrderChannels200ResponseToJSON(json: any): ListOrderChannels200Response;
57
+ export declare function ListOrderChannels200ResponseToJSONTyped(value?: ListOrderChannels200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,67 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_). **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body: 1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined to that brand — reads filtered, writes stamped. This is the recommended way to give a single brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the client so every call inherits it. A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token. Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide. List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored. Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfListOrderChannels200Response = instanceOfListOrderChannels200Response;
17
+ exports.ListOrderChannels200ResponseFromJSON = ListOrderChannels200ResponseFromJSON;
18
+ exports.ListOrderChannels200ResponseFromJSONTyped = ListOrderChannels200ResponseFromJSONTyped;
19
+ exports.ListOrderChannels200ResponseToJSON = ListOrderChannels200ResponseToJSON;
20
+ exports.ListOrderChannels200ResponseToJSONTyped = ListOrderChannels200ResponseToJSONTyped;
21
+ const ListOrderChannels200ResponseDataInner_1 = require("./ListOrderChannels200ResponseDataInner");
22
+ /**
23
+ * Check if a given object implements the ListOrderChannels200Response interface.
24
+ */
25
+ function instanceOfListOrderChannels200Response(value) {
26
+ if (!('data' in value) || value['data'] === undefined)
27
+ return false;
28
+ if (!('total' in value) || value['total'] === undefined)
29
+ return false;
30
+ if (!('page' in value) || value['page'] === undefined)
31
+ return false;
32
+ if (!('limit' in value) || value['limit'] === undefined)
33
+ return false;
34
+ if (!('totalPages' in value) || value['totalPages'] === undefined)
35
+ return false;
36
+ return true;
37
+ }
38
+ function ListOrderChannels200ResponseFromJSON(json) {
39
+ return ListOrderChannels200ResponseFromJSONTyped(json, false);
40
+ }
41
+ function ListOrderChannels200ResponseFromJSONTyped(json, ignoreDiscriminator) {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'data': (json['data'].map(ListOrderChannels200ResponseDataInner_1.ListOrderChannels200ResponseDataInnerFromJSON)),
47
+ 'total': json['total'],
48
+ 'page': json['page'],
49
+ 'limit': json['limit'],
50
+ 'totalPages': json['totalPages'],
51
+ };
52
+ }
53
+ function ListOrderChannels200ResponseToJSON(json) {
54
+ return ListOrderChannels200ResponseToJSONTyped(json, false);
55
+ }
56
+ function ListOrderChannels200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'data': (value['data'].map(ListOrderChannels200ResponseDataInner_1.ListOrderChannels200ResponseDataInnerToJSON)),
62
+ 'total': value['total'],
63
+ 'page': value['page'],
64
+ 'limit': value['limit'],
65
+ 'totalPages': value['totalPages'],
66
+ };
67
+ }