@zippendo/sdk 1.0.3 → 1.1.1

package/dist/apis/BrandsApi.js

@@ -0,0 +1,584 @@
+"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.  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.
+ */
+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.BrandsApi = void 0;
+const runtime = require("../runtime");
+const CheckBrandSlug200Response_1 = require("../models/CheckBrandSlug200Response");
+const CreateOrgBrandRequest_1 = require("../models/CreateOrgBrandRequest");
+const ListOrgBrands200Response_1 = require("../models/ListOrgBrands200Response");
+const ListOrgBrands200ResponseDataInner_1 = require("../models/ListOrgBrands200ResponseDataInner");
+const UpdateOrgBrandRequest_1 = require("../models/UpdateOrgBrandRequest");
+/**
+ *
+ */
+class BrandsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for archiveOrgBrand without sending the request
+     */
+    archiveOrgBrandRequestOpts(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 archiveOrgBrand().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling archiveOrgBrand().');
+            }
+            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}/brands/{brandId}/archive`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Archives a brand: it leaves the brand switcher and default listings, but its orders, shipments and settings are retained and remain visible in the organization-wide view.
+     * Archive brand
+     */
+    archiveOrgBrandRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.archiveOrgBrandRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Archives a brand: it leaves the brand switcher and default listings, but its orders, shipments and settings are retained and remain visible in the organization-wide view.
+     * Archive brand
+     */
+    archiveOrgBrand(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.archiveOrgBrandRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for checkBrandSlug without sending the request
+     */
+    checkBrandSlugRequestOpts(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 checkBrandSlug().');
+            }
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling checkBrandSlug().');
+            }
+            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}/brands/check-slug/{slug}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{slug}', encodeURIComponent(String(requestParameters['slug'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Reports whether a brand slug is free within this organization. Brand slugs are unique per organization, so the same slug may exist in another organization. Archived brands still hold their slug.
+     * Check brand slug availability
+     */
+    checkBrandSlugRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.checkBrandSlugRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CheckBrandSlug200Response_1.CheckBrandSlug200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Reports whether a brand slug is free within this organization. Brand slugs are unique per organization, so the same slug may exist in another organization. Archived brands still hold their slug.
+     * Check brand slug availability
+     */
+    checkBrandSlug(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.checkBrandSlugRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for createOrgBrand without sending the request
+     */
+    createOrgBrandRequestOpts(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 createOrgBrand().');
+            }
+            if (requestParameters['createOrgBrandRequest'] == null) {
+                throw new runtime.RequiredError('createOrgBrandRequest', 'Required parameter "createOrgBrandRequest" was null or undefined when calling createOrgBrand().');
+            }
+            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}/brands`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateOrgBrandRequest_1.CreateOrgBrandRequestToJSON)(requestParameters['createOrgBrandRequest']),
+            };
+        });
+    }
+    /**
+     * Creates a brand (sub-account) in the organization. The slug is derived from the name when omitted. Requires a plan that includes brands.
+     * Create brand
+     */
+    createOrgBrandRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createOrgBrandRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a brand (sub-account) in the organization. The slug is derived from the name when omitted. Requires a plan that includes brands.
+     * Create brand
+     */
+    createOrgBrand(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createOrgBrandRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteBrandLogo without sending the request
+     */
+    deleteBrandLogoRequestOpts(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 deleteBrandLogo().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling deleteBrandLogo().');
+            }
+            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}/brands/{brandId}/logo`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Removes a brand\'s logo. Its documents fall back to the organization\'s logo. Requires the brands and customBranding entitlements.
+     * Delete brand logo
+     */
+    deleteBrandLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteBrandLogoRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Removes a brand\'s logo. Its documents fall back to the organization\'s logo. Requires the brands and customBranding entitlements.
+     * Delete brand logo
+     */
+    deleteBrandLogo(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteBrandLogoRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getBrandLogo without sending the request
+     */
+    getBrandLogoRequestOpts(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 getBrandLogo().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling getBrandLogo().');
+            }
+            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}/brands/{brandId}/logo`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Streams the brand\'s logo bytes. This is the URL returned as the brand\'s `logoUrl`.
+     * Get brand logo
+     */
+    getBrandLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getBrandLogoRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Streams the brand\'s logo bytes. This is the URL returned as the brand\'s `logoUrl`.
+     * Get brand logo
+     */
+    getBrandLogo(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getBrandLogoRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOrgBrand without sending the request
+     */
+    getOrgBrandRequestOpts(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 getOrgBrand().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling getOrgBrand().');
+            }
+            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}/brands/{brandId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a single brand (sub-account) by id.
+     * Get brand
+     */
+    getOrgBrandRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOrgBrandRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a single brand (sub-account) by id.
+     * Get brand
+     */
+    getOrgBrand(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getOrgBrandRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listOrgBrands without sending the request
+     */
+    listOrgBrandsRequestOpts(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 listOrgBrands().');
+            }
+            const queryParameters = {};
+            if (requestParameters['includeArchived'] != null) {
+                queryParameters['includeArchived'] = requestParameters['includeArchived'];
+            }
+            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}/brands`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns the organization\'s brands (sub-accounts). Archived brands are excluded unless `includeArchived` is set.
+     * List brands
+     */
+    listOrgBrandsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listOrgBrandsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200Response_1.ListOrgBrands200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns the organization\'s brands (sub-accounts). Archived brands are excluded unless `includeArchived` is set.
+     * List brands
+     */
+    listOrgBrands(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listOrgBrandsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for unarchiveOrgBrand without sending the request
+     */
+    unarchiveOrgBrandRequestOpts(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 unarchiveOrgBrand().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling unarchiveOrgBrand().');
+            }
+            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}/brands/{brandId}/unarchive`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Restores an archived brand so it appears in the brand switcher again.
+     * Unarchive brand
+     */
+    unarchiveOrgBrandRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.unarchiveOrgBrandRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Restores an archived brand so it appears in the brand switcher again.
+     * Unarchive brand
+     */
+    unarchiveOrgBrand(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.unarchiveOrgBrandRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateOrgBrand without sending the request
+     */
+    updateOrgBrandRequestOpts(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 updateOrgBrand().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling updateOrgBrand().');
+            }
+            if (requestParameters['updateOrgBrandRequest'] == null) {
+                throw new runtime.RequiredError('updateOrgBrandRequest', 'Required parameter "updateOrgBrandRequest" was null or undefined when calling updateOrgBrand().');
+            }
+            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}/brands/{brandId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateOrgBrandRequest_1.UpdateOrgBrandRequestToJSON)(requestParameters['updateOrgBrandRequest']),
+            };
+        });
+    }
+    /**
+     * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization\'s value applies again.
+     * Update brand
+     */
+    updateOrgBrandRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateOrgBrandRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Updates a brand\'s name, slug, identity overrides (company name, VAT, customs, address) and document colours. Null clears an override so the organization\'s value applies again.
+     * Update brand
+     */
+    updateOrgBrand(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateOrgBrandRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for uploadBrandLogo without sending the request
+     */
+    uploadBrandLogoRequestOpts(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 uploadBrandLogo().');
+            }
+            if (requestParameters['brandId'] == null) {
+                throw new runtime.RequiredError('brandId', 'Required parameter "brandId" was null or undefined when calling uploadBrandLogo().');
+            }
+            if (requestParameters['file'] == null) {
+                throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling uploadBrandLogo().');
+            }
+            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}`;
+                }
+            }
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            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']);
+            }
+            let urlPath = `/orgs/{orgId}/brands/{brandId}/logo`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{brandId}', encodeURIComponent(String(requestParameters['brandId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: formParams,
+            };
+        });
+    }
+    /**
+     * Uploads a brand\'s logo as multipart/form-data. Accepts PNG, JPG or WEBP up to 5MB and 4096×4096px; the image is re-encoded and stored. Documents for this brand\'s shipments use it instead of the organization\'s logo. Requires the brands and customBranding entitlements.
+     * Upload brand logo
+     */
+    uploadBrandLogoRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.uploadBrandLogoRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListOrgBrands200ResponseDataInner_1.ListOrgBrands200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Uploads a brand\'s logo as multipart/form-data. Accepts PNG, JPG or WEBP up to 5MB and 4096×4096px; the image is re-encoded and stored. Documents for this brand\'s shipments use it instead of the organization\'s logo. Requires the brands and customBranding entitlements.
+     * Upload brand logo
+     */
+    uploadBrandLogo(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.uploadBrandLogoRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.BrandsApi = BrandsApi;

package/dist/apis/CarrierCatalogApi.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
+ * 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.  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

package/dist/apis/CarrierCatalogApi.js

@@ -3,7 +3,7 @@
 /* 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.
+ * 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.  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

package/dist/apis/CarriersApi.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
+ * 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.  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

package/dist/apis/CarriersApi.js

@@ -3,7 +3,7 @@
 /* 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.
+ * 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.  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

package/dist/apis/OrdersApi.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
+ * 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.  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