@shipengine/js-api 1.0.0-next.4 → 1.0.0

package/funding-sources/api.d.ts

@@ -0,0 +1,56 @@
+import { AxiosInstance } from "axios";
+import { Money } from "../payments";
+import { PageableQuery } from "../resources";
+import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceTransactionsResponse, MetadataResponse } from "./types";
+/**
+ * # Funding Sources API module - /v1/funding_sources
+ * Docs: https://auctane.atlassian.net/wiki/spaces/SE/pages/3628370266/ShipEngine+Funding+Sources+API
+ */
+export declare class FundingSourcesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of funding sources for a given user.
+     */
+    list: () => Promise<import("axios").AxiosResponse<{
+        fundingSources: FundingSource[];
+    }, any>>;
+    /**
+     * The `get` method retrieves a specific funding source by `fundingSourceId`.
+     */
+    get: (fundingSourceId: string) => Promise<import("axios").AxiosResponse<FundingSource, any>>;
+    /**
+     * The `create` method creates a new funding source for a given user. This requires
+     * payment information to be collected from the user.
+     */
+    create: (createFundingSource: CreateFundingSource) => Promise<import("axios").AxiosResponse<{
+        fundingSource: FundingSource;
+    }, any>>;
+    /**
+     * The `update` method updates a funding source for a given user. This allows the
+     * user to update the billing address or payment information associated with the
+     * funding source.
+     */
+    update: (billingInfo: FundingSourceAddress, creditCardInfo: CreditCardInfo, fundingSourceId: string) => Promise<import("axios").AxiosResponse<{
+        fundingSource: FundingSource;
+    }, any>>;
+    /**
+     * The `registerCarrier` method registers a carrier account and associates
+     * it with a given funding source.
+     */
+    registerCarrier: (carrier: CarrierRegistration) => Promise<import("axios").AxiosResponse<CarrierRegistrationResponse, any>>;
+    /**
+     * The `addFunds` method allows you to add funds to a funding source.
+     */
+    addFunds: (amount: Money, fundingSourceId: string) => Promise<import("axios").AxiosResponse<AddFundsResponse, any>>;
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    metadata: () => Promise<import("axios").AxiosResponse<MetadataResponse, any>>;
+    /**
+     * The `transactions` method returns all the transactions of a funding source.
+     * See the FundingSourceTransactions type for more information about return data.
+     */
+    transactions: (fundingSourceId: string, params?: PageableQuery) => Promise<import("axios").AxiosResponse<FundingSourceTransactionsResponse, any>>;
+}

package/funding-sources/index.d.ts

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

package/funding-sources/types.d.ts

@@ -0,0 +1,159 @@
+import { PageableResult } from "../resources";
+/**
+ * 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;
+    defaultCarrierId: string;
+    fundingSourceId: string;
+    paymentMethod: {
+        creditCardInfo: AbbreviatedCreditCardInfo | null;
+    };
+};
+export type AbbreviatedCreditCardInfo = {
+    cardNumberLastFour: string;
+    provider: Provider;
+};
+export type Provider = "visa" | "mastercard" | "americanExpress" | "discover";
+export type FundingSourceCarrier = {
+    acceptedTerms: Term[];
+    agreeToTerms: boolean;
+    carrierCode: string;
+    fundingSourceId: string;
+    iovationBlackBox: IovationBlackBox;
+    pickupAddress?: FundingSourceAddress;
+};
+export interface CarrierRegistration {
+    carriers: FundingSourceCarrier[];
+}
+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",
+    StampsSellerLabelProvider = "stamps_seller_label_provider",
+    Unknown = "unknown"
+}
+export type MetadataRegistrationRequirement = {
+    requirementType: MetadataRequirement;
+    satisfyingFormTypes: MetadataSatisfyingFormTypes[];
+};
+export type TransactionCategory = "adjustment" | "credit" | "debit" | "funds_added" | "insurance" | "label" | "refund" | "service_charge" | "unknown";
+export type FundingSourceTransaction = {
+    description?: string | null;
+    endingBalance: {
+        amount: number;
+        currency: string;
+    };
+    fundingSourceId: string;
+    fundingSourceTransactionId: string;
+    labelIds: string[];
+    relatedFundingSourceTransactionIds: string[];
+    shipmentIds: string[];
+    trackingNumbers: string[];
+    transactionAmount: {
+        amount: number;
+        currency: string;
+    };
+    transactionCategory: TransactionCategory;
+    transactionDate: string;
+};
+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 type FundingSourceTransactionsResponse = {
+    transactions: FundingSourceTransaction[];
+} & PageableResult;
+export {};

package/index.d.ts

@@ -2,19 +2,26 @@ export * as SE from "./types";
 export * from "./account-settings";
 export * from "./addresses";
 export * from "./carriers";
+export * from "./connections";
 export * from "./client";
 export * from "./custom-packages";
 export * from "./dimensions";
 export * from "./errors";
+export * from "./funding-sources";
 export * from "./insurance";
 export * from "./labels";
 export * from "./order-sources";
 export * from "./payments";
 export * from "./rates";
+export * from "./rate-cards";
 export * from "./relay-points";
 export * from "./resources";
 export * from "./sales-order-shipments";
 export * from "./sales-orders";
 export * from "./shipments";
+export * from "./shipping-rules";
+export * from "./utilities";
+export * from "./themes";
 export * from "./warehouses";
 export * from "./weight";
+export * from "./zones";