@myparcel-dev/sdk 4.1.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MyParcel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @myparcel/sdk
+
+[![npm](https://img.shields.io/npm/v/@myparcel/sdk?labelColor=27272A&logoColor=FFFFFF&style=for-the-badge&color=CC3534&logo=npm)](https://www.npmjs.com/package/@myparcel/sdk/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/myparcelnl/js-sdk?labelColor=27272A&style=for-the-badge)](https://github.com/myparcelnl/js-sdk/releases)
+[![codecov](https://codecov.io/gh/myparcelnl/js-sdk/graph/badge.svg?token=sdNcLRMAEn)](https://codecov.io/gh/myparcelnl/js-sdk)
+
+Official JavaScript SDK to connect to the MyParcel API via Node.js or browser.
+
+## Documentation
+
+To the [documentation](https://developer.myparcel.nl/documentation/51.javascript-sdk.html).
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).

package/lib/createMyParcelSdk.d.ts

@@ -0,0 +1,14 @@
+import { type AbstractEndpoint } from './model/endpoint/AbstractEndpoint';
+import { type EndpointResponse, type Options } from './model/client/AbstractClient.types';
+import { type AbstractClient } from './model/client/AbstractClient';
+type EndpointMethod<E extends AbstractEndpoint> = (options?: Options<E>) => Promise<EndpointResponse<E>>;
+export type MyParcelSdk<E extends AbstractEndpoint> = {
+    [K in E['name']]: EndpointMethod<Extract<E, {
+        name: K;
+    }>>;
+};
+/**
+ * Create a sdk instance with a client and given endpoints.
+ */
+export declare function createMyParcelSdk<E extends AbstractEndpoint>(client: AbstractClient, endpoints: E[]): MyParcelSdk<E>;
+export {};

package/lib/createMyParcelSdk.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/createPrivateSdk.d.ts

@@ -0,0 +1,7 @@
+import { type AbstractPrivateEndpoint } from './model/endpoint/AbstractPrivateEndpoint';
+import { type AbstractClient } from './model/client/AbstractClient';
+import { type MyParcelSdk } from './createMyParcelSdk';
+/**
+ * Create a private SDK which requires an Authorization header on all its endpoints.
+ */
+export declare const createPrivateSdk: <E extends AbstractPrivateEndpoint<import("./model").EndpointDefinition>>(client: AbstractClient, endpoints: E[]) => MyParcelSdk<E>;

package/lib/createPrivateSdk.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/createPublicSdk.d.ts

@@ -0,0 +1,7 @@
+import { type AbstractPublicEndpoint } from './model/endpoint/AbstractPublicEndpoint';
+import { type AbstractClient } from './model/client/AbstractClient';
+import { type MyParcelSdk } from './createMyParcelSdk';
+/**
+ * Create a public SDK which does not require Authorization headers and can be used in a browser.
+ */
+export declare const createPublicSdk: <E extends AbstractPublicEndpoint<import("./model").EndpointDefinition>>(client: AbstractClient, endpoints: E[]) => MyParcelSdk<E>;

package/lib/endpoints/endpoints.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/endpoints/index.d.ts

@@ -0,0 +1,2 @@
+export * from './private';
+export * from './public';

package/lib/endpoints/private/account-messages/AccountMessages.types.d.ts

@@ -0,0 +1,6 @@
+export interface MyParcelAccountMessage {
+    id: number;
+    account_id: number;
+    code: number;
+    message: string;
+}

package/lib/endpoints/private/account-messages/DeleteAccountMessage.d.ts

@@ -0,0 +1,19 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type HttpMethod } from '../../../types';
+type DeleteAccountMessageDefinition = CreateDefinition<{
+    name: typeof DeleteAccountMessage.name;
+    path: {
+        id: number;
+    };
+}>;
+/**
+ * Deletes one system message by ID.
+ */
+export declare class DeleteAccountMessage extends AbstractPrivateEndpoint<DeleteAccountMessageDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "deleteAccountMessage";
+    readonly path = "account_messages/:id";
+    readonly property = "messages";
+}
+export {};

package/lib/endpoints/private/account-messages/GetAccountMessages.d.ts

@@ -0,0 +1,19 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type MyParcelAccountMessage } from './AccountMessages.types';
+type GetAccountMessagesDefinition = CreateDefinition<{
+    name: typeof GetAccountMessages.name;
+    parameters: {
+        account_id: number;
+    };
+    response: MyParcelAccountMessage[];
+}>;
+/**
+ * Retrieve system messages.
+ */
+export declare class GetAccountMessages extends AbstractPrivateEndpoint<GetAccountMessagesDefinition> {
+    readonly name = "getAccountMessages";
+    readonly path = "account_messages";
+    readonly property = "messages";
+}
+export {};

package/lib/endpoints/private/account-messages/index.d.ts

@@ -0,0 +1,3 @@
+export * from './AccountMessages.types';
+export * from './DeleteAccountMessage';
+export * from './GetAccountMessages';

package/lib/endpoints/private/accounts/Account.types.d.ts

@@ -0,0 +1,58 @@
+import { type PlatformId } from '@myparcel/constants';
+import { type Address } from '../../../types/common.types';
+import { type PaginationParameters, type IntBoolean, type Price } from '../../../types';
+import { type MyParcelShop } from '../shops/Shop.types';
+export interface AccountAdditionalInfo {
+    ecommerce_platform: string;
+    phone: string;
+    coupon: string;
+}
+export interface AccountSettings {
+    affiliate_bcc: IntBoolean;
+    affiliate_fee: Price;
+    is_test: IntBoolean;
+    order_mode: IntBoolean;
+    order_feature: boolean;
+    order_Settings: {
+        shipment_label: 'apart' | 'nested' | 'none';
+    };
+    show_cumulio_dashboard: IntBoolean;
+    has_carrier_contract: IntBoolean;
+    has_carrier_mail_contract: IntBoolean;
+    has_carrier_small_package_contract: IntBoolean;
+    use_mfa: IntBoolean;
+    postnl_weight_unit_grams: IntBoolean;
+    allow_printerless_return: IntBoolean;
+}
+export type AccountStatus = 1 | 2 | 3 | 4;
+export interface MyParcelAccount {
+    additional_info: AccountAdditionalInfo;
+    carrier_references: [];
+    contact_id: number;
+    contact: Record<string, string>;
+    created: string;
+    delivery_address: null | Address;
+    email: string;
+    first_name: string;
+    gender: string;
+    general_Settings: AccountSettings;
+    id: number;
+    last_name: string;
+    modified: string;
+    origin_id: number;
+    phone: string;
+    platform_id: number;
+    shipment_estimates: Record<string, unknown>;
+    shops: MyParcelShop[];
+    status: AccountStatus;
+    terms_agreed: boolean;
+    username: string;
+    users: Record<string, unknown>;
+}
+export type GetAccountsParams = PaginationParameters & {
+    status?: AccountStatus;
+    from?: string;
+    to?: string;
+    q?: string;
+    platform_id?: PlatformId;
+};

package/lib/endpoints/private/accounts/GetAccount.d.ts

@@ -0,0 +1,19 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type MyParcelAccount } from './Account.types';
+type GetAccountDefinition = CreateDefinition<{
+    name: typeof GetAccount.name;
+    path: {
+        id: number;
+    };
+    response: [MyParcelAccount];
+}>;
+/**
+ * Retrieve a single account object by ID.
+ */
+export declare class GetAccount extends AbstractPrivateEndpoint<GetAccountDefinition> {
+    readonly name = "getAccount";
+    readonly path = "accounts/:id";
+    readonly property = "accounts";
+}
+export {};

