@zippendo/sdk 1.0.0

package/src/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.ts

@@ -0,0 +1,75 @@
+/* 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 BatchSplitShipmentRequestShipmentsInnerOrderLinesInner
+ */
+export interface BatchSplitShipmentRequestShipmentsInnerOrderLinesInner {
+    /**
+     * Order line identifier to move.
+     * @type {string}
+     * @memberof BatchSplitShipmentRequestShipmentsInnerOrderLinesInner
+     */
+    id: string;
+    /**
+     * Quantity of the order line to move.
+     * @type {number}
+     * @memberof BatchSplitShipmentRequestShipmentsInnerOrderLinesInner
+     */
+    quantity: number;
+}
+
+/**
+ * Check if a given object implements the BatchSplitShipmentRequestShipmentsInnerOrderLinesInner interface.
+ */
+export function instanceOfBatchSplitShipmentRequestShipmentsInnerOrderLinesInner(value: object): value is BatchSplitShipmentRequestShipmentsInnerOrderLinesInner {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    return true;
+}
+
+export function BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSON(json: any): BatchSplitShipmentRequestShipmentsInnerOrderLinesInner {
+    return BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSONTyped(json, false);
+}
+
+export function BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): BatchSplitShipmentRequestShipmentsInnerOrderLinesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'quantity': json['quantity'],
+    };
+}
+
+export function BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSON(json: any): BatchSplitShipmentRequestShipmentsInnerOrderLinesInner {
+    return BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSONTyped(json, false);
+}
+
+export function BatchSplitShipmentRequestShipmentsInnerOrderLinesInnerToJSONTyped(value?: BatchSplitShipmentRequestShipmentsInnerOrderLinesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'quantity': value['quantity'],
+    };
+}
+

package/src/models/ConnectCarrierRequest.ts

@@ -0,0 +1,92 @@
+/* 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 { ListCarriers200ResponseDataInnerConfigValue } from './ListCarriers200ResponseDataInnerConfigValue';
+import {
+    ListCarriers200ResponseDataInnerConfigValueFromJSON,
+    ListCarriers200ResponseDataInnerConfigValueFromJSONTyped,
+    ListCarriers200ResponseDataInnerConfigValueToJSON,
+    ListCarriers200ResponseDataInnerConfigValueToJSONTyped,
+} from './ListCarriers200ResponseDataInnerConfigValue';
+
+/**
+ * 
+ * @export
+ * @interface ConnectCarrierRequest
+ */
+export interface ConnectCarrierRequest {
+    /**
+     * Carrier display name
+     * @type {string}
+     * @memberof ConnectCarrierRequest
+     */
+    name: string;
+    /**
+     * Carrier slug identifier
+     * @type {string}
+     * @memberof ConnectCarrierRequest
+     */
+    carrierSlug: string;
+    /**
+     * Carrier configuration (required and optional fields)
+     * @type {{ [key: string]: ListCarriers200ResponseDataInnerConfigValue; }}
+     * @memberof ConnectCarrierRequest
+     */
+    config: { [key: string]: ListCarriers200ResponseDataInnerConfigValue; };
+}
+
+/**
+ * Check if a given object implements the ConnectCarrierRequest interface.
+ */
+export function instanceOfConnectCarrierRequest(value: object): value is ConnectCarrierRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('carrierSlug' in value) || value['carrierSlug'] === undefined) return false;
+    if (!('config' in value) || value['config'] === undefined) return false;
+    return true;
+}
+
+export function ConnectCarrierRequestFromJSON(json: any): ConnectCarrierRequest {
+    return ConnectCarrierRequestFromJSONTyped(json, false);
+}
+
+export function ConnectCarrierRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectCarrierRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'carrierSlug': json['carrierSlug'],
+        'config': (mapValues(json['config'], ListCarriers200ResponseDataInnerConfigValueFromJSON)),
+    };
+}
+
+export function ConnectCarrierRequestToJSON(json: any): ConnectCarrierRequest {
+    return ConnectCarrierRequestToJSONTyped(json, false);
+}
+
+export function ConnectCarrierRequestToJSONTyped(value?: ConnectCarrierRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'carrierSlug': value['carrierSlug'],
+        'config': (mapValues(value['config'], ListCarriers200ResponseDataInnerConfigValueToJSON)),
+    };
+}
+

package/src/models/CreateAddressRequest.ts

