@zippendo/sdk 1.1.4 → 1.2.1

package/dist/esm/models/UpdateShipmentRequestCarrierSettings.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
+/**
+ *
+ * @export
+ * @interface UpdateShipmentRequestCarrierSettings
+ */
+export interface UpdateShipmentRequestCarrierSettings {
+    /**
+     * Identifier of the carrier to use.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    carrierId: string;
+    /**
+     * Identifier of the carrier product/service.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    productId: string;
+    /**
+     * Additional service codes requested from the carrier.
+     * @type {Array<string>}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    services: Array<string>;
+    /**
+     * Carrier-specific extra parameters as key/value pairs.
+     * @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    additionalParameters: {
+        [key: string]: CreateShippingRuleRequestAdditionalParametersValue;
+    };
+}
+/**
+ * Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
+ */
+export declare function instanceOfUpdateShipmentRequestCarrierSettings(value: object): value is UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsFromJSON(json: any): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsToJSON(json: any): UpdateShipmentRequestCarrierSettings;
+export declare function UpdateShipmentRequestCarrierSettingsToJSONTyped(value?: UpdateShipmentRequestCarrierSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateShipmentRequestCarrierSettings.js

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { mapValues } from '../runtime';
+import { CreateShippingRuleRequestAdditionalParametersValueFromJSON, CreateShippingRuleRequestAdditionalParametersValueToJSON, } from './CreateShippingRuleRequestAdditionalParametersValue';
+/**
+ * Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
+ */
+export function instanceOfUpdateShipmentRequestCarrierSettings(value) {
+    if (!('carrierId' in value) || value['carrierId'] === undefined)
+        return false;
+    if (!('productId' in value) || value['productId'] === undefined)
+        return false;
+    if (!('services' in value) || value['services'] === undefined)
+        return false;
+    if (!('additionalParameters' in value) || value['additionalParameters'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateShipmentRequestCarrierSettingsFromJSON(json) {
+    return UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, false);
+}
+export function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'additionalParameters': (mapValues(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueFromJSON)),
+    };
+}
+export function UpdateShipmentRequestCarrierSettingsToJSON(json) {
+    return UpdateShipmentRequestCarrierSettingsToJSONTyped(json, false);
+}
+export function UpdateShipmentRequestCarrierSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': (mapValues(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueToJSON)),
+    };
+}

