@zippendo/sdk 1.2.4 → 1.2.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.
Files changed (122) 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 +1 -0
  10. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -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 +1 -0
  26. package/dist/esm/models/ListApiTokens401Response.js +1 -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 +1 -0
  40. package/dist/esm/models/SendShipment422Response.js +1 -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/index.d.ts +13 -0
  46. package/dist/esm/models/index.js +13 -0
  47. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -0
  48. package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -0
  49. package/dist/models/CreateOrderChannelRequest.d.ts +65 -0
  50. package/dist/models/CreateOrderChannelRequest.js +69 -0
  51. package/dist/models/CreateOrderChannelRequestSettings.d.ts +105 -0
  52. package/dist/models/CreateOrderChannelRequestSettings.js +73 -0
  53. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.d.ts +52 -0
  54. package/dist/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.js +64 -0
  55. package/dist/models/CreateOrderChannelWebhookSecret201Response.d.ts +44 -0
  56. package/dist/models/CreateOrderChannelWebhookSecret201Response.js +58 -0
  57. package/dist/models/CreateOrderRequest.d.ts +12 -0
  58. package/dist/models/CreateOrderRequest.js +4 -0
  59. package/dist/models/GetOrderChannelWebhookStatus200Response.d.ts +45 -0
  60. package/dist/models/GetOrderChannelWebhookStatus200Response.js +59 -0
  61. package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.d.ts +62 -0
  62. package/dist/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.js +66 -0
  63. package/dist/models/ListApiTokens401Response.d.ts +1 -0
  64. package/dist/models/ListApiTokens401Response.js +1 -0
  65. package/dist/models/ListOrderChannels200Response.d.ts +57 -0
  66. package/dist/models/ListOrderChannels200Response.js +67 -0
  67. package/dist/models/ListOrderChannels200ResponseDataInner.d.ts +121 -0
  68. package/dist/models/ListOrderChannels200ResponseDataInner.js +105 -0
  69. package/dist/models/ListOrderChannels200ResponseDataInnerSettings.d.ts +129 -0
  70. package/dist/models/ListOrderChannels200ResponseDataInnerSettings.js +93 -0
  71. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.d.ts +52 -0
  72. package/dist/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.js +64 -0
  73. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -0
  74. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +2 -1
  75. package/dist/models/RevokeOrderChannelWebhookSecret200Response.d.ts +32 -0
  76. package/dist/models/RevokeOrderChannelWebhookSecret200Response.js +50 -0
  77. package/dist/models/SendShipment422Response.d.ts +1 -0
  78. package/dist/models/SendShipment422Response.js +1 -0
  79. package/dist/models/UpdateOrderChannelRequest.d.ts +65 -0
  80. package/dist/models/UpdateOrderChannelRequest.js +59 -0
  81. package/dist/models/UpdateOrderChannelRequestSettings.d.ts +105 -0
  82. package/dist/models/UpdateOrderChannelRequestSettings.js +73 -0
  83. package/dist/models/index.d.ts +13 -0
  84. package/dist/models/index.js +13 -0
  85. package/docs/CreateOrderChannelRequest.md +42 -0
  86. package/docs/CreateOrderChannelRequestSettings.md +58 -0
  87. package/docs/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.md +38 -0
  88. package/docs/CreateOrderChannelWebhookSecret201Response.md +38 -0
  89. package/docs/CreateOrderRequest.md +4 -0
  90. package/docs/GetOrderChannelWebhookStatus200Response.md +38 -0
  91. package/docs/GetOrderChannelWebhookStatus200ResponseWebhooksInner.md +44 -0
  92. package/docs/ListOrderChannels200Response.md +42 -0
  93. package/docs/ListOrderChannels200ResponseDataInner.md +60 -0
  94. package/docs/ListOrderChannels200ResponseDataInnerSettings.md +67 -0
  95. package/docs/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.md +38 -0
  96. package/docs/OrderChannelsApi.md +650 -0
  97. package/docs/OrdersApi.md +1 -0
  98. package/docs/RevokeOrderChannelWebhookSecret200Response.md +34 -0
  99. package/docs/UpdateOrderChannelRequest.md +44 -0
  100. package/docs/UpdateOrderChannelRequestSettings.md +59 -0
  101. package/package.json +1 -1
  102. package/src/apis/OrderChannelsApi.ts +670 -0
  103. package/src/apis/index.ts +1 -0
  104. package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -0
  105. package/src/models/CreateOrderChannelRequest.ts +118 -0
  106. package/src/models/CreateOrderChannelRequestSettings.ts +169 -0
  107. package/src/models/CreateOrderChannelRequestSettingsShippingMethodMappingsInner.ts +94 -0
  108. package/src/models/CreateOrderChannelWebhookSecret201Response.ts +84 -0
  109. package/src/models/CreateOrderRequest.ts +16 -0
  110. package/src/models/GetOrderChannelWebhookStatus200Response.ts +92 -0
  111. package/src/models/GetOrderChannelWebhookStatus200ResponseWebhooksInner.ts +109 -0
  112. package/src/models/ListApiTokens401Response.ts +1 -0
  113. package/src/models/ListOrderChannels200Response.ts +110 -0
  114. package/src/models/ListOrderChannels200ResponseDataInner.ts +200 -0
  115. package/src/models/ListOrderChannels200ResponseDataInnerSettings.ts +207 -0
  116. package/src/models/ListOrderChannels200ResponseDataInnerSettingsShippingMethodMappingsInner.ts +94 -0
  117. package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +2 -1
  118. package/src/models/RevokeOrderChannelWebhookSecret200Response.ts +66 -0
  119. package/src/models/SendShipment422Response.ts +1 -0
  120. package/src/models/UpdateOrderChannelRequest.ts +113 -0
  121. package/src/models/UpdateOrderChannelRequestSettings.ts +169 -0
  122. package/src/models/index.ts +13 -0
