@payabli/sdk-node 0.0.144 → 0.0.146
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/query/client/Client.d.ts +58 -0
- package/dist/cjs/api/resources/query/client/Client.js +160 -0
- package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListSubscriptionsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsOrgRequest.d.ts +9 -0
- package/dist/cjs/api/resources/query/client/requests/ListTransactionsRequest.d.ts +9 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +8 -6
- package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +8 -6
- package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.ts +72 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.ts +72 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsTransactionsRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListVendorsOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListVendorsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryTransferDetailResponse.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryTransferSummary.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.ts +49 -0
- package/dist/cjs/api/resources/queryTypes/types/VCardTransactionQueryResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.d.ts +86 -0
- package/dist/cjs/api/resources/queryTypes/types/VCardTransactionRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
- package/dist/cjs/api/types/CustomerQueryRecords.d.ts +2 -0
- package/dist/cjs/api/types/QueryResponseTransactions.d.ts +74 -0
- package/dist/cjs/api/types/SplitCount.d.ts +4 -0
- package/dist/cjs/api/types/SplitCount.js +3 -0
- package/dist/cjs/api/types/SubscriptionQueryRecords.d.ts +10 -0
- package/dist/cjs/api/types/TransactionQueryRecords.d.ts +1 -0
- package/dist/cjs/api/types/TransactionQueryRecordsCustomer.d.ts +1 -0
- package/dist/cjs/api/types/VCardSummary.d.ts +4 -2
- package/dist/cjs/api/types/VendorResponseStoredMethod.d.ts +2 -1
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/query/client/Client.d.mts +58 -0
- package/dist/esm/api/resources/query/client/Client.mjs +160 -0
- package/dist/esm/api/resources/query/client/requests/ListSubscriptionsOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListSubscriptionsRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListTransactionsOrgRequest.d.mts +9 -0
- package/dist/esm/api/resources/query/client/requests/ListTransactionsRequest.d.mts +9 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +8 -6
- package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +8 -6
- package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.d.mts +72 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.d.mts +72 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsTransactionsRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListVendorsOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListVendorsRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/QueryTransferDetailResponse.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/QueryTransferSummary.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.d.mts +49 -0
- package/dist/esm/api/resources/queryTypes/types/VCardTransactionQueryResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.d.mts +86 -0
- package/dist/esm/api/resources/queryTypes/types/VCardTransactionRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
- package/dist/esm/api/types/CustomerQueryRecords.d.mts +2 -0
- package/dist/esm/api/types/QueryResponseTransactions.d.mts +74 -0
- package/dist/esm/api/types/SplitCount.d.mts +4 -0
- package/dist/esm/api/types/SplitCount.mjs +2 -0
- package/dist/esm/api/types/SubscriptionQueryRecords.d.mts +10 -0
- package/dist/esm/api/types/TransactionQueryRecords.d.mts +1 -0
- package/dist/esm/api/types/TransactionQueryRecordsCustomer.d.mts +1 -0
- package/dist/esm/api/types/VCardSummary.d.mts +4 -2
- package/dist/esm/api/types/VendorResponseStoredMethod.d.mts +2 -1
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +150 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Response body for queries about virtual card transactions.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* Summary: {
|
|
8
|
+
* totalPages: 20,
|
|
9
|
+
* totalRecords: 393,
|
|
10
|
+
* totalAmount: 231.58,
|
|
11
|
+
* totalactive: 388,
|
|
12
|
+
* totalamountactive: 219.58,
|
|
13
|
+
* totalbalanceactive: -213.83
|
|
14
|
+
* },
|
|
15
|
+
* Records: [{
|
|
16
|
+
* Identifier: "7HQ2P9B4XD",
|
|
17
|
+
* CardToken: "5RJ8MN2KC4",
|
|
18
|
+
* LastFour: "1234",
|
|
19
|
+
* ExpirationDate: "06-30-2029",
|
|
20
|
+
* Mcc: "5943",
|
|
21
|
+
* PayoutId: 84210,
|
|
22
|
+
* CustomerId: 1542,
|
|
23
|
+
* VendorId: 9821,
|
|
24
|
+
* MiscData1: "Invoice #12345",
|
|
25
|
+
* MiscData2: "Project: Office Supplies",
|
|
26
|
+
* CurrentUses: 1,
|
|
27
|
+
* Amount: 500,
|
|
28
|
+
* Balance: 425.5,
|
|
29
|
+
* PaypointId: 236,
|
|
30
|
+
* PaypointLegal: "Global Factory LLC",
|
|
31
|
+
* PaypointDba: "Global Factory",
|
|
32
|
+
* ExternalPaypointID: "pay-10",
|
|
33
|
+
* OrgName: "SupplyPro",
|
|
34
|
+
* Type: "AUTHORIZATION",
|
|
35
|
+
* Status: "AUTHORIZATION",
|
|
36
|
+
* CreatedOn: "2026-05-05 03:28:53.082830",
|
|
37
|
+
* TransactionAmount: "74.500",
|
|
38
|
+
* PostedAmount: "0.000",
|
|
39
|
+
* PostedOn: null,
|
|
40
|
+
* MerchantName: "Office Supply Co.",
|
|
41
|
+
* AuthorizationStatus: "AUTHORIZATION",
|
|
42
|
+
* ReasonToDecline: null
|
|
43
|
+
* }]
|
|
44
|
+
* }
|
|
45
|
+
*/
|
|
46
|
+
export interface VCardTransactionQueryResponse {
|
|
47
|
+
Summary: Payabli.VCardSummary;
|
|
48
|
+
Records: Payabli.VCardTransactionRecord[];
|
|
49
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* A virtual card transaction record returned by the query.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* Identifier: "7HQ2P9B4XD",
|
|
8
|
+
* CardToken: "5RJ8MN2KC4",
|
|
9
|
+
* LastFour: "1234",
|
|
10
|
+
* ExpirationDate: "06-30-2029",
|
|
11
|
+
* Mcc: "5943",
|
|
12
|
+
* PayoutId: 84210,
|
|
13
|
+
* CustomerId: 1542,
|
|
14
|
+
* VendorId: 9821,
|
|
15
|
+
* MiscData1: "Invoice #12345",
|
|
16
|
+
* MiscData2: "Project: Office Supplies",
|
|
17
|
+
* CurrentUses: 1,
|
|
18
|
+
* Amount: 500,
|
|
19
|
+
* Balance: 425.5,
|
|
20
|
+
* PaypointId: 236,
|
|
21
|
+
* PaypointLegal: "Global Factory LLC",
|
|
22
|
+
* PaypointDba: "Global Factory",
|
|
23
|
+
* ExternalPaypointID: "pay-10",
|
|
24
|
+
* OrgName: "SupplyPro",
|
|
25
|
+
* Type: "AUTHORIZATION",
|
|
26
|
+
* Status: "AUTHORIZATION",
|
|
27
|
+
* CreatedOn: "2026-05-05 03:28:53.082830",
|
|
28
|
+
* TransactionAmount: "74.500",
|
|
29
|
+
* PostedAmount: "0.000",
|
|
30
|
+
* PostedOn: null,
|
|
31
|
+
* MerchantName: "Office Supply Co.",
|
|
32
|
+
* AuthorizationStatus: "AUTHORIZATION",
|
|
33
|
+
* ReasonToDecline: null
|
|
34
|
+
* }
|
|
35
|
+
*/
|
|
36
|
+
export interface VCardTransactionRecord {
|
|
37
|
+
/** Unique identifier for the transaction. */
|
|
38
|
+
Identifier: string | null;
|
|
39
|
+
/** Token of the virtual card associated with the transaction. */
|
|
40
|
+
CardToken: string | null;
|
|
41
|
+
/** Last four digits of the masked virtual card number. */
|
|
42
|
+
LastFour: string | null;
|
|
43
|
+
/** Expiration date of the virtual card used for the transaction. */
|
|
44
|
+
ExpirationDate: string | null;
|
|
45
|
+
Mcc: Payabli.Mcc | null;
|
|
46
|
+
/** Identifier of the payout linked to this transaction. */
|
|
47
|
+
PayoutId: number | null;
|
|
48
|
+
/** Identifier of the customer linked to this transaction. */
|
|
49
|
+
CustomerId: number | null;
|
|
50
|
+
/** Identifier of the vendor linked to this transaction. */
|
|
51
|
+
VendorId: number | null;
|
|
52
|
+
/** Custom field 1 from the virtual card. */
|
|
53
|
+
MiscData1: string | null;
|
|
54
|
+
/** Custom field 2 from the virtual card. */
|
|
55
|
+
MiscData2: string | null;
|
|
56
|
+
/** Number of times the virtual card has been used. */
|
|
57
|
+
CurrentUses: number | null;
|
|
58
|
+
/** Authorized amount on the virtual card. */
|
|
59
|
+
Amount: number | null;
|
|
60
|
+
/** Current balance remaining on the virtual card. */
|
|
61
|
+
Balance: number | null;
|
|
62
|
+
/** Numeric identifier of the paypoint that issued the virtual card. */
|
|
63
|
+
PaypointId: number | null;
|
|
64
|
+
PaypointLegal: Payabli.Legalname | null;
|
|
65
|
+
PaypointDba: Payabli.Dbaname | null;
|
|
66
|
+
ExternalPaypointID: Payabli.ExternalPaypointId | null;
|
|
67
|
+
OrgName: Payabli.OrgParentName | null;
|
|
68
|
+
/** Transaction type, such as `AUTHORIZATION`. */
|
|
69
|
+
Type: string | null;
|
|
70
|
+
/** Transaction status, such as `AUTHORIZATION`. */
|
|
71
|
+
Status: string | null;
|
|
72
|
+
/** Date and time the transaction was created. Format: `YYYY-MM-DD HH:MM:SS.ffffff`. */
|
|
73
|
+
CreatedOn: string | null;
|
|
74
|
+
/** Amount of the transaction, as a string value. */
|
|
75
|
+
TransactionAmount: string | null;
|
|
76
|
+
/** Posted amount of the transaction, as a string value. */
|
|
77
|
+
PostedAmount: string | null;
|
|
78
|
+
/** Date and time the transaction was posted, in format `YYYY-MM-DD HH:MM:SS.ffffff`. Null when the transaction hasn't posted yet. */
|
|
79
|
+
PostedOn: string | null;
|
|
80
|
+
/** Name of the merchant where the virtual card was used. */
|
|
81
|
+
MerchantName: string | null;
|
|
82
|
+
/** Authorization status of the transaction. */
|
|
83
|
+
AuthorizationStatus: string | null;
|
|
84
|
+
/** Reason the transaction was declined, when applicable. */
|
|
85
|
+
ReasonToDecline: string | null;
|
|
86
|
+
}
|
|
@@ -24,3 +24,5 @@ export * from "./TransferOutMessageProperties.js";
|
|
|
24
24
|
export * from "./TransferOutQueryResponse.js";
|
|
25
25
|
export * from "./TransferOutRecord.js";
|
|
26
26
|
export * from "./TransferOutSummary.js";
|
|
27
|
+
export * from "./VCardTransactionQueryResponse.js";
|
|
28
|
+
export * from "./VCardTransactionRecord.js";
|
|
@@ -40,3 +40,5 @@ __exportStar(require("./TransferOutMessageProperties.js"), exports);
|
|
|
40
40
|
__exportStar(require("./TransferOutQueryResponse.js"), exports);
|
|
41
41
|
__exportStar(require("./TransferOutRecord.js"), exports);
|
|
42
42
|
__exportStar(require("./TransferOutSummary.js"), exports);
|
|
43
|
+
__exportStar(require("./VCardTransactionQueryResponse.js"), exports);
|
|
44
|
+
__exportStar(require("./VCardTransactionRecord.js"), exports);
|
|
@@ -104,6 +104,7 @@ import type * as Payabli from "../index.js";
|
|
|
104
104
|
* PayorId: 1551,
|
|
105
105
|
* PaypointId: 226,
|
|
106
106
|
* SettlementStatus: 2,
|
|
107
|
+
* splitCount: 0,
|
|
107
108
|
* TotalAmount: 30.22,
|
|
108
109
|
* TransStatus: 1
|
|
109
110
|
* }],
|
|
@@ -160,6 +161,7 @@ import type * as Payabli from "../index.js";
|
|
|
160
161
|
* PayorId: 1551,
|
|
161
162
|
* PaypointId: 226,
|
|
162
163
|
* SettlementStatus: 2,
|
|
164
|
+
* splitCount: 0,
|
|
163
165
|
* TotalAmount: 30.22,
|
|
164
166
|
* TransStatus: 1
|
|
165
167
|
* }],
|
|
@@ -1,6 +1,80 @@
|
|
|
1
1
|
import type * as Payabli from "../index.js";
|
|
2
2
|
/**
|
|
3
3
|
* Response payload for queries related to transactions
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* Records: [{
|
|
8
|
+
* ParentOrgName: "RealistRoofing",
|
|
9
|
+
* PaypointDbaname: "Eagle-Pointe",
|
|
10
|
+
* PaypointLegalname: "Eagle-Pointe",
|
|
11
|
+
* PaypointEntryname: "entry399",
|
|
12
|
+
* PaymentTransId: "399-8e7e5fc7-f483-43cc-9e78-d8a36ac857bf",
|
|
13
|
+
* ConnectorName: "GP",
|
|
14
|
+
* Method: "card",
|
|
15
|
+
* PayorId: 155974,
|
|
16
|
+
* PaymentData: {
|
|
17
|
+
* MaskedAccount: "5XXXXXXXXXXX4415",
|
|
18
|
+
* AccountExp: "12/29",
|
|
19
|
+
* HolderName: "RENEE DESCARTES",
|
|
20
|
+
* binData: {
|
|
21
|
+
* binMatchedLength: "9",
|
|
22
|
+
* binCardBrand: "MASTERCARD",
|
|
23
|
+
* binCardType: "CREDIT",
|
|
24
|
+
* binCardCategory: "MIXED PRODUCT",
|
|
25
|
+
* binCardIssuer: "ALLIED IRISH BANKS, PLC",
|
|
26
|
+
* binCardIssuerCountry: "IRELAND",
|
|
27
|
+
* binCardIsRegulated: "False",
|
|
28
|
+
* binCardUseCategory: "PERSONAL"
|
|
29
|
+
* },
|
|
30
|
+
* paymentDetails: {
|
|
31
|
+
* totalAmount: 6.79,
|
|
32
|
+
* serviceFee: 0,
|
|
33
|
+
* currency: "USD"
|
|
34
|
+
* }
|
|
35
|
+
* },
|
|
36
|
+
* TransStatus: -4,
|
|
37
|
+
* PaypointId: 399,
|
|
38
|
+
* splitFundingInstructions: [{}],
|
|
39
|
+
* splitCount: 1,
|
|
40
|
+
* TotalAmount: -6.79,
|
|
41
|
+
* NetAmount: -6.79,
|
|
42
|
+
* FeeAmount: 0,
|
|
43
|
+
* SettlementStatus: 0,
|
|
44
|
+
* Operation: "Reject",
|
|
45
|
+
* Source: "api",
|
|
46
|
+
* OrgId: 39,
|
|
47
|
+
* TransactionTime: "2026-03-02T18:56:23.109188",
|
|
48
|
+
* Customer: {
|
|
49
|
+
* FirstName: "Blaise",
|
|
50
|
+
* LastName: "Pascal",
|
|
51
|
+
* CompanyName: "Pensees LLC",
|
|
52
|
+
* BillingAddress1: "49912 Aufengrupt Pointe",
|
|
53
|
+
* BillingAddress2: "apt 6",
|
|
54
|
+
* BillingCity: "South Litzy",
|
|
55
|
+
* BillingState: "FL",
|
|
56
|
+
* BillingZip: "33000",
|
|
57
|
+
* BillingCountry: "US",
|
|
58
|
+
* BillingPhone: "+18955791994",
|
|
59
|
+
* BillingEmail: "blaise.pascal@gmail.com",
|
|
60
|
+
* CustomerNumber: "o99t",
|
|
61
|
+
* customerId: 155974,
|
|
62
|
+
* customerStatus: 1
|
|
63
|
+
* },
|
|
64
|
+
* TransactionEvents: [{
|
|
65
|
+
* TransEvent: "Created",
|
|
66
|
+
* EventData: "Card Reject - CTDR Id: 1379241",
|
|
67
|
+
* EventTime: "2026-03-02T18:56:23.352035"
|
|
68
|
+
* }]
|
|
69
|
+
* }],
|
|
70
|
+
* Summary: {
|
|
71
|
+
* totalRecords: 14,
|
|
72
|
+
* totalAmount: -79.48,
|
|
73
|
+
* totalNetAmount: -74.41,
|
|
74
|
+
* totalPages: 14,
|
|
75
|
+
* pageSize: 1
|
|
76
|
+
* }
|
|
77
|
+
* }
|
|
4
78
|
*/
|
|
5
79
|
export interface QueryResponseTransactions {
|
|
6
80
|
Records?: Payabli.TransactionQueryRecords[] | undefined;
|
|
@@ -40,6 +40,16 @@ export interface SubscriptionQueryRecords {
|
|
|
40
40
|
Source?: Payabli.Source | undefined;
|
|
41
41
|
/** The subscription start date. */
|
|
42
42
|
StartDate: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* The full stored payment method record linked to the subscription
|
|
45
|
+
* and charged on each billing cycle. Returned as `null` for legacy
|
|
46
|
+
* subscriptions that don't have a linked stored method.
|
|
47
|
+
*
|
|
48
|
+
* The shape is the same across payment vehicles (card, ACH, check).
|
|
49
|
+
* Only the populated fields differ. For example, `ABA` is populated
|
|
50
|
+
* for ACH, while `ExpDate` and `binData` are populated for card.
|
|
51
|
+
*/
|
|
52
|
+
StoredMethod: Payabli.VendorResponseStoredMethod | null;
|
|
43
53
|
/** Events associated with the subscription. */
|
|
44
54
|
SubEvents?: Payabli.GeneralEvents[] | undefined;
|
|
45
55
|
/**
|
|
@@ -48,6 +48,7 @@ export interface TransactionQueryRecords {
|
|
|
48
48
|
SettlementStatus?: number | undefined;
|
|
49
49
|
Source?: Payabli.Source | undefined;
|
|
50
50
|
splitFundingInstructions?: Payabli.SplitFunding | undefined;
|
|
51
|
+
splitCount: Payabli.SplitCount;
|
|
51
52
|
/** Transaction total amount (including service fee or sub-charge) */
|
|
52
53
|
TotalAmount?: number | undefined;
|
|
53
54
|
/** Events associated with this transaction. */
|
|
@@ -48,6 +48,7 @@ export interface TransactionQueryRecordsCustomer {
|
|
|
48
48
|
SettlementStatus?: number | undefined;
|
|
49
49
|
Source?: Payabli.Source | undefined;
|
|
50
50
|
splitFundingInstructions?: Payabli.SplitFunding | undefined;
|
|
51
|
+
splitCount: Payabli.SplitCount;
|
|
51
52
|
/** Transaction total amount (including service fee or sub-charge) */
|
|
52
53
|
TotalAmount?: number | undefined;
|
|
53
54
|
/** Events associated with this transaction. */
|
|
@@ -4,12 +4,14 @@ export interface VCardSummary {
|
|
|
4
4
|
totalRecords: Payabli.Totalrecords;
|
|
5
5
|
/** Total amount for the records. */
|
|
6
6
|
totalAmount: number;
|
|
7
|
+
/** Total net amount for the records. */
|
|
8
|
+
totalNetAmount?: number | undefined;
|
|
7
9
|
/** Total number of active vCards. */
|
|
8
10
|
totalactive: number;
|
|
9
11
|
/** Total amount of active vCards. */
|
|
10
|
-
|
|
12
|
+
totalamountactive: number;
|
|
11
13
|
/** Total balance of active vCards. */
|
|
12
14
|
totalbalanceactive: number;
|
|
13
|
-
|
|
15
|
+
pageidentifier?: Payabli.PageIdentifier | undefined;
|
|
14
16
|
pageSize?: Payabli.Pagesize | undefined;
|
|
15
17
|
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Payabli from "../index.js";
|
|
1
2
|
/**
|
|
2
3
|
* Stored payment method information
|
|
3
4
|
*/
|
|
@@ -12,7 +13,7 @@ export interface VendorResponseStoredMethod {
|
|
|
12
13
|
AchHolderType: string | null;
|
|
13
14
|
IsValidatedACH: boolean | null;
|
|
14
15
|
BIN: string | null;
|
|
15
|
-
binData:
|
|
16
|
+
binData: Payabli.BinData | null;
|
|
16
17
|
ABA: string | null;
|
|
17
18
|
PostalCode: string | null;
|
|
18
19
|
MethodType: string | null;
|
|
@@ -503,6 +503,7 @@ export * from "./SignerSsn.js";
|
|
|
503
503
|
export * from "./SignerState.js";
|
|
504
504
|
export * from "./SignerZip.js";
|
|
505
505
|
export * from "./Source.js";
|
|
506
|
+
export * from "./SplitCount.js";
|
|
506
507
|
export * from "./SplitFunding.js";
|
|
507
508
|
export * from "./SplitFundingContent.js";
|
|
508
509
|
export * from "./SplitFundingRefundContent.js";
|
|
@@ -519,6 +519,7 @@ __exportStar(require("./SignerSsn.js"), exports);
|
|
|
519
519
|
__exportStar(require("./SignerState.js"), exports);
|
|
520
520
|
__exportStar(require("./SignerZip.js"), exports);
|
|
521
521
|
__exportStar(require("./Source.js"), exports);
|
|
522
|
+
__exportStar(require("./SplitCount.js"), exports);
|
|
522
523
|
__exportStar(require("./SplitFunding.js"), exports);
|
|
523
524
|
__exportStar(require("./SplitFundingContent.js"), exports);
|
|
524
525
|
__exportStar(require("./SplitFundingRefundContent.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.146";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "@payabli/sdk-node",
|
|
9
|
-
"X-Fern-SDK-Version": "0.0.
|
|
10
|
-
"User-Agent": "@payabli/sdk-node/0.0.
|
|
9
|
+
"X-Fern-SDK-Version": "0.0.146",
|
|
10
|
+
"User-Agent": "@payabli/sdk-node/0.0.146",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
|
@@ -581,6 +581,14 @@ export declare class QueryClient {
|
|
|
581
581
|
* limitRecord: 0,
|
|
582
582
|
* sortBy: "desc(field_name)"
|
|
583
583
|
* })
|
|
584
|
+
*
|
|
585
|
+
* @example
|
|
586
|
+
* await client.query.listTransactions("8cfec329267", {
|
|
587
|
+
* limitRecord: 1,
|
|
588
|
+
* parameters: {
|
|
589
|
+
* "operation(eq)": "Reject"
|
|
590
|
+
* }
|
|
591
|
+
* })
|
|
584
592
|
*/
|
|
585
593
|
listTransactions(entry: Payabli.Entry, request?: Payabli.ListTransactionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryResponseTransactions>;
|
|
586
594
|
private __listTransactions;
|
|
@@ -615,6 +623,14 @@ export declare class QueryClient {
|
|
|
615
623
|
* limitRecord: 0,
|
|
616
624
|
* sortBy: "desc(field_name)"
|
|
617
625
|
* })
|
|
626
|
+
*
|
|
627
|
+
* @example
|
|
628
|
+
* await client.query.listTransactionsOrg(123, {
|
|
629
|
+
* limitRecord: 1,
|
|
630
|
+
* parameters: {
|
|
631
|
+
* "operation(eq)": "Reject"
|
|
632
|
+
* }
|
|
633
|
+
* })
|
|
618
634
|
*/
|
|
619
635
|
listTransactionsOrg(orgId: number, request?: Payabli.ListTransactionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryResponseTransactions>;
|
|
620
636
|
private __listTransactionsOrg;
|
|
@@ -842,6 +858,48 @@ export declare class QueryClient {
|
|
|
842
858
|
*/
|
|
843
859
|
listVcards(entry: Payabli.Entry, request?: Payabli.ListVcardsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardQueryResponse>;
|
|
844
860
|
private __listVcards;
|
|
861
|
+
/**
|
|
862
|
+
* Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
|
|
863
|
+
*
|
|
864
|
+
* @param {Payabli.Entry} entry
|
|
865
|
+
* @param {Payabli.ListVcardsTransactionsRequest} request
|
|
866
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
867
|
+
*
|
|
868
|
+
* @throws {@link Payabli.BadRequestError}
|
|
869
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
870
|
+
* @throws {@link Payabli.InternalServerError}
|
|
871
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
872
|
+
*
|
|
873
|
+
* @example
|
|
874
|
+
* await client.query.listVcardsTransactions("8cfec329267", {
|
|
875
|
+
* fromRecord: 0,
|
|
876
|
+
* limitRecord: 20,
|
|
877
|
+
* sortBy: "desc(CreatedOn)"
|
|
878
|
+
* })
|
|
879
|
+
*/
|
|
880
|
+
listVcardsTransactions(entry: Payabli.Entry, request?: Payabli.ListVcardsTransactionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardTransactionQueryResponse>;
|
|
881
|
+
private __listVcardsTransactions;
|
|
882
|
+
/**
|
|
883
|
+
* Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
|
|
884
|
+
*
|
|
885
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
886
|
+
* @param {Payabli.ListVcardsTransactionsOrgRequest} request
|
|
887
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
888
|
+
*
|
|
889
|
+
* @throws {@link Payabli.BadRequestError}
|
|
890
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
891
|
+
* @throws {@link Payabli.InternalServerError}
|
|
892
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
893
|
+
*
|
|
894
|
+
* @example
|
|
895
|
+
* await client.query.listVcardsTransactionsOrg(123, {
|
|
896
|
+
* fromRecord: 0,
|
|
897
|
+
* limitRecord: 20,
|
|
898
|
+
* sortBy: "desc(CreatedOn)"
|
|
899
|
+
* })
|
|
900
|
+
*/
|
|
901
|
+
listVcardsTransactionsOrg(orgId: number, request?: Payabli.ListVcardsTransactionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.VCardTransactionQueryResponse>;
|
|
902
|
+
private __listVcardsTransactionsOrg;
|
|
845
903
|
/**
|
|
846
904
|
* Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
847
905
|
*
|
|
@@ -1873,6 +1873,14 @@ export class QueryClient {
|
|
|
1873
1873
|
* limitRecord: 0,
|
|
1874
1874
|
* sortBy: "desc(field_name)"
|
|
1875
1875
|
* })
|
|
1876
|
+
*
|
|
1877
|
+
* @example
|
|
1878
|
+
* await client.query.listTransactions("8cfec329267", {
|
|
1879
|
+
* limitRecord: 1,
|
|
1880
|
+
* parameters: {
|
|
1881
|
+
* "operation(eq)": "Reject"
|
|
1882
|
+
* }
|
|
1883
|
+
* })
|
|
1876
1884
|
*/
|
|
1877
1885
|
listTransactions(entry, request = {}, requestOptions) {
|
|
1878
1886
|
return core.HttpResponsePromise.fromPromise(this.__listTransactions(entry, request, requestOptions));
|
|
@@ -1956,6 +1964,14 @@ export class QueryClient {
|
|
|
1956
1964
|
* limitRecord: 0,
|
|
1957
1965
|
* sortBy: "desc(field_name)"
|
|
1958
1966
|
* })
|
|
1967
|
+
*
|
|
1968
|
+
* @example
|
|
1969
|
+
* await client.query.listTransactionsOrg(123, {
|
|
1970
|
+
* limitRecord: 1,
|
|
1971
|
+
* parameters: {
|
|
1972
|
+
* "operation(eq)": "Reject"
|
|
1973
|
+
* }
|
|
1974
|
+
* })
|
|
1959
1975
|
*/
|
|
1960
1976
|
listTransactionsOrg(orgId, request = {}, requestOptions) {
|
|
1961
1977
|
return core.HttpResponsePromise.fromPromise(this.__listTransactionsOrg(orgId, request, requestOptions));
|
|
@@ -2764,6 +2780,150 @@ export class QueryClient {
|
|
|
2764
2780
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/vcards/{entry}");
|
|
2765
2781
|
});
|
|
2766
2782
|
}
|
|
2783
|
+
/**
|
|
2784
|
+
* Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
|
|
2785
|
+
*
|
|
2786
|
+
* @param {Payabli.Entry} entry
|
|
2787
|
+
* @param {Payabli.ListVcardsTransactionsRequest} request
|
|
2788
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2789
|
+
*
|
|
2790
|
+
* @throws {@link Payabli.BadRequestError}
|
|
2791
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
2792
|
+
* @throws {@link Payabli.InternalServerError}
|
|
2793
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
2794
|
+
*
|
|
2795
|
+
* @example
|
|
2796
|
+
* await client.query.listVcardsTransactions("8cfec329267", {
|
|
2797
|
+
* fromRecord: 0,
|
|
2798
|
+
* limitRecord: 20,
|
|
2799
|
+
* sortBy: "desc(CreatedOn)"
|
|
2800
|
+
* })
|
|
2801
|
+
*/
|
|
2802
|
+
listVcardsTransactions(entry, request = {}, requestOptions) {
|
|
2803
|
+
return core.HttpResponsePromise.fromPromise(this.__listVcardsTransactions(entry, request, requestOptions));
|
|
2804
|
+
}
|
|
2805
|
+
__listVcardsTransactions(entry_1) {
|
|
2806
|
+
return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
|
|
2807
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
2808
|
+
const { fromRecord, limitRecord, parameters, sortBy } = request;
|
|
2809
|
+
const _queryParams = {
|
|
2810
|
+
fromRecord,
|
|
2811
|
+
limitRecord,
|
|
2812
|
+
parameters: parameters != null ? toJson(parameters) : undefined,
|
|
2813
|
+
sortBy,
|
|
2814
|
+
};
|
|
2815
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2816
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
2817
|
+
const _response = yield core.fetcher({
|
|
2818
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Query/vcardsTransactions/${core.url.encodePathParam(entry)}`),
|
|
2819
|
+
method: "GET",
|
|
2820
|
+
headers: _headers,
|
|
2821
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
2822
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
2823
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
2824
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
2825
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
2826
|
+
logging: this._options.logging,
|
|
2827
|
+
});
|
|
2828
|
+
if (_response.ok) {
|
|
2829
|
+
return {
|
|
2830
|
+
data: _response.body,
|
|
2831
|
+
rawResponse: _response.rawResponse,
|
|
2832
|
+
};
|
|
2833
|
+
}
|
|
2834
|
+
if (_response.error.reason === "status-code") {
|
|
2835
|
+
switch (_response.error.statusCode) {
|
|
2836
|
+
case 400:
|
|
2837
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
2838
|
+
case 401:
|
|
2839
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
2840
|
+
case 500:
|
|
2841
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
2842
|
+
case 503:
|
|
2843
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
2844
|
+
default:
|
|
2845
|
+
throw new errors.PayabliError({
|
|
2846
|
+
statusCode: _response.error.statusCode,
|
|
2847
|
+
body: _response.error.body,
|
|
2848
|
+
rawResponse: _response.rawResponse,
|
|
2849
|
+
});
|
|
2850
|
+
}
|
|
2851
|
+
}
|
|
2852
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/vcardsTransactions/{entry}");
|
|
2853
|
+
});
|
|
2854
|
+
}
|
|
2855
|
+
/**
|
|
2856
|
+
* Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
|
|
2857
|
+
*
|
|
2858
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
2859
|
+
* @param {Payabli.ListVcardsTransactionsOrgRequest} request
|
|
2860
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2861
|
+
*
|
|
2862
|
+
* @throws {@link Payabli.BadRequestError}
|
|
2863
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
2864
|
+
* @throws {@link Payabli.InternalServerError}
|
|
2865
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
2866
|
+
*
|
|
2867
|
+
* @example
|
|
2868
|
+
* await client.query.listVcardsTransactionsOrg(123, {
|
|
2869
|
+
* fromRecord: 0,
|
|
2870
|
+
* limitRecord: 20,
|
|
2871
|
+
* sortBy: "desc(CreatedOn)"
|
|
2872
|
+
* })
|
|
2873
|
+
*/
|
|
2874
|
+
listVcardsTransactionsOrg(orgId, request = {}, requestOptions) {
|
|
2875
|
+
return core.HttpResponsePromise.fromPromise(this.__listVcardsTransactionsOrg(orgId, request, requestOptions));
|
|
2876
|
+
}
|
|
2877
|
+
__listVcardsTransactionsOrg(orgId_1) {
|
|
2878
|
+
return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
|
|
2879
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
2880
|
+
const { fromRecord, limitRecord, parameters, sortBy } = request;
|
|
2881
|
+
const _queryParams = {
|
|
2882
|
+
fromRecord,
|
|
2883
|
+
limitRecord,
|
|
2884
|
+
parameters: parameters != null ? toJson(parameters) : undefined,
|
|
2885
|
+
sortBy,
|
|
2886
|
+
};
|
|
2887
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
2888
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
2889
|
+
const _response = yield core.fetcher({
|
|
2890
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PayabliEnvironment.Sandbox, `Query/vcardsTransactions/org/${core.url.encodePathParam(orgId)}`),
|
|
2891
|
+
method: "GET",
|
|
2892
|
+
headers: _headers,
|
|
2893
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
2894
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
2895
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
2896
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
2897
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
2898
|
+
logging: this._options.logging,
|
|
2899
|
+
});
|
|
2900
|
+
if (_response.ok) {
|
|
2901
|
+
return {
|
|
2902
|
+
data: _response.body,
|
|
2903
|
+
rawResponse: _response.rawResponse,
|
|
2904
|
+
};
|
|
2905
|
+
}
|
|
2906
|
+
if (_response.error.reason === "status-code") {
|
|
2907
|
+
switch (_response.error.statusCode) {
|
|
2908
|
+
case 400:
|
|
2909
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
2910
|
+
case 401:
|
|
2911
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
2912
|
+
case 500:
|
|
2913
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
2914
|
+
case 503:
|
|
2915
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
2916
|
+
default:
|
|
2917
|
+
throw new errors.PayabliError({
|
|
2918
|
+
statusCode: _response.error.statusCode,
|
|
2919
|
+
body: _response.error.body,
|
|
2920
|
+
rawResponse: _response.rawResponse,
|
|
2921
|
+
});
|
|
2922
|
+
}
|
|
2923
|
+
}
|
|
2924
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/vcardsTransactions/org/{orgId}");
|
|
2925
|
+
});
|
|
2926
|
+
}
|
|
2767
2927
|
/**
|
|
2768
2928
|
* Retrieve a list of vcards (virtual credit cards) issued for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
2769
2929
|
*
|
|
@@ -70,6 +70,7 @@ export interface ListSubscriptionsOrgRequest {
|
|
|
70
70
|
* - `orgName` (ne, eq, ct, nct)
|
|
71
71
|
* - `externalPaypointId` (ct, nct, ne, eq)
|
|
72
72
|
* - `subId` (eq, ne)
|
|
73
|
+
* - `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
|
|
73
74
|
* - `orderDescription` (ct, nct)
|
|
74
75
|
* - `cycles` (eq, ne, gt, ge, lt, le)
|
|
75
76
|
* - `leftcycles` (eq, ne, gt, ge, lt, le)
|