@shipengine/js-api 3.11.0 → 3.12.1

package/auctane-pay/api.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import { CreateSessionRequest, CreateSessionResponse } from "./types";
+/**
+ * # Auctane Pay API module - /internal/auctane_pay
+ *
+ * This module provides access to the Auctane Pay endpoints in ShipEngine API.
+ */
+export declare class AuctanePayAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `createSession` method creates a new payment session.
+     *
+     * @param request - The request object containing the session details
+     * @returns a promise that resolves to the created session
+     */
+    createSession: (request: CreateSessionRequest) => Promise<import("axios").AxiosResponse<CreateSessionResponse, any>>;
+}

package/auctane-pay/index.d.ts

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

package/auctane-pay/types.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @category Entities
+ * Auctane Pay Session can return a lot of metadata, but will always returns the same 5 keys.
+ */
+export interface AuctanePaySessionMetadata {
+    [key: string]: string;
+    adyenClientKey: string;
+    adyenExpiration: string;
+    adyenSessionData: string;
+    adyenSessionId: string;
+    clientKey: string;
+}
+/**
+ * @category Entities
+ * Allowed Payment Method for AuctanePay
+ */
+export type AuctanePayPaymentMethod = "credit_card" | "pay_pal" | "stamps" | "pay_by_bank_us" | "pay_by_bank_eu";
+/**
+ * @category Entities
+ * Note: This is similar to but distinct from the TransactionCategory in funding-sources
+ */
+export type AuctanePayTransactionCategory = "add_funds" | "subscription" | "store";
+/**
+ * @category Entities
+ */
+export interface CreateSessionRequest {
+    /**
+     * URL to redirect after payment session completion
+     * @example "https://dashboard.shipengine.com/?sessionId=:id"
+     */
+    returnUrl?: string;
+    /**
+     * Category of the transaction
+     * @example "add_funds"
+     */
+    transactionCategory: AuctanePayTransactionCategory;
+}
+/**
+ * @category Entities
+ */
+export interface PaymentMethodHolderAddress {
+    /**
+     * Account holder address
+     */
+    accountHolderAddress: {
+        addressLine1: string;
+        addressLine2: string | null;
+        cityLocality: string;
+        countryCode: string;
+        postalCode: string;
+        stateProvince: string;
+    } | null;
+    /**
+     * Account holder name
+     */
+    accountHolderName: string | null;
+    /**
+     * The last four of the account number, this is only provided for bank accounts and card schemes.
+     */
+    accountNumberLastFour: string;
+    /**
+     * An account number preview, for a CC this is the last 4 digits, but shown like 1234.
+     * For an e-mail account it might be ay@auctane.com, etc.
+     */
+    accountNumberPreview: string;
+    /**
+     * If applicable/available, the current expiration we have on file for the payment method.
+     */
+    assignedPreferences: AuctanePayTransactionCategory[];
+    /**
+     * Date the payment method was last used. If the date it was last used is unavailable,
+     * this will be the date created/updated.
+     */
+    dateLastUsed: string;
+    /**
+     * List of processes or payment gateways in which this Payment Method is registered
+     */
+    enrolledProcessors: string[];
+    /**
+     * If applicable/available, the current expiration we have on file for the payment method.
+     */
+    expiration: string;
+    /**
+     * The Payment Method ID
+     */
+    id: string;
+    /**
+     * The nickname of the payment method
+     */
+    nickname: string;
+    /**
+     * Enumeration of supported payment methods.
+     */
+    paymentMethod: "unknown" | "visa" | "mastercard" | "amex" | "discover" | "maestro" | "dinersclub" | "ach" | "jcb" | "pulse" | "star" | "unionpay";
+    /**
+     * The Display Name to show in any text based UI/context for the Logo.
+     */
+    paymentMethodDisplayName: string;
+    /**
+     * Source account ID
+     */
+    sourceAccountId: string;
+}
+/**
+ * @category Entities
+ */
+export interface CreateSessionResponse {
+    /**
+     * Active payment methods
+     */
+    activePaymentMethods: PaymentMethodHolderAddress[];
+    /**
+     * Client key
+     */
+    clientKey: string;
+    /**
+     * Eligible payment method types
+     */
+    eligiblePaymentMethodTypes: AuctanePayPaymentMethod[];
+    /**
+     * The Auctane Pay Internal Session ID, use this ID to request the result of this session
+     * and payment methods created from it.
+     */
+    id: string;
+    /**
+     * Metadata
+     */
+    metadata: AuctanePaySessionMetadata;
+    /**
+     * Recent payment methods
+     */
+    recentPaymentMethods: PaymentMethodHolderAddress[];
+    /** @deprecated */
+    sessionData: string;
+    /** @deprecated */
+    sessionId: string;
+}

