@zippendo/sdk 1.3.1 → 1.3.3

package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts

@@ -142,6 +142,10 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
     readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
     readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
+    readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
+    readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
+    readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
+    readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
     readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
     readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
     readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -149,6 +153,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
     readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
     readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
+    readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
+    readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
+    readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
     readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
     readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
     readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -185,6 +192,9 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly AutomationInvalid: "AUTOMATION_INVALID";
     readonly ZippyDisabled: "ZIPPY_DISABLED";
     readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
+    readonly FilterInvalid: "FILTER_INVALID";
+    readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
+    readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
     readonly AdminForbidden: "ADMIN_FORBIDDEN";
     readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
     readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";

package/dist/models/BatchSendShipments200ResponseResultsInner.js

@@ -114,6 +114,10 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -121,6 +125,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -157,6 +164,9 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',

package/dist/models/ListApiTokens401Response.d.ts

@@ -120,6 +120,10 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
     readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
     readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
+    readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
+    readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
+    readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
+    readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
     readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
     readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
     readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -127,6 +131,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
     readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
     readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
+    readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
+    readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
+    readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
     readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
     readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
     readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -163,6 +170,9 @@ export declare const ListApiTokens401ResponseCodeEnum: {
     readonly AutomationInvalid: "AUTOMATION_INVALID";
     readonly ZippyDisabled: "ZIPPY_DISABLED";
     readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
+    readonly FilterInvalid: "FILTER_INVALID";
+    readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
+    readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
     readonly AdminForbidden: "ADMIN_FORBIDDEN";
     readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
     readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";

package/dist/models/ListApiTokens401Response.js

@@ -105,6 +105,10 @@ exports.ListApiTokens401ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -112,6 +116,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -148,6 +155,9 @@ exports.ListApiTokens401ResponseCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',

package/dist/models/SendShipment422Response.d.ts

@@ -127,6 +127,10 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly CarrierConfigInvalid: "CARRIER_CONFIG_INVALID";
     readonly CarrierParameterInvalid: "CARRIER_PARAMETER_INVALID";
     readonly CarrierServerUnavailable: "CARRIER_SERVER_UNAVAILABLE";
+    readonly CarrierUnreachable: "CARRIER_UNREACHABLE";
+    readonly CarrierNotResponding: "CARRIER_NOT_RESPONDING";
+    readonly LabelDownloadFailed: "LABEL_DOWNLOAD_FAILED";
+    readonly CarrierDocumentIncomplete: "CARRIER_DOCUMENT_INCOMPLETE";
     readonly CarrierGlsWrongAddress: "CARRIER_GLS_WRONG_ADDRESS";
     readonly CarrierDaoInvalidPostalCode: "CARRIER_DAO_INVALID_POSTAL_CODE";
     readonly CarrierPostnordBookingFailed: "CARRIER_POSTNORD_BOOKING_FAILED";
@@ -134,6 +138,9 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly CarrierDhlExpressBookingFailed: "CARRIER_DHL_EXPRESS_BOOKING_FAILED";
     readonly CarrierUpsBookingFailed: "CARRIER_UPS_BOOKING_FAILED";
     readonly CarrierMatkahuoltoBookingFailed: "CARRIER_MATKAHUOLTO_BOOKING_FAILED";
+    readonly CarrierDpdPlBookingFailed: "CARRIER_DPD_PL_BOOKING_FAILED";
+    readonly CarrierPostnlBookingFailed: "CARRIER_POSTNL_BOOKING_FAILED";
+    readonly CarrierRoyalMailBookingFailed: "CARRIER_ROYAL_MAIL_BOOKING_FAILED";
     readonly CarrierTrackingWebhookRegistrationFailed: "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED";
     readonly CarrierCustomsUnsupportedProduct: "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT";
     readonly CarrierCustomsIncomplete: "CARRIER_CUSTOMS_INCOMPLETE";
@@ -170,6 +177,9 @@ export declare const SendShipment422ResponseCodeEnum: {
     readonly AutomationInvalid: "AUTOMATION_INVALID";
     readonly ZippyDisabled: "ZIPPY_DISABLED";
     readonly ConversationNotFound: "CONVERSATION_NOT_FOUND";
+    readonly FilterInvalid: "FILTER_INVALID";
+    readonly SavedViewNotFound: "SAVED_VIEW_NOT_FOUND";
+    readonly SavedViewLimitReached: "SAVED_VIEW_LIMIT_REACHED";
     readonly AdminForbidden: "ADMIN_FORBIDDEN";
     readonly JobHandlerNotRegistered: "JOB_HANDLER_NOT_REGISTERED";
     readonly JobQueueNotConfigured: "JOB_QUEUE_NOT_CONFIGURED";

package/dist/models/SendShipment422Response.js

@@ -106,6 +106,10 @@ exports.SendShipment422ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -113,6 +117,9 @@ exports.SendShipment422ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -149,6 +156,9 @@ exports.SendShipment422ResponseCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',

package/docs/OrdersApi.md

@@ -245,11 +245,11 @@ example().catch(console.error);
 
 ## listOrders
 
-> ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search)
+> ListOrders200Response listOrders(orgId, page, limit, brandId, brandScope, status, orderChannelId, search, filter)
 
 List orders
 
-Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
 
 ### Example
 
@@ -285,6 +285,8 @@ async function example() {
     orderChannelId: clz9k2f0a0001abcd1234efgh,
     // string | Search by order number or customer name/email. (optional)
     search: Anna,
+    // 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)
+    filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
   } satisfies ListOrdersRequest;
 
   try {
@@ -312,6 +314,7 @@ example().catch(console.error);
 | **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] |
 | **orderChannelId** | `string` | Filter by order channel ID. | [Optional] [Defaults to `undefined`] |
 | **search** | `string` | Search by order number or customer name/email. | [Optional] [Defaults to `undefined`] |
+| **filter** | `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] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/ShipmentsApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.zippendo.com*
 | [**createReturnShipment**](ShipmentsApi.md#createreturnshipment) | **POST** /orgs/{orgId}/shipments/{shipmentId}/create-return | Create return shipment |
 | [**createShipment**](ShipmentsApi.md#createshipmentoperation) | **POST** /orgs/{orgId}/shipments | Create shipment |
 | [**deleteShipment**](ShipmentsApi.md#deleteshipment) | **DELETE** /orgs/{orgId}/shipments/{shipmentId} | Delete shipment |
+| [**fetchShipmentLabel**](ShipmentsApi.md#fetchshipmentlabel) | **POST** /orgs/{orgId}/shipments/{shipmentId}/fetch-label | Fetch missing label |
 | [**getShipment**](ShipmentsApi.md#getshipment) | **GET** /orgs/{orgId}/shipments/{shipmentId} | Get shipment |
 | [**getShipmentDocumentContent**](ShipmentsApi.md#getshipmentdocumentcontent) | **GET** /orgs/{orgId}/shipments/{shipmentId}/documents/{documentId}/content | Download shipment document |
 | [**listShipments**](ShipmentsApi.md#listshipments) | **GET** /orgs/{orgId}/shipments | List shipments |
@@ -182,7 +183,7 @@ example().catch(console.error);
 
 Create return shipment
 
-Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
 
 ### Example
 
@@ -407,6 +408,84 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## fetchShipmentLabel
+
+> CreateShipment201Response fetchShipmentLabel(orgId, shipmentId)
+
+Fetch missing label
+
+Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ShipmentsApi,
+} from '@zippendo/sdk';
+import type { FetchShipmentLabelRequest } from '@zippendo/sdk';
+
+async function example() {
+  console.log("🚀 Testing @zippendo/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ShipmentsApi(config);
+
+  const body = {
+    // string | Organization identifier.
+    orgId: org_1a2b3c4d,
+    // string | Shipment identifier.
+    shipmentId: shp_4d9e7a2f,
+  } satisfies FetchShipmentLabelRequest;
+
+  try {
+    const data = await api.fetchShipmentLabel(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **orgId** | `string` | Organization identifier. | [Defaults to `undefined`] |
+| **shipmentId** | `string` | Shipment identifier. | [Defaults to `undefined`] |
+
+### Return type
+
+[**CreateShipment201Response**](CreateShipment201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Default Response |  -  |
+| **403** | Default Response |  -  |
+| **404** | Default Response |  -  |
+| **409** | Default Response |  -  |
+| **422** | Default Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getShipment
 
 > CreateShipment201Response getShipment(orgId, shipmentId)
@@ -568,11 +647,11 @@ example().catch(console.error);
 
 ## listShipments
 
-> ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search)
+> ListShipments200Response listShipments(orgId, page, limit, brandId, brandScope, status, type, search, filter)
 
 List shipments
 
-List all shipments for an organization, paginated and ordered by newest first.
+List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
 
 ### Example
 
@@ -608,6 +687,8 @@ async function example() {
     type: outbound,
     // string | Search by shipment reference or parcel tracking number. (optional)
     search: SHIP-1042,
+    // 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)
+    filter: {"conjunction":"and","conditions":[{"id":"c_1","field":"status","operator":"in","value":["pending","processing"]}]},
   } satisfies ListShipmentsRequest;
 
   try {
@@ -635,6 +716,7 @@ example().catch(console.error);
 | **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] |
 | **type** | `outbound`, `inbound` | Filter by direction. | [Optional] [Defaults to `undefined`] [Enum: outbound, inbound] |
 | **search** | `string` | Search by shipment reference or parcel tracking number. | [Optional] [Defaults to `undefined`] |
+| **filter** | `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] [Defaults to `undefined`] |
 
 ### Return type
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zippendo/sdk",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "OpenAPI client for @zippendo/sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/OrdersApi.ts

