@zippendo/sdk 1.0.0

package/dist/apis/OrdersApi.js

@@ -0,0 +1,326 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListOrdersStatusEnum = exports.OrdersApi = void 0;
+const runtime = require("../runtime");
+const CreateOrder201Response_1 = require("../models/CreateOrder201Response");
+const CreateOrderRequest_1 = require("../models/CreateOrderRequest");
+const GetOrder200Response_1 = require("../models/GetOrder200Response");
+const ListOrders200Response_1 = require("../models/ListOrders200Response");
+const RevokeApiToken200Response_1 = require("../models/RevokeApiToken200Response");
+const UpdateOrderRequest_1 = require("../models/UpdateOrderRequest");
+/**
+ *
+ */
+class OrdersApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createOrder without sending the request
+     */
+    createOrderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling createOrder().');
+            }
+            if (requestParameters['createOrderRequest'] == null) {
+                throw new runtime.RequiredError('createOrderRequest', 'Required parameter "createOrderRequest" was null or undefined when calling createOrder().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/orders`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateOrderRequest_1.CreateOrderRequestToJSON)(requestParameters['createOrderRequest']),
+            };
+        });
+    }
+    /**
+     * Creates a new order under an existing order channel for the organization.
+     * Create order
+     */
+    createOrderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createOrderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateOrder201Response_1.CreateOrder201ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a new order under an existing order channel for the organization.
+     * Create order
+     */
+    createOrder(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createOrderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteOrder without sending the request
+     */
+    deleteOrderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling deleteOrder().');
+            }
+            if (requestParameters['orderId'] == null) {
+                throw new runtime.RequiredError('orderId', 'Required parameter "orderId" was null or undefined when calling deleteOrder().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/orders/{orderId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{orderId}', encodeURIComponent(String(requestParameters['orderId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes an order. Fails if the order has associated shipments.
+     * Delete order
+     */
+    deleteOrderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteOrderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, RevokeApiToken200Response_1.RevokeApiToken200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Deletes an order. Fails if the order has associated shipments.
+     * Delete order
+     */
+    deleteOrder(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteOrderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOrder without sending the request
+     */
+    getOrderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling getOrder().');
+            }
+            if (requestParameters['orderId'] == null) {
+                throw new runtime.RequiredError('orderId', 'Required parameter "orderId" was null or undefined when calling getOrder().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/orders/{orderId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{orderId}', encodeURIComponent(String(requestParameters['orderId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a single order with its channel, shipping rule, shipments, and documents.
+     * Get order
+     */
+    getOrderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOrderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetOrder200Response_1.GetOrder200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a single order with its channel, shipping rule, shipments, and documents.
+     * Get order
+     */
+    getOrder(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOrderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listOrders without sending the request
+     */
+    listOrdersRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling listOrders().');
+            }
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            if (requestParameters['orderChannelId'] != null) {
+                queryParameters['orderChannelId'] = requestParameters['orderChannelId'];
+            }
+            if (requestParameters['search'] != null) {
+                queryParameters['search'] = requestParameters['search'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/orders`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+     * List orders
+     */
+    listOrdersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listOrdersRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrders200Response_1.ListOrders200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of orders for an organization, filterable by status, channel, and search term.
+     * List orders
+     */
+    listOrders(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listOrdersRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateOrder without sending the request
+     */
+    updateOrderRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['orgId'] == null) {
+                throw new runtime.RequiredError('orgId', 'Required parameter "orgId" was null or undefined when calling updateOrder().');
+            }
+            if (requestParameters['orderId'] == null) {
+                throw new runtime.RequiredError('orderId', 'Required parameter "orderId" was null or undefined when calling updateOrder().');
+            }
+            if (requestParameters['updateOrderRequest'] == null) {
+                throw new runtime.RequiredError('updateOrderRequest', 'Required parameter "updateOrderRequest" was null or undefined when calling updateOrder().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/orgs/{orgId}/orders/{orderId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{orderId}', encodeURIComponent(String(requestParameters['orderId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateOrderRequest_1.UpdateOrderRequestToJSON)(requestParameters['updateOrderRequest']),
+            };
+        });
+    }
+    /**
+     * Updates an order that is not yet fulfilled or cancelled.
+     * Update order
+     */
+    updateOrderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateOrderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateOrder201Response_1.CreateOrder201ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Updates an order that is not yet fulfilled or cancelled.
+     * Update order
+     */
+    updateOrder(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateOrderRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.OrdersApi = OrdersApi;
+/**
+ * @export
+ */
+exports.ListOrdersStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    PartiallyFulfilled: 'partially_fulfilled',
+    Fulfilled: 'fulfilled',
+    Error: 'error',
+    Cancelled: 'cancelled'
+};

package/dist/apis/OrgsApi.d.ts

@@ -0,0 +1,144 @@
+/**
+ * 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 * as runtime from '../runtime';
+import { type GetOrg200Response } from '../models/GetOrg200Response';
+import { type GetOrgBranding200Response } from '../models/GetOrgBranding200Response';
+import { type UpdateOrg200Response } from '../models/UpdateOrg200Response';
+import { type UpdateOrgBrandingRequest } from '../models/UpdateOrgBrandingRequest';
+import { type UpdateOrgRequest } from '../models/UpdateOrgRequest';
+export interface DeleteOrgLogoRequest {
+    orgId: string;
+}
+export interface GetOrgRequest {
+    id: string;
+}
+export interface GetOrgBrandingRequest {
+    orgId: string;
+}
+export interface GetOrgLogoRequest {
+    orgId: string;
+}
+export interface UpdateOrgOperationRequest {
+    id: string;
+    updateOrgRequest: UpdateOrgRequest;
+}
+export interface UpdateOrgBrandingOperationRequest {
+    orgId: string;
+    updateOrgBrandingRequest: UpdateOrgBrandingRequest;
+}
+export interface UploadOrgLogoRequest {
+    orgId: string;
+    file: Blob;
+}
+/**
+ *
+ */
+export declare class OrgsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteOrgLogo without sending the request
+     */
+    deleteOrgLogoRequestOpts(requestParameters: DeleteOrgLogoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes the org logo. Requires the customBranding entitlement.
+     * Delete org logo
+     */
+    deleteOrgLogoRaw(requestParameters: DeleteOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>>;
+    /**
+     * Removes the org logo. Requires the customBranding entitlement.
+     * Delete org logo
+     */
+    deleteOrgLogo(requestParameters: DeleteOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response>;
+    /**
+     * Creates request options for getOrg without sending the request
+     */
+    getOrgRequestOpts(requestParameters: GetOrgRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns a specific organization by ID, including its member count.
+     * Get org
+     */
+    getOrgRaw(requestParameters: GetOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrg200Response>>;
+    /**
+     * Returns a specific organization by ID, including its member count.
+     * Get org
+     */
+    getOrg(requestParameters: GetOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrg200Response>;
+    /**
+     * Creates request options for getOrgBranding without sending the request
+     */
+    getOrgBrandingRequestOpts(requestParameters: GetOrgBrandingRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the org\'s brand colors and an authenticated URL to download the logo.
+     * Get org branding
+     */
+    getOrgBrandingRaw(requestParameters: GetOrgBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>>;
+    /**
+     * Returns the org\'s brand colors and an authenticated URL to download the logo.
+     * Get org branding
+     */
+    getOrgBranding(requestParameters: GetOrgBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response>;
+    /**
+     * Creates request options for getOrgLogo without sending the request
+     */
+    getOrgLogoRequestOpts(requestParameters: GetOrgLogoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the org logo image bytes with the stored content type.
+     * Download org logo
+     */
+    getOrgLogoRaw(requestParameters: GetOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Returns the org logo image bytes with the stored content type.
+     * Download org logo
+     */
+    getOrgLogo(requestParameters: GetOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for updateOrg without sending the request
+     */
+    updateOrgRequestOpts(requestParameters: UpdateOrgOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing organization\'s profile, billing, and customs settings.
+     * Update org
+     */
+    updateOrgRaw(requestParameters: UpdateOrgOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateOrg200Response>>;
+    /**
+     * Updates an existing organization\'s profile, billing, and customs settings.
+     * Update org
+     */
+    updateOrg(requestParameters: UpdateOrgOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateOrg200Response>;
+    /**
+     * Creates request options for updateOrgBranding without sending the request
+     */
+    updateOrgBrandingRequestOpts(requestParameters: UpdateOrgBrandingOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Sets the org brand colors. Requires the customBranding entitlement.
+     * Update org branding
+     */
+    updateOrgBrandingRaw(requestParameters: UpdateOrgBrandingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>>;
+    /**
+     * Sets the org brand colors. Requires the customBranding entitlement.
+     * Update org branding
+     */
+    updateOrgBranding(requestParameters: UpdateOrgBrandingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response>;
+    /**
+     * Creates request options for uploadOrgLogo without sending the request
+     */
+    uploadOrgLogoRequestOpts(requestParameters: UploadOrgLogoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Uploads the org logo as multipart/form-data. Accepts PNG, JPG, or WEBP up to 5MB and 4096×4096px; the image is re-encoded and stored. Requires the customBranding entitlement.
+     * Upload org logo
+     */
+    uploadOrgLogoRaw(requestParameters: UploadOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>>;
+    /**
+     * Uploads the org logo as multipart/form-data. Accepts PNG, JPG, or WEBP up to 5MB and 4096×4096px; the image is re-encoded and stored. Requires the customBranding entitlement.
+     * Upload org logo
+     */
+    uploadOrgLogo(requestParameters: UploadOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response>;
+}