package/client.d.ts

@@ -2,6 +2,7 @@ import { AxiosError, AxiosRequestHeaders } from "axios";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
+import { AuctanePayAPI } from "./auctane-pay";
 import { CarriersAPI } from "./carriers";
 import { ConnectionsAPI } from "./connections";
 import { CustomPackagesAPI } from "./custom-packages";
@@ -238,4 +239,11 @@ export declare class ShipEngineAPI {
      * @see {@link SellersAPI | The Sellers API module}
      */
     get sellers(): SellersAPI;
+    /**
+     * The `auctanePay` method provides access to the Auctane Pay endpoints in ShipEngine
+     * API. e.g. Create Payment Session
+     *
+     * @see {@link AuctanePayAPI | The Auctane Pay API module}
+     */
+    get auctanePay(): AuctanePayAPI;
 }

package/index.d.ts

@@ -1,6 +1,7 @@
 export * as SE from "./types";
 export * from "./account-settings";
 export * from "./addresses";
+export * from "./auctane-pay";
 export * from "./carriers";
 export * from "./connections";
 export * from "./client";

package/index.js

@@ -240,6 +240,22 @@ class AddressesAPI {
   }
 }
 
+class AuctanePayAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `createSession` method creates a new payment session.
+     *
+     * @param request - The request object containing the session details
+     * @returns a promise that resolves to the created session
+     */
+    this.createSession = (request) => {
+      return this.client.post("/internal/auctane_pay/sessions", request);
+    };
+    this.client = client;
+  }
+}
+
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
 const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
@@ -21897,10 +21913,20 @@ class ShipEngineAPI {
   get sellers() {
     return new SellersAPI(this.client);
   }
+  /**
+   * The `auctanePay` method provides access to the Auctane Pay endpoints in ShipEngine
+   * API. e.g. Create Payment Session
+   *
+   * @see {@link AuctanePayAPI | The Auctane Pay API module}
+   */
+  get auctanePay() {
+    return new AuctanePayAPI(this.client);
+  }
 }
 
 exports.AccountSettingsAPI = AccountSettingsAPI;
 exports.AddressesAPI = AddressesAPI;
+exports.AuctanePayAPI = AuctanePayAPI;
 exports.CarriersAPI = CarriersAPI;
 exports.CodedError = CodedError;
 exports.ConfirmationType = ConfirmationType;

package/index.mjs

@@ -236,6 +236,22 @@ class AddressesAPI {
   }
 }
 
+class AuctanePayAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `createSession` method creates a new payment session.
+     *
+     * @param request - The request object containing the session details
+     * @returns a promise that resolves to the created session
+     */
+    this.createSession = (request) => {
+      return this.client.post("/internal/auctane_pay/sessions", request);
+    };
+    this.client = client;
+  }
+}
+
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
 const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
@@ -21893,6 +21909,15 @@ class ShipEngineAPI {
   get sellers() {
     return new SellersAPI(this.client);
   }
+  /**
+   * The `auctanePay` method provides access to the Auctane Pay endpoints in ShipEngine
+   * API. e.g. Create Payment Session
+   *
+   * @see {@link AuctanePayAPI | The Auctane Pay API module}
+   */
+  get auctanePay() {
+    return new AuctanePayAPI(this.client);
+  }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "3.11.0",
+  "version": "3.12.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/types.d.ts

@@ -2,6 +2,7 @@ export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export * from "./account-settings/types";
 export * from "./account-billing-plan/types";
 export * from "./addresses/types";
+export * from "./auctane-pay/types";
 export * from "./carriers/types";
 export * from "./connections/types";
 export * from "./custom-packages/types";