@@ -0,0 +1,173 @@
+/* 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 CreateAddressRequest
+ */
+export interface CreateAddressRequest {
+    /**
+     * Name of the address
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    name: string;
+    /**
+     * Attention contact person
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    attContact: string;
+    /**
+     * Address line 1
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    address1: string;
+    /**
+     * Address line 2
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    address2?: string;
+    /**
+     * Postal/ZIP code
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    zipcode: string;
+    /**
+     * City
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    city: string;
+    /**
+     * Phone number
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    phone: string;
+    /**
+     * Country code (ISO 2 or 3 letter)
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    countryCode: string;
+    /**
+     * State/Province
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    state?: string;
+    /**
+     * Email address
+     * @type {string}
+     * @memberof CreateAddressRequest
+     */
+    email: string;
+    /**
+     * Customs identifiers (voec, eori, sprn, ioss, fda, duns)
+     * @type {{ [key: string]: string; }}
+     * @memberof CreateAddressRequest
+     */
+    customs?: { [key: string]: string; };
+    /**
+     * Address types (sender, pickup, return)
+     * @type {Array<CreateAddressRequestAddressTypesEnum>}
+     * @memberof CreateAddressRequest
+     */
+    addressTypes?: Array<CreateAddressRequestAddressTypesEnum>;
+}
+
+
+/**
+ * @export
+ */
+export const CreateAddressRequestAddressTypesEnum = {
+    Sender: 'sender',
+    Pickup: 'pickup',
+    Return: 'return'
+} as const;
+export type CreateAddressRequestAddressTypesEnum = typeof CreateAddressRequestAddressTypesEnum[keyof typeof CreateAddressRequestAddressTypesEnum];
+
+
+/**
+ * Check if a given object implements the CreateAddressRequest interface.
+ */
+export function instanceOfCreateAddressRequest(value: object): value is CreateAddressRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('attContact' in value) || value['attContact'] === undefined) return false;
+    if (!('address1' in value) || value['address1'] === undefined) return false;
+    if (!('zipcode' in value) || value['zipcode'] === undefined) return false;
+    if (!('city' in value) || value['city'] === undefined) return false;
+    if (!('phone' in value) || value['phone'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    return true;
+}
+
+export function CreateAddressRequestFromJSON(json: any): CreateAddressRequest {
+    return CreateAddressRequestFromJSONTyped(json, false);
+}
+
+export function CreateAddressRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateAddressRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'attContact': json['attContact'],
+        'address1': json['address1'],
+        'address2': json['address2'] == null ? undefined : json['address2'],
+        'zipcode': json['zipcode'],
+        'city': json['city'],
+        'phone': json['phone'],
+        'countryCode': json['countryCode'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'email': json['email'],
+        'customs': json['customs'] == null ? undefined : json['customs'],
+        'addressTypes': json['addressTypes'] == null ? undefined : json['addressTypes'],
+    };
+}
+
+export function CreateAddressRequestToJSON(json: any): CreateAddressRequest {
+    return CreateAddressRequestToJSONTyped(json, false);
+}
+
+export function CreateAddressRequestToJSONTyped(value?: CreateAddressRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'attContact': value['attContact'],
+        'address1': value['address1'],
+        'address2': value['address2'],
+        'zipcode': value['zipcode'],
+        'city': value['city'],
+        'phone': value['phone'],
+        'countryCode': value['countryCode'],
+        'state': value['state'],
+        'email': value['email'],
+        'customs': value['customs'],
+        'addressTypes': value['addressTypes'],
+    };
+}
+

package/src/models/CreateApiToken201Response.ts

@@ -0,0 +1,129 @@
+/* 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 CreateApiToken201Response
+ */
+export interface CreateApiToken201Response {
+    /**
+     * Unique API token identifier
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    id: string;
+    /**
+     * Token name for identification
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    name: string;
+    /**
+     * First 12 chars of the token for identification
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    tokenPrefix: string;
+    /**
+     * Permission scopes granted by the token
+     * @type {Array<string>}
+     * @memberof CreateApiToken201Response
+     */
+    scopes: Array<string>;
+    /**
+     * Timestamp the token was last used (ISO 8601), null if never used
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    lastUsedAt: string | null;
+    /**
+     * Expiry timestamp (ISO 8601), null if it never expires
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    expiresAt: string | null;
+    /**
+     * Creation timestamp (ISO 8601)
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    createdAt: string;
+    /**
+     * Full API token (only shown once)
+     * @type {string}
+     * @memberof CreateApiToken201Response
+     */
+    token: string;
+}
+
+/**
+ * Check if a given object implements the CreateApiToken201Response interface.
+ */
+export function instanceOfCreateApiToken201Response(value: object): value is CreateApiToken201Response {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('tokenPrefix' in value) || value['tokenPrefix'] === undefined) return false;
+    if (!('scopes' in value) || value['scopes'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('token' in value) || value['token'] === undefined) return false;
+    return true;
+}
+
+export function CreateApiToken201ResponseFromJSON(json: any): CreateApiToken201Response {
+    return CreateApiToken201ResponseFromJSONTyped(json, false);
+}
+
+export function CreateApiToken201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApiToken201Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'tokenPrefix': json['tokenPrefix'],
+        'scopes': json['scopes'],
+        'lastUsedAt': json['lastUsedAt'],
+        'expiresAt': json['expiresAt'],
+        'createdAt': json['createdAt'],
+        'token': json['token'],
+    };
+}
+
+export function CreateApiToken201ResponseToJSON(json: any): CreateApiToken201Response {
+    return CreateApiToken201ResponseToJSONTyped(json, false);
+}
+
+export function CreateApiToken201ResponseToJSONTyped(value?: CreateApiToken201Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'tokenPrefix': value['tokenPrefix'],
+        'scopes': value['scopes'],
+        'lastUsedAt': value['lastUsedAt'],
+        'expiresAt': value['expiresAt'],
+        'createdAt': value['createdAt'],
+        'token': value['token'],
+    };
+}
+