package/dist/esm/models/UpdateShipmentRequestDroppoint.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+/**
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
+ * @export
+ * @interface UpdateShipmentRequestDroppoint
+ */
+export interface UpdateShipmentRequestDroppoint {
+    /**
+     * Identifier of the selected service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    id: string;
+    /**
+     * Display name of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    name: string;
+    /**
+     * Formatted address of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    address: string;
+    /**
+     * Latitude/longitude of the service point.
+     * @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
+}
+/**
+ * Check if a given object implements the UpdateShipmentRequestDroppoint interface.
+ */
+export declare function instanceOfUpdateShipmentRequestDroppoint(value: object): value is UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointFromJSON(json: any): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointToJSON(json: any): UpdateShipmentRequestDroppoint;
+export declare function UpdateShipmentRequestDroppointToJSONTyped(value?: UpdateShipmentRequestDroppoint | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpdateShipmentRequestDroppoint.js

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON, ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON, } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+/**
+ * Check if a given object implements the UpdateShipmentRequestDroppoint interface.
+ */
+export function instanceOfUpdateShipmentRequestDroppoint(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('address' in value) || value['address'] === undefined)
+        return false;
+    return true;
+}
+export function UpdateShipmentRequestDroppointFromJSON(json) {
+    return UpdateShipmentRequestDroppointFromJSONTyped(json, false);
+}
+export function UpdateShipmentRequestDroppointFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'address': json['address'],
+        'coordinates': json['coordinates'] == null ? undefined : (json['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
+    };
+}
+export function UpdateShipmentRequestDroppointToJSON(json) {
+    return UpdateShipmentRequestDroppointToJSONTyped(json, false);
+}
+export function UpdateShipmentRequestDroppointToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'address': value['address'],
+        'coordinates': value['coordinates'] == null ? undefined : (value['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -35,6 +35,7 @@ export * from './CreateShipment201ResponseShippingRule';
 export * from './CreateShipment201ResponseTracking';
 export * from './CreateShipmentRequest';
 export * from './CreateShipmentRequestCarrierSettings';
+export * from './CreateShipmentRequestDroppoint';
 export * from './CreateShipmentRequestParcelsInner';
 export * from './CreateShipmentRequestParcelsInnerDimensions';
 export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
@@ -141,6 +142,8 @@ export * from './UpdateOrgBrandingRequest';
 export * from './UpdateOrgRequest';
 export * from './UpdateOrgWebhookRequest';
 export * from './UpdateShipmentRequest';
+export * from './UpdateShipmentRequestCarrierSettings';
+export * from './UpdateShipmentRequestDroppoint';
 export * from './UpdateShippingRuleRequest';
 export * from './VerifyApiToken200Response';
 export * from './VerifyApiTokenRequest';

package/dist/esm/models/index.js

@@ -37,6 +37,7 @@ export * from './CreateShipment201ResponseShippingRule';
 export * from './CreateShipment201ResponseTracking';
 export * from './CreateShipmentRequest';
 export * from './CreateShipmentRequestCarrierSettings';
+export * from './CreateShipmentRequestDroppoint';
 export * from './CreateShipmentRequestParcelsInner';
 export * from './CreateShipmentRequestParcelsInnerDimensions';
 export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
@@ -143,6 +144,8 @@ export * from './UpdateOrgBrandingRequest';
 export * from './UpdateOrgRequest';
 export * from './UpdateOrgWebhookRequest';
 export * from './UpdateShipmentRequest';
+export * from './UpdateShipmentRequestCarrierSettings';
+export * from './UpdateShipmentRequestDroppoint';
 export * from './UpdateShippingRuleRequest';
 export * from './VerifyApiToken200Response';
 export * from './VerifyApiTokenRequest';

package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts

@@ -23,19 +23,19 @@ export interface BatchSendShipments200ResponseResultsInner {
      */
     shipmentId: string;
     /**
-     * Whether this shipment was successfully booked with its carrier.
+     * `sent` when the carrier booked it, `failed` when the carrier or Zippendo rejected it, and `skipped` when the batch ran out of time before reaching it. A `skipped` shipment was never sent to the carrier and is safe to submit again.
      * @type {BatchSendShipments200ResponseResultsInnerStatusEnum}
      * @memberof BatchSendShipments200ResponseResultsInner
      */
     status: BatchSendShipments200ResponseResultsInnerStatusEnum;
     /**
-     * Canonical machine-readable error code, present when `status` is `failed`.
+     * Canonical machine-readable error code, present when `status` is `failed` or `skipped`.
      * @type {BatchSendShipments200ResponseResultsInnerCodeEnum}
      * @memberof BatchSendShipments200ResponseResultsInner
      */
     code?: BatchSendShipments200ResponseResultsInnerCodeEnum;
     /**
-     * Human-readable failure detail, present when `status` is `failed`.
+     * Human-readable detail, present when `status` is `failed` or `skipped`.
      * @type {string}
      * @memberof BatchSendShipments200ResponseResultsInner
      */
@@ -53,6 +53,7 @@ export interface BatchSendShipments200ResponseResultsInner {
 export declare const BatchSendShipments200ResponseResultsInnerStatusEnum: {
     readonly Sent: "sent";
     readonly Failed: "failed";
+    readonly Skipped: "skipped";
 };
 export type BatchSendShipments200ResponseResultsInnerStatusEnum = typeof BatchSendShipments200ResponseResultsInnerStatusEnum[keyof typeof BatchSendShipments200ResponseResultsInnerStatusEnum];
 /**
@@ -123,6 +124,8 @@ export declare const BatchSendShipments200ResponseResultsInnerCodeEnum: {
     readonly ShipmentDocumentNotFound: "SHIPMENT_DOCUMENT_NOT_FOUND";
     readonly ShipmentAlreadySent: "SHIPMENT_ALREADY_SENT";
     readonly ShipmentInvalidState: "SHIPMENT_INVALID_STATE";
+    readonly ShipmentServicePointRequired: "SHIPMENT_SERVICE_POINT_REQUIRED";
+    readonly ShipmentSendNotAttempted: "SHIPMENT_SEND_NOT_ATTEMPTED";
     readonly ParcelNotFound: "PARCEL_NOT_FOUND";
     readonly ParcelInvalidSplit: "PARCEL_INVALID_SPLIT";
     readonly PickupNotFound: "PICKUP_NOT_FOUND";

package/dist/models/BatchSendShipments200ResponseResultsInner.js

@@ -25,7 +25,8 @@ const SendShipment422ResponseErrorsInner_1 = require("./SendShipment422ResponseE
  */
 exports.BatchSendShipments200ResponseResultsInnerStatusEnum = {
     Sent: 'sent',
-    Failed: 'failed'
+    Failed: 'failed',
+    Skipped: 'skipped'
 };
 /**
  * @export
@@ -95,6 +96,8 @@ exports.BatchSendShipments200ResponseResultsInnerCodeEnum = {
     ShipmentDocumentNotFound: 'SHIPMENT_DOCUMENT_NOT_FOUND',
     ShipmentAlreadySent: 'SHIPMENT_ALREADY_SENT',
     ShipmentInvalidState: 'SHIPMENT_INVALID_STATE',
+    ShipmentServicePointRequired: 'SHIPMENT_SERVICE_POINT_REQUIRED',
+    ShipmentSendNotAttempted: 'SHIPMENT_SEND_NOT_ATTEMPTED',
     ParcelNotFound: 'PARCEL_NOT_FOUND',
     ParcelInvalidSplit: 'PARCEL_INVALID_SPLIT',
     PickupNotFound: 'PICKUP_NOT_FOUND',

package/dist/models/BatchSendShipments200ResponseSummary.d.ts

@@ -16,7 +16,7 @@
  */
 export interface BatchSendShipments200ResponseSummary {
     /**
-     * Number of unique shipments processed.
+     * Number of unique shipments requested.
      * @type {number}
      * @memberof BatchSendShipments200ResponseSummary
      */
@@ -28,11 +28,17 @@ export interface BatchSendShipments200ResponseSummary {
      */
     sent: number;
     /**
-     * How many failed.
+     * How many the carrier or Zippendo rejected.
      * @type {number}
      * @memberof BatchSendShipments200ResponseSummary
      */
     failed: number;
+    /**
+     * How many the batch ran out of time to attempt. Submit these again.
+     * @type {number}
+     * @memberof BatchSendShipments200ResponseSummary
+     */
+    skipped: number;
 }
 /**
  * Check if a given object implements the BatchSendShipments200ResponseSummary interface.

package/dist/models/BatchSendShipments200ResponseSummary.js

@@ -28,6 +28,8 @@ function instanceOfBatchSendShipments200ResponseSummary(value) {
         return false;
     if (!('failed' in value) || value['failed'] === undefined)
         return false;
+    if (!('skipped' in value) || value['skipped'] === undefined)
+        return false;
     return true;
 }
 function BatchSendShipments200ResponseSummaryFromJSON(json) {
@@ -41,6 +43,7 @@ function BatchSendShipments200ResponseSummaryFromJSONTyped(json, ignoreDiscrimin
         'total': json['total'],
         'sent': json['sent'],
         'failed': json['failed'],
+        'skipped': json['skipped'],
     };
 }
 function BatchSendShipments200ResponseSummaryToJSON(json) {
@@ -54,5 +57,6 @@ function BatchSendShipments200ResponseSummaryToJSONTyped(value, ignoreDiscrimina
         'total': value['total'],
         'sent': value['sent'],
         'failed': value['failed'],
+        'skipped': value['skipped'],
     };
 }

package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts

@@ -22,11 +22,11 @@ export interface CreateShipment201ResponseParcelsInnerOrderLinesInner {
      */
     id?: string;
     /**
-     * Stock keeping unit of the product.
+     * Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
      * @type {string}
      * @memberof CreateShipment201ResponseParcelsInnerOrderLinesInner
      */
-    sku: string;
+    sku?: string | null;
     /**
      * Number of units in this order line.
      * @type {number}

package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js

@@ -22,8 +22,6 @@ exports.CreateShipment201ResponseParcelsInnerOrderLinesInnerToJSONTyped = Create
  * Check if a given object implements the CreateShipment201ResponseParcelsInnerOrderLinesInner interface.
  */
 function instanceOfCreateShipment201ResponseParcelsInnerOrderLinesInner(value) {
-    if (!('sku' in value) || value['sku'] === undefined)
-        return false;
     if (!('quantity' in value) || value['quantity'] === undefined)
         return false;
     return true;
@@ -37,7 +35,7 @@ function CreateShipment201ResponseParcelsInnerOrderLinesInnerFromJSONTyped(json,
     }
     return {
         'id': json['id'] == null ? undefined : json['id'],
-        'sku': json['sku'],
+        'sku': json['sku'] === undefined ? undefined : json['sku'] === null ? null : json['sku'],
         'quantity': json['quantity'],
         'description': json['description'] === undefined ? undefined : json['description'] === null ? null : json['description'],
         'unitPrice': json['unitPrice'] === undefined ? undefined : json['unitPrice'] === null ? null : json['unitPrice'],

package/dist/models/CreateShipmentRequest.d.ts

@@ -11,6 +11,7 @@
  */
 import type { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
 import type { CreateShipmentRequestCarrierSettings } from './CreateShipmentRequestCarrierSettings';
+import type { CreateShipmentRequestDroppoint } from './CreateShipmentRequestDroppoint';
 import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
 import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
 /**
@@ -54,7 +55,7 @@ export interface CreateShipmentRequest {
      * @type {CreateShipmentRequestCarrierSettings}
      * @memberof CreateShipmentRequest
      */
-    carrierSettings: CreateShipmentRequestCarrierSettings;
+    carrierSettings?: CreateShipmentRequestCarrierSettings;
     /**
      * Parcels to include. Optional when orderId is provided.
      * @type {Array<CreateShipmentRequestParcelsInner>}
@@ -97,6 +98,18 @@ export interface CreateShipmentRequest {
      * @memberof CreateShipmentRequest
      */
     documentPrinterId?: string | null;
+    /**
+     * Create the shipment from this shipping rule: carrier settings and the sender address derive from the rule (explicit carrierSettings and addressId are then ignored).
+     * @type {string}
+     * @memberof CreateShipmentRequest
+     */
+    shippingRuleId?: string;
+    /**
+     *
+     * @type {CreateShipmentRequestDroppoint}
+     * @memberof CreateShipmentRequest
+     */
+    droppoint?: CreateShipmentRequestDroppoint;
 }
 /**
  * @export

package/dist/models/CreateShipmentRequest.js

@@ -21,6 +21,7 @@ exports.CreateShipmentRequestToJSON = CreateShipmentRequestToJSON;
 exports.CreateShipmentRequestToJSONTyped = CreateShipmentRequestToJSONTyped;
 const CreateShipmentRequestPickupDetails_1 = require("./CreateShipmentRequestPickupDetails");
 const CreateShipmentRequestCarrierSettings_1 = require("./CreateShipmentRequestCarrierSettings");
+const CreateShipmentRequestDroppoint_1 = require("./CreateShipmentRequestDroppoint");
 const CreateShipmentRequestPartiesInner_1 = require("./CreateShipmentRequestPartiesInner");
 const CreateShipmentRequestParcelsInner_1 = require("./CreateShipmentRequestParcelsInner");
 /**
@@ -49,8 +50,6 @@ exports.CreateShipmentRequestStatusEnum = {
 function instanceOfCreateShipmentRequest(value) {
     if (!('type' in value) || value['type'] === undefined)
         return false;
-    if (!('carrierSettings' in value) || value['carrierSettings'] === undefined)
-        return false;
     return true;
 }
 function CreateShipmentRequestFromJSON(json) {
@@ -66,7 +65,7 @@ function CreateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
         'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
         'parties': json['parties'] == null ? undefined : (json['parties'].map(CreateShipmentRequestPartiesInner_1.CreateShipmentRequestPartiesInnerFromJSON)),
         'type': json['type'],
-        'carrierSettings': (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
+        'carrierSettings': json['carrierSettings'] == null ? undefined : (0, CreateShipmentRequestCarrierSettings_1.CreateShipmentRequestCarrierSettingsFromJSON)(json['carrierSettings']),
         'parcels': json['parcels'] == null ? undefined : (json['parcels'].map(CreateShipmentRequestParcelsInner_1.CreateShipmentRequestParcelsInnerFromJSON)),
         'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : (0, CreateShipmentRequestPickupDetails_1.CreateShipmentRequestPickupDetailsFromJSON)(json['pickupDetails']),
         'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
@@ -74,6 +73,8 @@ function CreateShipmentRequestFromJSONTyped(json, ignoreDiscriminator) {
         'orderId': json['orderId'] === undefined ? undefined : json['orderId'] === null ? null : json['orderId'],
         'labelPrinterId': json['labelPrinterId'] === undefined ? undefined : json['labelPrinterId'] === null ? null : json['labelPrinterId'],
         'documentPrinterId': json['documentPrinterId'] === undefined ? undefined : json['documentPrinterId'] === null ? null : json['documentPrinterId'],
+        'shippingRuleId': json['shippingRuleId'] == null ? undefined : json['shippingRuleId'],
+        'droppoint': json['droppoint'] == null ? undefined : (0, CreateShipmentRequestDroppoint_1.CreateShipmentRequestDroppointFromJSON)(json['droppoint']),
     };
 }
 function CreateShipmentRequestToJSON(json) {
@@ -97,5 +98,7 @@ function CreateShipmentRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'orderId': value['orderId'],
         'labelPrinterId': value['labelPrinterId'],
         'documentPrinterId': value['documentPrinterId'],
+        'shippingRuleId': value['shippingRuleId'],
+        'droppoint': (0, CreateShipmentRequestDroppoint_1.CreateShipmentRequestDroppointToJSON)(value['droppoint']),
     };
 }

package/dist/models/CreateShipmentRequestCarrierSettings.d.ts

@@ -11,7 +11,7 @@
  */
 import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
 /**
- *
+ * Carrier configuration for the shipment. Optional when shippingRuleId is provided.
  * @export
  * @interface CreateShipmentRequestCarrierSettings
  */

package/dist/models/CreateShipmentRequestDroppoint.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+/**
+ * Display details of the selected service point, stored alongside `servicePointId`. Used with a service-point shipping rule.
+ * @export
+ * @interface CreateShipmentRequestDroppoint
+ */
+export interface CreateShipmentRequestDroppoint {
+    /**
+     * Identifier of the selected service point.
+     * @type {string}
+     * @memberof CreateShipmentRequestDroppoint
+     */
+    id: string;
+    /**
+     * Display name of the service point.
+     * @type {string}
+     * @memberof CreateShipmentRequestDroppoint
+     */
+    name: string;
+    /**
+     * Formatted address of the service point.
+     * @type {string}
+     * @memberof CreateShipmentRequestDroppoint
+     */
+    address: string;
+    /**
+     * Latitude/longitude of the service point.
+     * @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
+     * @memberof CreateShipmentRequestDroppoint
+     */
+    coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
+}
+/**
+ * Check if a given object implements the CreateShipmentRequestDroppoint interface.
+ */
+export declare function instanceOfCreateShipmentRequestDroppoint(value: object): value is CreateShipmentRequestDroppoint;
+export declare function CreateShipmentRequestDroppointFromJSON(json: any): CreateShipmentRequestDroppoint;
+export declare function CreateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateShipmentRequestDroppoint;
+export declare function CreateShipmentRequestDroppointToJSON(json: any): CreateShipmentRequestDroppoint;
+export declare function CreateShipmentRequestDroppointToJSONTyped(value?: CreateShipmentRequestDroppoint | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CreateShipmentRequestDroppoint.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * 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`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfCreateShipmentRequestDroppoint = instanceOfCreateShipmentRequestDroppoint;
+exports.CreateShipmentRequestDroppointFromJSON = CreateShipmentRequestDroppointFromJSON;
+exports.CreateShipmentRequestDroppointFromJSONTyped = CreateShipmentRequestDroppointFromJSONTyped;
+exports.CreateShipmentRequestDroppointToJSON = CreateShipmentRequestDroppointToJSON;
+exports.CreateShipmentRequestDroppointToJSONTyped = CreateShipmentRequestDroppointToJSONTyped;
+const ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1 = require("./ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner");
+/**
+ * Check if a given object implements the CreateShipmentRequestDroppoint interface.
+ */
+function instanceOfCreateShipmentRequestDroppoint(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('address' in value) || value['address'] === undefined)
+        return false;
+    return true;
+}
+function CreateShipmentRequestDroppointFromJSON(json) {
+    return CreateShipmentRequestDroppointFromJSONTyped(json, false);
+}
+function CreateShipmentRequestDroppointFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'address': json['address'],
+        'coordinates': json['coordinates'] == null ? undefined : (json['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
+    };
+}
+function CreateShipmentRequestDroppointToJSON(json) {
+    return CreateShipmentRequestDroppointToJSONTyped(json, false);
+}
+function CreateShipmentRequestDroppointToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'address': value['address'],
+        'coordinates': value['coordinates'] == null ? undefined : (value['coordinates'].map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner_1.ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
+    };
+}

package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts

@@ -22,11 +22,11 @@ export interface CreateShipmentRequestParcelsInnerOrderLinesInner {
      */
     id?: string;
     /**
-     * Stock keeping unit of the product.
+     * Stock keeping unit of the product. Optional — not every webshop assigns SKUs.
      * @type {string}
      * @memberof CreateShipmentRequestParcelsInnerOrderLinesInner
      */
-    sku: string;
+    sku?: string | null;
     /**
      * Number of units in this order line.
      * @type {number}