@shipengine/js-api 0.40.0 → 1.0.0-next.0

package/funding-sources/types.d.ts

@@ -1,135 +0,0 @@
-/**
- * An encoded device fingerprint string containing information about the end-user's computing device such as OS, browser, etc.
- * Required for carrier registration and US Wallet creation.
- */
-type IovationBlackBox = string;
-export type CreateFundingSource = {
-    acceptedTerms: Term[];
-    agreeToTerms: boolean;
-    billingInfo: FundingSourceAddress;
-    iovationBlackBox: IovationBlackBox;
-    paymentMethod: {
-        creditCardInfo: CreditCardInfo;
-    };
-};
-export type FundingSource = {
-    currencyCode: string;
-    fundingSourceId: string;
-    paymentMethod: {
-        creditCardInfo: AbbreviatedCreditCardInfo | null;
-    };
-};
-export type AbbreviatedCreditCardInfo = {
-    cardNumberLastFour: string;
-    provider: Provider;
-};
-export type Provider = "visa" | "mastercard" | "americanExpress" | "discover";
-export interface CarrierRegistration {
-    carriers: [
-        {
-            acceptedTerms: Term[];
-            agreeToTerms: boolean;
-            carrierCode: string;
-            fundingSourceId: string;
-            iovationBlackBox: IovationBlackBox;
-            pickupAddress?: FundingSourceAddress;
-        }
-    ];
-}
-export interface FundingSourceAddress {
-    addressLine1: string;
-    addressLine2?: string;
-    cityLocality: string;
-    company: string;
-    countryCode: string;
-    email: string;
-    fullName: string;
-    phone: string;
-    postalCode: string;
-    stateProvince: string;
-}
-export interface CreditCardInfo {
-    cardNumber: string;
-    cvv: string;
-    expirationMonth: number;
-    expirationYear: number;
-    name: string;
-    provider: Provider;
-}
-export interface Term {
-    termType: string;
-    version: string;
-}
-export type MetadataRequiredTerm = {
-    termType: string;
-    version: string;
-};
-export declare enum MetadataCapability {
-    AutoFunding = "auto_funding",
-    UpdatePaymentMethod = "update_payment_method",
-    DefaultPurchaseAmount = "default_purchase_amount",
-    ReportsLink = "reports_link",
-    BalanceHistory = "balance_history",
-    Nickname = "nickname",
-    RefreshServices = "refresh_services",
-    UpdatePassword = "update_password",
-    AccountSettingsLink = "account_settings_link",
-    Unknown = "unknown"
-}
-export declare enum MetadataRequirement {
-    BillingAddress = "billing_address",
-    CurrencyCode = "currency_code",
-    IovationBlackBox = "iovation_black_box",
-    Nickname = "nickname",
-    PaymentMethod = "payment_method",
-    PickupAddress = "pickup_address",
-    Unknown = "unknown"
-}
-export declare enum MetadataSatisfyingFormTypes {
-    Address = "address",
-    CreditCard = "credit_card",
-    StampsAccountCredentials = "stamps_account_credentials",
-    StampSellerLabelProvider = "stamps_seller_label_provider",
-    Unknown = "unknown"
-}
-export type MetadataRegistrationRequirement = {
-    requirementType: MetadataRequirement;
-    satisfyingFormTypes: MetadataSatisfyingFormTypes[];
-};
-export interface CarrierRegistrationResponse {
-    carrierAttachmentResults: [
-        {
-            carrierId: string;
-            errorMessage: string;
-            fundingSourceId: string;
-            isSuccessful: boolean;
-            nickname: string;
-        }
-    ];
-}
-export interface MetadataResponse {
-    defaultFundingSourceProfile: {
-        capabilities: MetadataCapability[] | null;
-        countryCode: string;
-        currencyCode: string;
-        registrationRequirements: MetadataRegistrationRequirement[];
-        requiredTerms: MetadataRequiredTerm[];
-    };
-    defaultRegionProfile: {
-        carrierProfiles: Array<{
-            capabilities: MetadataCapability[] | null;
-            carrierCode: string;
-            registrationRequirements: MetadataRegistrationRequirement[];
-            requiredTerms: MetadataRequiredTerm[];
-        }>;
-        countryCode: string;
-        currencyCode: string;
-    };
-}
-export type AddFundsResponse = {
-    balance: {
-        amount: number;
-        currency: string;
-    };
-};
-export {};

package/rate-cards/api.d.ts

