@zippendo/sdk 1.0.0

package/src/apis/OrgsApi.ts

@@ -0,0 +1,516 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetOrg200Response,
+    GetOrg200ResponseFromJSON,
+    GetOrg200ResponseToJSON,
+} from '../models/GetOrg200Response';
+import {
+    type GetOrgBranding200Response,
+    GetOrgBranding200ResponseFromJSON,
+    GetOrgBranding200ResponseToJSON,
+} from '../models/GetOrgBranding200Response';
+import {
+    type ListApiTokens401Response,
+    ListApiTokens401ResponseFromJSON,
+    ListApiTokens401ResponseToJSON,
+} from '../models/ListApiTokens401Response';
+import {
+    type UpdateOrg200Response,
+    UpdateOrg200ResponseFromJSON,
+    UpdateOrg200ResponseToJSON,
+} from '../models/UpdateOrg200Response';
+import {
+    type UpdateOrgBrandingRequest,
+    UpdateOrgBrandingRequestFromJSON,
+    UpdateOrgBrandingRequestToJSON,
+} from '../models/UpdateOrgBrandingRequest';
+import {
+    type UpdateOrgRequest,
+    UpdateOrgRequestFromJSON,
+    UpdateOrgRequestToJSON,
+} 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 class OrgsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteOrgLogo without sending the request
+     */
+    async deleteOrgLogoRequestOpts(requestParameters: DeleteOrgLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling deleteOrgLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/branding/logo`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Removes the org logo. Requires the customBranding entitlement.
+     * Delete org logo
+     */
+    async deleteOrgLogoRaw(requestParameters: DeleteOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>> {
+        const requestOptions = await this.deleteOrgLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetOrgBranding200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Removes the org logo. Requires the customBranding entitlement.
+     * Delete org logo
+     */
+    async deleteOrgLogo(requestParameters: DeleteOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response> {
+        const response = await this.deleteOrgLogoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getOrg without sending the request
+     */
+    async getOrgRequestOpts(requestParameters: GetOrgRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getOrg().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns a specific organization by ID, including its member count.
+     * Get org
+     */
+    async getOrgRaw(requestParameters: GetOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrg200Response>> {
+        const requestOptions = await this.getOrgRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetOrg200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a specific organization by ID, including its member count.
+     * Get org
+     */
+    async getOrg(requestParameters: GetOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrg200Response> {
+        const response = await this.getOrgRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getOrgBranding without sending the request
+     */
+    async getOrgBrandingRequestOpts(requestParameters: GetOrgBrandingRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling getOrgBranding().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/branding`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the org\'s brand colors and an authenticated URL to download the logo.
+     * Get org branding
+     */
+    async getOrgBrandingRaw(requestParameters: GetOrgBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>> {
+        const requestOptions = await this.getOrgBrandingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetOrgBranding200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the org\'s brand colors and an authenticated URL to download the logo.
+     * Get org branding
+     */
+    async getOrgBranding(requestParameters: GetOrgBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response> {
+        const response = await this.getOrgBrandingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getOrgLogo without sending the request
+     */
+    async getOrgLogoRequestOpts(requestParameters: GetOrgLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling getOrgLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/branding/logo`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the org logo image bytes with the stored content type.
+     * Download org logo
+     */
+    async getOrgLogoRaw(requestParameters: GetOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.getOrgLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Returns the org logo image bytes with the stored content type.
+     * Download org logo
+     */
+    async getOrgLogo(requestParameters: GetOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.getOrgLogoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateOrg without sending the request
+     */
+    async updateOrgRequestOpts(requestParameters: UpdateOrgOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateOrg().'
+            );
+        }
+
+        if (requestParameters['updateOrgRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateOrgRequest',
+                'Required parameter "updateOrgRequest" was null or undefined when calling updateOrg().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateOrgRequestToJSON(requestParameters['updateOrgRequest']),
+        };
+    }
+
+    /**
+     * Updates an existing organization\'s profile, billing, and customs settings.
+     * Update org
+     */
+    async updateOrgRaw(requestParameters: UpdateOrgOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateOrg200Response>> {
+        const requestOptions = await this.updateOrgRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UpdateOrg200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Updates an existing organization\'s profile, billing, and customs settings.
+     * Update org
+     */
+    async updateOrg(requestParameters: UpdateOrgOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateOrg200Response> {
+        const response = await this.updateOrgRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateOrgBranding without sending the request
+     */
+    async updateOrgBrandingRequestOpts(requestParameters: UpdateOrgBrandingOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling updateOrgBranding().'
+            );
+        }
+
+        if (requestParameters['updateOrgBrandingRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateOrgBrandingRequest',
+                'Required parameter "updateOrgBrandingRequest" was null or undefined when calling updateOrgBranding().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/branding`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateOrgBrandingRequestToJSON(requestParameters['updateOrgBrandingRequest']),
+        };
+    }
+
+    /**
+     * Sets the org brand colors. Requires the customBranding entitlement.
+     * Update org branding
+     */
+    async updateOrgBrandingRaw(requestParameters: UpdateOrgBrandingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>> {
+        const requestOptions = await this.updateOrgBrandingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetOrgBranding200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Sets the org brand colors. Requires the customBranding entitlement.
+     * Update org branding
+     */
+    async updateOrgBranding(requestParameters: UpdateOrgBrandingOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response> {
+        const response = await this.updateOrgBrandingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for uploadOrgLogo without sending the request
+     */
+    async uploadOrgLogoRequestOpts(requestParameters: UploadOrgLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling uploadOrgLogo().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling uploadOrgLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+
+        let urlPath = `/orgs/{orgId}/branding/logo`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * 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
+     */
+    async uploadOrgLogoRaw(requestParameters: UploadOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOrgBranding200Response>> {
+        const requestOptions = await this.uploadOrgLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetOrgBranding200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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
+     */
+    async uploadOrgLogo(requestParameters: UploadOrgLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOrgBranding200Response> {
+        const response = await this.uploadOrgLogoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/QuotesApi.ts

@@ -0,0 +1,112 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type CreateShippingQuote200Response,
+    CreateShippingQuote200ResponseFromJSON,
+    CreateShippingQuote200ResponseToJSON,
+} from '../models/CreateShippingQuote200Response';
+import {
+    type CreateShippingQuote400Response,
+    CreateShippingQuote400ResponseFromJSON,
+    CreateShippingQuote400ResponseToJSON,
+} from '../models/CreateShippingQuote400Response';
+import {
+    type CreateShippingQuote404Response,
+    CreateShippingQuote404ResponseFromJSON,
+    CreateShippingQuote404ResponseToJSON,
+} from '../models/CreateShippingQuote404Response';
+import {
+    type CreateShippingQuoteRequest,
+    CreateShippingQuoteRequestFromJSON,
+    CreateShippingQuoteRequestToJSON,
+} from '../models/CreateShippingQuoteRequest';
+
+export interface CreateShippingQuoteOperationRequest {
+    orgId: string;
+    createShippingQuoteRequest: CreateShippingQuoteRequest;
+}
+
+/**
+ * 
+ */
+export class QuotesApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createShippingQuote without sending the request
+     */
+    async createShippingQuoteRequestOpts(requestParameters: CreateShippingQuoteOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling createShippingQuote().'
+            );
+        }
+
+        if (requestParameters['createShippingQuoteRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createShippingQuoteRequest',
+                'Required parameter "createShippingQuoteRequest" was null or undefined when calling createShippingQuote().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/orgs/{orgId}/shipping-quote`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateShippingQuoteRequestToJSON(requestParameters['createShippingQuoteRequest']),
+        };
+    }
+
+    /**
+     * Calculates shipping rates from configured shipping rules based on cart items and destination.
+     * Calculate shipping rates
+     */
+    async createShippingQuoteRaw(requestParameters: CreateShippingQuoteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShippingQuote200Response>> {
+        const requestOptions = await this.createShippingQuoteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateShippingQuote200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Calculates shipping rates from configured shipping rules based on cart items and destination.
+     * Calculate shipping rates
+     */
+    async createShippingQuote(requestParameters: CreateShippingQuoteOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShippingQuote200Response> {
+        const response = await this.createShippingQuoteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}