@@ -0,0 +1,670 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Zippendo Public API
5
+ * 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`.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: support@zippendo.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type CreateOrderChannelRequest,
18
+ CreateOrderChannelRequestFromJSON,
19
+ CreateOrderChannelRequestToJSON,
20
+ } from '../models/CreateOrderChannelRequest';
21
+ import {
22
+ type CreateOrderChannelWebhookSecret201Response,
23
+ CreateOrderChannelWebhookSecret201ResponseFromJSON,
24
+ CreateOrderChannelWebhookSecret201ResponseToJSON,
25
+ } from '../models/CreateOrderChannelWebhookSecret201Response';
26
+ import {
27
+ type GetOrderChannelWebhookStatus200Response,
28
+ GetOrderChannelWebhookStatus200ResponseFromJSON,
29
+ GetOrderChannelWebhookStatus200ResponseToJSON,
30
+ } from '../models/GetOrderChannelWebhookStatus200Response';
31
+ import {
32
+ type ListApiTokens401Response,
33
+ ListApiTokens401ResponseFromJSON,
34
+ ListApiTokens401ResponseToJSON,
35
+ } from '../models/ListApiTokens401Response';
36
+ import {
37
+ type ListOrderChannels200Response,
38
+ ListOrderChannels200ResponseFromJSON,
39
+ ListOrderChannels200ResponseToJSON,
40
+ } from '../models/ListOrderChannels200Response';
41
+ import {
42
+ type ListOrderChannels200ResponseDataInner,
43
+ ListOrderChannels200ResponseDataInnerFromJSON,
44
+ ListOrderChannels200ResponseDataInnerToJSON,
45
+ } from '../models/ListOrderChannels200ResponseDataInner';
46
+ import {
47
+ type RevokeApiToken200Response,
48
+ RevokeApiToken200ResponseFromJSON,
49
+ RevokeApiToken200ResponseToJSON,
50
+ } from '../models/RevokeApiToken200Response';
51
+ import {
52
+ type RevokeOrderChannelWebhookSecret200Response,
53
+ RevokeOrderChannelWebhookSecret200ResponseFromJSON,
54
+ RevokeOrderChannelWebhookSecret200ResponseToJSON,
55
+ } from '../models/RevokeOrderChannelWebhookSecret200Response';
56
+ import {
57
+ type UpdateOrderChannelRequest,
58
+ UpdateOrderChannelRequestFromJSON,
59
+ UpdateOrderChannelRequestToJSON,
60
+ } from '../models/UpdateOrderChannelRequest';
61
+
62
+ export interface CreateOrderChannelOperationRequest {
63
+ orgId: string;
64
+ createOrderChannelRequest: CreateOrderChannelRequest;
65
+ }
66
+
67
+ export interface CreateOrderChannelWebhookSecretRequest {
68
+ orgId: string;
69
+ channelId: string;
70
+ }
71
+
72
+ export interface DeleteOrderChannelRequest {
73
+ orgId: string;
74
+ channelId: string;
75
+ }
76
+
77
+ export interface GetOrderChannelRequest {
78
+ orgId: string;
79
+ channelId: string;
80
+ }
81
+
82
+ export interface GetOrderChannelWebhookStatusRequest {
83
+ orgId: string;
84
+ channelId: string;
85
+ }
86
+
87
+ export interface ListOrderChannelsRequest {
88
+ orgId: string;
89
+ page?: number;
90
+ limit?: number;
91
+ brandId?: string;
92
+ brandScope?: ListOrderChannelsBrandScopeEnum;
93
+ type?: ListOrderChannelsTypeEnum;
94
+ enabled?: string;
95
+ search?: string;
96
+ }
97
+
98
+ export interface RevokeOrderChannelWebhookSecretRequest {
99
+ orgId: string;
100
+ channelId: string;
101
+ }
102
+
103
+ export interface UpdateOrderChannelOperationRequest {
104
+ orgId: string;
105
+ channelId: string;
106
+ updateOrderChannelRequest: UpdateOrderChannelRequest;
107
+ }
108
+
109
+ /**
110
+ *
111
+ */
112
+ export class OrderChannelsApi extends runtime.BaseAPI {
113
+
114
+ /**
115
+ * Creates request options for createOrderChannel without sending the request
116
+ */
117
+ async createOrderChannelRequestOpts(requestParameters: CreateOrderChannelOperationRequest): Promise<runtime.RequestOpts> {
118
+ if (requestParameters['orgId'] == null) {
119
+ throw new runtime.RequiredError(
120
+ 'orgId',
121
+ 'Required parameter "orgId" was null or undefined when calling createOrderChannel().'
122
+ );
123
+ }
124
+
125
+ if (requestParameters['createOrderChannelRequest'] == null) {
126
+ throw new runtime.RequiredError(
127
+ 'createOrderChannelRequest',
128
+ 'Required parameter "createOrderChannelRequest" was null or undefined when calling createOrderChannel().'
129
+ );
130
+ }
131
+
132
+ const queryParameters: any = {};
133
+
134
+ const headerParameters: runtime.HTTPHeaders = {};
135
+
136
+ headerParameters['Content-Type'] = 'application/json';
137
+
138
+ if (this.configuration && this.configuration.accessToken) {
139
+ const token = this.configuration.accessToken;
140
+ const tokenString = await token("bearerAuth", []);
141
+
142
+ if (tokenString) {
143
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
144
+ }
145
+ }
146
+
147
+ let urlPath = `/orgs/{orgId}/order-channels`;
148
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
149
+
150
+ return {
151
+ path: urlPath,
152
+ method: 'POST',
153
+ headers: headerParameters,
154
+ query: queryParameters,
155
+ body: CreateOrderChannelRequestToJSON(requestParameters['createOrderChannelRequest']),
156
+ };
157
+ }
158
+
159
+ /**
160
+ * Creates a new order channel for an organization.
161
+ * Create order channel
162
+ */
163
+ async createOrderChannelRaw(requestParameters: CreateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>> {
164
+ const requestOptions = await this.createOrderChannelRequestOpts(requestParameters);
165
+ const response = await this.request(requestOptions, initOverrides);
166
+
167
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
168
+ }
169
+
170
+ /**
171
+ * Creates a new order channel for an organization.
172
+ * Create order channel
173
+ */
174
+ async createOrderChannel(requestParameters: CreateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner> {
175
+ const response = await this.createOrderChannelRaw(requestParameters, initOverrides);
176
+ return await response.value();
177
+ }
178
+
179
+ /**
180
+ * Creates request options for createOrderChannelWebhookSecret without sending the request
181
+ */
182
+ async createOrderChannelWebhookSecretRequestOpts(requestParameters: CreateOrderChannelWebhookSecretRequest): Promise<runtime.RequestOpts> {
183
+ if (requestParameters['orgId'] == null) {
184
+ throw new runtime.RequiredError(
185
+ 'orgId',
186
+ 'Required parameter "orgId" was null or undefined when calling createOrderChannelWebhookSecret().'
187
+ );
188
+ }
189
+
190
+ if (requestParameters['channelId'] == null) {
191
+ throw new runtime.RequiredError(
192
+ 'channelId',
193
+ 'Required parameter "channelId" was null or undefined when calling createOrderChannelWebhookSecret().'
194
+ );
195
+ }
196
+
197
+ const queryParameters: any = {};
198
+
199
+ const headerParameters: runtime.HTTPHeaders = {};
200
+
201
+ if (this.configuration && this.configuration.accessToken) {
202
+ const token = this.configuration.accessToken;
203
+ const tokenString = await token("bearerAuth", []);
204
+
205
+ if (tokenString) {
206
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
207
+ }
208
+ }
209
+
210
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhook-secret`;
211
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
212
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
213
+
214
+ return {
215
+ path: urlPath,
216
+ method: 'POST',
217
+ headers: headerParameters,
218
+ query: queryParameters,
219
+ };
220
+ }
221
+
222
+ /**
223
+ * Generates (or rotates) the custom channel\'s webhook signing secret used to authenticate order pushes to the ingest URL. The secret is returned only once. Rotating invalidates the previous secret immediately.
224
+ * Create or rotate webhook signing secret
225
+ */
226
+ async createOrderChannelWebhookSecretRaw(requestParameters: CreateOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateOrderChannelWebhookSecret201Response>> {
227
+ const requestOptions = await this.createOrderChannelWebhookSecretRequestOpts(requestParameters);
228
+ const response = await this.request(requestOptions, initOverrides);
229
+
230
+ return new runtime.JSONApiResponse(response, (jsonValue) => CreateOrderChannelWebhookSecret201ResponseFromJSON(jsonValue));
231
+ }
232
+
233
+ /**
234
+ * Generates (or rotates) the custom channel\'s webhook signing secret used to authenticate order pushes to the ingest URL. The secret is returned only once. Rotating invalidates the previous secret immediately.
235
+ * Create or rotate webhook signing secret
236
+ */
237
+ async createOrderChannelWebhookSecret(requestParameters: CreateOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateOrderChannelWebhookSecret201Response> {
238
+ const response = await this.createOrderChannelWebhookSecretRaw(requestParameters, initOverrides);
239
+ return await response.value();
240
+ }
241
+
242
+ /**
243
+ * Creates request options for deleteOrderChannel without sending the request
244
+ */
245
+ async deleteOrderChannelRequestOpts(requestParameters: DeleteOrderChannelRequest): Promise<runtime.RequestOpts> {
246
+ if (requestParameters['orgId'] == null) {
247
+ throw new runtime.RequiredError(
248
+ 'orgId',
249
+ 'Required parameter "orgId" was null or undefined when calling deleteOrderChannel().'
250
+ );
251
+ }
252
+
253
+ if (requestParameters['channelId'] == null) {
254
+ throw new runtime.RequiredError(
255
+ 'channelId',
256
+ 'Required parameter "channelId" was null or undefined when calling deleteOrderChannel().'
257
+ );
258
+ }
259
+
260
+ const queryParameters: any = {};
261
+
262
+ const headerParameters: runtime.HTTPHeaders = {};
263
+
264
+ if (this.configuration && this.configuration.accessToken) {
265
+ const token = this.configuration.accessToken;
266
+ const tokenString = await token("bearerAuth", []);
267
+
268
+ if (tokenString) {
269
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
270
+ }
271
+ }
272
+
273
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
274
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
275
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
276
+
277
+ return {
278
+ path: urlPath,
279
+ method: 'DELETE',
280
+ headers: headerParameters,
281
+ query: queryParameters,
282
+ };
283
+ }
284
+
285
+ /**
286
+ * Deletes an order channel and cascades deletion of its orders.
287
+ * Delete order channel
288
+ */
289
+ async deleteOrderChannelRaw(requestParameters: DeleteOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RevokeApiToken200Response>> {
290
+ const requestOptions = await this.deleteOrderChannelRequestOpts(requestParameters);
291
+ const response = await this.request(requestOptions, initOverrides);
292
+
293
+ return new runtime.JSONApiResponse(response, (jsonValue) => RevokeApiToken200ResponseFromJSON(jsonValue));
294
+ }
295
+
296
+ /**
297
+ * Deletes an order channel and cascades deletion of its orders.
298
+ * Delete order channel
299
+ */
300
+ async deleteOrderChannel(requestParameters: DeleteOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeApiToken200Response> {
301
+ const response = await this.deleteOrderChannelRaw(requestParameters, initOverrides);
302
+ return await response.value();
303
+ }
304
+
305
+ /**
306
+ * Creates request options for getOrderChannel without sending the request
307
+ */
308
+ async getOrderChannelRequestOpts(requestParameters: GetOrderChannelRequest): Promise<runtime.RequestOpts> {
309
+ if (requestParameters['orgId'] == null) {
310
+ throw new runtime.RequiredError(
311
+ 'orgId',
312
+ 'Required parameter "orgId" was null or undefined when calling getOrderChannel().'
313
+ );
314
+ }
315
+
316
+ if (requestParameters['channelId'] == null) {
317
+ throw new runtime.RequiredError(
318
+ 'channelId',
319
+ 'Required parameter "channelId" was null or undefined when calling getOrderChannel().'
320
+ );
321
+ }
322
+
323
+ const queryParameters: any = {};
324
+
325
+ const headerParameters: runtime.HTTPHeaders = {};
326
+
327
+ if (this.configuration && this.configuration.accessToken) {
328
+ const token = this.configuration.accessToken;
329
+ const tokenString = await token("bearerAuth", []);
330
+
331
+ if (tokenString) {
332
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
333
+ }
334
+ }
335
+
336
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
337
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
338
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
339
+
340
+ return {
341
+ path: urlPath,
342
+ method: 'GET',
343
+ headers: headerParameters,
344
+ query: queryParameters,
345
+ };
346
+ }
347
+
348
+ /**
349
+ * Returns a single order channel by ID, including its linked shipping rules.
350
+ * Get order channel
351
+ */
352
+ async getOrderChannelRaw(requestParameters: GetOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>> {
353
+ const requestOptions = await this.getOrderChannelRequestOpts(requestParameters);
354
+ const response = await this.request(requestOptions, initOverrides);
355
+
356
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
357
+ }
358
+
359
+ /**
360
+ * Returns a single order channel by ID, including its linked shipping rules.
361
+ * Get order channel
362
+ */
363
+ async getOrderChannel(requestParameters: GetOrderChannelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner> {
364
+ const response = await this.getOrderChannelRaw(requestParameters, initOverrides);
365
+ return await response.value();
366
+ }
367
+
368
+ /**
369
+ * Creates request options for getOrderChannelWebhookStatus without sending the request
370
+ */
371
+ async getOrderChannelWebhookStatusRequestOpts(requestParameters: GetOrderChannelWebhookStatusRequest): Promise<runtime.RequestOpts> {
372
+ if (requestParameters['orgId'] == null) {
373
+ throw new runtime.RequiredError(
374
+ 'orgId',
375
+ 'Required parameter "orgId" was null or undefined when calling getOrderChannelWebhookStatus().'
376
+ );
377
+ }
378
+
379
+ if (requestParameters['channelId'] == null) {
380
+ throw new runtime.RequiredError(
381
+ 'channelId',
382
+ 'Required parameter "channelId" was null or undefined when calling getOrderChannelWebhookStatus().'
383
+ );
384
+ }
385
+
386
+ const queryParameters: any = {};
387
+
388
+ const headerParameters: runtime.HTTPHeaders = {};
389
+
390
+ if (this.configuration && this.configuration.accessToken) {
391
+ const token = this.configuration.accessToken;
392
+ const tokenString = await token("bearerAuth", []);
393
+
394
+ if (tokenString) {
395
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
396
+ }
397
+ }
398
+
399
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhooks`;
400
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
401
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
402
+
403
+ return {
404
+ path: urlPath,
405
+ method: 'GET',
406
+ headers: headerParameters,
407
+ query: queryParameters,
408
+ };
409
+ }
410
+
411
+ /**
412
+ * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
413
+ * Get channel webhook status
414
+ */
415
+ async getOrderChannelWebhookStatusRaw(requestParameters: GetOrderChannelWebhookStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrderChannelWebhookStatus200Response>> {
416
+ const requestOptions = await this.getOrderChannelWebhookStatusRequestOpts(requestParameters);
417
+ const response = await this.request(requestOptions, initOverrides);
418
+
419
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetOrderChannelWebhookStatus200ResponseFromJSON(jsonValue));
420
+ }
421
+
422
+ /**
423
+ * Returns whether webhooks are enabled and lists the webhooks registered with the platform.
424
+ * Get channel webhook status
425
+ */
426
+ async getOrderChannelWebhookStatus(requestParameters: GetOrderChannelWebhookStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrderChannelWebhookStatus200Response> {
427
+ const response = await this.getOrderChannelWebhookStatusRaw(requestParameters, initOverrides);
428
+ return await response.value();
429
+ }
430
+
431
+ /**
432
+ * Creates request options for listOrderChannels without sending the request
433
+ */
434
+ async listOrderChannelsRequestOpts(requestParameters: ListOrderChannelsRequest): Promise<runtime.RequestOpts> {
435
+ if (requestParameters['orgId'] == null) {
436
+ throw new runtime.RequiredError(
437
+ 'orgId',
438
+ 'Required parameter "orgId" was null or undefined when calling listOrderChannels().'
439
+ );
440
+ }
441
+
442
+ const queryParameters: any = {};
443
+
444
+ if (requestParameters['page'] != null) {
445
+ queryParameters['page'] = requestParameters['page'];
446
+ }
447
+
448
+ if (requestParameters['limit'] != null) {
449
+ queryParameters['limit'] = requestParameters['limit'];
450
+ }
451
+
452
+ if (requestParameters['brandId'] != null) {
453
+ queryParameters['brandId'] = requestParameters['brandId'];
454
+ }
455
+
456
+ if (requestParameters['brandScope'] != null) {
457
+ queryParameters['brandScope'] = requestParameters['brandScope'];
458
+ }
459
+
460
+ if (requestParameters['type'] != null) {
461
+ queryParameters['type'] = requestParameters['type'];
462
+ }
463
+
464
+ if (requestParameters['enabled'] != null) {
465
+ queryParameters['enabled'] = requestParameters['enabled'];
466
+ }
467
+
468
+ if (requestParameters['search'] != null) {
469
+ queryParameters['search'] = requestParameters['search'];
470
+ }
471
+
472
+ const headerParameters: runtime.HTTPHeaders = {};
473
+
474
+ if (this.configuration && this.configuration.accessToken) {
475
+ const token = this.configuration.accessToken;
476
+ const tokenString = await token("bearerAuth", []);
477
+
478
+ if (tokenString) {
479
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
480
+ }
481
+ }
482
+
483
+ let urlPath = `/orgs/{orgId}/order-channels`;
484
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
485
+
486
+ return {
487
+ path: urlPath,
488
+ method: 'GET',
489
+ headers: headerParameters,
490
+ query: queryParameters,
491
+ };
492
+ }
493
+
494
+ /**
495
+ * Returns a paginated list of order channels for an organization.
496
+ * List order channels
497
+ */
498
+ async listOrderChannelsRaw(requestParameters: ListOrderChannelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200Response>> {
499
+ const requestOptions = await this.listOrderChannelsRequestOpts(requestParameters);
500
+ const response = await this.request(requestOptions, initOverrides);
501
+
502
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseFromJSON(jsonValue));
503
+ }
504
+
505
+ /**
506
+ * Returns a paginated list of order channels for an organization.
507
+ * List order channels
508
+ */
509
+ async listOrderChannels(requestParameters: ListOrderChannelsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200Response> {
510
+ const response = await this.listOrderChannelsRaw(requestParameters, initOverrides);
511
+ return await response.value();
512
+ }
513
+
514
+ /**
515
+ * Creates request options for revokeOrderChannelWebhookSecret without sending the request
516
+ */
517
+ async revokeOrderChannelWebhookSecretRequestOpts(requestParameters: RevokeOrderChannelWebhookSecretRequest): Promise<runtime.RequestOpts> {
518
+ if (requestParameters['orgId'] == null) {
519
+ throw new runtime.RequiredError(
520
+ 'orgId',
521
+ 'Required parameter "orgId" was null or undefined when calling revokeOrderChannelWebhookSecret().'
522
+ );
523
+ }
524
+
525
+ if (requestParameters['channelId'] == null) {
526
+ throw new runtime.RequiredError(
527
+ 'channelId',
528
+ 'Required parameter "channelId" was null or undefined when calling revokeOrderChannelWebhookSecret().'
529
+ );
530
+ }
531
+
532
+ const queryParameters: any = {};
533
+
534
+ const headerParameters: runtime.HTTPHeaders = {};
535
+
536
+ if (this.configuration && this.configuration.accessToken) {
537
+ const token = this.configuration.accessToken;
538
+ const tokenString = await token("bearerAuth", []);
539
+
540
+ if (tokenString) {
541
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
542
+ }
543
+ }
544
+
545
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}/webhook-secret`;
546
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
547
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
548
+
549
+ return {
550
+ path: urlPath,
551
+ method: 'DELETE',
552
+ headers: headerParameters,
553
+ query: queryParameters,
554
+ };
555
+ }
556
+
557
+ /**
558
+ * Revokes the custom channel\'s webhook signing secret. All subsequent pushes to the ingest URL are rejected until a new secret is generated.
559
+ * Revoke webhook signing secret
560
+ */
561
+ async revokeOrderChannelWebhookSecretRaw(requestParameters: RevokeOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RevokeOrderChannelWebhookSecret200Response>> {
562
+ const requestOptions = await this.revokeOrderChannelWebhookSecretRequestOpts(requestParameters);
563
+ const response = await this.request(requestOptions, initOverrides);
564
+
565
+ return new runtime.JSONApiResponse(response, (jsonValue) => RevokeOrderChannelWebhookSecret200ResponseFromJSON(jsonValue));
566
+ }
567
+
568
+ /**
569
+ * Revokes the custom channel\'s webhook signing secret. All subsequent pushes to the ingest URL are rejected until a new secret is generated.
570
+ * Revoke webhook signing secret
571
+ */
572
+ async revokeOrderChannelWebhookSecret(requestParameters: RevokeOrderChannelWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeOrderChannelWebhookSecret200Response> {
573
+ const response = await this.revokeOrderChannelWebhookSecretRaw(requestParameters, initOverrides);
574
+ return await response.value();
575
+ }
576
+
577
+ /**
578
+ * Creates request options for updateOrderChannel without sending the request
579
+ */
580
+ async updateOrderChannelRequestOpts(requestParameters: UpdateOrderChannelOperationRequest): Promise<runtime.RequestOpts> {
581
+ if (requestParameters['orgId'] == null) {
582
+ throw new runtime.RequiredError(
583
+ 'orgId',
584
+ 'Required parameter "orgId" was null or undefined when calling updateOrderChannel().'
585
+ );
586
+ }
587
+
588
+ if (requestParameters['channelId'] == null) {
589
+ throw new runtime.RequiredError(
590
+ 'channelId',
591
+ 'Required parameter "channelId" was null or undefined when calling updateOrderChannel().'
592
+ );
593
+ }
594
+
595
+ if (requestParameters['updateOrderChannelRequest'] == null) {
596
+ throw new runtime.RequiredError(
597
+ 'updateOrderChannelRequest',
598
+ 'Required parameter "updateOrderChannelRequest" was null or undefined when calling updateOrderChannel().'
599
+ );
600
+ }
601
+
602
+ const queryParameters: any = {};
603
+
604
+ const headerParameters: runtime.HTTPHeaders = {};
605
+
606
+ headerParameters['Content-Type'] = 'application/json';
607
+
608
+ if (this.configuration && this.configuration.accessToken) {
609
+ const token = this.configuration.accessToken;
610
+ const tokenString = await token("bearerAuth", []);
611
+
612
+ if (tokenString) {
613
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
614
+ }
615
+ }
616
+
617
+ let urlPath = `/orgs/{orgId}/order-channels/{channelId}`;
618
+ urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
619
+ urlPath = urlPath.replace('{channelId}', encodeURIComponent(String(requestParameters['channelId'])));
620
+
621
+ return {
622
+ path: urlPath,
623
+ method: 'PATCH',
624
+ headers: headerParameters,
625
+ query: queryParameters,
626
+ body: UpdateOrderChannelRequestToJSON(requestParameters['updateOrderChannelRequest']),
627
+ };
628
+ }
629
+
630
+ /**
631
+ * Updates an order channel and its linked shipping rules.
632
+ * Update order channel
633
+ */
634
+ async updateOrderChannelRaw(requestParameters: UpdateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrderChannels200ResponseDataInner>> {
635
+ const requestOptions = await this.updateOrderChannelRequestOpts(requestParameters);
636
+ const response = await this.request(requestOptions, initOverrides);
637
+
638
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListOrderChannels200ResponseDataInnerFromJSON(jsonValue));
639
+ }
640
+
641
+ /**
642
+ * Updates an order channel and its linked shipping rules.
643
+ * Update order channel
644
+ */
645
+ async updateOrderChannel(requestParameters: UpdateOrderChannelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrderChannels200ResponseDataInner> {
646
+ const response = await this.updateOrderChannelRaw(requestParameters, initOverrides);
647
+ return await response.value();
648
+ }
649
+
650
+ }
651
+
652
+ /**
653
+ * @export
654
+ */
655
+ export const ListOrderChannelsBrandScopeEnum = {
656
+ Own: 'own',
657
+ Shared: 'shared',
658
+ Both: 'both'
659
+ } as const;
660
+ export type ListOrderChannelsBrandScopeEnum = typeof ListOrderChannelsBrandScopeEnum[keyof typeof ListOrderChannelsBrandScopeEnum];
661
+ /**
662
+ * @export
663
+ */
664
+ export const ListOrderChannelsTypeEnum = {
665
+ Shopify: 'shopify',
666
+ Woocommerce: 'woocommerce',
667
+ Manual: 'manual',
668
+ Custom: 'custom'
669
+ } as const;
670
+ export type ListOrderChannelsTypeEnum = typeof ListOrderChannelsTypeEnum[keyof typeof ListOrderChannelsTypeEnum];
package/src/apis/index.ts CHANGED
@@ -5,6 +5,7 @@ export * from './BillingApi';
5
5
  export * from './BrandsApi';
6
6
  export * from './CarrierCatalogApi';
7
7
  export * from './CarriersApi';
8
+ export * from './OrderChannelsApi';
8
9
  export * from './OrdersApi';
9
10
  export * from './OrgsApi';
10
11
  export * from './QuotesApi';
@@ -169,6 +169,7 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
169
169
  ShippingRuleInvalid: 'SHIPPING_RULE_INVALID',
170
170
  AddressNotFound: 'ADDRESS_NOT_FOUND',
171
171
  OrderNotFound: 'ORDER_NOT_FOUND',
172
+ OrderExists: 'ORDER_EXISTS',
172
173
  OrderChannelNotFound: 'ORDER_CHANNEL_NOT_FOUND',
173
174
  OrderChannelConfigInvalid: 'ORDER_CHANNEL_CONFIG_INVALID',
174
175
  IntegrationNotConfigured: 'INTEGRATION_NOT_CONFIGURED',