@@ -1,44 +0,0 @@
-import { AxiosInstance } from "axios";
-import { RateCard, RateCardInput } from "./types";
-/**
- * # Rate Cards API module - /v1/rate_cards
- */
-export declare class RateCardsAPI {
-    private client;
-    constructor(client: AxiosInstance);
-    /**
-     * The `list` method retrieves a list of rate cards for a given list of carrier ID's.
-     */
-    list: (carrierIds: string[]) => Promise<import("axios").AxiosResponse<{
-        rateCards: RateCard[];
-    }, any>>;
-    /**
-     * The `get` method retrieves a specific rate card by `rateCardId`.
-     */
-    get: (rateCardId: string) => Promise<import("axios").AxiosResponse<RateCard, any>>;
-    /**
-     * The `create` method creates a new rate card for a given user.
-     */
-    create: (rateCardInput: RateCardInput) => Promise<import("axios").AxiosResponse<RateCard, any>>;
-    /**
-     * The `update` method updates a specific rate card by `rateCardId` with a new
-     * `RateCard`.
-     */
-    update: (rateCard: RateCard) => Promise<import("axios").AxiosResponse<RateCard, any>>;
-    /**
-     * The `download` method allows for downloading a given rate card by `rateCardId`.
-     */
-    download: (rateCardId: string) => Promise<import("axios").AxiosResponse<Blob, any>>;
-    /**
-     * The `upload` method allows for uploading a given rate card as a spreadsheet file.
-     */
-    upload: (rateCardId: string, file: File) => Promise<import("axios").AxiosResponse<RateCard, any>>;
-    /**
-     * The `publish` method allows for publishing a given rate card by `rateCardId`.
-     */
-    publish: (rateCardId: string) => Promise<import("axios").AxiosResponse<any, any>>;
-    /**
-     * @description https://auctane.atlassian.net/wiki/spaces/TE/pages/3837431603/Inc+1+3.+Rate+Card+Details#Delete-Rate-Card
-     */
-    delete: (rateCardId: string) => Promise<import("axios").AxiosResponse<any, any>>;
-}

package/rate-cards/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./api";
-export * from "./types";

package/rate-cards/types.d.ts

@@ -1,88 +0,0 @@
-import { CarrierService, PackageRatingType } from "../carriers";
-import { Currency } from "../payments";
-import { ISOString } from "../resources";
-import { WeightBandIncremental, WeightBandMinMax } from "../weight-band";
-import { Zone } from "../zones";
-/**
- * @category Entities
- */
-export interface ShipFromLocation {
-    countryCode: string;
-    postalCode?: string;
-}
-/**
- * @category Entities
- */
-export type SurchargeType = "percentage" | "fixed";
-/**
- * @category Entities
- */
-export interface RateSurcharge {
-    name: string;
-    type: SurchargeType;
-    value: number;
-}
-/**
- * @category Entities
- */
-export type RateService = Pick<CarrierService, "serviceCode" | "name"> & {
-    surcharges?: RateSurcharge[];
-    zones?: RateZone[];
-};
-/**
- * @category Entities
- */
-export type RateZone = Zone & {
-    packageTypes?: RatePackageType[];
-    surcharges?: RateSurcharge[];
-};
-/**
- * @category Entities
- */
-export type RateWeightBandMinMax = WeightBandMinMax & {
-    rate?: number;
-};
-/**
- * @category Entities
- */
-export type RateWeightBandIncremental = WeightBandIncremental & {
-    rate?: number;
-};
-/**
- * @category Entities
- */
-export type RatePackageType = Pick<PackageRatingType, "packageId" | "name" | "description" | "dimensions" | "maxWeight" | "carrierPackageTypeCode"> & {
-    weightBands?: {
-        incrementalBands?: RateWeightBandIncremental[];
-        minMaxBands?: RateWeightBandMinMax[];
-    };
-};
-/**
- * @category Entities
- */
-export declare enum RateCardStatus {
-    DRAFT = "Draft",
-    DELETED = "Deleted",
-    PUBLISHED = "Published"
-}
-/**
- * @category Entities
- */
-export interface RateCard {
-    carrierId: string;
-    createdAt?: ISOString;
-    currency?: Currency;
-    endDate?: ISOString;
-    id: string;
-    name: string;
-    publishedAt?: ISOString;
-    services?: RateService[];
-    shipFrom?: ShipFromLocation;
-    startDate?: ISOString;
-    status?: RateCardStatus;
-    surcharges?: RateSurcharge[];
-}
-/**
- * @category Entities
- */
-export type RateCardInput = Partial<RateCard> & Pick<RateCard, "carrierId" | "name">;

package/shipments/api.d.ts

