@zippendo/sdk 1.0.0

package/src/models/UpdateOrgBrandingRequest.ts

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * 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';
+/**
+ * 
+ * @export
+ * @interface UpdateOrgBrandingRequest
+ */
+export interface UpdateOrgBrandingRequest {
+    /**
+     * Primary brand color (hex) — tints the document title and table headers
+     * @type {string}
+     * @memberof UpdateOrgBrandingRequest
+     */
+    primaryColor?: string | null;
+    /**
+     * Secondary brand color (hex) — tints the subtitle, section headings, and totals accent
+     * @type {string}
+     * @memberof UpdateOrgBrandingRequest
+     */
+    secondaryColor?: string | null;
+}
+
+/**
+ * Check if a given object implements the UpdateOrgBrandingRequest interface.
+ */
+export function instanceOfUpdateOrgBrandingRequest(value: object): value is UpdateOrgBrandingRequest {
+    return true;
+}
+
+export function UpdateOrgBrandingRequestFromJSON(json: any): UpdateOrgBrandingRequest {
+    return UpdateOrgBrandingRequestFromJSONTyped(json, false);
+}
+
+export function UpdateOrgBrandingRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrgBrandingRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'primaryColor': json['primaryColor'] === undefined ? undefined : json['primaryColor'] === null ? null : json['primaryColor'],
+        'secondaryColor': json['secondaryColor'] === undefined ? undefined : json['secondaryColor'] === null ? null : json['secondaryColor'],
+    };
+}
+
+export function UpdateOrgBrandingRequestToJSON(json: any): UpdateOrgBrandingRequest {
+    return UpdateOrgBrandingRequestToJSONTyped(json, false);
+}
+
+export function UpdateOrgBrandingRequestToJSONTyped(value?: UpdateOrgBrandingRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'primaryColor': value['primaryColor'],
+        'secondaryColor': value['secondaryColor'],
+    };
+}
+

package/src/models/UpdateOrgRequest.ts

@@ -0,0 +1,184 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * 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';
+/**
+ * 
+ * @export
+ * @interface UpdateOrgRequest
+ */
+export interface UpdateOrgRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    name?: string;
+    /**
+     * Organization slug
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    slug?: string;
+    /**
+     * Organization description
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    description?: string;
+    /**
+     * Billing currency (ISO 4217 code)
+     * @type {UpdateOrgRequestCurrencyEnum}
+     * @memberof UpdateOrgRequest
+     */
+    currency?: UpdateOrgRequestCurrencyEnum;
+    /**
+     * Company VAT/tax ID for invoices
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    vatNumber?: string | null;
+    /**
+     * Allow shipments beyond plan limit (overage charges apply)
+     * @type {boolean}
+     * @memberof UpdateOrgRequest
+     */
+    overageEnabled?: boolean;
+    /**
+     * Billing email for invoices
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    billingEmail?: string | null;
+    /**
+     * Legal company name
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    companyName?: string | null;
+    /**
+     * Address line 1
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    addressLine1?: string | null;
+    /**
+     * Address line 2
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    addressLine2?: string | null;
+    /**
+     * City
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    city?: string | null;
+    /**
+     * Postal code
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    postalCode?: string | null;
+    /**
+     * Country (ISO 3166-1 alpha-2 code)
+     * @type {string}
+     * @memberof UpdateOrgRequest
+     */
+    country?: string | null;
+    /**
+     * Organization-wide customs identifiers (EORI, IOSS, VOEC, etc.); null clears all
+     * @type {{ [key: string]: string; }}
+     * @memberof UpdateOrgRequest
+     */
+    customs?: { [key: string]: string; } | null;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateOrgRequestCurrencyEnum = {
+    Dkk: 'DKK',
+    Eur: 'EUR',
+    Usd: 'USD',
+    Gbp: 'GBP',
+    Sek: 'SEK',
+    Nok: 'NOK'
+} as const;
+export type UpdateOrgRequestCurrencyEnum = typeof UpdateOrgRequestCurrencyEnum[keyof typeof UpdateOrgRequestCurrencyEnum];
+
+
+/**
+ * Check if a given object implements the UpdateOrgRequest interface.
+ */
+export function instanceOfUpdateOrgRequest(value: object): value is UpdateOrgRequest {
+    return true;
+}
+
+export function UpdateOrgRequestFromJSON(json: any): UpdateOrgRequest {
+    return UpdateOrgRequestFromJSONTyped(json, false);
+}
+
+export function UpdateOrgRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrgRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
+        'overageEnabled': json['overageEnabled'] == null ? undefined : json['overageEnabled'],
+        'billingEmail': json['billingEmail'] === undefined ? undefined : json['billingEmail'] === null ? null : json['billingEmail'],
+        'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
+        'addressLine1': json['addressLine1'] === undefined ? undefined : json['addressLine1'] === null ? null : json['addressLine1'],
+        'addressLine2': json['addressLine2'] === undefined ? undefined : json['addressLine2'] === null ? null : json['addressLine2'],
+        'city': json['city'] === undefined ? undefined : json['city'] === null ? null : json['city'],
+        'postalCode': json['postalCode'] === undefined ? undefined : json['postalCode'] === null ? null : json['postalCode'],
+        'country': json['country'] === undefined ? undefined : json['country'] === null ? null : json['country'],
+        'customs': json['customs'] === undefined ? undefined : json['customs'] === null ? null : json['customs'],
+    };
+}
+
+export function UpdateOrgRequestToJSON(json: any): UpdateOrgRequest {
+    return UpdateOrgRequestToJSONTyped(json, false);
+}
+
+export function UpdateOrgRequestToJSONTyped(value?: UpdateOrgRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'slug': value['slug'],
+        'description': value['description'],
+        'currency': value['currency'],
+        'vatNumber': value['vatNumber'],
+        'overageEnabled': value['overageEnabled'],
+        'billingEmail': value['billingEmail'],
+        'companyName': value['companyName'],
+        'addressLine1': value['addressLine1'],
+        'addressLine2': value['addressLine2'],
+        'city': value['city'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+        'customs': value['customs'],
+    };
+}
+

