@zippendo/sdk 1.0.0

package/src/apis/AddressesApi.ts

@@ -0,0 +1,420 @@
+/* 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 CreateAddressRequest,
+    CreateAddressRequestFromJSON,
+    CreateAddressRequestToJSON,
+} from '../models/CreateAddressRequest';
+import {
+    type ListAddresses200Response,
+    ListAddresses200ResponseFromJSON,
+    ListAddresses200ResponseToJSON,
+} from '../models/ListAddresses200Response';
+import {
+    type ListAddresses200ResponseDataInner,
+    ListAddresses200ResponseDataInnerFromJSON,
+    ListAddresses200ResponseDataInnerToJSON,
+} from '../models/ListAddresses200ResponseDataInner';
+import {
+    type ListApiTokens401Response,
+    ListApiTokens401ResponseFromJSON,
+    ListApiTokens401ResponseToJSON,
+} from '../models/ListApiTokens401Response';
+import {
+    type UpdateAddressRequest,
+    UpdateAddressRequestFromJSON,
+    UpdateAddressRequestToJSON,
+} from '../models/UpdateAddressRequest';
+
+export interface CreateAddressOperationRequest {
+    orgId: string;
+    createAddressRequest: CreateAddressRequest;
+}
+
+export interface DeleteAddressRequest {
+    orgId: string;
+    addressId: string;
+}
+
+export interface GetAddressRequest {
+    orgId: string;
+    addressId: string;
+}
+
+export interface ListAddressesRequest {
+    orgId: string;
+    page?: number;
+    limit?: number;
+    type?: ListAddressesTypeEnum;
+}
+
+export interface UpdateAddressOperationRequest {
+    orgId: string;
+    addressId: string;
+    updateAddressRequest: UpdateAddressRequest;
+}
+
+/**
+ * 
+ */
+export class AddressesApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createAddress without sending the request
+     */
+    async createAddressRequestOpts(requestParameters: CreateAddressOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling createAddress().'
+            );
+        }
+
+        if (requestParameters['createAddressRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createAddressRequest',
+                'Required parameter "createAddressRequest" was null or undefined when calling createAddress().'
+            );
+        }
+
+        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}/addresses`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateAddressRequestToJSON(requestParameters['createAddressRequest']),
+        };
+    }
+
+    /**
+     * Creates a new sender, pickup or return address for the organization.
+     * Create address
+     */
+    async createAddressRaw(requestParameters: CreateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAddresses200ResponseDataInner>> {
+        const requestOptions = await this.createAddressRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAddresses200ResponseDataInnerFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a new sender, pickup or return address for the organization.
+     * Create address
+     */
+    async createAddress(requestParameters: CreateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAddresses200ResponseDataInner> {
+        const response = await this.createAddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteAddress without sending the request
+     */
+    async deleteAddressRequestOpts(requestParameters: DeleteAddressRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling deleteAddress().'
+            );
+        }
+
+        if (requestParameters['addressId'] == null) {
+            throw new runtime.RequiredError(
+                'addressId',
+                'Required parameter "addressId" was null or undefined when calling deleteAddress().'
+            );
+        }
+
+        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}/addresses/{addressId}`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+        urlPath = urlPath.replace('{addressId}', encodeURIComponent(String(requestParameters['addressId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Deletes an address belonging to the organization.
+     * Delete address
+     */
+    async deleteAddressRaw(requestParameters: DeleteAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.deleteAddressRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Deletes an address belonging to the organization.
+     * Delete address
+     */
+    async deleteAddress(requestParameters: DeleteAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.deleteAddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getAddress without sending the request
+     */
+    async getAddressRequestOpts(requestParameters: GetAddressRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling getAddress().'
+            );
+        }
+
+        if (requestParameters['addressId'] == null) {
+            throw new runtime.RequiredError(
+                'addressId',
+                'Required parameter "addressId" was null or undefined when calling getAddress().'
+            );
+        }
+
+        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}/addresses/{addressId}`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+        urlPath = urlPath.replace('{addressId}', encodeURIComponent(String(requestParameters['addressId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns a single address belonging to the organization, identified by its ID.
+     * Get address
+     */
+    async getAddressRaw(requestParameters: GetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAddresses200ResponseDataInner>> {
+        const requestOptions = await this.getAddressRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAddresses200ResponseDataInnerFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a single address belonging to the organization, identified by its ID.
+     * Get address
+     */
+    async getAddress(requestParameters: GetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAddresses200ResponseDataInner> {
+        const response = await this.getAddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listAddresses without sending the request
+     */
+    async listAddressesRequestOpts(requestParameters: ListAddressesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling listAddresses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['type'] != null) {
+            queryParameters['type'] = requestParameters['type'];
+        }
+
+        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}/addresses`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns a paginated list of addresses for the organization, optionally filtered by type.
+     * List addresses
+     */
+    async listAddressesRaw(requestParameters: ListAddressesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAddresses200Response>> {
+        const requestOptions = await this.listAddressesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAddresses200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a paginated list of addresses for the organization, optionally filtered by type.
+     * List addresses
+     */
+    async listAddresses(requestParameters: ListAddressesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAddresses200Response> {
+        const response = await this.listAddressesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for updateAddress without sending the request
+     */
+    async updateAddressRequestOpts(requestParameters: UpdateAddressOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling updateAddress().'
+            );
+        }
+
+        if (requestParameters['addressId'] == null) {
+            throw new runtime.RequiredError(
+                'addressId',
+                'Required parameter "addressId" was null or undefined when calling updateAddress().'
+            );
+        }
+
+        if (requestParameters['updateAddressRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateAddressRequest',
+                'Required parameter "updateAddressRequest" was null or undefined when calling updateAddress().'
+            );
+        }
+
+        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}/addresses/{addressId}`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+        urlPath = urlPath.replace('{addressId}', encodeURIComponent(String(requestParameters['addressId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateAddressRequestToJSON(requestParameters['updateAddressRequest']),
+        };
+    }
+
+    /**
+     * Updates an existing address belonging to the organization.
+     * Update address
+     */
+    async updateAddressRaw(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAddresses200ResponseDataInner>> {
+        const requestOptions = await this.updateAddressRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListAddresses200ResponseDataInnerFromJSON(jsonValue));
+    }
+
+    /**
+     * Updates an existing address belonging to the organization.
+     * Update address
+     */
+    async updateAddress(requestParameters: UpdateAddressOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAddresses200ResponseDataInner> {
+        const response = await this.updateAddressRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListAddressesTypeEnum = {
+    Sender: 'sender',
+    Pickup: 'pickup',
+    Return: 'return'
+} as const;
+export type ListAddressesTypeEnum = typeof ListAddressesTypeEnum[keyof typeof ListAddressesTypeEnum];

package/src/apis/BillingApi.ts

@@ -0,0 +1,91 @@
+/* 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 GetBillingUsage200Response,
+    GetBillingUsage200ResponseFromJSON,
+    GetBillingUsage200ResponseToJSON,
+} from '../models/GetBillingUsage200Response';
+import {
+    type ListApiTokens401Response,
+    ListApiTokens401ResponseFromJSON,
+    ListApiTokens401ResponseToJSON,
+} from '../models/ListApiTokens401Response';
+
+export interface GetBillingUsageRequest {
+    orgId: string;
+}
+
+/**
+ * 
+ */
+export class BillingApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getBillingUsage without sending the request
+     */
+    async getBillingUsageRequestOpts(requestParameters: GetBillingUsageRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling getBillingUsage().'
+            );
+        }
+
+        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}/billing/usage`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get detailed usage statistics for the current billing period.
+     * Get usage
+     */
+    async getBillingUsageRaw(requestParameters: GetBillingUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBillingUsage200Response>> {
+        const requestOptions = await this.getBillingUsageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetBillingUsage200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get detailed usage statistics for the current billing period.
+     * Get usage
+     */
+    async getBillingUsage(requestParameters: GetBillingUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBillingUsage200Response> {
+        const response = await this.getBillingUsageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/CarrierCatalogApi.ts

@@ -0,0 +1,91 @@
+/* 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 ListApiTokens401Response,
+    ListApiTokens401ResponseFromJSON,
+    ListApiTokens401ResponseToJSON,
+} from '../models/ListApiTokens401Response';
+import {
+    type ListAvailableCarriers200ResponseInner,
+    ListAvailableCarriers200ResponseInnerFromJSON,
+    ListAvailableCarriers200ResponseInnerToJSON,
+} from '../models/ListAvailableCarriers200ResponseInner';
+
+export interface ListAvailableCarriersRequest {
+    orgId: string;
+}
+
+/**
+ * 
+ */
+export class CarrierCatalogApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for listAvailableCarriers without sending the request
+     */
+    async listAvailableCarriersRequestOpts(requestParameters: ListAvailableCarriersRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['orgId'] == null) {
+            throw new runtime.RequiredError(
+                'orgId',
+                'Required parameter "orgId" was null or undefined when calling listAvailableCarriers().'
+            );
+        }
+
+        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}/available-carriers`;
+        urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the carriers available to connect, as supported by the carrier server.
+     * List available carriers
+     */
+    async listAvailableCarriersRaw(requestParameters: ListAvailableCarriersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ListAvailableCarriers200ResponseInner>>> {
+        const requestOptions = await this.listAvailableCarriersRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ListAvailableCarriers200ResponseInnerFromJSON));
+    }
+
+    /**
+     * Returns the carriers available to connect, as supported by the carrier server.
+     * List available carriers
+     */
+    async listAvailableCarriers(requestParameters: ListAvailableCarriersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ListAvailableCarriers200ResponseInner>> {
+        const response = await this.listAvailableCarriersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}