package/lib/endpoints/private/accounts/GetAccounts.d.ts

@@ -0,0 +1,13 @@
+import { type GetAccountsParams, type MyParcelAccount } from './Account.types';
+import { AbstractPrivateEndpoint, type CreateDefinition, type PaginatedResponse } from '../../../model';
+type GetAccountsDefinition = CreateDefinition<{
+    name: typeof GetAccounts.name;
+    parameters: GetAccountsParams;
+    response: PaginatedResponse<MyParcelAccount[]>;
+}>;
+export declare class GetAccounts extends AbstractPrivateEndpoint<GetAccountsDefinition> {
+    readonly name = "getAccounts";
+    readonly path = "accounts";
+    readonly property = "accounts";
+}
+export {};

package/lib/endpoints/private/accounts/PutAccount.d.ts

@@ -0,0 +1,18 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type HttpMethod } from '../../../types';
+import { type MyParcelAccount } from './Account.types';
+type PutAccountDefinition = CreateDefinition<{
+    name: typeof PutAccount.name;
+    path: {
+        id: number;
+    };
+    response: MyParcelAccount[];
+}>;
+export declare class PutAccount extends AbstractPrivateEndpoint<PutAccountDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "putAccount";
+    readonly path = "accounts";
+    readonly property = "accounts";
+}
+export {};

