@zippendo/sdk 1.0.0

package/dist/models/index.d.ts

@@ -0,0 +1,143 @@
+export * from './BatchSendShipments200Response';
+export * from './BatchSendShipments200ResponseResultsInner';
+export * from './BatchSendShipments200ResponseSummary';
+export * from './BatchSendShipmentsRequest';
+export * from './BatchSplitShipment201Response';
+export * from './BatchSplitShipmentRequest';
+export * from './BatchSplitShipmentRequestShipmentsInner';
+export * from './BatchSplitShipmentRequestShipmentsInnerOrderLinesInner';
+export * from './ConnectCarrierRequest';
+export * from './CreateAddressRequest';
+export * from './CreateApiToken201Response';
+export * from './CreateApiTokenRequest';
+export * from './CreateOrder201Response';
+export * from './CreateOrder201ResponseOrderLinesInner';
+export * from './CreateOrder201ResponseShippingAddress';
+export * from './CreateOrderRequest';
+export * from './CreateOrderRequestOrderLinesInner';
+export * from './CreateOrderRequestShippingAddress';
+export * from './CreateOrgWebhook201Response';
+export * from './CreateOrgWebhookRequest';
+export * from './CreateShipment201Response';
+export * from './CreateShipment201ResponseActivitiesInner';
+export * from './CreateShipment201ResponseDocumentsInner';
+export * from './CreateShipment201ResponseErrorsInner';
+export * from './CreateShipment201ResponseLogsInner';
+export * from './CreateShipment201ResponseParcelsInner';
+export * from './CreateShipment201ResponseParcelsInnerDimensions';
+export * from './CreateShipment201ResponseParcelsInnerOrderLinesInner';
+export * from './CreateShipment201ResponsePartiesInner';
+export * from './CreateShipment201ResponsePartiesInnerAttributesInner';
+export * from './CreateShipment201ResponsePickupDetails';
+export * from './CreateShipment201ResponseShippingRule';
+export * from './CreateShipment201ResponseTracking';
+export * from './CreateShipmentRequest';
+export * from './CreateShipmentRequestCarrierSettings';
+export * from './CreateShipmentRequestParcelsInner';
+export * from './CreateShipmentRequestParcelsInnerDimensions';
+export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
+export * from './CreateShipmentRequestPartiesInner';
+export * from './CreateShipmentRequestPartiesInnerAttributesInner';
+export * from './CreateShipmentRequestPickupDetails';
+export * from './CreateShippingQuote200Response';
+export * from './CreateShippingQuote200ResponseRatesInner';
+export * from './CreateShippingQuote400Response';
+export * from './CreateShippingQuote404Response';
+export * from './CreateShippingQuoteRequest';
+export * from './CreateShippingQuoteRequestDestination';
+export * from './CreateShippingQuoteRequestItemsInner';
+export * from './CreateShippingRule201Response';
+export * from './CreateShippingRuleRequest';
+export * from './CreateShippingRuleRequestAdditionalParameters';
+export * from './CreateShippingRuleRequestAdditionalParametersAnyOfInner';
+export * from './CreateShippingRuleRequestAdditionalParametersAnyOfValue';
+export * from './CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf';
+export * from './CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner';
+export * from './CreateShippingRuleRequestConditionsInner';
+export * from './CreateShippingRuleRequestConditionsInnerOneOf';
+export * from './CreateShippingRuleRequestConditionsInnerOneOf1';
+export * from './CreateShippingRuleRequestConditionsInnerOneOf2';
+export * from './CreateShippingRuleRequestConditionsInnerOneOf3';
+export * from './CreateShippingRuleRequestConditionsInnerOneOf4';
+export * from './DeleteOrgWebhook200Response';
+export * from './DeleteShippingRule200Response';
+export * from './GetBillingUsage200Response';
+export * from './GetBillingUsage200ResponseAddOnsInner';
+export * from './GetBillingUsage200ResponseCurrentPeriod';
+export * from './GetBillingUsage200ResponseLimits';
+export * from './GetBillingUsage200ResponseLimitsTeamMembers';
+export * from './GetBillingUsage200ResponseShipments';
+export * from './GetOrder200Response';
+export * from './GetOrder200ResponseShipmentsInner';
+export * from './GetOrder200ResponseShippingRule';
+export * from './GetOrg200Response';
+export * from './GetOrg200ResponseCount';
+export * from './GetOrgBranding200Response';
+export * from './HealthCheck200Response';
+export * from './ListAddresses200Response';
+export * from './ListAddresses200ResponseDataInner';
+export * from './ListApiTokens200Response';
+export * from './ListApiTokens200ResponseDataInner';
+export * from './ListApiTokens200ResponseDataInnerCreatedBy';
+export * from './ListApiTokens401Response';
+export * from './ListAvailableCarriers200ResponseInner';
+export * from './ListAvailableCarriers200ResponseInnerRequiredFieldsInner';
+export * from './ListCarrierProductServicePoints200ResponseInner';
+export * from './ListCarrierProductServicePoints200ResponseInnerAddress';
+export * from './ListCarrierProductServicePointsRequest';
+export * from './ListCarrierProducts200ResponseInner';
+export * from './ListCarrierProducts200ResponseInnerAdditionalParametersInner';
+export * from './ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner';
+export * from './ListCarrierProducts200ResponseInnerServicesInner';
+export * from './ListCarrierProducts200ResponseInnerWeightLimits';
+export * from './ListCarriers200Response';
+export * from './ListCarriers200ResponseDataInner';
+export * from './ListCarriers200ResponseDataInnerConfigValue';
+export * from './ListOrders200Response';
+export * from './ListOrders200ResponseDataInner';
+export * from './ListOrders200ResponseDataInnerOrderChannel';
+export * from './ListOrgWebhookDeliveries200Response';
+export * from './ListOrgWebhookDeliveries200ResponseDataInner';
+export * from './ListOrgWebhooks200Response';
+export * from './ListOrgWebhooks200ResponseDataInner';
+export * from './ListShipments200Response';
+export * from './ListShipments200ResponseDataInner';
+export * from './ListShipments200ResponseDataInnerAddress';
+export * from './ListShipments200ResponseDataInnerCarrierSettings';
+export * from './ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue';
+export * from './ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf';
+export * from './ListShippingRules200Response';
+export * from './ListShippingRules200ResponseDataInner';
+export * from './ListShippingRules200ResponseDataInnerAdditionalParametersInner';
+export * from './ListShippingRules200ResponseDataInnerCarrier';
+export * from './ListShippingRules200ResponseDataInnerConditionsInner';
+export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf';
+export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf1';
+export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf2';
+export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf3';
+export * from './ListShippingRules200ResponseDataInnerConditionsInnerOneOf4';
+export * from './ListShippingRules200ResponseDataInnerLabelPrinter';
+export * from './ListShippingRules200ResponseDataInnerReturnShippingRule';
+export * from './RevokeApiToken200Response';
+export * from './SendShipment422Response';
+export * from './SendShipment422ResponseErrorsInner';
+export * from './SplitShipment201Response';
+export * from './SplitShipmentParcel200Response';
+export * from './SplitShipmentParcelRequest';
+export * from './SplitShipmentParcelRequestParcelsInner';
+export * from './SplitShipmentRequest';
+export * from './TestOrgWebhook200Response';
+export * from './TrackShipment200Response';
+export * from './TrackShipment200ResponseEventsInner';
+export * from './UpdateAddressRequest';
+export * from './UpdateApiTokenRequest';
+export * from './UpdateCarrierRequest';
+export * from './UpdateOrderRequest';
+export * from './UpdateOrg200Response';
+export * from './UpdateOrgBrandingRequest';
+export * from './UpdateOrgRequest';
+export * from './UpdateOrgWebhookRequest';
+export * from './UpdateShipmentRequest';
+export * from './UpdateShippingRuleRequest';
+export * from './VerifyApiToken200Response';
+export * from './VerifyApiTokenRequest';

