@zippendo/sdk 1.0.0

package/dist/apis/RulesApi.js

@@ -0,0 +1,306 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RulesApi = void 0;
+const runtime = require("../runtime");
+const CreateShippingRule201Response_1 = require("../models/CreateShippingRule201Response");
+const CreateShippingRuleRequest_1 = require("../models/CreateShippingRuleRequest");
+const DeleteShippingRule200Response_1 = require("../models/DeleteShippingRule200Response");
+const ListShippingRules200Response_1 = require("../models/ListShippingRules200Response");
+const ListShippingRules200ResponseDataInner_1 = require("../models/ListShippingRules200ResponseDataInner");
+const UpdateShippingRuleRequest_1 = require("../models/UpdateShippingRuleRequest");
+/**
+ *
+ */
+class RulesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createShippingRule without sending the request
+     */
+    createShippingRuleRequestOpts(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 createShippingRule().');
+            }
+            if (requestParameters['createShippingRuleRequest'] == null) {
+                throw new runtime.RequiredError('createShippingRuleRequest', 'Required parameter "createShippingRuleRequest" was null or undefined when calling createShippingRule().');
+            }
+            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}/shipping-rules`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, CreateShippingRuleRequest_1.CreateShippingRuleRequestToJSON)(requestParameters['createShippingRuleRequest']),
+            };
+        });
+    }
+    /**
+     * Creates a new shipping rule with conditions and carrier product for the organization.
+     * Create shipping rule
+     */
+    createShippingRuleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createShippingRuleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateShippingRule201Response_1.CreateShippingRule201ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Creates a new shipping rule with conditions and carrier product for the organization.
+     * Create shipping rule
+     */
+    createShippingRule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createShippingRuleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteShippingRule without sending the request
+     */
+    deleteShippingRuleRequestOpts(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 deleteShippingRule().');
+            }
+            if (requestParameters['ruleId'] == null) {
+                throw new runtime.RequiredError('ruleId', 'Required parameter "ruleId" was null or undefined when calling deleteShippingRule().');
+            }
+            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}/shipping-rules/{ruleId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{ruleId}', encodeURIComponent(String(requestParameters['ruleId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Deletes a shipping rule belonging to the organization.
+     * Delete shipping rule
+     */
+    deleteShippingRuleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteShippingRuleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, DeleteShippingRule200Response_1.DeleteShippingRule200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Deletes a shipping rule belonging to the organization.
+     * Delete shipping rule
+     */
+    deleteShippingRule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteShippingRuleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getShippingRule without sending the request
+     */
+    getShippingRuleRequestOpts(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 getShippingRule().');
+            }
+            if (requestParameters['ruleId'] == null) {
+                throw new runtime.RequiredError('ruleId', 'Required parameter "ruleId" was null or undefined when calling getShippingRule().');
+            }
+            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}/shipping-rules/{ruleId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{ruleId}', encodeURIComponent(String(requestParameters['ruleId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a single shipping rule with its carrier, address and printer relations.
+     * Get shipping rule
+     */
+    getShippingRuleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getShippingRuleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListShippingRules200ResponseDataInner_1.ListShippingRules200ResponseDataInnerFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a single shipping rule with its carrier, address and printer relations.
+     * Get shipping rule
+     */
+    getShippingRule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getShippingRuleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for listShippingRules without sending the request
+     */
+    listShippingRulesRequestOpts(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 listShippingRules().');
+            }
+            const queryParameters = {};
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            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}/shipping-rules`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of shipping rules for the organization with their relations.
+     * List shipping rules
+     */
+    listShippingRulesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listShippingRulesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ListShippingRules200Response_1.ListShippingRules200ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns a paginated list of shipping rules for the organization with their relations.
+     * List shipping rules
+     */
+    listShippingRules(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listShippingRulesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for updateShippingRule without sending the request
+     */
+    updateShippingRuleRequestOpts(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 updateShippingRule().');
+            }
+            if (requestParameters['ruleId'] == null) {
+                throw new runtime.RequiredError('ruleId', 'Required parameter "ruleId" was null or undefined when calling updateShippingRule().');
+            }
+            if (requestParameters['updateShippingRuleRequest'] == null) {
+                throw new runtime.RequiredError('updateShippingRuleRequest', 'Required parameter "updateShippingRuleRequest" was null or undefined when calling updateShippingRule().');
+            }
+            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}/shipping-rules/{ruleId}`;
+            urlPath = urlPath.replace('{orgId}', encodeURIComponent(String(requestParameters['orgId'])));
+            urlPath = urlPath.replace('{ruleId}', encodeURIComponent(String(requestParameters['ruleId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, UpdateShippingRuleRequest_1.UpdateShippingRuleRequestToJSON)(requestParameters['updateShippingRuleRequest']),
+            };
+        });
+    }
+    /**
+     * Updates an existing shipping rule for the organization.
+     * Update shipping rule
+     */
+    updateShippingRuleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateShippingRuleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CreateShippingRule201Response_1.CreateShippingRule201ResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Updates an existing shipping rule for the organization.
+     * Update shipping rule
+     */
+    updateShippingRule(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateShippingRuleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.RulesApi = RulesApi;

package/dist/apis/ShipmentsApi.d.ts

@@ -0,0 +1,281 @@
+/**
+ * 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 BatchSendShipments200Response } from '../models/BatchSendShipments200Response';
+import { type BatchSendShipmentsRequest } from '../models/BatchSendShipmentsRequest';
+import { type BatchSplitShipment201Response } from '../models/BatchSplitShipment201Response';
+import { type BatchSplitShipmentRequest } from '../models/BatchSplitShipmentRequest';
+import { type CreateShipment201Response } from '../models/CreateShipment201Response';
+import { type CreateShipmentRequest } from '../models/CreateShipmentRequest';
+import { type ListShipments200Response } from '../models/ListShipments200Response';
+import { type RevokeApiToken200Response } from '../models/RevokeApiToken200Response';
+import { type SplitShipment201Response } from '../models/SplitShipment201Response';
+import { type SplitShipmentParcel200Response } from '../models/SplitShipmentParcel200Response';
+import { type SplitShipmentParcelRequest } from '../models/SplitShipmentParcelRequest';
+import { type SplitShipmentRequest } from '../models/SplitShipmentRequest';
+import { type TrackShipment200Response } from '../models/TrackShipment200Response';
+import { type UpdateShipmentRequest } from '../models/UpdateShipmentRequest';
+export interface BatchSendShipmentsOperationRequest {
+    orgId: string;
+    batchSendShipmentsRequest: BatchSendShipmentsRequest;
+}
+export interface BatchSplitShipmentOperationRequest {
+    orgId: string;
+    shipmentId: string;
+    batchSplitShipmentRequest: BatchSplitShipmentRequest;
+}
+export interface CreateReturnShipmentRequest {
+    orgId: string;
+    shipmentId: string;
+}
+export interface CreateShipmentOperationRequest {
+    orgId: string;
+    createShipmentRequest: CreateShipmentRequest;
+}
+export interface DeleteShipmentRequest {
+    orgId: string;
+    shipmentId: string;
+}
+export interface GetShipmentRequest {
+    orgId: string;
+    shipmentId: string;
+}
+export interface GetShipmentDocumentContentRequest {
+    orgId: string;
+    shipmentId: string;
+    documentId: string;
+    disposition?: GetShipmentDocumentContentDispositionEnum;
+    filename?: string;
+}
+export interface ListShipmentsRequest {
+    orgId: string;
+    page?: number;
+    limit?: number;
+}
+export interface SendShipmentRequest {
+    orgId: string;
+    shipmentId: string;
+}
+export interface SplitShipmentOperationRequest {
+    orgId: string;
+    shipmentId: string;
+    splitShipmentRequest: SplitShipmentRequest;
+}
+export interface SplitShipmentParcelOperationRequest {
+    orgId: string;
+    shipmentId: string;
+    splitShipmentParcelRequest: SplitShipmentParcelRequest;
+}
+export interface TrackShipmentRequest {
+    orgId: string;
+    shipmentId: string;
+}
+export interface UpdateShipmentOperationRequest {
+    orgId: string;
+    shipmentId: string;
+    updateShipmentRequest: UpdateShipmentRequest;
+}
+/**
+ *
+ */
+export declare class ShipmentsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for batchSendShipments without sending the request
+     */
+    batchSendShipmentsRequestOpts(requestParameters: BatchSendShipmentsOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
+     * Batch send shipments
+     */
+    batchSendShipmentsRaw(requestParameters: BatchSendShipmentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchSendShipments200Response>>;
+    /**
+     * Book multiple pending/error shipments with their carriers in one request. Each shipment is processed independently and reported in `results`; a failure on one shipment never aborts the others. Use it to send every shipment on an order at once.
+     * Batch send shipments
+     */
+    batchSendShipments(requestParameters: BatchSendShipmentsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchSendShipments200Response>;
+    /**
+     * Creates request options for batchSplitShipment without sending the request
+     */
+    batchSplitShipmentRequestOpts(requestParameters: BatchSplitShipmentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Split a parcel into multiple new shipments with per-line quantities in a single atomic operation. Only draft or pending shipments can be split.
+     * Batch split shipment
+     */
+    batchSplitShipmentRaw(requestParameters: BatchSplitShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BatchSplitShipment201Response>>;
+    /**
+     * Split a parcel into multiple new shipments with per-line quantities in a single atomic operation. Only draft or pending shipments can be split.
+     * Batch split shipment
+     */
+    batchSplitShipment(requestParameters: BatchSplitShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BatchSplitShipment201Response>;
+    /**
+     * Creates request options for createReturnShipment without sending the request
+     */
+    createReturnShipmentRequestOpts(requestParameters: CreateReturnShipmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create return shipment
+     */
+    createReturnShipmentRaw(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
+    /**
+     * Create and auto-send a return shipment from a dispatched outbound shipment with swapped sender/receiver. Requires a configured return shipping rule.
+     * Create return shipment
+     */
+    createReturnShipment(requestParameters: CreateReturnShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
+    /**
+     * Creates request options for createShipment without sending the request
+     */
+    createShipmentRequestOpts(requestParameters: CreateShipmentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
+     * Create shipment
+     */
+    createShipmentRaw(requestParameters: CreateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
+    /**
+     * Create a new shipment for an organization. When orderId is provided, parties and parcels are derived from the order.
+     * Create shipment
+     */
+    createShipment(requestParameters: CreateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
+    /**
+     * Creates request options for deleteShipment without sending the request
+     */
+    deleteShipmentRequestOpts(requestParameters: DeleteShipmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a shipment. Only shipments in pending status can be deleted.
+     * Delete shipment
+     */
+    deleteShipmentRaw(requestParameters: DeleteShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RevokeApiToken200Response>>;
+    /**
+     * Delete a shipment. Only shipments in pending status can be deleted.
+     * Delete shipment
+     */
+    deleteShipment(requestParameters: DeleteShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RevokeApiToken200Response>;
+    /**
+     * Creates request options for getShipment without sending the request
+     */
+    getShipmentRequestOpts(requestParameters: GetShipmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve a single shipment by its ID, including parcels, parties, documents and activity.
+     * Get shipment
+     */
+    getShipmentRaw(requestParameters: GetShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
+    /**
+     * Retrieve a single shipment by its ID, including parcels, parties, documents and activity.
+     * Get shipment
+     */
+    getShipment(requestParameters: GetShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
+    /**
+     * Creates request options for getShipmentDocumentContent without sending the request
+     */
+    getShipmentDocumentContentRequestOpts(requestParameters: GetShipmentDocumentContentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Streams a shipment document or label file from storage.
+     * Download shipment document
+     */
+    getShipmentDocumentContentRaw(requestParameters: GetShipmentDocumentContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Streams a shipment document or label file from storage.
+     * Download shipment document
+     */
+    getShipmentDocumentContent(requestParameters: GetShipmentDocumentContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listShipments without sending the request
+     */
+    listShipmentsRequestOpts(requestParameters: ListShipmentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all shipments for an organization, paginated and ordered by newest first.
+     * List shipments
+     */
+    listShipmentsRaw(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListShipments200Response>>;
+    /**
+     * List all shipments for an organization, paginated and ordered by newest first.
+     * List shipments
+     */
+    listShipments(requestParameters: ListShipmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListShipments200Response>;
+    /**
+     * Creates request options for sendShipment without sending the request
+     */
+    sendShipmentRequestOpts(requestParameters: SendShipmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
+     * Send shipment
+     */
+    sendShipmentRaw(requestParameters: SendShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
+    /**
+     * Book a pending or error shipment with the carrier, generating labels and tracking. Returns 422 with carrier errors if booking fails.
+     * Send shipment
+     */
+    sendShipment(requestParameters: SendShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
+    /**
+     * Creates request options for splitShipment without sending the request
+     */
+    splitShipmentRequestOpts(requestParameters: SplitShipmentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Move order lines from a parcel into a new shipment. Only draft or pending shipments can be split.
+     * Split shipment
+     */
+    splitShipmentRaw(requestParameters: SplitShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SplitShipment201Response>>;
+    /**
+     * Move order lines from a parcel into a new shipment. Only draft or pending shipments can be split.
+     * Split shipment
+     */
+    splitShipment(requestParameters: SplitShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SplitShipment201Response>;
+    /**
+     * Creates request options for splitShipmentParcel without sending the request
+     */
+    splitShipmentParcelRequestOpts(requestParameters: SplitShipmentParcelOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Redistribute order lines across parcels within a shipment, moving lines between parcels and creating new ones. Only draft, pending or error shipments can be modified.
+     * Split parcels
+     */
+    splitShipmentParcelRaw(requestParameters: SplitShipmentParcelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SplitShipmentParcel200Response>>;
+    /**
+     * Redistribute order lines across parcels within a shipment, moving lines between parcels and creating new ones. Only draft, pending or error shipments can be modified.
+     * Split parcels
+     */
+    splitShipmentParcel(requestParameters: SplitShipmentParcelOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SplitShipmentParcel200Response>;
+    /**
+     * Creates request options for trackShipment without sending the request
+     */
+    trackShipmentRequestOpts(requestParameters: TrackShipmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieve the tracking timeline for a shipment, including current status and all carrier events.
+     * Get shipment tracking
+     */
+    trackShipmentRaw(requestParameters: TrackShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TrackShipment200Response>>;
+    /**
+     * Retrieve the tracking timeline for a shipment, including current status and all carrier events.
+     * Get shipment tracking
+     */
+    trackShipment(requestParameters: TrackShipmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TrackShipment200Response>;
+    /**
+     * Creates request options for updateShipment without sending the request
+     */
+    updateShipmentRequestOpts(requestParameters: UpdateShipmentOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an existing shipment. Only draft, pending or error shipments can be updated; an applied shipping rule overrides carrier settings and sender party.
+     * Update shipment
+     */
+    updateShipmentRaw(requestParameters: UpdateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateShipment201Response>>;
+    /**
+     * Update an existing shipment. Only draft, pending or error shipments can be updated; an applied shipping rule overrides carrier settings and sender party.
+     * Update shipment
+     */
+    updateShipment(requestParameters: UpdateShipmentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateShipment201Response>;
+}
+/**
+ * @export
+ */
+export declare const GetShipmentDocumentContentDispositionEnum: {
+    readonly Inline: "inline";
+    readonly Attachment: "attachment";
+};
+export type GetShipmentDocumentContentDispositionEnum = typeof GetShipmentDocumentContentDispositionEnum[keyof typeof GetShipmentDocumentContentDispositionEnum];