@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.
Files changed (181) hide show
  1. package/README.md +13 -13
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +6 -0
  4. package/dist/cjs/Client.js +52 -42
  5. package/dist/cjs/api/resources/ghostCard/client/Client.d.ts +67 -0
  6. package/dist/cjs/api/resources/ghostCard/client/Client.js +201 -0
  7. package/dist/cjs/api/resources/ghostCard/client/index.d.ts +1 -0
  8. package/dist/cjs/api/resources/ghostCard/client/index.js +17 -0
  9. package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.ts +53 -0
  10. package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.js +3 -0
  11. package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.ts +14 -0
  12. package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.js +3 -0
  13. package/dist/cjs/api/resources/ghostCard/client/requests/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/ghostCard/client/requests/index.js +2 -0
  15. package/dist/cjs/api/resources/ghostCard/exports.d.ts +2 -0
  16. package/dist/cjs/api/resources/ghostCard/exports.js +21 -0
  17. package/dist/cjs/api/resources/ghostCard/index.d.ts +2 -0
  18. package/dist/cjs/api/resources/ghostCard/index.js +18 -0
  19. package/dist/cjs/api/resources/ghostCard/types/CardStatus.d.ts +8 -0
  20. package/dist/cjs/api/resources/ghostCard/types/CardStatus.js +11 -0
  21. package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.d.ts +17 -0
  22. package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.js +3 -0
  23. package/dist/cjs/api/resources/ghostCard/types/index.d.ts +2 -0
  24. package/dist/cjs/api/resources/ghostCard/types/index.js +18 -0
  25. package/dist/cjs/api/resources/index.d.ts +6 -0
  26. package/dist/cjs/api/resources/index.js +7 -1
  27. package/dist/cjs/api/resources/payoutSubscription/client/Client.d.ts +156 -0
  28. package/dist/cjs/api/resources/payoutSubscription/client/Client.js +385 -0
  29. package/dist/cjs/api/resources/payoutSubscription/client/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/payoutSubscription/client/index.js +17 -0
  31. package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.ts +67 -0
  32. package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.js +3 -0
  33. package/dist/cjs/api/resources/payoutSubscription/client/requests/index.d.ts +1 -0
  34. package/dist/cjs/api/resources/payoutSubscription/client/requests/index.js +2 -0
  35. package/dist/cjs/api/resources/payoutSubscription/exports.d.ts +2 -0
  36. package/dist/cjs/api/resources/payoutSubscription/exports.js +21 -0
  37. package/dist/cjs/api/resources/payoutSubscription/index.d.ts +2 -0
  38. package/dist/cjs/api/resources/payoutSubscription/index.js +18 -0
  39. package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.ts +20 -0
  40. package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.js +3 -0
  41. package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.ts +14 -0
  42. package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.js +3 -0
  43. package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +151 -0
  44. package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.js +3 -0
  45. package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.ts +31 -0
  46. package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.js +3 -0
  47. package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.ts +9 -0
  48. package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.js +3 -0
  49. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.d.ts +4 -0
  50. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.js +3 -0
  51. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +195 -0
  52. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.js +3 -0
  53. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +195 -0
  54. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.js +3 -0
  55. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.ts +69 -0
  56. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.js +3 -0
  57. package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +155 -0
  58. package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.js +3 -0
  59. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.ts +9 -0
  60. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.js +3 -0
  61. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.ts +15 -0
  62. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.js +3 -0
  63. package/dist/cjs/api/resources/payoutSubscription/types/index.d.ts +12 -0
  64. package/dist/cjs/api/resources/payoutSubscription/types/index.js +28 -0
  65. package/dist/cjs/api/resources/query/client/Client.d.ts +46 -6
  66. package/dist/cjs/api/resources/query/client/Client.js +150 -6
  67. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.ts +84 -0
  68. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.js +3 -0
  69. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.ts +84 -0
  70. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.js +3 -0
  71. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  72. package/dist/cjs/api/types/NotificationStandardRequest.d.ts +0 -31
  73. package/dist/cjs/api/types/NotificationStandardRequest.js +0 -31
  74. package/dist/cjs/api/types/Remitaddress1.d.ts +1 -1
  75. package/dist/cjs/api/types/Remitaddress2.d.ts +1 -1
  76. package/dist/cjs/api/types/Remitcity.d.ts +1 -1
  77. package/dist/cjs/api/types/Remitcountry.d.ts +1 -1
  78. package/dist/cjs/api/types/Remitstate.d.ts +1 -1
  79. package/dist/cjs/api/types/Remitzip.d.ts +1 -1
  80. package/dist/cjs/api/types/VendorData.d.ts +6 -6
  81. package/dist/cjs/api/types/VendorEin.d.ts +1 -1
  82. package/dist/cjs/api/types/VendorName1.d.ts +1 -1
  83. package/dist/cjs/api/types/VendorName2.d.ts +1 -1
  84. package/dist/cjs/api/types/VendorNumber.d.ts +1 -1
  85. package/dist/cjs/api/types/VendorOutData.d.ts +9 -9
  86. package/dist/cjs/api/types/VendorQueryRecord.d.ts +1 -1
  87. package/dist/cjs/api/types/Vendorstatus.d.ts +5 -3
  88. package/dist/cjs/core/file/file.js +3 -2
  89. package/dist/cjs/version.d.ts +1 -1
  90. package/dist/cjs/version.js +1 -1
  91. package/dist/esm/BaseClient.mjs +2 -2
  92. package/dist/esm/Client.d.mts +6 -0
  93. package/dist/esm/Client.mjs +10 -0
  94. package/dist/esm/api/resources/ghostCard/client/Client.d.mts +67 -0
  95. package/dist/esm/api/resources/ghostCard/client/Client.mjs +164 -0
  96. package/dist/esm/api/resources/ghostCard/client/index.d.mts +1 -0
  97. package/dist/esm/api/resources/ghostCard/client/index.mjs +1 -0
  98. package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.mts +53 -0
  99. package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.mjs +2 -0
  100. package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.mts +14 -0
  101. package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.mjs +2 -0
  102. package/dist/esm/api/resources/ghostCard/client/requests/index.d.mts +2 -0
  103. package/dist/esm/api/resources/ghostCard/client/requests/index.mjs +1 -0
  104. package/dist/esm/api/resources/ghostCard/exports.d.mts +2 -0
  105. package/dist/esm/api/resources/ghostCard/exports.mjs +3 -0
  106. package/dist/esm/api/resources/ghostCard/index.d.mts +2 -0
  107. package/dist/esm/api/resources/ghostCard/index.mjs +2 -0
  108. package/dist/esm/api/resources/ghostCard/types/CardStatus.d.mts +8 -0
  109. package/dist/esm/api/resources/ghostCard/types/CardStatus.mjs +8 -0
  110. package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.d.mts +17 -0
  111. package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.mjs +2 -0
  112. package/dist/esm/api/resources/ghostCard/types/index.d.mts +2 -0
  113. package/dist/esm/api/resources/ghostCard/types/index.mjs +2 -0
  114. package/dist/esm/api/resources/index.d.mts +6 -0
  115. package/dist/esm/api/resources/index.mjs +6 -0
  116. package/dist/esm/api/resources/payoutSubscription/client/Client.d.mts +156 -0
  117. package/dist/esm/api/resources/payoutSubscription/client/Client.mjs +348 -0
  118. package/dist/esm/api/resources/payoutSubscription/client/index.d.mts +1 -0
  119. package/dist/esm/api/resources/payoutSubscription/client/index.mjs +1 -0
  120. package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.mts +67 -0
  121. package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.mjs +2 -0
  122. package/dist/esm/api/resources/payoutSubscription/client/requests/index.d.mts +1 -0
  123. package/dist/esm/api/resources/payoutSubscription/client/requests/index.mjs +1 -0
  124. package/dist/esm/api/resources/payoutSubscription/exports.d.mts +2 -0
  125. package/dist/esm/api/resources/payoutSubscription/exports.mjs +3 -0
  126. package/dist/esm/api/resources/payoutSubscription/index.d.mts +2 -0
  127. package/dist/esm/api/resources/payoutSubscription/index.mjs +2 -0
  128. package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.mts +20 -0
  129. package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.mjs +2 -0
  130. package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.mts +14 -0
  131. package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.mjs +2 -0
  132. package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +151 -0
  133. package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.mjs +2 -0
  134. package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.mts +31 -0
  135. package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.mjs +2 -0
  136. package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.mts +9 -0
  137. package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.mjs +2 -0
  138. package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.d.mts +4 -0
  139. package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.mjs +2 -0
  140. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +195 -0
  141. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.mjs +2 -0
  142. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +195 -0
  143. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.mjs +2 -0
  144. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.mts +69 -0
  145. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.mjs +2 -0
  146. package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +155 -0
  147. package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.mjs +2 -0
  148. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.mts +9 -0
  149. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.mjs +2 -0
  150. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.mts +15 -0
  151. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.mjs +2 -0
  152. package/dist/esm/api/resources/payoutSubscription/types/index.d.mts +12 -0
  153. package/dist/esm/api/resources/payoutSubscription/types/index.mjs +12 -0
  154. package/dist/esm/api/resources/query/client/Client.d.mts +46 -6
  155. package/dist/esm/api/resources/query/client/Client.mjs +150 -6
  156. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.mts +84 -0
  157. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.mjs +2 -0
  158. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.mts +84 -0
  159. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.mjs +2 -0
  160. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  161. package/dist/esm/api/types/NotificationStandardRequest.d.mts +0 -31
  162. package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -31
  163. package/dist/esm/api/types/Remitaddress1.d.mts +1 -1
  164. package/dist/esm/api/types/Remitaddress2.d.mts +1 -1
  165. package/dist/esm/api/types/Remitcity.d.mts +1 -1
  166. package/dist/esm/api/types/Remitcountry.d.mts +1 -1
  167. package/dist/esm/api/types/Remitstate.d.mts +1 -1
  168. package/dist/esm/api/types/Remitzip.d.mts +1 -1
  169. package/dist/esm/api/types/VendorData.d.mts +6 -6
  170. package/dist/esm/api/types/VendorEin.d.mts +1 -1
  171. package/dist/esm/api/types/VendorName1.d.mts +1 -1
  172. package/dist/esm/api/types/VendorName2.d.mts +1 -1
  173. package/dist/esm/api/types/VendorNumber.d.mts +1 -1
  174. package/dist/esm/api/types/VendorOutData.d.mts +9 -9
  175. package/dist/esm/api/types/VendorQueryRecord.d.mts +1 -1
  176. package/dist/esm/api/types/Vendorstatus.d.mts +5 -3
  177. package/dist/esm/core/file/file.mjs +3 -2
  178. package/dist/esm/version.d.mts +1 -1
  179. package/dist/esm/version.mjs +1 -1
  180. package/package.json +29 -7
  181. package/reference.md +682 -78