package/lib/endpoints/private/accounts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Account.types';
+export * from './GetAccount';
+export * from './GetAccounts';
+export * from './PutAccount';

package/lib/endpoints/private/api-key/ApiKey.types.d.ts

@@ -0,0 +1,12 @@
+export interface MyParcelApiKey {
+    id: number;
+    account_id: number;
+    shop_id: number;
+    status: number;
+    username: string;
+    key: string;
+}
+export interface ApiKeyPostData {
+    account_id: number;
+    shop_id: number;
+}

package/lib/endpoints/private/api-key/GetApiKeys.d.ts

@@ -0,0 +1,16 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type MyParcelApiKey } from './ApiKey.types';
+type GetApiKeysDefinition = CreateDefinition<{
+    name: typeof GetApiKeys.name;
+    response: MyParcelApiKey[];
+}>;
+/**
+ * Retrieve all API keys.
+ */
+export declare class GetApiKeys extends AbstractPrivateEndpoint<GetApiKeysDefinition> {
+    readonly name = "getApiKeys";
+    readonly path = "keys";
+    readonly property = "api_keys";
+}
+export {};

package/lib/endpoints/private/api-key/PostApiKeys.d.ts

@@ -0,0 +1,19 @@
+import { type ApiKeyPostData, type MyParcelApiKey } from './ApiKey.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type HttpMethod } from '../../../types';
+type PostApiKeyDefinition = CreateDefinition<{
+    name: typeof PostApiKeys.name;
+    body: ApiKeyPostData[];
+    response: MyParcelApiKey[];
+}>;
+/**
+ * Submit a single new key.
+ */
+export declare class PostApiKeys extends AbstractPrivateEndpoint<PostApiKeyDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postApiKeys";
+    readonly path = "keys";
+    readonly property = "api_keys";
+}
+export {};

package/lib/endpoints/private/api-key/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ApiKey.types';
+export * from './GetApiKeys';
+export * from './PostApiKeys';

package/lib/endpoints/private/carrier-options/CarrierOption.types.d.ts

@@ -0,0 +1,46 @@
+import { type CarrierId, type CarrierName } from '@myparcel/constants';
+import { type IntBoolean } from '../../../types';
+export type MyParcelCarrierOption = {
+    api_key: string;
+    carrier: {
+        id: CarrierId;
+        name: CarrierName;
+    };
+    carrier_id: CarrierId;
+    enabled: IntBoolean;
+    id: number;
+    optional: IntBoolean;
+    options: {
+        customerCode: string;
+        customerNumber: string;
+        customerCollectionLocation: string;
+        serviceLevels: number;
+        barcodeOptions: {
+            gpType: string;
+            gpRange: string;
+        };
+    };
+    password: string;
+    primary: IntBoolean;
+    type: 'main' | 'custom';
+    username: string;
+    subscription_id?: number;
+    label?: string;
+};
+export type CarrierOptionPostData = {
+    carrier_id: CarrierId;
+    username?: string;
+    password?: string;
+    options?: Record<string, unknown>;
+    api_key?: string;
+};
+export type CarrierOptionPutData = {
+    carrier_id: CarrierId;
+    enabled: IntBoolean;
+};
+export type CarrierOptionsParameters = {
+    enabled?: IntBoolean;
+    carrier_id?: CarrierId | string;
+    subscription_id?: number;
+    type: 'main' | 'custom';
+};