@@ -1,72 +0,0 @@
-import { AxiosInstance } from "axios";
-import { BatchableQuery, CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery, TaggableQuery } from "../resources";
-import { Shipment, ShipmentRateResponse, ShipmentStatus } from "./types";
-/**
- * # Shipments - Get Shipment Rates Options
- */
-export type GetShipmentRatesOptions = {
-    /**
-     * Date to filter rates by (they must be more recent than this date if passed)
-     * @example "2019-03-12T19:24:13.657Z"
-     */
-    createdAtStart?: string;
-    /**
-     * `shipmentId` is the unique identifier of the shipment to retrieve.
-     */
-    shipmentId: string;
-};
-export type ListShipmentOptions = {
-    /**
-     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
-     * orders.
-     */
-    salesOrderId?: string;
-    /**
-     * `shipmentStatus` is the current fulfillment status of the shipment.
-     */
-    shipmentStatus?: ShipmentStatus;
-} & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
-/**
- * # Shipments - List Shipments Result
- */
-export type ListShipmentResult = {
-    /**
-     * `shipments` is an array of shipments to be returned.
-     */
-    shipments: Shipment[];
-} & PageableResult;
-/**
- * # Shipments - Create Shipments Result
- */
-export type CreateShipmentResult = {
-    /**
-     * `hasErrors` is a boolean that indicates if any errors occurred during the
-     * creation of the shipments.
-     */
-    hasErrors: boolean;
-    /**
-     * `shipments` is an array of shipments that were created.
-     */
-    shipments: Shipment[];
-};
-/**
- * # Shipments API module - /v1/shipments
- */
-export declare class ShipmentsAPI {
-    private client;
-    constructor(client: AxiosInstance);
-    /**
-     * The `getShipmentRates` method retrieves rates for a given shipment by
-     * shipment ID.
-     */
-    getShipmentRates: ({ shipmentId, createdAtStart }: GetShipmentRatesOptions) => Promise<import("axios").AxiosResponse<ShipmentRateResponse, any>>;
-    /**
-     * The `list` method retrieves a list of shipments for a given user.
-     */
-    list: (options?: ListShipmentOptions) => Promise<import("axios").AxiosResponse<ListShipmentResult, any>>;
-    /**
-     * The `create` method allows for creating shipments based on a list of shipment
-     * items passed into this method.
-     */
-    create: (...shipments: Partial<Omit<Shipment, "items">>[]) => Promise<import("axios").AxiosResponse<CreateShipmentResult, any>>;
-}

package/shipping-rules/api.d.ts

@@ -1,20 +0,0 @@
-import { AxiosInstance } from "axios";
-import { RequiredFields } from "../types";
-import { ShippingRule } from "./types";
-/**
- * # Shipping Rules API module - /v1/shipping_rules
- */
-export declare class ShippingRulesAPI {
-    private client;
-    constructor(client: AxiosInstance);
-    /**
-     * The `list` method retrieves the list of shipping rules by seller.
-     */
-    list: () => Promise<import("axios").AxiosResponse<{
-        shippingRules: ShippingRule[];
-    }, any>>;
-    /**
-     * The `create` method creates a new shipping rule for a given user.
-     */
-    create: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<RequiredFields<ShippingRule, "id">, any>>;
-}

package/shipping-rules/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./api";
-export * from "./types";

package/shipping-rules/types.d.ts

@@ -1,50 +0,0 @@
-import { ISOString } from "../resources";
-/**
- * @category Entities
- */
-type RuleType = "dimension" | "number_of_packages" | "ship_from_address_residential_indicator" | "ship_from_country_code" | "ship_to_address_residential_indicator" | "ship_to_country_code" | "warehouse_id" | "weight";
-/**
- * @category Entities
- */
-type RuleTypeCondition = "is" | "is_less" | "is_more" | "is_not";
-/**
- * @category Entities
- */
-export interface ShippingRulesConditions {
-    identifier: RuleType;
-    operation: RuleTypeCondition;
-    value: string;
-}
-/**
- * @category Entities
- */
-export interface ShippingRuleSelectedService {
-    carrierId: string;
-    carrierServiceCode: string;
-}
-/**
- * @category Entities
- */
-export interface ShippingRule {
-    active?: boolean;
-    code?: string;
-    createdAt?: ISOString;
-    default: {
-        services: ShippingRuleSelectedService[];
-        sortBy?: string;
-    };
-    deleted?: boolean;
-    deletedAt?: ISOString;
-    id?: string;
-    name: string;
-    rules?: [
-        {
-            conditions: ShippingRulesConditions[];
-            priority: number;
-            services: ShippingRuleSelectedService[];
-            sortBy?: string;
-        }
-    ];
-    updatedAt?: ISOString;
-}
-export {};

package/utilities/index.d.ts

@@ -1 +0,0 @@
-export * from "./ip-address";

package/utilities/ip-address.d.ts

@@ -1 +0,0 @@
-export declare const getEndUserIpAddress: () => Promise<string | undefined>;

package/weight-band/index.d.ts

@@ -1 +0,0 @@
-export * from "./types";

package/weight-band/types.d.ts

@@ -1,17 +0,0 @@
-import { WeightUnit } from "../weight";
-/**
- * @category Entities
- */
-export type WeightBandIncremental = {
-    increment: number;
-    minimum: number;
-    unit: WeightUnit;
-};
-/**
- * @category Entities
- */
-export type WeightBandMinMax = {
-    maximum: number;
-    minimum: number;
-    unit: WeightUnit;
-};

package/zones/index.d.ts

@@ -1 +0,0 @@
-export * from "./types";

package/zones/types.d.ts

@@ -1,7 +0,0 @@
-/**
- * @category Entities
- */
-export type Zone = {
-    name: string;
-    zoneCode: string;
-};