@@ -0,0 +1,155 @@
1
+ import type * as Payabli from "../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ import type * as Payabli from "../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,15 @@
1
+ import type * as Payabli from "../../../index.mjs";
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,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,12 @@
1
+ export * from "./AddPayoutSubscriptionResponse.mjs";
2
+ export * from "./DeletePayoutSubscriptionResponse.mjs";
3
+ export * from "./GetPayoutSubscriptionResponse.mjs";
4
+ export * from "./PayoutPaymentDetail.mjs";
5
+ export * from "./PayoutScheduleDetail.mjs";
6
+ export * from "./PayoutSetPause.mjs";
7
+ export * from "./PayoutSubscriptionQueryRecord.mjs";
8
+ export * from "./PayoutSubscriptionQueryRecordPascal.mjs";
9
+ export * from "./PayoutSubscriptionRequestBody.mjs";
10
+ export * from "./QueryPayoutSubscriptionResponse.mjs";
11
+ export * from "./UpdatePayoutSubscriptionBody.mjs";
12
+ export * from "./UpdatePayoutSubscriptionResponse.mjs";
@@ -0,0 +1,12 @@
1
+ export * from "./AddPayoutSubscriptionResponse.mjs";
2
+ export * from "./DeletePayoutSubscriptionResponse.mjs";
3
+ export * from "./GetPayoutSubscriptionResponse.mjs";
4
+ export * from "./PayoutPaymentDetail.mjs";
5
+ export * from "./PayoutScheduleDetail.mjs";
6
+ export * from "./PayoutSetPause.mjs";
7
+ export * from "./PayoutSubscriptionQueryRecord.mjs";
8
+ export * from "./PayoutSubscriptionQueryRecordPascal.mjs";
9
+ export * from "./PayoutSubscriptionRequestBody.mjs";
10
+ export * from "./QueryPayoutSubscriptionResponse.mjs";
11
+ export * from "./UpdatePayoutSubscriptionBody.mjs";
12
+ export * from "./UpdatePayoutSubscriptionResponse.mjs";
@@ -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 --request GET \
481
- * --url 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\
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 --request GET \
516
- * --url 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\
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
  *