package/lib/endpoints/private/carrier-options/DeleteCarrierOptions.d.ts

@@ -0,0 +1,17 @@
+import { type HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type DeleteCarrierOptionsDefinition = CreateDefinition<{
+    name: typeof DeleteCarrierOptions.name;
+    path: {
+        contract_id: number;
+        account_id: number;
+    };
+}>;
+export declare class DeleteCarrierOptions extends AbstractPrivateEndpoint<DeleteCarrierOptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "deleteCarrierOption";
+    readonly path = "accounts/:account_id/carrier_options/:contract_id";
+    readonly property = "carrier_options";
+}
+export {};

package/lib/endpoints/private/carrier-options/GetCarrierOptions.d.ts

@@ -0,0 +1,17 @@
+import { type MyParcelCarrierOption, type CarrierOptionsParameters } from './CarrierOption.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type GetCarrierOptionsDefinition = CreateDefinition<{
+    name: typeof GetCarrierOptions.name;
+    path: {
+        account_id: number;
+    };
+    parameters: CarrierOptionsParameters;
+    response: MyParcelCarrierOption[];
+}>;
+export declare class GetCarrierOptions extends AbstractPrivateEndpoint<GetCarrierOptionsDefinition> {
+    readonly name = "getCarrierOptions";
+    readonly path = "carrier_management/accounts/:account_id/carrier_options";
+    readonly property = "carrier_options";
+}
+export {};

package/lib/endpoints/private/carrier-options/PostCarrierOptions.d.ts

@@ -0,0 +1,19 @@
+import { type HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CarrierOptionPostData } from './CarrierOption.types';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type PostCarrierOptionsDefinition = CreateDefinition<{
+    name: typeof PostCarrierOptions.name;
+    body: CarrierOptionPostData[];
+    response: {
+        id: number;
+    }[];
+}>;
+export declare class PostCarrierOptions extends AbstractPrivateEndpoint<PostCarrierOptionsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postCarrierOptions";
+    readonly path = "accounts/:account_id/carrier_options";
+    readonly property = "carrier_options";
+    readonly responseProperty = "ids";
+}
+export {};

package/lib/endpoints/private/carrier-options/PutCarrierOptions.d.ts

@@ -0,0 +1,21 @@
+import { type CarrierOptionPutData } from './CarrierOption.types';
+import { type HttpMethod } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type PutCarrierOptionsDefinition = CreateDefinition<{
+    name: typeof PutCarrierOptions.name;
+    path: {
+        account_id: number;
+    };
+    body: CarrierOptionPutData[];
+}>;
+/**
+ * Retrieve carrier options for an account
+ */
+export declare class PutCarrierOptions extends AbstractPrivateEndpoint<PutCarrierOptionsDefinition> {
+    readonly name = "putCarrierOptions";
+    readonly path = "carrier_management/accounts/:account_id/carrier_options";
+    readonly property = "carrier_options";
+    readonly method: HttpMethod;
+}
+export {};

package/lib/endpoints/private/carrier-options/index.d.ts

@@ -0,0 +1,5 @@
+export * from './CarrierOption.types';
+export * from './DeleteCarrierOptions';
+export * from './GetCarrierOptions';
+export * from './PostCarrierOptions';
+export * from './PutCarrierOptions';

package/lib/endpoints/private/index.d.ts

@@ -0,0 +1,13 @@
+export * from './account-messages';
+export * from './accounts';
+export * from './api-key';
+export * from './carrier-options';
+export * from './locations';
+export * from './shipments';
+export * from './shops';
+export * from './subscription-capabilities';
+export * from './subscriptions';
+export * from './system-country-codes';
+export * from './system-messages';
+export * from './track-traces';
+export * from './webhook-subscriptions';

package/lib/endpoints/private/locations/GetLocations.d.ts

