@zippendo/sdk 1.3.1 → 1.3.2

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.
@@ -37,6 +37,7 @@ export interface ListOrdersRequest {
37
37
  status?: ListOrdersStatusEnum;
38
38
  orderChannelId?: string;
39
39
  search?: string;
40
+ filter?: string;
40
41
  }
41
42
  export interface UpdateOrderOperationRequest {
42
43
  orgId: string;
@@ -94,12 +95,12 @@ export declare class OrdersApi extends runtime.BaseAPI {
94
95
  */
95
96
  listOrdersRequestOpts(requestParameters: ListOrdersRequest): Promise<runtime.RequestOpts>;
96
97
  /**
97
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
98
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
98
99
  * List orders
99
100
  */
100
101
  listOrdersRaw(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrders200Response>>;
101
102
  /**
102
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
103
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
103
104
  * List orders
104
105
  */
105
106
  listOrders(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrders200Response>;
@@ -221,6 +221,9 @@ class OrdersApi extends runtime.BaseAPI {
221
221
  if (requestParameters['search'] != null) {
222
222
  queryParameters['search'] = requestParameters['search'];
223
223
  }
224
+ if (requestParameters['filter'] != null) {
225
+ queryParameters['filter'] = requestParameters['filter'];
226
+ }
224
227
  const headerParameters = {};
225
228
  if (this.configuration && this.configuration.accessToken) {
226
229
  const token = this.configuration.accessToken;
@@ -240,7 +243,7 @@ class OrdersApi extends runtime.BaseAPI {
240
243
  });
241
244
  }
242
245
  /**
243
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
246
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
244
247
  * List orders
245
248
  */
246
249
  listOrdersRaw(requestParameters, initOverrides) {
@@ -251,7 +254,7 @@ class OrdersApi extends runtime.BaseAPI {
251
254
  });
252
255
  }
253
256
  /**
254
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
257
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
255
258
  * List orders
256
259
  */
257
260
  listOrders(requestParameters, initOverrides) {
@@ -65,6 +65,7 @@ export interface ListShipmentsRequest {
65
65
  status?: ListShipmentsStatusEnum;
66
66
  type?: ListShipmentsTypeEnum;
67
67
  search?: string;
68
+ filter?: string;
68
69
  }
69
70
  export interface SendShipmentRequest {
70
71
  orgId: string;
@@ -196,12 +197,12 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
196
197
  */
197
198
  listShipmentsRequestOpts(requestParameters: ListShipmentsRequest): Promise<runtime.RequestOpts>;
198
199
  /**
199
- * List all shipments for an organization, paginated and ordered by newest first.
200
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
200
201
  * List shipments
201
202
  */
202
203
  listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>>;
203
204
  /**
204
- * List all shipments for an organization, paginated and ordered by newest first.
205
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
205
206
  * List shipments
206
207
  */
207
208
  listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response>;
@@ -452,6 +452,9 @@ class ShipmentsApi extends runtime.BaseAPI {
452
452
  if (requestParameters['search'] != null) {
453
453
  queryParameters['search'] = requestParameters['search'];
454
454
  }
455
+ if (requestParameters['filter'] != null) {
456
+ queryParameters['filter'] = requestParameters['filter'];
457
+ }
455
458
  const headerParameters = {};
456
459
  if (this.configuration && this.configuration.accessToken) {
457
460
  const token = this.configuration.accessToken;
@@ -471,7 +474,7 @@ class ShipmentsApi extends runtime.BaseAPI {
471
474
  });
472
475
  }
473
476
  /**
474
- * List all shipments for an organization, paginated and ordered by newest first.
477
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
475
478
  * List shipments
476
479
  */
477
480
  listShipmentsRaw(requestParameters, initOverrides) {
@@ -482,7 +485,7 @@ class ShipmentsApi extends runtime.BaseAPI {
482
485
  });
483
486
  }
484
487
  /**
485
- * List all shipments for an organization, paginated and ordered by newest first.
488
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
486
489
  * List shipments
487
490
  */
488
491
  listShipments(requestParameters, initOverrides) {
@@ -37,6 +37,7 @@ export interface ListOrdersRequest {
37
37
  status?: ListOrdersStatusEnum;
38
38
  orderChannelId?: string;
39
39
  search?: string;
40
+ filter?: string;
40
41
  }
41
42
  export interface UpdateOrderOperationRequest {
42
43
  orgId: string;
@@ -94,12 +95,12 @@ export declare class OrdersApi extends runtime.BaseAPI {
94
95
  */
95
96
  listOrdersRequestOpts(requestParameters: ListOrdersRequest): Promise<runtime.RequestOpts>;
96
97
  /**
97
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
98
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
98
99
  * List orders
99
100
  */
100
101
  listOrdersRaw(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrders200Response>>;
101
102
  /**
102
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
103
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
103
104
  * List orders
104
105
  */
105
106
  listOrders(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrders200Response>;
@@ -218,6 +218,9 @@ export class OrdersApi extends runtime.BaseAPI {
218
218
  if (requestParameters['search'] != null) {
219
219
  queryParameters['search'] = requestParameters['search'];
220
220
  }
221
+ if (requestParameters['filter'] != null) {
222
+ queryParameters['filter'] = requestParameters['filter'];
223
+ }
221
224
  const headerParameters = {};
222
225
  if (this.configuration && this.configuration.accessToken) {
223
226
  const token = this.configuration.accessToken;
@@ -237,7 +240,7 @@ export class OrdersApi extends runtime.BaseAPI {
237
240
  });
238
241
  }
239
242
  /**
240
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
243
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
241
244
  * List orders
242
245
  */
243
246
  listOrdersRaw(requestParameters, initOverrides) {
@@ -248,7 +251,7 @@ export class OrdersApi extends runtime.BaseAPI {
248
251
  });
249
252
  }
250
253
  /**
251
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
254
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
252
255
  * List orders
253
256
  */
254
257
  listOrders(requestParameters, initOverrides) {
@@ -65,6 +65,7 @@ export interface ListShipmentsRequest {
65
65
  status?: ListShipmentsStatusEnum;
66
66
  type?: ListShipmentsTypeEnum;
67
67
  search?: string;
68
+ filter?: string;
68
69
  }
69
70
  export interface SendShipmentRequest {
70
71
  orgId: string;
@@ -196,12 +197,12 @@ export declare class ShipmentsApi extends runtime.BaseAPI {
196
197
  */
197
198
  listShipmentsRequestOpts(requestParameters: ListShipmentsRequest): Promise<runtime.RequestOpts>;
198
199
  /**
199
- * List all shipments for an organization, paginated and ordered by newest first.
200
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
200
201
  * List shipments
201
202
  */
202
203
  listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>>;
203
204
  /**
204
- * List all shipments for an organization, paginated and ordered by newest first.
205
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
205
206
  * List shipments
206
207
  */
207
208
  listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response>;
@@ -449,6 +449,9 @@ export class ShipmentsApi extends runtime.BaseAPI {
449
449
  if (requestParameters['search'] != null) {
450
450
  queryParameters['search'] = requestParameters['search'];
451
451
  }
452
+ if (requestParameters['filter'] != null) {
453
+ queryParameters['filter'] = requestParameters['filter'];
454
+ }
452
455
  const headerParameters = {};
453
456
  if (this.configuration && this.configuration.accessToken) {
454
457
  const token = this.configuration.accessToken;
@@ -468,7 +471,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
468
471
  });
469
472
  }
470
473
  /**
471
- * List all shipments for an organization, paginated and ordered by newest first.
474
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
472
475
  * List shipments
473
476
  */
474
477
  listShipmentsRaw(requestParameters, initOverrides) {
@@ -479,7 +482,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
479
482
  });
480
483
  }
481
484
  /**
482
- * List all shipments for an organization, paginated and ordered by newest first.
485
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
483
486
  * List shipments
484
487
  */
485
488
  listShipments(requestParameters, initOverrides) {
@@ -185,6 +185,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
185
185
  readonly AutomationInvalid: "AUTOMATION_INVALID";
186
186
  readonly ZippyDisabled: "ZIPPY_DISABLED";
187
187
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
188
+ readonly FilterInvalid: "FILTER_INVALID";
189
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
190
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
188
191
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
189
192
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
190
193
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -149,6 +149,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
149
149
  AutomationInvalid: 'AUTOMATION_INVALID',
150
150
  ZippyDisabled: 'ZIPPY_DISABLED',
151
151
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
152
+ FilterInvalid: 'FILTER_INVALID',
153
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
154
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
152
155
  AdminForbidden: 'ADMIN_FORBIDDEN',
153
156
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
154
157
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -163,6 +163,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
163
163
  readonly AutomationInvalid: "AUTOMATION_INVALID";
164
164
  readonly ZippyDisabled: "ZIPPY_DISABLED";
165
165
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
166
+ readonly FilterInvalid: "FILTER_INVALID";
167
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
168
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
166
169
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
167
170
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
168
171
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -140,6 +140,9 @@ export const ListApiTokens401ResponseCodeEnum = {
140
140
  AutomationInvalid: 'AUTOMATION_INVALID',
141
141
  ZippyDisabled: 'ZIPPY_DISABLED',
142
142
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
143
+ FilterInvalid: 'FILTER_INVALID',
144
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
145
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
143
146
  AdminForbidden: 'ADMIN_FORBIDDEN',
144
147
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
145
148
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -170,6 +170,9 @@ export declare const SendShipment422ResponseCodeEnum: {
170
170
  readonly AutomationInvalid: "AUTOMATION_INVALID";
171
171
  readonly ZippyDisabled: "ZIPPY_DISABLED";
172
172
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
173
+ readonly FilterInvalid: "FILTER_INVALID";
174
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
175
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
173
176
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
174
177
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
175
178
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -141,6 +141,9 @@ export const SendShipment422ResponseCodeEnum = {
141
141
  AutomationInvalid: 'AUTOMATION_INVALID',
142
142
  ZippyDisabled: 'ZIPPY_DISABLED',
143
143
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
144
+ FilterInvalid: 'FILTER_INVALID',
145
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
146
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
144
147
  AdminForbidden: 'ADMIN_FORBIDDEN',
145
148
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
146
149
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -185,6 +185,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
185
185
  readonly AutomationInvalid: "AUTOMATION_INVALID";
186
186
  readonly ZippyDisabled: "ZIPPY_DISABLED";
187
187
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
188
+ readonly FilterInvalid: "FILTER_INVALID";
189
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
190
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
188
191
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
189
192
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
190
193
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -157,6 +157,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
157
157
  AutomationInvalid: 'AUTOMATION_INVALID',
158
158
  ZippyDisabled: 'ZIPPY_DISABLED',
159
159
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
160
+ FilterInvalid: 'FILTER_INVALID',
161
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
162
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
160
163
  AdminForbidden: 'ADMIN_FORBIDDEN',
161
164
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
162
165
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -163,6 +163,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
163
163
  readonly AutomationInvalid: "AUTOMATION_INVALID";
164
164
  readonly ZippyDisabled: "ZIPPY_DISABLED";
165
165
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
166
+ readonly FilterInvalid: "FILTER_INVALID";
167
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
168
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
166
169
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
167
170
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
168
171
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -148,6 +148,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
148
148
  AutomationInvalid: 'AUTOMATION_INVALID',
149
149
  ZippyDisabled: 'ZIPPY_DISABLED',
150
150
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
151
+ FilterInvalid: 'FILTER_INVALID',
152
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
153
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
151
154
  AdminForbidden: 'ADMIN_FORBIDDEN',
152
155
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
153
156
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -170,6 +170,9 @@ export declare const SendShipment422ResponseCodeEnum: {
170
170
  readonly AutomationInvalid: "AUTOMATION_INVALID";
171
171
  readonly ZippyDisabled: "ZIPPY_DISABLED";
172
172
  readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
173
+ readonly FilterInvalid: "FILTER_INVALID";
174
+ readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
175
+ readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
173
176
  readonly AdminForbidden: "ADMIN_FORBIDDEN";
174
177
  readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
175
178
  readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";
@@ -149,6 +149,9 @@ exports.SendShipment422ResponseCodeEnum = {
149
149
  AutomationInvalid: 'AUTOMATION_INVALID',
150
150
  ZippyDisabled: 'ZIPPY_DISABLED',
151
151
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
152
+ FilterInvalid: 'FILTER_INVALID',
153
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
154
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
152
155
  AdminForbidden: 'ADMIN_FORBIDDEN',
153
156
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
154
157
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
package/docs/OrdersApi.md CHANGED
@@ -245,11 +245,11 @@ example().catch(console.error);
245
245
 
246
246
  ## listOrders
247
247
 
248
- > ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search)
248
+ > ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search, filter)
249
249
 
250
250
  List orders
251
251
 
252
- Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
252
+ Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
253
253
 
254
254
  ### Example
255
255
 
@@ -285,6 +285,8 @@ async function example() {
285
285
  orderChannelId: clz9k2f0a0001abcd1234efgh,
286
286
  // string | Search by order number or customer name/email. (optional)
287
287
  search: Anna,
288
+ // string | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`. (optional)
289
+ filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
288
290
  } satisfies ListOrdersRequest;
289
291
 
290
292
  try {
@@ -312,6 +314,7 @@ example().catch(console.error);
312
314
  | **status** | `pending`, `processing`, `partially_fulfilled`, `fulfilled`, `error`, `cancelled` | Order fulfilment status derived from its shipments. | [Optional] [Defaults to `undefined`] [Enum: pending, processing, partially_fulfilled, fulfilled, error, cancelled] |
313
315
  | **orderChannelId** | `string` | Filter by order channel ID. | [Optional] [Defaults to `undefined`] |
314
316
  | **search** | `string` | Search by order number or customer name/email. | [Optional] [Defaults to `undefined`] |
317
+ | **filter** | `string` | Advanced filter as a JSON-encoded definition: a &#x60;conjunction&#x60; (&#x60;and&#x60;/&#x60;or&#x60;) over &#x60;conditions&#x60;, each &#x60;{ id, field, operator, value }&#x60; or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 &#x60;FILTER_INVALID&#x60;. | [Optional] [Defaults to `undefined`] |
315
318
 
316
319
  ### Return type
317
320
 
@@ -568,11 +568,11 @@ example().catch(console.error);
568
568
 
569
569
  ## listShipments
570
570
 
571
- > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search)
571
+ > ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search, filter)
572
572
 
573
573
  List shipments
574
574
 
575
- List all shipments for an organization, paginated and ordered by newest first.
575
+ List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
576
576
 
577
577
  ### Example
578
578
 
@@ -608,6 +608,8 @@ async function example() {
608
608
  type: outbound,
609
609
  // string | Search by shipment reference or parcel tracking number. (optional)
610
610
  search: SHIP-1042,
611
+ // string | Advanced filter as a JSON-encoded definition: a `conjunction` (`and`/`or`) over `conditions`, each `{ id, field, operator, value }` or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 `FILTER_INVALID`. (optional)
612
+ filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
611
613
  } satisfies ListShipmentsRequest;
612
614
 
613
615
  try {
@@ -635,6 +637,7 @@ example().catch(console.error);
635
637
  | **status** | `draft`, `pending`, `processing`, `dispatched`, `partly_dispatched`, `error`, `cancelled`, `on_hold` | Filter by shipment status. | [Optional] [Defaults to `undefined`] [Enum: draft, pending, processing, dispatched, partly_dispatched, error, cancelled, on_hold] |
636
638
  | **type** | `outbound`, `inbound` | Filter by direction. | [Optional] [Defaults to `undefined`] [Enum: outbound, inbound] |
637
639
  | **search** | `string` | Search by shipment reference or parcel tracking number. | [Optional] [Defaults to `undefined`] |
640
+ | **filter** | `string` | Advanced filter as a JSON-encoded definition: a &#x60;conjunction&#x60; (&#x60;and&#x60;/&#x60;or&#x60;) over &#x60;conditions&#x60;, each &#x60;{ id, field, operator, value }&#x60; or a nested group. Fields and operators per list are documented under Filtering lists in the API overview. An invalid filter returns 400 &#x60;FILTER_INVALID&#x60;. | [Optional] [Defaults to `undefined`] |
638
641
 
639
642
  ### Return type
640
643
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zippendo/sdk",
3
- "version": "1.3.1",
3
+ "version": "1.3.2",
4
4
  "description": "OpenAPI client for @zippendo/sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -73,6 +73,7 @@ export interface ListOrdersRequest {
73
73
  status?: ListOrdersStatusEnum;
74
74
  orderChannelId?: string;
75
75
  search?: string;
76
+ filter?: string;
76
77
  }
77
78
 
78
79
  export interface UpdateOrderOperationRequest {
@@ -318,6 +319,10 @@ export class OrdersApi extends runtime.BaseAPI {
318
319
  queryParameters['search'] = requestParameters['search'];
319
320
  }
320
321
 
322
+ if (requestParameters['filter'] != null) {
323
+ queryParameters['filter'] = requestParameters['filter'];
324
+ }
325
+
321
326
  const headerParameters: runtime.HTTPHeaders = {};
322
327
 
323
328
  if (this.configuration && this.configuration.accessToken) {
@@ -341,7 +346,7 @@ export class OrdersApi extends runtime.BaseAPI {
341
346
  }
342
347
 
343
348
  /**
344
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
349
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
345
350
  * List orders
346
351
  */
347
352
  async listOrdersRaw(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrders200Response>> {
@@ -352,7 +357,7 @@ export class OrdersApi extends runtime.BaseAPI {
352
357
  }
353
358
 
354
359
  /**
355
- * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
360
+ * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
356
361
  * List orders
357
362
  */
358
363
  async listOrders(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrders200Response> {
@@ -142,6 +142,7 @@ export interface ListShipmentsRequest {
142
142
  status?: ListShipmentsStatusEnum;
143
143
  type?: ListShipmentsTypeEnum;
144
144
  search?: string;
145
+ filter?: string;
145
146
  }
146
147
 
147
148
  export interface SendShipmentRequest {
@@ -688,6 +689,10 @@ export class ShipmentsApi extends runtime.BaseAPI {
688
689
  queryParameters['search'] = requestParameters['search'];
689
690
  }
690
691
 
692
+ if (requestParameters['filter'] != null) {
693
+ queryParameters['filter'] = requestParameters['filter'];
694
+ }
695
+
691
696
  const headerParameters: runtime.HTTPHeaders = {};
692
697
 
693
698
  if (this.configuration && this.configuration.accessToken) {
@@ -711,7 +716,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
711
716
  }
712
717
 
713
718
  /**
714
- * List all shipments for an organization, paginated and ordered by newest first.
719
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
715
720
  * List shipments
716
721
  */
717
722
  async listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>> {
@@ -722,7 +727,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
722
727
  }
723
728
 
724
729
  /**
725
- * List all shipments for an organization, paginated and ordered by newest first.
730
+ * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
726
731
  * List shipments
727
732
  */
728
733
  async listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response> {
@@ -199,6 +199,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
199
199
  AutomationInvalid: 'AUTOMATION_INVALID',
200
200
  ZippyDisabled: 'ZIPPY_DISABLED',
201
201
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
202
+ FilterInvalid: 'FILTER_INVALID',
203
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
204
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
202
205
  AdminForbidden: 'ADMIN_FORBIDDEN',
203
206
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
204
207
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -169,6 +169,9 @@ export const ListApiTokens401ResponseCodeEnum = {
169
169
  AutomationInvalid: 'AUTOMATION_INVALID',
170
170
  ZippyDisabled: 'ZIPPY_DISABLED',
171
171
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
172
+ FilterInvalid: 'FILTER_INVALID',
173
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
174
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
172
175
  AdminForbidden: 'ADMIN_FORBIDDEN',
173
176
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
174
177
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',
@@ -183,6 +183,9 @@ export const SendShipment422ResponseCodeEnum = {
183
183
  AutomationInvalid: 'AUTOMATION_INVALID',
184
184
  ZippyDisabled: 'ZIPPY_DISABLED',
185
185
  ConversationNotFound: 'CONVERSATION_NOT_FOUND',
186
+ FilterInvalid: 'FILTER_INVALID',
187
+ SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
188
+ SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
186
189
  AdminForbidden: 'ADMIN_FORBIDDEN',
187
190
  JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
188
191
  JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',