@@ -1563,13 +1563,158 @@ export class QueryClient {
1563
1563
  return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/subscriptions/org/{orgId}");
1564
1564
  });
1565
1565
  }
1566
+ /**
1567
+ * 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.
1568
+ *
1569
+ * @param {Payabli.Entry} entry
1570
+ * @param {Payabli.ListPayoutSubscriptionsRequest} request
1571
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
1572
+ *
1573
+ * @throws {@link Payabli.BadRequestError}
1574
+ * @throws {@link Payabli.UnauthorizedError}
1575
+ * @throws {@link Payabli.InternalServerError}
1576
+ * @throws {@link Payabli.ServiceUnavailableError}
1577
+ *
1578
+ * @example
1579
+ * await client.query.listPayoutSubscriptions("8cfec329267", {
1580
+ * fromRecord: 0,
1581
+ * limitRecord: 20,
1582
+ * sortBy: "desc(field_name)"
1583
+ * })
1584
+ */
1585
+ listPayoutSubscriptions(entry, request = {}, requestOptions) {
1586
+ return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptions(entry, request, requestOptions));
1587
+ }
1588
+ __listPayoutSubscriptions(entry_1) {
1589
+ return __awaiter(this, arguments, void 0, function* (entry, request = {}, requestOptions) {
1590
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1591
+ const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
1592
+ const _queryParams = {
1593
+ exportFormat: exportFormat != null ? exportFormat : undefined,
1594
+ fromRecord,
1595
+ limitRecord,
1596
+ parameters: parameters != null ? toJson(parameters) : undefined,
1597
+ sortBy,
1598
+ };
1599
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1600
+ 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);
1601
+ const _response = yield core.fetcher({
1602
+ 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)}`),
1603
+ method: "GET",
1604
+ headers: _headers,
1605
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1606
+ 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,
1607
+ 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,
1608
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1609
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1610
+ logging: this._options.logging,
1611
+ });
1612
+ if (_response.ok) {
1613
+ return {
1614
+ data: _response.body,
1615
+ rawResponse: _response.rawResponse,
1616
+ };
1617
+ }
1618
+ if (_response.error.reason === "status-code") {
1619
+ switch (_response.error.statusCode) {
1620
+ case 400:
1621
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1622
+ case 401:
1623
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1624
+ case 500:
1625
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1626
+ case 503:
1627
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1628
+ default:
1629
+ throw new errors.PayabliError({
1630
+ statusCode: _response.error.statusCode,
1631
+ body: _response.error.body,
1632
+ rawResponse: _response.rawResponse,
1633
+ });
1634
+ }
1635
+ }
1636
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/payoutsubscriptions/{entry}");
1637
+ });
1638
+ }
1639
+ /**
1640
+ * 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.
1641
+ *
1642
+ * @param {number} orgId - The numeric identifier for organization, assigned by Payabli.
1643
+ * @param {Payabli.ListPayoutSubscriptionsOrgRequest} request
1644
+ * @param {QueryClient.RequestOptions} requestOptions - Request-specific configuration.
1645
+ *
1646
+ * @throws {@link Payabli.BadRequestError}
1647
+ * @throws {@link Payabli.UnauthorizedError}
1648
+ * @throws {@link Payabli.InternalServerError}
1649
+ * @throws {@link Payabli.ServiceUnavailableError}
1650
+ *
1651
+ * @example
1652
+ * await client.query.listPayoutSubscriptionsOrg(123, {
1653
+ * fromRecord: 0,
1654
+ * limitRecord: 20,
1655
+ * sortBy: "desc(field_name)"
1656
+ * })
1657
+ */
1658
+ listPayoutSubscriptionsOrg(orgId, request = {}, requestOptions) {
1659
+ return core.HttpResponsePromise.fromPromise(this.__listPayoutSubscriptionsOrg(orgId, request, requestOptions));
1660
+ }
1661
+ __listPayoutSubscriptionsOrg(orgId_1) {
1662
+ return __awaiter(this, arguments, void 0, function* (orgId, request = {}, requestOptions) {
1663
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
1664
+ const { exportFormat, fromRecord, limitRecord, parameters, sortBy } = request;
1665
+ const _queryParams = {
1666
+ exportFormat: exportFormat != null ? exportFormat : undefined,
1667
+ fromRecord,
1668
+ limitRecord,
1669
+ parameters: parameters != null ? toJson(parameters) : undefined,
1670
+ sortBy,
1671
+ };
1672
+ const _authRequest = yield this._options.authProvider.getAuthRequest();
1673
+ 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);
1674
+ const _response = yield core.fetcher({
1675
+ 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)}`),
1676
+ method: "GET",
1677
+ headers: _headers,
1678
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
1679
+ 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,
1680
+ 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,
1681
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
1682
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
1683
+ logging: this._options.logging,
1684
+ });
1685
+ if (_response.ok) {
1686
+ return {
1687
+ data: _response.body,
1688
+ rawResponse: _response.rawResponse,
1689
+ };
1690
+ }
1691
+ if (_response.error.reason === "status-code") {
1692
+ switch (_response.error.statusCode) {
1693
+ case 400:
1694
+ throw new Payabli.BadRequestError(_response.error.body, _response.rawResponse);
1695
+ case 401:
1696
+ throw new Payabli.UnauthorizedError(_response.error.body, _response.rawResponse);
1697
+ case 500:
1698
+ throw new Payabli.InternalServerError(_response.error.body, _response.rawResponse);
1699
+ case 503:
1700
+ throw new Payabli.ServiceUnavailableError(_response.error.body, _response.rawResponse);
1701
+ default:
1702
+ throw new errors.PayabliError({
1703
+ statusCode: _response.error.statusCode,
1704
+ body: _response.error.body,
1705
+ rawResponse: _response.rawResponse,
1706
+ });
1707
+ }
1708
+ }
1709
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/Query/payoutsubscriptions/org/{orgId}");
1710
+ });
1711
+ }
1566
1712
  /**
1567
1713
  * 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.
1568
1714
  * By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
1569
1715
  * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
1570
- * ``` curl --request GET \
1571
- * --url 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\
1572
- * --header 'requestToken: <api-key>'
1716
+ * ``` 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\
1717
+ * -H 'requestToken: <API TOKEN>'
1573
1718
  *
1574
1719
  * ```
1575
1720
  *
@@ -1651,9 +1796,8 @@ export class QueryClient {
1651
1796
  * For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
1652
1797
  *
1653
1798
  * ```
1654
- * curl --request GET \
1655
- * --url 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\
1656
- * --header 'requestToken: <api-key>'
1799
+ * 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"\
1800
+ * -H 'requestToken: <API TOKEN>'
1657
1801
  *
1658
1802
  * ```
1659
1803
  *
@@ -0,0 +1,84 @@
1
+ import type * as Payabli from "../../../../index.mjs";
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
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,84 @@
1
+ import type * as Payabli from "../../../../index.mjs";
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
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -15,6 +15,8 @@ export type { ListNotificationsRequest } from "./ListNotificationsRequest.mjs";
15
15
  export type { ListOrganizationsRequest } from "./ListOrganizationsRequest.mjs";
16
16
  export type { ListPayoutOrgRequest } from "./ListPayoutOrgRequest.mjs";
17
17
  export type { ListPayoutRequest } from "./ListPayoutRequest.mjs";
18
+ export type { ListPayoutSubscriptionsOrgRequest } from "./ListPayoutSubscriptionsOrgRequest.mjs";
19
+ export type { ListPayoutSubscriptionsRequest } from "./ListPayoutSubscriptionsRequest.mjs";
18
20
  export type { ListPaypointsRequest } from "./ListPaypointsRequest.mjs";
19
21
  export type { ListSettlementsOrgRequest } from "./ListSettlementsOrgRequest.mjs";
20
22
  export type { ListSettlementsRequest } from "./ListSettlementsRequest.mjs";