@payabli/sdk-node 0.0.134 → 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/NotificationStandardRequest.d.ts +0 -31
- package/dist/cjs/api/types/NotificationStandardRequest.js +0 -31
- 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/NotificationStandardRequest.d.mts +0 -31
- package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -31
- 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,69 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
export interface PayoutSubscriptionRequestBody {
|
|
3
|
+
entryPoint: Payabli.Entrypointfield;
|
|
4
|
+
subdomain?: Payabli.Subdomain | undefined;
|
|
5
|
+
accountId?: Payabli.AccountId | undefined;
|
|
6
|
+
source?: Payabli.Source | undefined;
|
|
7
|
+
setPause?: Payabli.PayoutSetPause | undefined;
|
|
8
|
+
/** Payment method for the payout subscription. Supports `ach`, `vcard`, and `check`. The `managed` method isn't supported for payout subscriptions. */
|
|
9
|
+
paymentMethod: Payabli.AuthorizePaymentMethod;
|
|
10
|
+
/** Object describing details of the payout. */
|
|
11
|
+
paymentDetails?: Payabli.PayoutPaymentDetail | undefined;
|
|
12
|
+
/** Object identifying the vendor for this subscription. Only a `vendorId` or `vendorNumber` is needed to link to an existing vendor. */
|
|
13
|
+
vendorData: PayoutSubscriptionRequestBody.VendorData;
|
|
14
|
+
/** Array of bills associated with the payout subscription. If omitted and `doNotCreateBills` isn't set to `true`, the system creates a bill automatically. */
|
|
15
|
+
billData?: Payabli.BillPayOutDataRequest[] | undefined;
|
|
16
|
+
/** Object describing the schedule for the payout subscription. */
|
|
17
|
+
scheduleDetails?: Payabli.PayoutScheduleDetail | undefined;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace PayoutSubscriptionRequestBody {
|
|
20
|
+
/**
|
|
21
|
+
* Object containing vendor data.
|
|
22
|
+
*/
|
|
23
|
+
interface VendorData {
|
|
24
|
+
vendorNumber?: Payabli.VendorNumber | undefined;
|
|
25
|
+
name1?: Payabli.VendorName1 | undefined;
|
|
26
|
+
name2?: Payabli.VendorName2 | undefined;
|
|
27
|
+
ein?: Payabli.VendorEin | undefined;
|
|
28
|
+
phone?: Payabli.VendorPhone | undefined;
|
|
29
|
+
email?: Payabli.Email | undefined;
|
|
30
|
+
address1?: Payabli.AddressNullable | undefined;
|
|
31
|
+
city?: string | undefined;
|
|
32
|
+
state?: string | undefined;
|
|
33
|
+
zip?: string | undefined;
|
|
34
|
+
country?: string | undefined;
|
|
35
|
+
mcc?: Payabli.Mcc | undefined;
|
|
36
|
+
contacts?: Payabli.ContactsField | undefined;
|
|
37
|
+
billingData?: VendorData.BillingData | undefined;
|
|
38
|
+
vendorStatus?: Payabli.Vendorstatus | undefined;
|
|
39
|
+
remitAddress1?: Payabli.Remitaddress1 | undefined;
|
|
40
|
+
remitAddress2?: Payabli.Remitaddress2 | undefined;
|
|
41
|
+
remitCity?: Payabli.Remitcity | undefined;
|
|
42
|
+
remitState?: Payabli.Remitstate | undefined;
|
|
43
|
+
remitZip?: Payabli.Remitzip | undefined;
|
|
44
|
+
remitCountry?: Payabli.Remitcountry | undefined;
|
|
45
|
+
customerVendorAccount?: string | undefined;
|
|
46
|
+
customField1?: string | undefined;
|
|
47
|
+
customField2?: string | undefined;
|
|
48
|
+
additionalData?: Payabli.AdditionalData | undefined;
|
|
49
|
+
address2?: Payabli.AddressAddtlNullable | undefined;
|
|
50
|
+
internalReferenceId?: number | undefined;
|
|
51
|
+
locationCode?: Payabli.LocationCode | undefined;
|
|
52
|
+
payeeName1?: Payabli.PayeeName | undefined;
|
|
53
|
+
payeeName2?: Payabli.PayeeName | undefined;
|
|
54
|
+
paymentMethod?: Payabli.VendorPaymentMethod | undefined;
|
|
55
|
+
vendorId?: Payabli.Vendorid | undefined;
|
|
56
|
+
}
|
|
57
|
+
namespace VendorData {
|
|
58
|
+
/**
|
|
59
|
+
* Object containing vendor's bank information. This object is deprecated for this endpoint. Use the `paymentMethod` object in payout authorize requests instead.
|
|
60
|
+
*/
|
|
61
|
+
interface BillingData {
|
|
62
|
+
bankName?: Payabli.BankName | undefined;
|
|
63
|
+
routingAccount?: Payabli.RoutingAccount | undefined;
|
|
64
|
+
accountNumber?: Payabli.AccountNumber | undefined;
|
|
65
|
+
typeAccount?: Payabli.TypeAccount | undefined;
|
|
66
|
+
bankAccountHolderName?: Payabli.BankAccountHolderName | undefined;
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Payout subscription query response body.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* Summary: {
|
|
8
|
+
* totalRecords: 1,
|
|
9
|
+
* totalAmount: 500,
|
|
10
|
+
* totalNetAmount: 500,
|
|
11
|
+
* totalPages: 1,
|
|
12
|
+
* pageSize: 20,
|
|
13
|
+
* pageIdentifier: "XXXXXXXXXXXXXXXXXXX"
|
|
14
|
+
* },
|
|
15
|
+
* Records: [{
|
|
16
|
+
* IdOutSubscription: 42,
|
|
17
|
+
* Status: 1,
|
|
18
|
+
* Events: [{
|
|
19
|
+
* description: "TransferCreated",
|
|
20
|
+
* eventTime: "2025-09-01T06:00:00Z",
|
|
21
|
+
* extraData: {
|
|
22
|
+
* "key": "value"
|
|
23
|
+
* },
|
|
24
|
+
* refData: "refData",
|
|
25
|
+
* source: "api"
|
|
26
|
+
* }],
|
|
27
|
+
* Vendor: {
|
|
28
|
+
* VendorNumber: "1234",
|
|
29
|
+
* Name1: "Herman's Coatings",
|
|
30
|
+
* Name2: "Herman's Coating Supply Company, LLC",
|
|
31
|
+
* EIN: "123456789",
|
|
32
|
+
* Phone: "2125551234",
|
|
33
|
+
* Email: "example@email.com",
|
|
34
|
+
* Address1: "123 Ocean Drive",
|
|
35
|
+
* Address2: "Suite 400",
|
|
36
|
+
* City: "Bristol",
|
|
37
|
+
* State: "GA",
|
|
38
|
+
* Zip: "31113",
|
|
39
|
+
* Country: "US",
|
|
40
|
+
* Mcc: "7777",
|
|
41
|
+
* LocationCode: "LOC123",
|
|
42
|
+
* Contacts: {
|
|
43
|
+
* ContactEmail: "eric@martinezcoatings.com",
|
|
44
|
+
* ContactName: "Eric Martinez",
|
|
45
|
+
* ContactPhone: "5555555555",
|
|
46
|
+
* ContactTitle: "Owner"
|
|
47
|
+
* },
|
|
48
|
+
* BillingData: {
|
|
49
|
+
* id: 123456,
|
|
50
|
+
* accountId: "bank-account-001",
|
|
51
|
+
* nickname: "Main Checking Account",
|
|
52
|
+
* bankName: "Example Bank",
|
|
53
|
+
* routingAccount: "123456789",
|
|
54
|
+
* accountNumber: "9876543210",
|
|
55
|
+
* typeAccount: Payabli.TypeAccount.Checking,
|
|
56
|
+
* bankAccountHolderName: "John Doe",
|
|
57
|
+
* bankAccountHolderType: Payabli.BankAccountHolderType.Business,
|
|
58
|
+
* bankAccountFunction: 2,
|
|
59
|
+
* verified: true,
|
|
60
|
+
* status: 1,
|
|
61
|
+
* services: [],
|
|
62
|
+
* "default": true
|
|
63
|
+
* },
|
|
64
|
+
* VendorStatus: 1,
|
|
65
|
+
* VendorId: 1,
|
|
66
|
+
* Summary: {
|
|
67
|
+
* ActiveBills: 2,
|
|
68
|
+
* PendingBills: 4,
|
|
69
|
+
* InTransitBills: 3,
|
|
70
|
+
* PaidBills: 18,
|
|
71
|
+
* OverdueBills: 1,
|
|
72
|
+
* ApprovedBills: 5,
|
|
73
|
+
* DisapprovedBills: 1,
|
|
74
|
+
* TotalBills: 34,
|
|
75
|
+
* ActiveBillsAmount: 1250.75,
|
|
76
|
+
* PendingBillsAmount: 2890.5,
|
|
77
|
+
* InTransitBillsAmount: 1675.25,
|
|
78
|
+
* PaidBillsAmount: 15420.8,
|
|
79
|
+
* OverdueBillsAmount: 425,
|
|
80
|
+
* ApprovedBillsAmount: 3240.9,
|
|
81
|
+
* DisapprovedBillsAmount: 180,
|
|
82
|
+
* TotalBillsAmount: 25083.2
|
|
83
|
+
* },
|
|
84
|
+
* PaypointLegalname: "Sunshine Services, LLC",
|
|
85
|
+
* PaypointDbaname: "Sunshine Gutters",
|
|
86
|
+
* PaypointEntryname: "d193cf9a46",
|
|
87
|
+
* ParentOrgName: "PropertyManager Pro",
|
|
88
|
+
* ParentOrgId: 1000,
|
|
89
|
+
* CreatedDate: "2022-07-01T15:00:01Z",
|
|
90
|
+
* LastUpdated: "2022-07-01T15:00:01Z",
|
|
91
|
+
* remitAddress1: "123 Walnut Street",
|
|
92
|
+
* remitAddress2: "Suite 900",
|
|
93
|
+
* remitCity: "Miami",
|
|
94
|
+
* remitState: "FL",
|
|
95
|
+
* remitZip: "31113",
|
|
96
|
+
* remitCountry: "US",
|
|
97
|
+
* payeeName1: "payeeName1",
|
|
98
|
+
* payeeName2: "payeeName2",
|
|
99
|
+
* customField1: "",
|
|
100
|
+
* customField2: "",
|
|
101
|
+
* customerVendorAccount: "123-456",
|
|
102
|
+
* InternalReferenceId: 1000000,
|
|
103
|
+
* externalPaypointID: "Paypoint-100",
|
|
104
|
+
* StoredMethods: []
|
|
105
|
+
* },
|
|
106
|
+
* BillData: [{
|
|
107
|
+
* billId: 3001,
|
|
108
|
+
* invoiceNumber: "INV-5001",
|
|
109
|
+
* netAmount: "500",
|
|
110
|
+
* invoiceDate: "2025-08-01",
|
|
111
|
+
* dueDate: "2025-08-15"
|
|
112
|
+
* }],
|
|
113
|
+
* ExternalPaypointID: "d193cf9a46-10",
|
|
114
|
+
* Method: "ach",
|
|
115
|
+
* PaypointId: 255,
|
|
116
|
+
* TotalAmount: 500,
|
|
117
|
+
* NetAmount: 500,
|
|
118
|
+
* FeeAmount: 0,
|
|
119
|
+
* PaymentData: {
|
|
120
|
+
* AccountType: "checking",
|
|
121
|
+
* HolderName: "Herman Coatings",
|
|
122
|
+
* Initiator: "merchant",
|
|
123
|
+
* MaskedAccount: "XXXXXX5666",
|
|
124
|
+
* paymentDetails: {
|
|
125
|
+
* currency: "USD",
|
|
126
|
+
* serviceFee: 0,
|
|
127
|
+
* totalAmount: 500
|
|
128
|
+
* },
|
|
129
|
+
* Sequence: "subsequent",
|
|
130
|
+
* StoredMethodUsageType: "recurring"
|
|
131
|
+
* },
|
|
132
|
+
* StartDate: "2025-09-01T00:00:00Z",
|
|
133
|
+
* EndDate: "2026-09-01T00:00:00Z",
|
|
134
|
+
* NextDate: "2025-10-01T00:00:00Z",
|
|
135
|
+
* Frequency: "monthly",
|
|
136
|
+
* TotalCycles: 12,
|
|
137
|
+
* LeftCycles: 11,
|
|
138
|
+
* LastRun: "2025-09-01T06:00:00Z",
|
|
139
|
+
* EntrypageId: 0,
|
|
140
|
+
* UntilCancelled: false,
|
|
141
|
+
* LastUpdated: "2025-08-01T12:00:00Z",
|
|
142
|
+
* CreatedAt: "2025-08-01T12:00:00Z",
|
|
143
|
+
* PaypointLegalname: "Sunshine Services, LLC",
|
|
144
|
+
* PaypointDbaname: "Sunshine Gutters",
|
|
145
|
+
* PaypointEntryname: "d193cf9a46",
|
|
146
|
+
* ParentOrgName: "PropertyManager Pro",
|
|
147
|
+
* ParentOrgId: 236,
|
|
148
|
+
* Source: "api"
|
|
149
|
+
* }]
|
|
150
|
+
* }
|
|
151
|
+
*/
|
|
152
|
+
export interface QueryPayoutSubscriptionResponse {
|
|
153
|
+
Summary?: Payabli.QuerySummary | undefined;
|
|
154
|
+
Records?: Payabli.PayoutSubscriptionQueryRecordPascal[] | undefined;
|
|
155
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
export interface UpdatePayoutSubscriptionBody {
|
|
3
|
+
setPause?: Payabli.PayoutSetPause | undefined;
|
|
4
|
+
/** Object describing details of the payout. */
|
|
5
|
+
paymentDetails?: Payabli.PayoutPaymentDetail | undefined;
|
|
6
|
+
paymentMethod?: Payabli.AuthorizePaymentMethod | undefined;
|
|
7
|
+
/** Object describing the schedule for the payout subscription. */
|
|
8
|
+
scheduleDetails?: Payabli.PayoutScheduleDetail | undefined;
|
|
9
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type * as Payabli from "../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Success response
|
|
4
|
+
*/
|
|
5
|
+
export interface UpdatePayoutSubscriptionResponse {
|
|
6
|
+
isSuccess?: Payabli.IsSuccess | undefined;
|
|
7
|
+
responseText: Payabli.ResponseText;
|
|
8
|
+
/**
|
|
9
|
+
* If `isSuccess` = true, this contains the payout subscription ID. When the subscription is paused, it also includes a description (for example, "42 paused").
|
|
10
|
+
*
|
|
11
|
+
* If `isSuccess` = false, this contains the reason for the failure.
|
|
12
|
+
*/
|
|
13
|
+
responseData?: string | undefined;
|
|
14
|
+
customerId?: Payabli.CustomerId | undefined;
|
|
15
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export * from "./AddPayoutSubscriptionResponse.js";
|
|
2
|
+
export * from "./DeletePayoutSubscriptionResponse.js";
|
|
3
|
+
export * from "./GetPayoutSubscriptionResponse.js";
|
|
4
|
+
export * from "./PayoutPaymentDetail.js";
|
|
5
|
+
export * from "./PayoutScheduleDetail.js";
|
|
6
|
+
export * from "./PayoutSetPause.js";
|
|
7
|
+
export * from "./PayoutSubscriptionQueryRecord.js";
|
|
8
|
+
export * from "./PayoutSubscriptionQueryRecordPascal.js";
|
|
9
|
+
export * from "./PayoutSubscriptionRequestBody.js";
|
|
10
|
+
export * from "./QueryPayoutSubscriptionResponse.js";
|
|
11
|
+
export * from "./UpdatePayoutSubscriptionBody.js";
|
|
12
|
+
export * from "./UpdatePayoutSubscriptionResponse.js";
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./AddPayoutSubscriptionResponse.js"), exports);
|
|
18
|
+
__exportStar(require("./DeletePayoutSubscriptionResponse.js"), exports);
|
|
19
|
+
__exportStar(require("./GetPayoutSubscriptionResponse.js"), exports);
|
|
20
|
+
__exportStar(require("./PayoutPaymentDetail.js"), exports);
|
|
21
|
+
__exportStar(require("./PayoutScheduleDetail.js"), exports);
|
|
22
|
+
__exportStar(require("./PayoutSetPause.js"), exports);
|
|
23
|
+
__exportStar(require("./PayoutSubscriptionQueryRecord.js"), exports);
|
|
24
|
+
__exportStar(require("./PayoutSubscriptionQueryRecordPascal.js"), exports);
|
|
25
|
+
__exportStar(require("./PayoutSubscriptionRequestBody.js"), exports);
|
|
26
|
+
__exportStar(require("./QueryPayoutSubscriptionResponse.js"), exports);
|
|
27
|
+
__exportStar(require("./UpdatePayoutSubscriptionBody.js"), exports);
|
|
28
|
+
__exportStar(require("./UpdatePayoutSubscriptionResponse.js"), exports);
|
|
@@ -473,13 +473,54 @@ export declare class QueryClient {
|
|
|
473
473
|
*/
|
|
474
474
|
listSubscriptionsOrg(orgId: number, request?: Payabli.ListSubscriptionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QuerySubscriptionResponse>;
|
|
475
475
|
private __listSubscriptionsOrg;
|
|
476
|
+
/**
|
|
477
|
+
* Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
478
|
+
*
|
|
479
|
+
* @param {Payabli.Entry} entry
|
|
480
|
+
* @param {Payabli.ListPayoutSubscriptionsRequest} request
|
|
481
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
482
|
+
*
|
|
483
|
+
* @throws {@link Payabli.BadRequestError}
|
|
484
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
485
|
+
* @throws {@link Payabli.InternalServerError}
|
|
486
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
487
|
+
*
|
|
488
|
+
* @example
|
|
489
|
+
* await client.query.listPayoutSubscriptions("8cfec329267", {
|
|
490
|
+
* fromRecord: 0,
|
|
491
|
+
* limitRecord: 20,
|
|
492
|
+
* sortBy: "desc(field_name)"
|
|
493
|
+
* })
|
|
494
|
+
*/
|
|
495
|
+
listPayoutSubscriptions(entry: Payabli.Entry, request?: Payabli.ListPayoutSubscriptionsRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryPayoutSubscriptionResponse>;
|
|
496
|
+
private __listPayoutSubscriptions;
|
|
497
|
+
/**
|
|
498
|
+
* Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
499
|
+
*
|
|
500
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
501
|
+
* @param {Payabli.ListPayoutSubscriptionsOrgRequest} request
|
|
502
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
503
|
+
*
|
|
504
|
+
* @throws {@link Payabli.BadRequestError}
|
|
505
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
506
|
+
* @throws {@link Payabli.InternalServerError}
|
|
507
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
508
|
+
*
|
|
509
|
+
* @example
|
|
510
|
+
* await client.query.listPayoutSubscriptionsOrg(123, {
|
|
511
|
+
* fromRecord: 0,
|
|
512
|
+
* limitRecord: 20,
|
|
513
|
+
* sortBy: "desc(field_name)"
|
|
514
|
+
* })
|
|
515
|
+
*/
|
|
516
|
+
listPayoutSubscriptionsOrg(orgId: number, request?: Payabli.ListPayoutSubscriptionsOrgRequest, requestOptions?: QueryClient.RequestOptions): core.HttpResponsePromise<Payabli.QueryPayoutSubscriptionResponse>;
|
|
517
|
+
private __listPayoutSubscriptionsOrg;
|
|
476
518
|
/**
|
|
477
519
|
* Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
478
520
|
* By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
|
|
479
521
|
* For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
480
|
-
* ``` curl
|
|
481
|
-
*
|
|
482
|
-
* --header 'requestToken: <api-key>'
|
|
522
|
+
* ``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
|
|
523
|
+
* -H 'requestToken: <API TOKEN>'
|
|
483
524
|
*
|
|
484
525
|
* ```
|
|
485
526
|
*
|
|
@@ -512,9 +553,8 @@ export declare class QueryClient {
|
|
|
512
553
|
* For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
513
554
|
*
|
|
514
555
|
* ```
|
|
515
|
-
* curl
|
|
516
|
-
*
|
|
517
|
-
* --header 'requestToken: <api-key>'
|
|
556
|
+
* curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
|
|
557
|
+
* -H 'requestToken: <API TOKEN>'
|
|
518
558
|
*
|
|
519
559
|
* ```
|
|
520
560
|
*
|
|
@@ -1599,13 +1599,158 @@ class QueryClient {
|
|
|
1599
1599
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/subscriptions/org/{orgId}");
|
|
1600
1600
|
});
|
|
1601
1601
|
}
|
|
1602
|
+
/**
|
|
1603
|
+
* Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
1604
|
+
*
|
|
1605
|
+
* @param {Payabli.Entry} entry
|
|
1606
|
+
* @param {Payabli.ListPayoutSubscriptionsRequest} request
|
|
1607
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1608
|
+
*
|
|
1609
|
+
* @throws {@link Payabli.BadRequestError}
|
|
1610
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
1611
|
+
* @throws {@link Payabli.InternalServerError}
|
|
1612
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
1613
|
+
*
|
|
1614
|
+
* @example
|
|
1615
|
+
* await client.query.listPayoutSubscriptions("8cfec329267", {
|
|
1616
|
+
* fromRecord: 0,
|
|
1617
|
+
* limitRecord: 20,
|
|
1618
|
+
* sortBy: "desc(field_name)"
|
|
1619
|
+
* })
|
|
1620
|
+
*/
|
|
1621
|
+
listPayoutSubscriptions(entry, request = {}, requestOptions) {
|
|
1622
|
+
return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptions(entry, request, requestOptions));
|
|
1623
|
+
}
|
|
1624
|
+
__listPayoutSubscriptions(entry_1) {
|
|
1625
|
+
return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
|
|
1626
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
1627
|
+
const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
|
|
1628
|
+
const _queryParams = {
|
|
1629
|
+
exportFormat: exportFormat != null ? exportFormat : undefined,
|
|
1630
|
+
fromRecord,
|
|
1631
|
+
limitRecord,
|
|
1632
|
+
parameters: parameters != null ? (0, json_js_1.toJson)(parameters) : undefined,
|
|
1633
|
+
sortBy,
|
|
1634
|
+
};
|
|
1635
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
1636
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
1637
|
+
const _response = yield core.fetcher({
|
|
1638
|
+
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/payoutsubscriptions/${core.url.encodePathParam(entry)}`),
|
|
1639
|
+
method: "GET",
|
|
1640
|
+
headers: _headers,
|
|
1641
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
1642
|
+
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,
|
|
1643
|
+
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,
|
|
1644
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
1645
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
1646
|
+
logging: this._options.logging,
|
|
1647
|
+
});
|
|
1648
|
+
if (_response.ok) {
|
|
1649
|
+
return {
|
|
1650
|
+
data: _response.body,
|
|
1651
|
+
rawResponse: _response.rawResponse,
|
|
1652
|
+
};
|
|
1653
|
+
}
|
|
1654
|
+
if (_response.error.reason === "status-code") {
|
|
1655
|
+
switch (_response.error.statusCode) {
|
|
1656
|
+
case 400:
|
|
1657
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
1658
|
+
case 401:
|
|
1659
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
1660
|
+
case 500:
|
|
1661
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
1662
|
+
case 503:
|
|
1663
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
1664
|
+
default:
|
|
1665
|
+
throw new errors.PayabliError({
|
|
1666
|
+
statusCode: _response.error.statusCode,
|
|
1667
|
+
body: _response.error.body,
|
|
1668
|
+
rawResponse: _response.rawResponse,
|
|
1669
|
+
});
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/payoutsubscriptions/{entry}");
|
|
1673
|
+
});
|
|
1674
|
+
}
|
|
1675
|
+
/**
|
|
1676
|
+
* Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
1677
|
+
*
|
|
1678
|
+
* @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
|
|
1679
|
+
* @param {Payabli.ListPayoutSubscriptionsOrgRequest} request
|
|
1680
|
+
* @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
1681
|
+
*
|
|
1682
|
+
* @throws {@link Payabli.BadRequestError}
|
|
1683
|
+
* @throws {@link Payabli.UnauthorizedError}
|
|
1684
|
+
* @throws {@link Payabli.InternalServerError}
|
|
1685
|
+
* @throws {@link Payabli.ServiceUnavailableError}
|
|
1686
|
+
*
|
|
1687
|
+
* @example
|
|
1688
|
+
* await client.query.listPayoutSubscriptionsOrg(123, {
|
|
1689
|
+
* fromRecord: 0,
|
|
1690
|
+
* limitRecord: 20,
|
|
1691
|
+
* sortBy: "desc(field_name)"
|
|
1692
|
+
* })
|
|
1693
|
+
*/
|
|
1694
|
+
listPayoutSubscriptionsOrg(orgId, request = {}, requestOptions) {
|
|
1695
|
+
return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptionsOrg(orgId, request, requestOptions));
|
|
1696
|
+
}
|
|
1697
|
+
__listPayoutSubscriptionsOrg(orgId_1) {
|
|
1698
|
+
return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
|
|
1699
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
1700
|
+
const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
|
|
1701
|
+
const _queryParams = {
|
|
1702
|
+
exportFormat: exportFormat != null ? exportFormat : undefined,
|
|
1703
|
+
fromRecord,
|
|
1704
|
+
limitRecord,
|
|
1705
|
+
parameters: parameters != null ? (0, json_js_1.toJson)(parameters) : undefined,
|
|
1706
|
+
sortBy,
|
|
1707
|
+
};
|
|
1708
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
1709
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
1710
|
+
const _response = yield core.fetcher({
|
|
1711
|
+
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/payoutsubscriptions/org/${core.url.encodePathParam(orgId)}`),
|
|
1712
|
+
method: "GET",
|
|
1713
|
+
headers: _headers,
|
|
1714
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
1715
|
+
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,
|
|
1716
|
+
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,
|
|
1717
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
1718
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
1719
|
+
logging: this._options.logging,
|
|
1720
|
+
});
|
|
1721
|
+
if (_response.ok) {
|
|
1722
|
+
return {
|
|
1723
|
+
data: _response.body,
|
|
1724
|
+
rawResponse: _response.rawResponse,
|
|
1725
|
+
};
|
|
1726
|
+
}
|
|
1727
|
+
if (_response.error.reason === "status-code") {
|
|
1728
|
+
switch (_response.error.statusCode) {
|
|
1729
|
+
case 400:
|
|
1730
|
+
throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
|
|
1731
|
+
case 401:
|
|
1732
|
+
throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
1733
|
+
case 500:
|
|
1734
|
+
throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
|
|
1735
|
+
case 503:
|
|
1736
|
+
throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
1737
|
+
default:
|
|
1738
|
+
throw new errors.PayabliError({
|
|
1739
|
+
statusCode: _response.error.statusCode,
|
|
1740
|
+
body: _response.error.body,
|
|
1741
|
+
rawResponse: _response.rawResponse,
|
|
1742
|
+
});
|
|
1743
|
+
}
|
|
1744
|
+
}
|
|
1745
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/Query/payoutsubscriptions/org/{orgId}");
|
|
1746
|
+
});
|
|
1747
|
+
}
|
|
1602
1748
|
/**
|
|
1603
1749
|
* Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
1604
1750
|
* By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
|
|
1605
1751
|
* For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
1606
|
-
* ``` curl
|
|
1607
|
-
*
|
|
1608
|
-
* --header 'requestToken: <api-key>'
|
|
1752
|
+
* ``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
|
|
1753
|
+
* -H 'requestToken: <API TOKEN>'
|
|
1609
1754
|
*
|
|
1610
1755
|
* ```
|
|
1611
1756
|
*
|
|
@@ -1687,9 +1832,8 @@ class QueryClient {
|
|
|
1687
1832
|
* For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
1688
1833
|
*
|
|
1689
1834
|
* ```
|
|
1690
|
-
* curl
|
|
1691
|
-
*
|
|
1692
|
-
* --header 'requestToken: <api-key>'
|
|
1835
|
+
* curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
|
|
1836
|
+
* -H 'requestToken: <API TOKEN>'
|
|
1693
1837
|
*
|
|
1694
1838
|
* ```
|
|
1695
1839
|
*
|
|
@@ -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 ListPayoutSubscriptionsOrgRequest {
|
|
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/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
26
|
+
*
|
|
27
|
+
* should become:
|
|
28
|
+
*
|
|
29
|
+
* --url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?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
|
+
}
|