package/src/models/CreateApiTokenRequest.ts

@@ -0,0 +1,126 @@
+/* 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 CreateApiTokenRequest
+ */
+export interface CreateApiTokenRequest {
+    /**
+     * Token name for identification
+     * @type {string}
+     * @memberof CreateApiTokenRequest
+     */
+    name: string;
+    /**
+     * Permission scopes for the token
+     * @type {Array<CreateApiTokenRequestScopesEnum>}
+     * @memberof CreateApiTokenRequest
+     */
+    scopes: Array<CreateApiTokenRequestScopesEnum>;
+    /**
+     * Token expiry in days (optional, max 365)
+     * @type {number}
+     * @memberof CreateApiTokenRequest
+     */
+    expiresInDays?: number;
+}
+
+
+/**
+ * @export
+ */
+export const CreateApiTokenRequestScopesEnum = {
+    ReadApiTokens: 'read:api_tokens',
+    WriteApiTokens: 'write:api_tokens',
+    ReadOrgs: 'read:orgs',
+    WriteOrgs: 'write:orgs',
+    ReadUsers: 'read:users',
+    WriteUsers: 'write:users',
+    ReadRoles: 'read:roles',
+    WriteRoles: 'write:roles',
+    ReadOrgMembers: 'read:org_members',
+    WriteOrgMembers: 'write:org_members',
+    ReadCarriers: 'read:carriers',
+    WriteCarriers: 'write:carriers',
+    ReadAddresses: 'read:addresses',
+    WriteAddresses: 'write:addresses',
+    ReadShippingRules: 'read:shipping_rules',
+    WriteShippingRules: 'write:shipping_rules',
+    ReadShipments: 'read:shipments',
+    WriteShipments: 'write:shipments',
+    ReadOrders: 'read:orders',
+    WriteOrders: 'write:orders',
+    ReadOrderChannels: 'read:order_channels',
+    WriteOrderChannels: 'write:order_channels',
+    ReadReturnPortals: 'read:return_portals',
+    WriteReturnPortals: 'write:return_portals',
+    ReadPrinters: 'read:printers',
+    WritePrinters: 'write:printers',
+    ReadWebhooks: 'read:webhooks',
+    WriteWebhooks: 'write:webhooks',
+    ReadAutomations: 'read:automations',
+    WriteAutomations: 'write:automations',
+    ReadIntegrations: 'read:integrations',
+    WriteIntegrations: 'write:integrations',
+    ReadAll: 'read:all',
+    WriteAll: 'write:all'
+} as const;
+export type CreateApiTokenRequestScopesEnum = typeof CreateApiTokenRequestScopesEnum[keyof typeof CreateApiTokenRequestScopesEnum];
+
+
+/**
+ * Check if a given object implements the CreateApiTokenRequest interface.
+ */
+export function instanceOfCreateApiTokenRequest(value: object): value is CreateApiTokenRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('scopes' in value) || value['scopes'] === undefined) return false;
+    return true;
+}
+
+export function CreateApiTokenRequestFromJSON(json: any): CreateApiTokenRequest {
+    return CreateApiTokenRequestFromJSONTyped(json, false);
+}
+
+export function CreateApiTokenRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApiTokenRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'scopes': json['scopes'],
+        'expiresInDays': json['expiresInDays'] == null ? undefined : json['expiresInDays'],
+    };
+}
+
+export function CreateApiTokenRequestToJSON(json: any): CreateApiTokenRequest {
+    return CreateApiTokenRequestToJSONTyped(json, false);
+}
+
+export function CreateApiTokenRequestToJSONTyped(value?: CreateApiTokenRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'scopes': value['scopes'],
+        'expiresInDays': value['expiresInDays'],
+    };
+}
+