@@ -73,6 +73,7 @@ export interface ListOrdersRequest {
     status?: ListOrdersStatusEnum;
     orderChannelId?: string;
     search?: string;
+    filter?: string;
 }
 
 export interface UpdateOrderOperationRequest {
@@ -318,6 +319,10 @@ export class OrdersApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -341,7 +346,7 @@ export class OrdersApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+     * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
      * List orders
      */
     async listOrdersRaw(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOrders200Response>> {
@@ -352,7 +357,7 @@ export class OrdersApi extends runtime.BaseAPI {
     }
 
     /**
-     * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+     * Returns a paginated list of orders for an organization, filterable by status, channel, search term and an advanced filter definition.
      * List orders
      */
     async listOrders(requestParameters: ListOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOrders200Response> {

package/src/apis/ShipmentsApi.ts

@@ -120,6 +120,11 @@ export interface DeleteShipmentRequest {
     shipmentId: string;
 }
 
+export interface FetchShipmentLabelRequest {
+    orgId: string;
+    shipmentId: string;
+}
+
 export interface GetShipmentRequest {
     orgId: string;
     shipmentId: string;
@@ -142,6 +147,7 @@ export interface ListShipmentsRequest {
     status?: ListShipmentsStatusEnum;
     type?: ListShipmentsTypeEnum;
     search?: string;
+    filter?: string;
 }
 
 export interface SendShipmentRequest {
@@ -359,7 +365,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
      * Create return shipment
      */
     async createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
@@ -370,7 +376,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule. The return is returned with its booking outcome: `dispatched`, or `error` with the carrier\'s reasons in `errors`.
      * Create return shipment
      */
     async createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
@@ -506,6 +512,69 @@ export class ShipmentsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for fetchShipmentLabel without sending the request
+     */
+    async fetchShipmentLabelRequestOpts(requestParameters: FetchShipmentLabelRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling fetchShipmentLabel().'
+            );
+        }
+
+        if (requestParameters['shipmentId'] == null) {
+            throw new runtime.RequiredError(
+                'shipmentId',
+                'Required parameter "shipmentId" was null or undefined when calling fetchShipmentLabel().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/shipments/{shipmentId}/fetch-label`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+        urlPath = urlPath.replace('{shipmentId}', encodeURIComponent(String(requestParameters['shipmentId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
+     * Fetch missing label
+     */
+    async fetchShipmentLabelRaw(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>> {
+        const requestOptions = await this.fetchShipmentLabelRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateShipment201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Ask the carrier again for the label of a dispatched shipment whose label could not be downloaded when it was sent (it carries a LABEL_DOWNLOAD_FAILED error). Stores the label, clears the error and returns the shipment.
+     * Fetch missing label
+     */
+    async fetchShipmentLabel(requestParameters: FetchShipmentLabelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response> {
+        const response = await this.fetchShipmentLabelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getShipment without sending the request
      */
@@ -688,6 +757,10 @@ export class ShipmentsApi extends runtime.BaseAPI {
             queryParameters['search'] = requestParameters['search'];
         }
 
+        if (requestParameters['filter'] != null) {
+            queryParameters['filter'] = requestParameters['filter'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -711,7 +784,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * List all shipments for an organization, paginated and ordered by newest first.
+     * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
      * List shipments
      */
     async listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>> {
@@ -722,7 +795,7 @@ export class ShipmentsApi extends runtime.BaseAPI {
     }
 
     /**
-     * List all shipments for an organization, paginated and ordered by newest first.
+     * List all shipments for an organization, paginated and ordered by newest first. Accepts an advanced filter definition.
      * List shipments
      */
     async listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response> {

package/src/models/BatchSendShipments200ResponseResultsInner.ts

@@ -156,6 +156,10 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -163,6 +167,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -199,6 +206,9 @@ export const BatchSendShipments200ResponseResultsInnerCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',

package/src/models/ListApiTokens401Response.ts

@@ -126,6 +126,10 @@ export const ListApiTokens401ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -133,6 +137,9 @@ export const ListApiTokens401ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -169,6 +176,9 @@ export const ListApiTokens401ResponseCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',

package/src/models/SendShipment422Response.ts

@@ -140,6 +140,10 @@ export const SendShipment422ResponseCodeEnum = {
     CarrierConfigInvalid: 'CARRIER_CONFIG_INVALID',
     CarrierParameterInvalid: 'CARRIER_PARAMETER_INVALID',
     CarrierServerUnavailable: 'CARRIER_SERVER_UNAVAILABLE',
+    CarrierUnreachable: 'CARRIER_UNREACHABLE',
+    CarrierNotResponding: 'CARRIER_NOT_RESPONDING',
+    LabelDownloadFailed: 'LABEL_DOWNLOAD_FAILED',
+    CarrierDocumentIncomplete: 'CARRIER_DOCUMENT_INCOMPLETE',
     CarrierGlsWrongAddress: 'CARRIER_GLS_WRONG_ADDRESS',
     CarrierDaoInvalidPostalCode: 'CARRIER_DAO_INVALID_POSTAL_CODE',
     CarrierPostnordBookingFailed: 'CARRIER_POSTNORD_BOOKING_FAILED',
@@ -147,6 +151,9 @@ export const SendShipment422ResponseCodeEnum = {
     CarrierDhlExpressBookingFailed: 'CARRIER_DHL_EXPRESS_BOOKING_FAILED',
     CarrierUpsBookingFailed: 'CARRIER_UPS_BOOKING_FAILED',
     CarrierMatkahuoltoBookingFailed: 'CARRIER_MATKAHUOLTO_BOOKING_FAILED',
+    CarrierDpdPlBookingFailed: 'CARRIER_DPD_PL_BOOKING_FAILED',
+    CarrierPostnlBookingFailed: 'CARRIER_POSTNL_BOOKING_FAILED',
+    CarrierRoyalMailBookingFailed: 'CARRIER_ROYAL_MAIL_BOOKING_FAILED',
     CarrierTrackingWebhookRegistrationFailed: 'CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED',
     CarrierCustomsUnsupportedProduct: 'CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT',
     CarrierCustomsIncomplete: 'CARRIER_CUSTOMS_INCOMPLETE',
@@ -183,6 +190,9 @@ export const SendShipment422ResponseCodeEnum = {
     AutomationInvalid: 'AUTOMATION_INVALID',
     ZippyDisabled: 'ZIPPY_DISABLED',
     ConversationNotFound: 'CONVERSATION_NOT_FOUND',
+    FilterInvalid: 'FILTER_INVALID',
+    SavedViewNotFound: 'SAVED_VIEW_NOT_FOUND',
+    SavedViewLimitReached: 'SAVED_VIEW_LIMIT_REACHED',
     AdminForbidden: 'ADMIN_FORBIDDEN',
     JobHandlerNotRegistered: 'JOB_HANDLER_NOT_REGISTERED',
     JobQueueNotConfigured: 'JOB_QUEUE_NOT_CONFIGURED',