package/dist/models/index.js

@@ -0,0 +1,161 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./BatchSendShipments200Response"), exports);
+__exportStar(require("./BatchSendShipments200ResponseResultsInner"), exports);
+__exportStar(require("./BatchSendShipments200ResponseSummary"), exports);
+__exportStar(require("./BatchSendShipmentsRequest"), exports);
+__exportStar(require("./BatchSplitShipment201Response"), exports);
+__exportStar(require("./BatchSplitShipmentRequest"), exports);
+__exportStar(require("./BatchSplitShipmentRequestShipmentsInner"), exports);
+__exportStar(require("./BatchSplitShipmentRequestShipmentsInnerOrderLinesInner"), exports);
+__exportStar(require("./ConnectCarrierRequest"), exports);
+__exportStar(require("./CreateAddressRequest"), exports);
+__exportStar(require("./CreateApiToken201Response"), exports);
+__exportStar(require("./CreateApiTokenRequest"), exports);
+__exportStar(require("./CreateOrder201Response"), exports);
+__exportStar(require("./CreateOrder201ResponseOrderLinesInner"), exports);
+__exportStar(require("./CreateOrder201ResponseShippingAddress"), exports);
+__exportStar(require("./CreateOrderRequest"), exports);
+__exportStar(require("./CreateOrderRequestOrderLinesInner"), exports);
+__exportStar(require("./CreateOrderRequestShippingAddress"), exports);
+__exportStar(require("./CreateOrgWebhook201Response"), exports);
+__exportStar(require("./CreateOrgWebhookRequest"), exports);
+__exportStar(require("./CreateShipment201Response"), exports);
+__exportStar(require("./CreateShipment201ResponseActivitiesInner"), exports);
+__exportStar(require("./CreateShipment201ResponseDocumentsInner"), exports);
+__exportStar(require("./CreateShipment201ResponseErrorsInner"), exports);
+__exportStar(require("./CreateShipment201ResponseLogsInner"), exports);
+__exportStar(require("./CreateShipment201ResponseParcelsInner"), exports);
+__exportStar(require("./CreateShipment201ResponseParcelsInnerDimensions"), exports);
+__exportStar(require("./CreateShipment201ResponseParcelsInnerOrderLinesInner"), exports);
+__exportStar(require("./CreateShipment201ResponsePartiesInner"), exports);
+__exportStar(require("./CreateShipment201ResponsePartiesInnerAttributesInner"), exports);
+__exportStar(require("./CreateShipment201ResponsePickupDetails"), exports);
+__exportStar(require("./CreateShipment201ResponseShippingRule"), exports);
+__exportStar(require("./CreateShipment201ResponseTracking"), exports);
+__exportStar(require("./CreateShipmentRequest"), exports);
+__exportStar(require("./CreateShipmentRequestCarrierSettings"), exports);
+__exportStar(require("./CreateShipmentRequestParcelsInner"), exports);
+__exportStar(require("./CreateShipmentRequestParcelsInnerDimensions"), exports);
+__exportStar(require("./CreateShipmentRequestParcelsInnerOrderLinesInner"), exports);
+__exportStar(require("./CreateShipmentRequestPartiesInner"), exports);
+__exportStar(require("./CreateShipmentRequestPartiesInnerAttributesInner"), exports);
+__exportStar(require("./CreateShipmentRequestPickupDetails"), exports);
+__exportStar(require("./CreateShippingQuote200Response"), exports);
+__exportStar(require("./CreateShippingQuote200ResponseRatesInner"), exports);
+__exportStar(require("./CreateShippingQuote400Response"), exports);
+__exportStar(require("./CreateShippingQuote404Response"), exports);
+__exportStar(require("./CreateShippingQuoteRequest"), exports);
+__exportStar(require("./CreateShippingQuoteRequestDestination"), exports);
+__exportStar(require("./CreateShippingQuoteRequestItemsInner"), exports);
+__exportStar(require("./CreateShippingRule201Response"), exports);
+__exportStar(require("./CreateShippingRuleRequest"), exports);
+__exportStar(require("./CreateShippingRuleRequestAdditionalParameters"), exports);
+__exportStar(require("./CreateShippingRuleRequestAdditionalParametersAnyOfInner"), exports);
+__exportStar(require("./CreateShippingRuleRequestAdditionalParametersAnyOfValue"), exports);
+__exportStar(require("./CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf"), exports);
+__exportStar(require("./CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInner"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInnerOneOf"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInnerOneOf1"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInnerOneOf2"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInnerOneOf3"), exports);
+__exportStar(require("./CreateShippingRuleRequestConditionsInnerOneOf4"), exports);
+__exportStar(require("./DeleteOrgWebhook200Response"), exports);
+__exportStar(require("./DeleteShippingRule200Response"), exports);
+__exportStar(require("./GetBillingUsage200Response"), exports);
+__exportStar(require("./GetBillingUsage200ResponseAddOnsInner"), exports);
+__exportStar(require("./GetBillingUsage200ResponseCurrentPeriod"), exports);
+__exportStar(require("./GetBillingUsage200ResponseLimits"), exports);
+__exportStar(require("./GetBillingUsage200ResponseLimitsTeamMembers"), exports);
+__exportStar(require("./GetBillingUsage200ResponseShipments"), exports);
+__exportStar(require("./GetOrder200Response"), exports);
+__exportStar(require("./GetOrder200ResponseShipmentsInner"), exports);
+__exportStar(require("./GetOrder200ResponseShippingRule"), exports);
+__exportStar(require("./GetOrg200Response"), exports);
+__exportStar(require("./GetOrg200ResponseCount"), exports);
+__exportStar(require("./GetOrgBranding200Response"), exports);
+__exportStar(require("./HealthCheck200Response"), exports);
+__exportStar(require("./ListAddresses200Response"), exports);
+__exportStar(require("./ListAddresses200ResponseDataInner"), exports);
+__exportStar(require("./ListApiTokens200Response"), exports);
+__exportStar(require("./ListApiTokens200ResponseDataInner"), exports);
+__exportStar(require("./ListApiTokens200ResponseDataInnerCreatedBy"), exports);
+__exportStar(require("./ListApiTokens401Response"), exports);
+__exportStar(require("./ListAvailableCarriers200ResponseInner"), exports);
+__exportStar(require("./ListAvailableCarriers200ResponseInnerRequiredFieldsInner"), exports);
+__exportStar(require("./ListCarrierProductServicePoints200ResponseInner"), exports);
+__exportStar(require("./ListCarrierProductServicePoints200ResponseInnerAddress"), exports);
+__exportStar(require("./ListCarrierProductServicePointsRequest"), exports);
+__exportStar(require("./ListCarrierProducts200ResponseInner"), exports);
+__exportStar(require("./ListCarrierProducts200ResponseInnerAdditionalParametersInner"), exports);
+__exportStar(require("./ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner"), exports);
+__exportStar(require("./ListCarrierProducts200ResponseInnerServicesInner"), exports);
+__exportStar(require("./ListCarrierProducts200ResponseInnerWeightLimits"), exports);
+__exportStar(require("./ListCarriers200Response"), exports);
+__exportStar(require("./ListCarriers200ResponseDataInner"), exports);
+__exportStar(require("./ListCarriers200ResponseDataInnerConfigValue"), exports);
+__exportStar(require("./ListOrders200Response"), exports);
+__exportStar(require("./ListOrders200ResponseDataInner"), exports);
+__exportStar(require("./ListOrders200ResponseDataInnerOrderChannel"), exports);
+__exportStar(require("./ListOrgWebhookDeliveries200Response"), exports);
+__exportStar(require("./ListOrgWebhookDeliveries200ResponseDataInner"), exports);
+__exportStar(require("./ListOrgWebhooks200Response"), exports);
+__exportStar(require("./ListOrgWebhooks200ResponseDataInner"), exports);
+__exportStar(require("./ListShipments200Response"), exports);
+__exportStar(require("./ListShipments200ResponseDataInner"), exports);
+__exportStar(require("./ListShipments200ResponseDataInnerAddress"), exports);
+__exportStar(require("./ListShipments200ResponseDataInnerCarrierSettings"), exports);
+__exportStar(require("./ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue"), exports);
+__exportStar(require("./ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf"), exports);
+__exportStar(require("./ListShippingRules200Response"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInner"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerAdditionalParametersInner"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerCarrier"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInner"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneOf"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneOf1"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneOf2"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneOf3"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerConditionsInnerOneOf4"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerLabelPrinter"), exports);
+__exportStar(require("./ListShippingRules200ResponseDataInnerReturnShippingRule"), exports);
+__exportStar(require("./RevokeApiToken200Response"), exports);
+__exportStar(require("./SendShipment422Response"), exports);
+__exportStar(require("./SendShipment422ResponseErrorsInner"), exports);
+__exportStar(require("./SplitShipment201Response"), exports);
+__exportStar(require("./SplitShipmentParcel200Response"), exports);
+__exportStar(require("./SplitShipmentParcelRequest"), exports);
+__exportStar(require("./SplitShipmentParcelRequestParcelsInner"), exports);
+__exportStar(require("./SplitShipmentRequest"), exports);
+__exportStar(require("./TestOrgWebhook200Response"), exports);
+__exportStar(require("./TrackShipment200Response"), exports);
+__exportStar(require("./TrackShipment200ResponseEventsInner"), exports);
+__exportStar(require("./UpdateAddressRequest"), exports);
+__exportStar(require("./UpdateApiTokenRequest"), exports);
+__exportStar(require("./UpdateCarrierRequest"), exports);
+__exportStar(require("./UpdateOrderRequest"), exports);
+__exportStar(require("./UpdateOrg200Response"), exports);
+__exportStar(require("./UpdateOrgBrandingRequest"), exports);
+__exportStar(require("./UpdateOrgRequest"), exports);
+__exportStar(require("./UpdateOrgWebhookRequest"), exports);
+__exportStar(require("./UpdateShipmentRequest"), exports);
+__exportStar(require("./UpdateShippingRuleRequest"), exports);
+__exportStar(require("./VerifyApiToken200Response"), exports);
+__exportStar(require("./VerifyApiTokenRequest"), exports);

package/dist/runtime.d.ts

@@ -0,0 +1,185 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function anyToJSON(value: any): any;
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}