package/src/models/UpdateOrgWebhookRequest.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * 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';
+/**
+ * 
+ * @export
+ * @interface UpdateOrgWebhookRequest
+ */
+export interface UpdateOrgWebhookRequest {
+    /**
+     * Human-readable webhook name
+     * @type {string}
+     * @memberof UpdateOrgWebhookRequest
+     */
+    name?: string;
+    /**
+     * Webhook endpoint URL
+     * @type {string}
+     * @memberof UpdateOrgWebhookRequest
+     */
+    url?: string;
+    /**
+     * Events to subscribe to
+     * @type {Array<UpdateOrgWebhookRequestEventsEnum>}
+     * @memberof UpdateOrgWebhookRequest
+     */
+    events?: Array<UpdateOrgWebhookRequestEventsEnum>;
+    /**
+     * Whether the webhook is active
+     * @type {boolean}
+     * @memberof UpdateOrgWebhookRequest
+     */
+    isActive?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateOrgWebhookRequestEventsEnum = {
+    ShipmentCreated: 'shipment.created',
+    ShipmentUpdated: 'shipment.updated',
+    ShipmentDispatched: 'shipment.dispatched',
+    ShipmentCancelled: 'shipment.cancelled',
+    ShipmentError: 'shipment.error',
+    OrderCreated: 'order.created',
+    OrderUpdated: 'order.updated',
+    OrderCancelled: 'order.cancelled',
+    TrackingUpdated: 'tracking.updated'
+} as const;
+export type UpdateOrgWebhookRequestEventsEnum = typeof UpdateOrgWebhookRequestEventsEnum[keyof typeof UpdateOrgWebhookRequestEventsEnum];
+
+
+/**
+ * Check if a given object implements the UpdateOrgWebhookRequest interface.
+ */
+export function instanceOfUpdateOrgWebhookRequest(value: object): value is UpdateOrgWebhookRequest {
+    return true;
+}
+
+export function UpdateOrgWebhookRequestFromJSON(json: any): UpdateOrgWebhookRequest {
+    return UpdateOrgWebhookRequestFromJSONTyped(json, false);
+}
+
+export function UpdateOrgWebhookRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateOrgWebhookRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'url': json['url'] == null ? undefined : json['url'],
+        'events': json['events'] == null ? undefined : json['events'],
+        'isActive': json['isActive'] == null ? undefined : json['isActive'],
+    };
+}
+
+export function UpdateOrgWebhookRequestToJSON(json: any): UpdateOrgWebhookRequest {
+    return UpdateOrgWebhookRequestToJSONTyped(json, false);
+}
+
+export function UpdateOrgWebhookRequestToJSONTyped(value?: UpdateOrgWebhookRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'url': value['url'],
+        'events': value['events'],
+        'isActive': value['isActive'],
+    };
+}
+