@@ -0,0 +1,14 @@
+import { type LocationParameters, type MyParcelLocation } from './Location.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+type GetLocationsDefinition = CreateDefinition<{
+    name: typeof GetLocations.name;
+    parameters: LocationParameters;
+    response: MyParcelLocation[];
+}>;
+export declare class GetLocations extends AbstractPrivateEndpoint<GetLocationsDefinition> {
+    readonly name = "getLocations";
+    readonly path = "locations";
+    readonly property = "locations";
+}
+export {};

package/lib/endpoints/private/locations/Location.types.d.ts

@@ -0,0 +1,9 @@
+export type LocationParameters = {
+    cc: string;
+    postal_code: string;
+    number: string;
+};
+export interface MyParcelLocation {
+    street: string;
+    city: string;
+}

package/lib/endpoints/private/locations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GetLocations';
+export * from './Location.types';

package/lib/endpoints/private/shipments/GetShipment.d.ts

@@ -0,0 +1,19 @@
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type MyParcelShipment } from '../..';
+type GetShipmentDefinition = CreateDefinition<{
+    name: typeof GetShipment.name;
+    path: {
+        id: number;
+    };
+    response: [MyParcelShipment];
+}>;
+/**
+ * Retrieve a single shipment by ID.
+ */
+export declare class GetShipment extends AbstractPrivateEndpoint<GetShipmentDefinition> {
+    readonly name = "getShipment";
+    readonly path = "shipments/:id";
+    readonly property = "shipments";
+}
+export {};

package/lib/endpoints/private/shipments/GetShipments.d.ts

@@ -0,0 +1,22 @@
+import { type PaginationParameters } from '../../../types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition, type PaginatedResponse } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type MyParcelShipment } from '../..';
+type Parameters = PaginationParameters & {
+    carrier?: number;
+    hidden?: boolean;
+};
+type GetShipmentsDefinition = CreateDefinition<{
+    name: typeof GetShipments.name;
+    parameters: Parameters;
+    response: PaginatedResponse<MyParcelShipment[]>;
+}>;
+/**
+ * Retrieve all shipments, or a paginated subset.
+ */
+export declare class GetShipments extends AbstractPrivateEndpoint<GetShipmentsDefinition> {
+    readonly name = "getShipments";
+    readonly path = "shipments";
+    readonly property = "shipments";
+}
+export {};

package/lib/endpoints/private/shipments/PatchShipment.d.ts

@@ -0,0 +1,21 @@
+import { type HttpMethod, type RequestHeaders } from '../../../types/request.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type ShipmentPatchData } from './Shipment.types';
+type PatchShipmentsDefinition = CreateDefinition<{
+    name: typeof PatchShipments.name;
+    body: ShipmentPatchData[];
+}>;
+/**
+ * Patch an existing shipment.
+ *
+ * @see https://developer.myparcel.nl/api-reference/06.shipments.html
+ */
+export declare class PatchShipments extends AbstractPrivateEndpoint<PatchShipmentsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "patchShipments";
+    readonly path = "shipments";
+    readonly property = "shipments";
+    getHeaders(): RequestHeaders;
+}
+export {};

package/lib/endpoints/private/shipments/PostShipments.d.ts

@@ -0,0 +1,23 @@
+import { type HttpMethod, type RequestHeaders } from '../../../types/request.types';
+import { AbstractPrivateEndpoint } from '../../../model/endpoint/AbstractPrivateEndpoint';
+import { type CreateDefinition } from '../../../model/endpoint/AbstractEndpoint.types';
+import { type PostedShipmentReference, type ShipmentPostData } from './Shipment.types';
+type PostShipmentsDefinition = CreateDefinition<{
+    name: typeof PostShipments.name;
+    body: ShipmentPostData[];
+    response: PostedShipmentReference[];
+}>;
+/**
+ * Create a shipment.
+ *
+ * @see https://developer.myparcel.nl/api-reference/06.shipments.html
+ */
+export declare class PostShipments extends AbstractPrivateEndpoint<PostShipmentsDefinition> {
+    readonly method: HttpMethod;
+    readonly name = "postShipments";
+    readonly path = "shipments";
+    readonly property = "shipments";
+    readonly responseProperty = "ids";
+    getHeaders(): RequestHeaders;
+}
+export {};