@payabli/sdk-node 0.0.135 → 0.0.136
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/README.md +13 -13
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +6 -0
- package/dist/cjs/Client.js +52 -42
- package/dist/cjs/api/resources/ghostCard/client/Client.d.ts +67 -0
- package/dist/cjs/api/resources/ghostCard/client/Client.js +201 -0
- package/dist/cjs/api/resources/ghostCard/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/ghostCard/client/index.js +17 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.ts +53 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.js +3 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.ts +14 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.js +3 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/ghostCard/exports.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/exports.js +21 -0
- package/dist/cjs/api/resources/ghostCard/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/index.js +18 -0
- package/dist/cjs/api/resources/ghostCard/types/CardStatus.d.ts +8 -0
- package/dist/cjs/api/resources/ghostCard/types/CardStatus.js +11 -0
- package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.d.ts +17 -0
- package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.js +3 -0
- package/dist/cjs/api/resources/ghostCard/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/ghostCard/types/index.js +18 -0
- package/dist/cjs/api/resources/index.d.ts +6 -0
- package/dist/cjs/api/resources/index.js +7 -1
- package/dist/cjs/api/resources/payoutSubscription/client/Client.d.ts +156 -0
- package/dist/cjs/api/resources/payoutSubscription/client/Client.js +385 -0
- package/dist/cjs/api/resources/payoutSubscription/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/client/index.js +17 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.ts +67 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/payoutSubscription/exports.d.ts +2 -0
- package/dist/cjs/api/resources/payoutSubscription/exports.js +21 -0
- package/dist/cjs/api/resources/payoutSubscription/index.d.ts +2 -0
- package/dist/cjs/api/resources/payoutSubscription/index.js +18 -0
- package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.ts +20 -0
- package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.ts +14 -0
- package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +151 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.ts +31 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.ts +9 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.d.ts +4 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +195 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +195 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.ts +69 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +155 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.ts +9 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.ts +15 -0
- package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.js +3 -0
- package/dist/cjs/api/resources/payoutSubscription/types/index.d.ts +12 -0
- package/dist/cjs/api/resources/payoutSubscription/types/index.js +28 -0
- package/dist/cjs/api/resources/query/client/Client.d.ts +46 -6
- package/dist/cjs/api/resources/query/client/Client.js +150 -6
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.ts +84 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.ts +84 -0
- package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/types/Remitaddress1.d.ts +1 -1
- package/dist/cjs/api/types/Remitaddress2.d.ts +1 -1
- package/dist/cjs/api/types/Remitcity.d.ts +1 -1
- package/dist/cjs/api/types/Remitcountry.d.ts +1 -1
- package/dist/cjs/api/types/Remitstate.d.ts +1 -1
- package/dist/cjs/api/types/Remitzip.d.ts +1 -1
- package/dist/cjs/api/types/VendorData.d.ts +6 -6
- package/dist/cjs/api/types/VendorEin.d.ts +1 -1
- package/dist/cjs/api/types/VendorName1.d.ts +1 -1
- package/dist/cjs/api/types/VendorName2.d.ts +1 -1
- package/dist/cjs/api/types/VendorNumber.d.ts +1 -1
- package/dist/cjs/api/types/VendorOutData.d.ts +9 -9
- package/dist/cjs/api/types/VendorQueryRecord.d.ts +1 -1
- package/dist/cjs/api/types/Vendorstatus.d.ts +5 -3
- package/dist/cjs/core/file/file.js +3 -2
- 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/Client.d.mts +6 -0
- package/dist/esm/Client.mjs +10 -0
- package/dist/esm/api/resources/ghostCard/client/Client.d.mts +67 -0
- package/dist/esm/api/resources/ghostCard/client/Client.mjs +164 -0
- package/dist/esm/api/resources/ghostCard/client/index.d.mts +1 -0
- package/dist/esm/api/resources/ghostCard/client/index.mjs +1 -0
- package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.mts +53 -0
- package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.mts +14 -0
- package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/ghostCard/exports.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/exports.mjs +3 -0
- package/dist/esm/api/resources/ghostCard/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/index.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/types/CardStatus.d.mts +8 -0
- package/dist/esm/api/resources/ghostCard/types/CardStatus.mjs +8 -0
- package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.d.mts +17 -0
- package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.mjs +2 -0
- package/dist/esm/api/resources/ghostCard/types/index.d.mts +2 -0
- package/dist/esm/api/resources/ghostCard/types/index.mjs +2 -0
- package/dist/esm/api/resources/index.d.mts +6 -0
- package/dist/esm/api/resources/index.mjs +6 -0
- package/dist/esm/api/resources/payoutSubscription/client/Client.d.mts +156 -0
- package/dist/esm/api/resources/payoutSubscription/client/Client.mjs +348 -0
- package/dist/esm/api/resources/payoutSubscription/client/index.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/index.mjs +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.mts +67 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/payoutSubscription/exports.d.mts +2 -0
- package/dist/esm/api/resources/payoutSubscription/exports.mjs +3 -0
- package/dist/esm/api/resources/payoutSubscription/index.d.mts +2 -0
- package/dist/esm/api/resources/payoutSubscription/index.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.mts +20 -0
- package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.mts +14 -0
- package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +151 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.mts +31 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.mts +9 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.d.mts +4 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +195 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +195 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.mts +69 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +155 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.mts +9 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.mts +15 -0
- package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.mjs +2 -0
- package/dist/esm/api/resources/payoutSubscription/types/index.d.mts +12 -0
- package/dist/esm/api/resources/payoutSubscription/types/index.mjs +12 -0
- package/dist/esm/api/resources/query/client/Client.d.mts +46 -6
- package/dist/esm/api/resources/query/client/Client.mjs +150 -6
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.mts +84 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.mts +84 -0
- package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
- package/dist/esm/api/types/Remitaddress1.d.mts +1 -1
- package/dist/esm/api/types/Remitaddress2.d.mts +1 -1
- package/dist/esm/api/types/Remitcity.d.mts +1 -1
- package/dist/esm/api/types/Remitcountry.d.mts +1 -1
- package/dist/esm/api/types/Remitstate.d.mts +1 -1
- package/dist/esm/api/types/Remitzip.d.mts +1 -1
- package/dist/esm/api/types/VendorData.d.mts +6 -6
- package/dist/esm/api/types/VendorEin.d.mts +1 -1
- package/dist/esm/api/types/VendorName1.d.mts +1 -1
- package/dist/esm/api/types/VendorName2.d.mts +1 -1
- package/dist/esm/api/types/VendorNumber.d.mts +1 -1
- package/dist/esm/api/types/VendorOutData.d.mts +9 -9
- package/dist/esm/api/types/VendorQueryRecord.d.mts +1 -1
- package/dist/esm/api/types/Vendorstatus.d.mts +5 -3
- package/dist/esm/core/file/file.mjs +3 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +29 -7
- package/reference.md +682 -78
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import type * as Payabli from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* fromRecord: 0,
|
|
6
|
+
* limitRecord: 20,
|
|
7
|
+
* sortBy: "desc(field_name)"
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface ListPayoutSubscriptionsRequest {
|
|
11
|
+
exportFormat?: Payabli.ExportFormat;
|
|
12
|
+
/** The number of records to skip before starting to collect the result set. */
|
|
13
|
+
fromRecord?: number;
|
|
14
|
+
/** Max number of records to return for the query. Use `0` or negative value to return all records. */
|
|
15
|
+
limitRecord?: number;
|
|
16
|
+
/**
|
|
17
|
+
* Collection of field names, conditions, and values used to filter the query.
|
|
18
|
+
* <Info>
|
|
19
|
+
* **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20
|
+
*
|
|
21
|
+
* Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
22
|
+
*
|
|
23
|
+
* For example:
|
|
24
|
+
*
|
|
25
|
+
* --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
26
|
+
*
|
|
27
|
+
* should become:
|
|
28
|
+
*
|
|
29
|
+
* --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
|
|
30
|
+
* </Info>
|
|
31
|
+
* See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
32
|
+
* **List of field names accepted:**
|
|
33
|
+
*
|
|
34
|
+
* - `startDate` (gt, ge, lt, le, eq, ne)
|
|
35
|
+
* - `endDate` (gt, ge, lt, le, eq, ne)
|
|
36
|
+
* - `nextDate` (gt, ge, lt, le, eq, ne)
|
|
37
|
+
* - `frequency` (in, nin, ne, eq)
|
|
38
|
+
* - `method` (in, nin, eq, ne)
|
|
39
|
+
* - `totalAmount` (gt, ge, lt, le, eq, ne)
|
|
40
|
+
* - `netAmount` (gt, ge, lt, le, eq, ne)
|
|
41
|
+
* - `feeAmount` (gt, ge, lt, le, eq, ne)
|
|
42
|
+
* - `status` (in, nin, eq, ne)
|
|
43
|
+
* - `untilcancelled` (eq, ne)
|
|
44
|
+
* - `payaccountLastfour` (ct, nct)
|
|
45
|
+
* - `payaccountType` (ne, eq, in, nin)
|
|
46
|
+
* - `payaccountCurrency` (ne, eq, in, nin)
|
|
47
|
+
* - `paypointId` (ne, eq)
|
|
48
|
+
* - `paypointLegal` (ne, eq, ct, nct)
|
|
49
|
+
* - `paypointDba` (ne, eq, ct, nct)
|
|
50
|
+
* - `orgName` (ne, eq, ct, nct, nin, in)
|
|
51
|
+
* - `parentOrgId` (ne, eq, nin, in)
|
|
52
|
+
* - `subscriptionId` (eq, ne)
|
|
53
|
+
* - `orderDescription` (ct, nct)
|
|
54
|
+
* - `cycles` (eq, ne, gt, ge, lt, le)
|
|
55
|
+
* - `leftcycles` (eq, ne, gt, ge, lt, le)
|
|
56
|
+
* - `createdAt` (eq, ne, gt, ge, lt, le)
|
|
57
|
+
* - `updatedOn` (eq, ne, gt, ge, lt, le)
|
|
58
|
+
* - `vendorNumber` (ne, eq, ct, nct)
|
|
59
|
+
* - `name` (ne, eq, ct, nct)
|
|
60
|
+
* - `phone` (ne, eq, ct, nct)
|
|
61
|
+
* - `email` (ne, eq, ct, nct)
|
|
62
|
+
* - `address` (ne, eq, ct, nct)
|
|
63
|
+
* - `remitAddress` (ct, nct)
|
|
64
|
+
* - `city` (ne, eq, ct, nct)
|
|
65
|
+
* - `state` (ne, eq, ct, nct)
|
|
66
|
+
* - `country` (ne, eq, ct, nct)
|
|
67
|
+
* - `zip` (ne, eq, ct, nct)
|
|
68
|
+
*
|
|
69
|
+
* **List of comparison operators accepted:**
|
|
70
|
+
* - `eq` or empty => equal
|
|
71
|
+
* - `gt` => greater than
|
|
72
|
+
* - `ge` => greater or equal
|
|
73
|
+
* - `lt` => less than
|
|
74
|
+
* - `le` => less or equal
|
|
75
|
+
* - `ne` => not equal
|
|
76
|
+
* - `ct` => contains
|
|
77
|
+
* - `nct` => not contains
|
|
78
|
+
* - `in` => inside array
|
|
79
|
+
* - `nin` => not inside array
|
|
80
|
+
*/
|
|
81
|
+
parameters?: Record<string, string>;
|
|
82
|
+
/** The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`. */
|
|
83
|
+
sortBy?: string;
|
|
84
|
+
}
|
|
@@ -15,6 +15,8 @@ export type { ListNotificationsRequest } from "./ListNotificationsRequest.js";
|
|
|
15
15
|
export type { ListOrganizationsRequest } from "./ListOrganizationsRequest.js";
|
|
16
16
|
export type { ListPayoutOrgRequest } from "./ListPayoutOrgRequest.js";
|
|
17
17
|
export type { ListPayoutRequest } from "./ListPayoutRequest.js";
|
|
18
|
+
export type { ListPayoutSubscriptionsOrgRequest } from "./ListPayoutSubscriptionsOrgRequest.js";
|
|
19
|
+
export type { ListPayoutSubscriptionsRequest } from "./ListPayoutSubscriptionsRequest.js";
|
|
18
20
|
export type { ListPaypointsRequest } from "./ListPaypointsRequest.js";
|
|
19
21
|
export type { ListSettlementsOrgRequest } from "./ListSettlementsOrgRequest.js";
|
|
20
22
|
export type { ListSettlementsRequest } from "./ListSettlementsRequest.js";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Remittance address. Used for mailing paper checks.
|
|
2
|
+
* Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided. Allowed characters are letters, numbers, spaces, and `. ,
|
|
3
3
|
*/
|
|
4
4
|
export type Remitaddress1 = string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Remittance address state. Used for mailing paper checks.
|
|
2
|
+
* Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian province abbreviation.
|
|
3
3
|
*/
|
|
4
4
|
export type Remitstate = string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Remittance address ZIP code. Used for mailing paper checks.
|
|
2
|
+
* Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits or ZIP+4 format.
|
|
3
3
|
*/
|
|
4
4
|
export type Remitzip = string;
|
|
@@ -2,17 +2,17 @@ import type * as Payabli from "../index.js";
|
|
|
2
2
|
export interface VendorData {
|
|
3
3
|
vendorNumber?: Payabli.VendorNumber | undefined;
|
|
4
4
|
AdditionalData?: Payabli.AdditionalData | undefined;
|
|
5
|
-
/** Vendor's address */
|
|
5
|
+
/** Vendor's street address. If any address field is provided, this field is required along with `city`, `state`, and `zip`. Allowed characters are letters, numbers, spaces, and `. , */
|
|
6
6
|
address1?: Payabli.AddressNullable | undefined;
|
|
7
|
-
/** Additional line for vendor's address. */
|
|
7
|
+
/** Additional line for vendor's address, such as a suite or unit number. Always optional. */
|
|
8
8
|
address2?: Payabli.AddressAddtlNullable | undefined;
|
|
9
9
|
/** Object containing vendor's bank information. */
|
|
10
10
|
billingData?: Payabli.BillingData | undefined;
|
|
11
|
-
/** Vendor's city. */
|
|
11
|
+
/** Vendor's city. Required if any address field is provided. */
|
|
12
12
|
city?: string | undefined;
|
|
13
13
|
/** Array of objects describing the vendor's contacts. */
|
|
14
14
|
contacts?: Payabli.ContactsField | undefined;
|
|
15
|
-
/** Vendor's country. */
|
|
15
|
+
/** Vendor's country. Must be `US` or `CA`. Defaults to `US` if not provided. */
|
|
16
16
|
country?: string | undefined;
|
|
17
17
|
/** Custom field 1 for vendor */
|
|
18
18
|
customField1?: string | undefined;
|
|
@@ -40,9 +40,9 @@ export interface VendorData {
|
|
|
40
40
|
remitEmail?: Payabli.RemitEmail | undefined;
|
|
41
41
|
remitState?: Payabli.Remitstate | undefined;
|
|
42
42
|
remitZip?: Payabli.Remitzip | undefined;
|
|
43
|
-
/** Vendor's state. Must be a
|
|
43
|
+
/** Vendor's state or province. Required if any address field is provided. Must be a valid US state abbreviation (such as `CA`, `NY`) or Canadian province abbreviation (such as `ON`, `BC`), depending on the `country` value. */
|
|
44
44
|
state?: string | undefined;
|
|
45
45
|
vendorStatus?: Payabli.Vendorstatus | undefined;
|
|
46
|
-
/** Vendor's
|
|
46
|
+
/** Vendor's ZIP or postal code. Required if any address field is provided. For US addresses, use five digits (`12345`) or ZIP+4 format (`12345-6789`). */
|
|
47
47
|
zip?: string | undefined;
|
|
48
48
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type * as Payabli from "../index.js";
|
|
2
2
|
export interface VendorOutData {
|
|
3
3
|
additionalData?: Payabli.AdditionalData | undefined;
|
|
4
|
-
/** Vendor's address */
|
|
4
|
+
/** Vendor's street address. Allowed characters are letters, numbers, spaces, and `. , */
|
|
5
5
|
Address1?: Payabli.AddressNullable | undefined;
|
|
6
|
-
/** Additional line for vendor's address. */
|
|
6
|
+
/** Additional line for vendor's address, such as a suite or unit number. */
|
|
7
7
|
Address2?: Payabli.AddressAddtlNullable | undefined;
|
|
8
8
|
/** Object containing vendor's bank information. */
|
|
9
9
|
BillingData?: Payabli.BillingData | undefined;
|
|
@@ -11,11 +11,11 @@ export interface VendorOutData {
|
|
|
11
11
|
City: string;
|
|
12
12
|
/** Array of objects describing the vendor's contacts. */
|
|
13
13
|
Contacts?: Payabli.ContactsField | undefined;
|
|
14
|
-
/** Vendor's country. */
|
|
14
|
+
/** Vendor's country. `US` or `CA`. */
|
|
15
15
|
Country: string;
|
|
16
16
|
/** Account number of paypoint in the vendor side. */
|
|
17
17
|
customerVendorAccount?: string | undefined;
|
|
18
|
-
/** EIN/Tax ID for vendor. In
|
|
18
|
+
/** EIN/Tax ID for vendor. Must be nine digits formatted as `XX-XXXXXXX`. In responses, this field is masked and looks like: `XXXXX6789`. */
|
|
19
19
|
EIN: string;
|
|
20
20
|
/** Vendor's email address. Required for vCard. */
|
|
21
21
|
Email?: Payabli.Email | undefined;
|
|
@@ -23,14 +23,14 @@ export interface VendorOutData {
|
|
|
23
23
|
InternalReferenceId?: number | undefined;
|
|
24
24
|
LocationCode?: Payabli.LocationCode | undefined;
|
|
25
25
|
Mcc?: Payabli.Mcc | undefined;
|
|
26
|
-
/** Primary name for vendor. Required for new vendor. */
|
|
26
|
+
/** Primary name for vendor. Required for new vendor. Allowed characters are letters, numbers, spaces, and `. , ' & ( ) */
|
|
27
27
|
Name1: string;
|
|
28
|
-
/** Secondary name for vendor. */
|
|
28
|
+
/** Secondary name for vendor. If provided, allowed characters are the same as `Name1`. */
|
|
29
29
|
Name2?: string | undefined;
|
|
30
30
|
payeeName1?: Payabli.PayeeName | undefined;
|
|
31
31
|
payeeName2?: Payabli.PayeeName | undefined;
|
|
32
32
|
PaymentMethod?: Payabli.VendorPaymentMethod | undefined;
|
|
33
|
-
/** Vendor's phone number */
|
|
33
|
+
/** Vendor's phone number. Digits only when creating or updating a vendor. */
|
|
34
34
|
Phone: string;
|
|
35
35
|
remitAddress1?: Payabli.Remitaddress1 | undefined;
|
|
36
36
|
remitAddress2?: Payabli.Remitaddress2 | undefined;
|
|
@@ -38,12 +38,12 @@ export interface VendorOutData {
|
|
|
38
38
|
remitCountry?: Payabli.Remitcountry | undefined;
|
|
39
39
|
remitState?: Payabli.Remitstate | undefined;
|
|
40
40
|
remitZip?: Payabli.Remitzip | undefined;
|
|
41
|
-
/** Vendor's state. Must be a
|
|
41
|
+
/** Vendor's state or province. Must be a valid US state or Canadian province abbreviation, depending on the `Country` value. */
|
|
42
42
|
State: string;
|
|
43
43
|
/** Payabli identifier for vendor record. Required when `VendorNumber` isn't included. */
|
|
44
44
|
VendorId?: Payabli.Vendorid | undefined;
|
|
45
45
|
VendorNumber?: Payabli.VendorNumber | undefined;
|
|
46
46
|
VendorStatus?: Payabli.Vendorstatus | undefined;
|
|
47
|
-
/** Vendor's
|
|
47
|
+
/** Vendor's ZIP or postal code. For US addresses, five digits (`12345`) or ZIP+4 format (`12345-6789`). */
|
|
48
48
|
Zip: string;
|
|
49
49
|
}
|
|
@@ -6,7 +6,7 @@ import type * as Payabli from "../index.js";
|
|
|
6
6
|
* Name1: "Herman's Coatings",
|
|
7
7
|
* Name2: "Herman's Coating Supply Company, LLC",
|
|
8
8
|
* EIN: "123456789",
|
|
9
|
-
* Phone: "
|
|
9
|
+
* Phone: "2125551234",
|
|
10
10
|
* Email: "example@email.com",
|
|
11
11
|
* Address1: "123 Ocean Drive",
|
|
12
12
|
* Address2: "Suite 400",
|
|
@@ -85,7 +85,7 @@ function getFileWithMetadata(file_1) {
|
|
|
85
85
|
}
|
|
86
86
|
if ("path" in file) {
|
|
87
87
|
const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
|
|
88
|
-
if (!fs ||
|
|
88
|
+
if (!(fs === null || fs === void 0 ? void 0 : fs.createReadStream)) {
|
|
89
89
|
throw new Error("File path uploads are not supported in this environment.");
|
|
90
90
|
}
|
|
91
91
|
const data = fs.createReadStream(file.path);
|
|
@@ -126,9 +126,10 @@ function isFileLike(value) {
|
|
|
126
126
|
}
|
|
127
127
|
function tryGetFileSizeFromPath(path) {
|
|
128
128
|
return __awaiter(this, void 0, void 0, function* () {
|
|
129
|
+
var _a;
|
|
129
130
|
try {
|
|
130
131
|
const fs = yield Promise.resolve().then(() => __importStar(require("fs")));
|
|
131
|
-
if (!fs ||
|
|
132
|
+
if (!((_a = fs === null || fs === void 0 ? void 0 : fs.promises) === null || _a === void 0 ? void 0 : _a.stat)) {
|
|
132
133
|
return undefined;
|
|
133
134
|
}
|
|
134
135
|
const fileStat = yield fs.promises.stat(path);
|
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.136";
|
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.136",
|
|
10
|
+
"User-Agent": "@payabli/sdk-node/0.0.136",
|
|
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);
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -5,6 +5,7 @@ import { CheckCaptureClient } from "./api/resources/checkCapture/client/Client.m
|
|
|
5
5
|
import { CloudClient } from "./api/resources/cloud/client/Client.mjs";
|
|
6
6
|
import { CustomerClient } from "./api/resources/customer/client/Client.mjs";
|
|
7
7
|
import { ExportClient } from "./api/resources/export/client/Client.mjs";
|
|
8
|
+
import { GhostCardClient } from "./api/resources/ghostCard/client/Client.mjs";
|
|
8
9
|
import { HostedPaymentPagesClient } from "./api/resources/hostedPaymentPages/client/Client.mjs";
|
|
9
10
|
import { ImportClient } from "./api/resources/import/client/Client.mjs";
|
|
10
11
|
import { InvoiceClient } from "./api/resources/invoice/client/Client.mjs";
|
|
@@ -17,6 +18,7 @@ import { OcrClient } from "./api/resources/ocr/client/Client.mjs";
|
|
|
17
18
|
import { OrganizationClient } from "./api/resources/organization/client/Client.mjs";
|
|
18
19
|
import { PaymentLinkClient } from "./api/resources/paymentLink/client/Client.mjs";
|
|
19
20
|
import { PaymentMethodDomainClient } from "./api/resources/paymentMethodDomain/client/Client.mjs";
|
|
21
|
+
import { PayoutSubscriptionClient } from "./api/resources/payoutSubscription/client/Client.mjs";
|
|
20
22
|
import { PaypointClient } from "./api/resources/paypoint/client/Client.mjs";
|
|
21
23
|
import { QueryClient } from "./api/resources/query/client/Client.mjs";
|
|
22
24
|
import { StatisticClient } from "./api/resources/statistic/client/Client.mjs";
|
|
@@ -43,6 +45,7 @@ export declare class PayabliClient {
|
|
|
43
45
|
protected _cloud: CloudClient | undefined;
|
|
44
46
|
protected _customer: CustomerClient | undefined;
|
|
45
47
|
protected _export: ExportClient | undefined;
|
|
48
|
+
protected _ghostCard: GhostCardClient | undefined;
|
|
46
49
|
protected _hostedPaymentPages: HostedPaymentPagesClient | undefined;
|
|
47
50
|
protected _import: ImportClient | undefined;
|
|
48
51
|
protected _invoice: InvoiceClient | undefined;
|
|
@@ -55,6 +58,7 @@ export declare class PayabliClient {
|
|
|
55
58
|
protected _organization: OrganizationClient | undefined;
|
|
56
59
|
protected _paymentLink: PaymentLinkClient | undefined;
|
|
57
60
|
protected _paymentMethodDomain: PaymentMethodDomainClient | undefined;
|
|
61
|
+
protected _payoutSubscription: PayoutSubscriptionClient | undefined;
|
|
58
62
|
protected _paypoint: PaypointClient | undefined;
|
|
59
63
|
protected _query: QueryClient | undefined;
|
|
60
64
|
protected _statistic: StatisticClient | undefined;
|
|
@@ -72,6 +76,7 @@ export declare class PayabliClient {
|
|
|
72
76
|
get cloud(): CloudClient;
|
|
73
77
|
get customer(): CustomerClient;
|
|
74
78
|
get export(): ExportClient;
|
|
79
|
+
get ghostCard(): GhostCardClient;
|
|
75
80
|
get hostedPaymentPages(): HostedPaymentPagesClient;
|
|
76
81
|
get import(): ImportClient;
|
|
77
82
|
get invoice(): InvoiceClient;
|
|
@@ -84,6 +89,7 @@ export declare class PayabliClient {
|
|
|
84
89
|
get organization(): OrganizationClient;
|
|
85
90
|
get paymentLink(): PaymentLinkClient;
|
|
86
91
|
get paymentMethodDomain(): PaymentMethodDomainClient;
|
|
92
|
+
get payoutSubscription(): PayoutSubscriptionClient;
|
|
87
93
|
get paypoint(): PaypointClient;
|
|
88
94
|
get query(): QueryClient;
|
|
89
95
|
get statistic(): StatisticClient;
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -15,6 +15,7 @@ import { CheckCaptureClient } from "./api/resources/checkCapture/client/Client.m
|
|
|
15
15
|
import { CloudClient } from "./api/resources/cloud/client/Client.mjs";
|
|
16
16
|
import { CustomerClient } from "./api/resources/customer/client/Client.mjs";
|
|
17
17
|
import { ExportClient } from "./api/resources/export/client/Client.mjs";
|
|
18
|
+
import { GhostCardClient } from "./api/resources/ghostCard/client/Client.mjs";
|
|
18
19
|
import { HostedPaymentPagesClient } from "./api/resources/hostedPaymentPages/client/Client.mjs";
|
|
19
20
|
import { ImportClient } from "./api/resources/import/client/Client.mjs";
|
|
20
21
|
import { InvoiceClient } from "./api/resources/invoice/client/Client.mjs";
|
|
@@ -27,6 +28,7 @@ import { OcrClient } from "./api/resources/ocr/client/Client.mjs";
|
|
|
27
28
|
import { OrganizationClient } from "./api/resources/organization/client/Client.mjs";
|
|
28
29
|
import { PaymentLinkClient } from "./api/resources/paymentLink/client/Client.mjs";
|
|
29
30
|
import { PaymentMethodDomainClient } from "./api/resources/paymentMethodDomain/client/Client.mjs";
|
|
31
|
+
import { PayoutSubscriptionClient } from "./api/resources/payoutSubscription/client/Client.mjs";
|
|
30
32
|
import { PaypointClient } from "./api/resources/paypoint/client/Client.mjs";
|
|
31
33
|
import { QueryClient } from "./api/resources/query/client/Client.mjs";
|
|
32
34
|
import { StatisticClient } from "./api/resources/statistic/client/Client.mjs";
|
|
@@ -70,6 +72,10 @@ export class PayabliClient {
|
|
|
70
72
|
var _a;
|
|
71
73
|
return ((_a = this._export) !== null && _a !== void 0 ? _a : (this._export = new ExportClient(this._options)));
|
|
72
74
|
}
|
|
75
|
+
get ghostCard() {
|
|
76
|
+
var _a;
|
|
77
|
+
return ((_a = this._ghostCard) !== null && _a !== void 0 ? _a : (this._ghostCard = new GhostCardClient(this._options)));
|
|
78
|
+
}
|
|
73
79
|
get hostedPaymentPages() {
|
|
74
80
|
var _a;
|
|
75
81
|
return ((_a = this._hostedPaymentPages) !== null && _a !== void 0 ? _a : (this._hostedPaymentPages = new HostedPaymentPagesClient(this._options)));
|
|
@@ -118,6 +124,10 @@ export class PayabliClient {
|
|
|
118
124
|
var _a;
|
|
119
125
|
return ((_a = this._paymentMethodDomain) !== null && _a !== void 0 ? _a : (this._paymentMethodDomain = new PaymentMethodDomainClient(this._options)));
|
|
120
126
|
}
|
|
127
|
+
get payoutSubscription() {
|
|
128
|
+
var _a;
|
|
129
|
+
return ((_a = this._payoutSubscription) !== null && _a !== void 0 ? _a : (this._payoutSubscription = new PayoutSubscriptionClient(this._options)));
|
|
130
|
+
}
|
|
121
131
|
get paypoint() {
|
|
122
132
|
var _a;
|
|
123
133
|
return ((_a = this._paypoint) !== null && _a !== void 0 ? _a : (this._paypoint = new PaypointClient(this._options)));
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
|
|
3
|
+
import * as core from "../../../../core/index.mjs";
|
|
4
|
+
import * as Payabli from "../../../index.mjs";
|
|
5
|
+
export declare namespace GhostCardClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class GhostCardClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<GhostCardClient.Options>;
|
|
12
|
+
constructor(options?: GhostCardClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
|
|
15
|
+
*
|
|
16
|
+
* Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
|
|
17
|
+
*
|
|
18
|
+
* @param {Payabli.Entry} entry
|
|
19
|
+
* @param {Payabli.CreateGhostCardRequestBody} request
|
|
20
|
+
* @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
21
|
+
*
|
|
22
|
+
* @throws {@link Payabli.BadRequestError}
|
|
23
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
24
|
+
* @throws {@link Payabli.InternalServerError}
|
|
25
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* await client.ghostCard.createGhostCard("8cfec2e0fa", {
|
|
29
|
+
* vendorId: 42,
|
|
30
|
+
* expenseLimit: 500,
|
|
31
|
+
* maxNumberOfUses: 3,
|
|
32
|
+
* exactAmount: false,
|
|
33
|
+
* expenseLimitPeriod: "monthly",
|
|
34
|
+
* billingCycle: "monthly",
|
|
35
|
+
* billingCycleDay: "1",
|
|
36
|
+
* dailyTransactionCount: 5,
|
|
37
|
+
* dailyAmountLimit: 200,
|
|
38
|
+
* transactionAmountLimit: 100,
|
|
39
|
+
* mcc: "5411",
|
|
40
|
+
* tcc: "R",
|
|
41
|
+
* misc1: "PO-98765",
|
|
42
|
+
* misc2: "Dept-Finance"
|
|
43
|
+
* })
|
|
44
|
+
*/
|
|
45
|
+
createGhostCard(entry: Payabli.Entry, request: Payabli.CreateGhostCardRequestBody, requestOptions?: GhostCardClient.RequestOptions): core.HttpResponsePromise<Payabli.CreateGhostCardResponse>;
|
|
46
|
+
private __createGhostCard;
|
|
47
|
+
/**
|
|
48
|
+
* Updates the status of a virtual card (including ghost cards) under a paypoint.
|
|
49
|
+
*
|
|
50
|
+
* @param {Payabli.Entry} entry
|
|
51
|
+
* @param {Payabli.UpdateCardRequestBody} request
|
|
52
|
+
* @param {GhostCardClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link Payabli.BadRequestError}
|
|
55
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
56
|
+
* @throws {@link Payabli.InternalServerError}
|
|
57
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* await client.ghostCard.updateCard("8cfec2e0fa", {
|
|
61
|
+
* cardToken: "gc_abc123def456",
|
|
62
|
+
* status: "Cancelled"
|
|
63
|
+
* })
|
|
64
|
+
*/
|
|
65
|
+
updateCard(entry: Payabli.Entry, request: Payabli.UpdateCardRequestBody, requestOptions?: GhostCardClient.RequestOptions): core.HttpResponsePromise<Payabli.PayabliApiResponse>;
|
|
66
|
+
private __updateCard;
|
|
67
|
+
}
|