package/src/models/UpdateShipmentRequest.ts

@@ -0,0 +1,224 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * 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 type { CreateShipmentRequestPickupDetails } from './CreateShipmentRequestPickupDetails';
+import {
+    CreateShipmentRequestPickupDetailsFromJSON,
+    CreateShipmentRequestPickupDetailsFromJSONTyped,
+    CreateShipmentRequestPickupDetailsToJSON,
+    CreateShipmentRequestPickupDetailsToJSONTyped,
+} from './CreateShipmentRequestPickupDetails';
+import type { CreateShipmentRequestCarrierSettings } from './CreateShipmentRequestCarrierSettings';
+import {
+    CreateShipmentRequestCarrierSettingsFromJSON,
+    CreateShipmentRequestCarrierSettingsFromJSONTyped,
+    CreateShipmentRequestCarrierSettingsToJSON,
+    CreateShipmentRequestCarrierSettingsToJSONTyped,
+} from './CreateShipmentRequestCarrierSettings';
+import type { CreateShipmentRequestPartiesInner } from './CreateShipmentRequestPartiesInner';
+import {
+    CreateShipmentRequestPartiesInnerFromJSON,
+    CreateShipmentRequestPartiesInnerFromJSONTyped,
+    CreateShipmentRequestPartiesInnerToJSON,
+    CreateShipmentRequestPartiesInnerToJSONTyped,
+} from './CreateShipmentRequestPartiesInner';
+import type { CreateShipmentRequestParcelsInner } from './CreateShipmentRequestParcelsInner';
+import {
+    CreateShipmentRequestParcelsInnerFromJSON,
+    CreateShipmentRequestParcelsInnerFromJSONTyped,
+    CreateShipmentRequestParcelsInnerToJSON,
+    CreateShipmentRequestParcelsInnerToJSONTyped,
+} from './CreateShipmentRequestParcelsInner';
+
+/**
+ * 
+ * @export
+ * @interface UpdateShipmentRequest
+ */
+export interface UpdateShipmentRequest {
+    /**
+     * Customer-facing shipment reference.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    reference?: string;
+    /**
+     * Sender address identifier.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    addressId?: string | null;
+    /**
+     * Selected carrier service point identifier.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    servicePointId?: string | null;
+    /**
+     * Parties involved in the shipment. Optional when orderId is provided.
+     * @type {Array<CreateShipmentRequestPartiesInner>}
+     * @memberof UpdateShipmentRequest
+     */
+    parties?: Array<CreateShipmentRequestPartiesInner>;
+    /**
+     * Direction of the shipment relative to the organization.
+     * @type {UpdateShipmentRequestTypeEnum}
+     * @memberof UpdateShipmentRequest
+     */
+    type?: UpdateShipmentRequestTypeEnum;
+    /**
+     * 
+     * @type {CreateShipmentRequestCarrierSettings}
+     * @memberof UpdateShipmentRequest
+     */
+    carrierSettings?: CreateShipmentRequestCarrierSettings;
+    /**
+     * Parcels to include. Optional when orderId is provided.
+     * @type {Array<CreateShipmentRequestParcelsInner>}
+     * @memberof UpdateShipmentRequest
+     */
+    parcels?: Array<CreateShipmentRequestParcelsInner>;
+    /**
+     * 
+     * @type {CreateShipmentRequestPickupDetails}
+     * @memberof UpdateShipmentRequest
+     */
+    pickupDetails?: CreateShipmentRequestPickupDetails | null;
+    /**
+     * Incoterm governing the shipment.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    termOfTrade?: string;
+    /**
+     * Lifecycle status of the shipment.
+     * @type {UpdateShipmentRequestStatusEnum}
+     * @memberof UpdateShipmentRequest
+     */
+    status?: UpdateShipmentRequestStatusEnum;
+    /**
+     * Order to derive parties and parcels from.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    orderId?: string | null;
+    /**
+     * Printer to assign for labels.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    labelPrinterId?: string | null;
+    /**
+     * Printer to assign for documents.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    documentPrinterId?: string | null;
+    /**
+     * Shipping rule to apply to the shipment. Pass null to clear.
+     * @type {string}
+     * @memberof UpdateShipmentRequest
+     */
+    shippingRuleId?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const UpdateShipmentRequestTypeEnum = {
+    Outbound: 'outbound',
+    Inbound: 'inbound'
+} as const;
+export type UpdateShipmentRequestTypeEnum = typeof UpdateShipmentRequestTypeEnum[keyof typeof UpdateShipmentRequestTypeEnum];
+
+/**
+ * @export
+ */
+export const UpdateShipmentRequestStatusEnum = {
+    Draft: 'draft',
+    Pending: 'pending',
+    Processing: 'processing',
+    Dispatched: 'dispatched',
+    PartlyDispatched: 'partly_dispatched',
+    Error: 'error',
+    Cancelled: 'cancelled',
+    OnHold: 'on_hold'
+} as const;
+export type UpdateShipmentRequestStatusEnum = typeof UpdateShipmentRequestStatusEnum[keyof typeof UpdateShipmentRequestStatusEnum];
+
+
+/**
+ * Check if a given object implements the UpdateShipmentRequest interface.
+ */
+export function instanceOfUpdateShipmentRequest(value: object): value is UpdateShipmentRequest {
+    return true;
+}
+
+export function UpdateShipmentRequestFromJSON(json: any): UpdateShipmentRequest {
+    return UpdateShipmentRequestFromJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reference': json['reference'] == null ? undefined : json['reference'],
+        'addressId': json['addressId'] === undefined ? undefined : json['addressId'] === null ? null : json['addressId'],
+        'servicePointId': json['servicePointId'] === undefined ? undefined : json['servicePointId'] === null ? null : json['servicePointId'],
+        'parties': json['parties'] == null ? undefined : ((json['parties'] as Array<any>).map(CreateShipmentRequestPartiesInnerFromJSON)),
+        'type': json['type'] == null ? undefined : json['type'],
+        'carrierSettings': json['carrierSettings'] == null ? undefined : CreateShipmentRequestCarrierSettingsFromJSON(json['carrierSettings']),
+        'parcels': json['parcels'] == null ? undefined : ((json['parcels'] as Array<any>).map(CreateShipmentRequestParcelsInnerFromJSON)),
+        'pickupDetails': json['pickupDetails'] === undefined ? undefined : json['pickupDetails'] === null ? null : CreateShipmentRequestPickupDetailsFromJSON(json['pickupDetails']),
+        'termOfTrade': json['termOfTrade'] == null ? undefined : json['termOfTrade'],
+        'status': json['status'] == null ? undefined : json['status'],
+        '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'] === undefined ? undefined : json['shippingRuleId'] === null ? null : json['shippingRuleId'],
+    };
+}
+
+export function UpdateShipmentRequestToJSON(json: any): UpdateShipmentRequest {
+    return UpdateShipmentRequestToJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestToJSONTyped(value?: UpdateShipmentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reference': value['reference'],
+        'addressId': value['addressId'],
+        'servicePointId': value['servicePointId'],
+        'parties': value['parties'] == null ? undefined : ((value['parties'] as Array<any>).map(CreateShipmentRequestPartiesInnerToJSON)),
+        'type': value['type'],
+        'carrierSettings': CreateShipmentRequestCarrierSettingsToJSON(value['carrierSettings']),
+        'parcels': value['parcels'] == null ? undefined : ((value['parcels'] as Array<any>).map(CreateShipmentRequestParcelsInnerToJSON)),
+        'pickupDetails': CreateShipmentRequestPickupDetailsToJSON(value['pickupDetails']),
+        'termOfTrade': value['termOfTrade'],
+        'status': value['status'],
+        'orderId': value['orderId'],
+        'labelPrinterId': value['labelPrinterId'],
+        'documentPrinterId': value['documentPrinterId'],
+        'shippingRuleId': value['shippingRuleId'],
+    };
+}
+