@shipengine/js-api 0.41.2 → 0.42.0

package/funding-sources/api.d.ts

@@ -1,6 +1,7 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
-import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, MetadataResponse } from "./types";
+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
@@ -47,4 +48,9 @@ export declare class FundingSourcesAPI {
      * 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/types.d.ts

@@ -1,3 +1,4 @@
+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.
@@ -96,6 +97,26 @@ 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: [
         {
@@ -132,4 +153,7 @@ export type AddFundsResponse = {
         currency: string;
     };
 };
+export type FundingSourceTransactionsResponse = {
+    transactions: FundingSourceTransaction[];
+} & PageableResult;
 export {};

package/index.js

@@ -3404,6 +3404,18 @@ class FundingSourcesAPI {
     this.metadata = () => __async$2(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
+    /**
+     * The `transactions` method returns all the transactions of a funding source.
+     * See the FundingSourceTransactions type for more information about return data.
+     */
+    this.transactions = (fundingSourceId, params) => {
+      return this.client.get(
+        `/v1/funding_sources/${fundingSourceId}/transactions`,
+        {
+          params
+        }
+      );
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -3400,6 +3400,18 @@ class FundingSourcesAPI {
     this.metadata = () => __async$2(this, null, function* () {
       return yield this.client.get("/v1/funding_sources/metadata");
     });
+    /**
+     * The `transactions` method returns all the transactions of a funding source.
+     * See the FundingSourceTransactions type for more information about return data.
+     */
+    this.transactions = (fundingSourceId, params) => {
+      return this.client.get(
+        `/v1/funding_sources/${fundingSourceId}/transactions`,
+        {
+          params
+        }
+      );
+    };
     this.client = client;
   }
 }

package/package.json

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