@apideck/unify 0.23.1 → 0.23.2

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 (210) hide show
  1. package/README.md +26 -0
  2. package/docs/sdks/bankfeedaccounts/README.md +571 -0
  3. package/docs/sdks/bankfeedstatements/README.md +605 -0
  4. package/funcs/accountingBankFeedAccountsCreate.d.ts +17 -0
  5. package/funcs/accountingBankFeedAccountsCreate.d.ts.map +1 -0
  6. package/funcs/accountingBankFeedAccountsCreate.js +123 -0
  7. package/funcs/accountingBankFeedAccountsCreate.js.map +1 -0
  8. package/funcs/accountingBankFeedAccountsDelete.d.ts +17 -0
  9. package/funcs/accountingBankFeedAccountsDelete.d.ts.map +1 -0
  10. package/funcs/accountingBankFeedAccountsDelete.js +128 -0
  11. package/funcs/accountingBankFeedAccountsDelete.js.map +1 -0
  12. package/funcs/accountingBankFeedAccountsGet.d.ts +17 -0
  13. package/funcs/accountingBankFeedAccountsGet.d.ts.map +1 -0
  14. package/funcs/accountingBankFeedAccountsGet.js +129 -0
  15. package/funcs/accountingBankFeedAccountsGet.js.map +1 -0
  16. package/funcs/accountingBankFeedAccountsList.d.ts +20 -0
  17. package/funcs/accountingBankFeedAccountsList.d.ts.map +1 -0
  18. package/funcs/accountingBankFeedAccountsList.js +149 -0
  19. package/funcs/accountingBankFeedAccountsList.js.map +1 -0
  20. package/funcs/accountingBankFeedAccountsUpdate.d.ts +17 -0
  21. package/funcs/accountingBankFeedAccountsUpdate.d.ts.map +1 -0
  22. package/funcs/accountingBankFeedAccountsUpdate.js +129 -0
  23. package/funcs/accountingBankFeedAccountsUpdate.js.map +1 -0
  24. package/funcs/accountingBankFeedStatementsCreate.d.ts +17 -0
  25. package/funcs/accountingBankFeedStatementsCreate.d.ts.map +1 -0
  26. package/funcs/accountingBankFeedStatementsCreate.js +123 -0
  27. package/funcs/accountingBankFeedStatementsCreate.js.map +1 -0
  28. package/funcs/accountingBankFeedStatementsDelete.d.ts +17 -0
  29. package/funcs/accountingBankFeedStatementsDelete.d.ts.map +1 -0
  30. package/funcs/accountingBankFeedStatementsDelete.js +128 -0
  31. package/funcs/accountingBankFeedStatementsDelete.js.map +1 -0
  32. package/funcs/accountingBankFeedStatementsGet.d.ts +17 -0
  33. package/funcs/accountingBankFeedStatementsGet.d.ts.map +1 -0
  34. package/funcs/accountingBankFeedStatementsGet.js +129 -0
  35. package/funcs/accountingBankFeedStatementsGet.js.map +1 -0
  36. package/funcs/accountingBankFeedStatementsList.d.ts +20 -0
  37. package/funcs/accountingBankFeedStatementsList.d.ts.map +1 -0
  38. package/funcs/accountingBankFeedStatementsList.js +149 -0
  39. package/funcs/accountingBankFeedStatementsList.js.map +1 -0
  40. package/funcs/accountingBankFeedStatementsUpdate.d.ts +17 -0
  41. package/funcs/accountingBankFeedStatementsUpdate.d.ts.map +1 -0
  42. package/funcs/accountingBankFeedStatementsUpdate.js +129 -0
  43. package/funcs/accountingBankFeedStatementsUpdate.js.map +1 -0
  44. package/jsr.json +1 -1
  45. package/lib/config.d.ts +4 -4
  46. package/lib/config.js +4 -4
  47. package/lib/sdks.d.ts +3 -1
  48. package/lib/sdks.d.ts.map +1 -1
  49. package/lib/sdks.js +6 -11
  50. package/lib/sdks.js.map +1 -1
  51. package/models/components/bankfeedaccount.d.ts +230 -0
  52. package/models/components/bankfeedaccount.d.ts.map +1 -0
  53. package/models/components/bankfeedaccount.js +229 -0
  54. package/models/components/bankfeedaccount.js.map +1 -0
  55. package/models/components/bankfeedstatement.d.ts +307 -0
  56. package/models/components/bankfeedstatement.d.ts.map +1 -0
  57. package/models/components/bankfeedstatement.js +286 -0
  58. package/models/components/bankfeedstatement.js.map +1 -0
  59. package/models/components/createbankfeedaccountresponse.d.ts +70 -0
  60. package/models/components/createbankfeedaccountresponse.d.ts.map +1 -0
  61. package/models/components/createbankfeedaccountresponse.js +83 -0
  62. package/models/components/createbankfeedaccountresponse.js.map +1 -0
  63. package/models/components/createbankfeedstatementresponse.d.ts +70 -0
  64. package/models/components/createbankfeedstatementresponse.d.ts.map +1 -0
  65. package/models/components/createbankfeedstatementresponse.js +83 -0
  66. package/models/components/createbankfeedstatementresponse.js.map +1 -0
  67. package/models/components/creditordebit.d.ts +34 -0
  68. package/models/components/creditordebit.d.ts.map +1 -0
  69. package/models/components/creditordebit.js +53 -0
  70. package/models/components/creditordebit.js.map +1 -0
  71. package/models/components/deletebankfeedaccountresponse.d.ts +70 -0
  72. package/models/components/deletebankfeedaccountresponse.d.ts.map +1 -0
  73. package/models/components/deletebankfeedaccountresponse.js +83 -0
  74. package/models/components/deletebankfeedaccountresponse.js.map +1 -0
  75. package/models/components/deletebankfeedstatementresponse.d.ts +70 -0
  76. package/models/components/deletebankfeedstatementresponse.d.ts.map +1 -0
  77. package/models/components/deletebankfeedstatementresponse.js +83 -0
  78. package/models/components/deletebankfeedstatementresponse.js.map +1 -0
  79. package/models/components/ecommerceorderlineitem.d.ts +2 -2
  80. package/models/components/ecommerceorderlineitem.d.ts.map +1 -1
  81. package/models/components/ecommerceorderlineitem.js +2 -2
  82. package/models/components/ecommerceorderlineitem.js.map +1 -1
  83. package/models/components/getbankfeedaccountresponse.d.ts +67 -0
  84. package/models/components/getbankfeedaccountresponse.d.ts.map +1 -0
  85. package/models/components/getbankfeedaccountresponse.js +83 -0
  86. package/models/components/getbankfeedaccountresponse.js.map +1 -0
  87. package/models/components/getbankfeedaccountsresponse.d.ts +79 -0
  88. package/models/components/getbankfeedaccountsresponse.d.ts.map +1 -0
  89. package/models/components/getbankfeedaccountsresponse.js +89 -0
  90. package/models/components/getbankfeedaccountsresponse.js.map +1 -0
  91. package/models/components/getbankfeedstatementresponse.d.ts +67 -0
  92. package/models/components/getbankfeedstatementresponse.d.ts.map +1 -0
  93. package/models/components/getbankfeedstatementresponse.js +83 -0
  94. package/models/components/getbankfeedstatementresponse.js.map +1 -0
  95. package/models/components/getbankfeedstatementsresponse.d.ts +79 -0
  96. package/models/components/getbankfeedstatementsresponse.d.ts.map +1 -0
  97. package/models/components/getbankfeedstatementsresponse.js +89 -0
  98. package/models/components/getbankfeedstatementsresponse.js.map +1 -0
  99. package/models/components/index.d.ts +13 -0
  100. package/models/components/index.d.ts.map +1 -1
  101. package/models/components/index.js +13 -0
  102. package/models/components/index.js.map +1 -1
  103. package/models/components/updatebankfeedaccountresponse.d.ts +70 -0
  104. package/models/components/updatebankfeedaccountresponse.d.ts.map +1 -0
  105. package/models/components/updatebankfeedaccountresponse.js +83 -0
  106. package/models/components/updatebankfeedaccountresponse.js.map +1 -0
  107. package/models/components/updatebankfeedstatementresponse.d.ts +70 -0
  108. package/models/components/updatebankfeedstatementresponse.d.ts.map +1 -0
  109. package/models/components/updatebankfeedstatementresponse.js +83 -0
  110. package/models/components/updatebankfeedstatementresponse.js.map +1 -0
  111. package/models/operations/accountingbankfeedaccountsadd.d.ts +118 -0
  112. package/models/operations/accountingbankfeedaccountsadd.d.ts.map +1 -0
  113. package/models/operations/accountingbankfeedaccountsadd.js +153 -0
  114. package/models/operations/accountingbankfeedaccountsadd.js.map +1 -0
  115. package/models/operations/accountingbankfeedaccountsall.d.ts +140 -0
  116. package/models/operations/accountingbankfeedaccountsall.d.ts.map +1 -0
  117. package/models/operations/accountingbankfeedaccountsall.js +159 -0
  118. package/models/operations/accountingbankfeedaccountsall.js.map +1 -0
  119. package/models/operations/accountingbankfeedaccountsdelete.d.ts +121 -0
  120. package/models/operations/accountingbankfeedaccountsdelete.d.ts.map +1 -0
  121. package/models/operations/accountingbankfeedaccountsdelete.js +145 -0
  122. package/models/operations/accountingbankfeedaccountsdelete.js.map +1 -0
  123. package/models/operations/accountingbankfeedaccountsone.d.ts +126 -0
  124. package/models/operations/accountingbankfeedaccountsone.d.ts.map +1 -0
  125. package/models/operations/accountingbankfeedaccountsone.js +147 -0
  126. package/models/operations/accountingbankfeedaccountsone.js.map +1 -0
  127. package/models/operations/accountingbankfeedaccountsupdate.d.ts +123 -0
  128. package/models/operations/accountingbankfeedaccountsupdate.d.ts.map +1 -0
  129. package/models/operations/accountingbankfeedaccountsupdate.js +155 -0
  130. package/models/operations/accountingbankfeedaccountsupdate.js.map +1 -0
  131. package/models/operations/accountingbankfeedstatementsadd.d.ts +118 -0
  132. package/models/operations/accountingbankfeedstatementsadd.d.ts.map +1 -0
  133. package/models/operations/accountingbankfeedstatementsadd.js +153 -0
  134. package/models/operations/accountingbankfeedstatementsadd.js.map +1 -0
  135. package/models/operations/accountingbankfeedstatementsall.d.ts +140 -0
  136. package/models/operations/accountingbankfeedstatementsall.d.ts.map +1 -0
  137. package/models/operations/accountingbankfeedstatementsall.js +159 -0
  138. package/models/operations/accountingbankfeedstatementsall.js.map +1 -0
  139. package/models/operations/accountingbankfeedstatementsdelete.d.ts +121 -0
  140. package/models/operations/accountingbankfeedstatementsdelete.d.ts.map +1 -0
  141. package/models/operations/accountingbankfeedstatementsdelete.js +145 -0
  142. package/models/operations/accountingbankfeedstatementsdelete.js.map +1 -0
  143. package/models/operations/accountingbankfeedstatementsone.d.ts +126 -0
  144. package/models/operations/accountingbankfeedstatementsone.d.ts.map +1 -0
  145. package/models/operations/accountingbankfeedstatementsone.js +147 -0
  146. package/models/operations/accountingbankfeedstatementsone.js.map +1 -0
  147. package/models/operations/accountingbankfeedstatementsupdate.d.ts +123 -0
  148. package/models/operations/accountingbankfeedstatementsupdate.d.ts.map +1 -0
  149. package/models/operations/accountingbankfeedstatementsupdate.js +155 -0
  150. package/models/operations/accountingbankfeedstatementsupdate.js.map +1 -0
  151. package/models/operations/index.d.ts +10 -0
  152. package/models/operations/index.d.ts.map +1 -1
  153. package/models/operations/index.js +10 -0
  154. package/models/operations/index.js.map +1 -1
  155. package/package.json +1 -1
  156. package/sdk/accounting.d.ts +6 -0
  157. package/sdk/accounting.d.ts.map +1 -1
  158. package/sdk/accounting.js +8 -0
  159. package/sdk/accounting.js.map +1 -1
  160. package/sdk/bankfeedaccounts.d.ts +43 -0
  161. package/sdk/bankfeedaccounts.d.ts.map +1 -0
  162. package/sdk/bankfeedaccounts.js +63 -0
  163. package/sdk/bankfeedaccounts.js.map +1 -0
  164. package/sdk/bankfeedstatements.d.ts +43 -0
  165. package/sdk/bankfeedstatements.d.ts.map +1 -0
  166. package/sdk/bankfeedstatements.js +63 -0
  167. package/sdk/bankfeedstatements.js.map +1 -0
  168. package/src/__tests__/bankfeedaccounts.test.ts +333 -0
  169. package/src/__tests__/bankfeedstatements.test.ts +398 -0
  170. package/src/funcs/accountingBankFeedAccountsCreate.ts +221 -0
  171. package/src/funcs/accountingBankFeedAccountsDelete.ts +227 -0
  172. package/src/funcs/accountingBankFeedAccountsGet.ts +228 -0
  173. package/src/funcs/accountingBankFeedAccountsList.ts +295 -0
  174. package/src/funcs/accountingBankFeedAccountsUpdate.ts +228 -0
  175. package/src/funcs/accountingBankFeedStatementsCreate.ts +221 -0
  176. package/src/funcs/accountingBankFeedStatementsDelete.ts +227 -0
  177. package/src/funcs/accountingBankFeedStatementsGet.ts +228 -0
  178. package/src/funcs/accountingBankFeedStatementsList.ts +295 -0
  179. package/src/funcs/accountingBankFeedStatementsUpdate.ts +228 -0
  180. package/src/lib/config.ts +4 -4
  181. package/src/lib/sdks.ts +11 -11
  182. package/src/models/components/bankfeedaccount.ts +413 -0
  183. package/src/models/components/bankfeedstatement.ts +535 -0
  184. package/src/models/components/createbankfeedaccountresponse.ts +133 -0
  185. package/src/models/components/createbankfeedstatementresponse.ts +133 -0
  186. package/src/models/components/creditordebit.ts +39 -0
  187. package/src/models/components/deletebankfeedaccountresponse.ts +133 -0
  188. package/src/models/components/deletebankfeedstatementresponse.ts +133 -0
  189. package/src/models/components/ecommerceorderlineitem.ts +4 -4
  190. package/src/models/components/getbankfeedaccountresponse.ts +128 -0
  191. package/src/models/components/getbankfeedaccountsresponse.ts +156 -0
  192. package/src/models/components/getbankfeedstatementresponse.ts +130 -0
  193. package/src/models/components/getbankfeedstatementsresponse.ts +156 -0
  194. package/src/models/components/index.ts +13 -0
  195. package/src/models/components/updatebankfeedaccountresponse.ts +133 -0
  196. package/src/models/components/updatebankfeedstatementresponse.ts +133 -0
  197. package/src/models/operations/accountingbankfeedaccountsadd.ts +281 -0
  198. package/src/models/operations/accountingbankfeedaccountsall.ts +305 -0
  199. package/src/models/operations/accountingbankfeedaccountsdelete.ts +294 -0
  200. package/src/models/operations/accountingbankfeedaccountsone.ts +283 -0
  201. package/src/models/operations/accountingbankfeedaccountsupdate.ts +306 -0
  202. package/src/models/operations/accountingbankfeedstatementsadd.ts +289 -0
  203. package/src/models/operations/accountingbankfeedstatementsall.ts +313 -0
  204. package/src/models/operations/accountingbankfeedstatementsdelete.ts +295 -0
  205. package/src/models/operations/accountingbankfeedstatementsone.ts +291 -0
  206. package/src/models/operations/accountingbankfeedstatementsupdate.ts +307 -0
  207. package/src/models/operations/index.ts +10 -0
  208. package/src/sdk/accounting.ts +12 -0
  209. package/src/sdk/bankfeedaccounts.ts +105 -0
  210. package/src/sdk/bankfeedstatements.ts +105 -0
@@ -0,0 +1,605 @@
1
+ # BankFeedStatements
2
+ (*accounting.bankFeedStatements*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List Bank Feed Statements
9
+ * [create](#create) - Create Bank Feed Statement
10
+ * [get](#get) - Get Bank Feed Statement
11
+ * [update](#update) - Update Bank Feed Statement
12
+ * [delete](#delete) - Delete Bank Feed Statement
13
+
14
+ ## list
15
+
16
+ List Bank Feed Statements
17
+
18
+ ### Example Usage
19
+
20
+ ```typescript
21
+ import { Apideck } from "@apideck/unify";
22
+
23
+ const apideck = new Apideck({
24
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
25
+ consumerId: "test-consumer",
26
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
27
+ });
28
+
29
+ async function run() {
30
+ const result = await apideck.accounting.bankFeedStatements.list({
31
+ serviceId: "salesforce",
32
+ passThrough: {
33
+ "search": "San Francisco",
34
+ },
35
+ fields: "id,updated_at",
36
+ });
37
+
38
+ for await (const page of result) {
39
+ // Handle the page
40
+ console.log(page);
41
+ }
42
+ }
43
+
44
+ run();
45
+ ```
46
+
47
+ ### Standalone function
48
+
49
+ The standalone function version of this method:
50
+
51
+ ```typescript
52
+ import { ApideckCore } from "@apideck/unify/core.js";
53
+ import { accountingBankFeedStatementsList } from "@apideck/unify/funcs/accountingBankFeedStatementsList.js";
54
+
55
+ // Use `ApideckCore` for best tree-shaking performance.
56
+ // You can create one instance of it to use across an application.
57
+ const apideck = new ApideckCore({
58
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
59
+ consumerId: "test-consumer",
60
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
61
+ });
62
+
63
+ async function run() {
64
+ const res = await accountingBankFeedStatementsList(apideck, {
65
+ serviceId: "salesforce",
66
+ passThrough: {
67
+ "search": "San Francisco",
68
+ },
69
+ fields: "id,updated_at",
70
+ });
71
+
72
+ if (!res.ok) {
73
+ throw res.error;
74
+ }
75
+
76
+ const { value: result } = res;
77
+
78
+ for await (const page of result) {
79
+ // Handle the page
80
+ console.log(page);
81
+ }
82
+ }
83
+
84
+ run();
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ | Parameter | Type | Required | Description |
90
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
91
+ | `request` | [operations.AccountingBankFeedStatementsAllRequest](../../models/operations/accountingbankfeedstatementsallrequest.md) | :heavy_check_mark: | The request object to use for the request. |
92
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
93
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
94
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
95
+
96
+ ### Response
97
+
98
+ **Promise\<[operations.AccountingBankFeedStatementsAllResponse](../../models/operations/accountingbankfeedstatementsallresponse.md)\>**
99
+
100
+ ### Errors
101
+
102
+ | Error Type | Status Code | Content Type |
103
+ | ------------------------------ | ------------------------------ | ------------------------------ |
104
+ | errors.BadRequestResponse | 400 | application/json |
105
+ | errors.UnauthorizedResponse | 401 | application/json |
106
+ | errors.PaymentRequiredResponse | 402 | application/json |
107
+ | errors.NotFoundResponse | 404 | application/json |
108
+ | errors.UnprocessableResponse | 422 | application/json |
109
+ | errors.APIError | 4XX, 5XX | \*/\* |
110
+
111
+ ## create
112
+
113
+ Create Bank Feed Statement
114
+
115
+ ### Example Usage
116
+
117
+ ```typescript
118
+ import { Apideck } from "@apideck/unify";
119
+
120
+ const apideck = new Apideck({
121
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
122
+ consumerId: "test-consumer",
123
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
124
+ });
125
+
126
+ async function run() {
127
+ const result = await apideck.accounting.bankFeedStatements.create({
128
+ serviceId: "salesforce",
129
+ bankFeedStatement: {
130
+ bankFeedAccountId: "acc_456",
131
+ status: "pending",
132
+ startDate: new Date("2021-05-01T12:00:00.000Z"),
133
+ endDate: new Date("2025-01-31T12:00:00.000Z"),
134
+ startBalance: 10500.25,
135
+ startBalanceCreditOrDebit: "debit",
136
+ endBalance: 9800.5,
137
+ endBalanceCreditOrDebit: "debit",
138
+ transactions: [
139
+ {
140
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
141
+ description: "Payment received from ACME Corp",
142
+ amount: 250,
143
+ creditOrDebit: "debit",
144
+ sourceTransactionId: "txn_987",
145
+ counterparty: "ACME Corp",
146
+ reference: "INV-2025-01",
147
+ transactionType: "payment",
148
+ },
149
+ {
150
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
151
+ description: "Payment received from ACME Corp",
152
+ amount: 250,
153
+ creditOrDebit: "debit",
154
+ sourceTransactionId: "txn_987",
155
+ counterparty: "ACME Corp",
156
+ reference: "INV-2025-01",
157
+ transactionType: "payment",
158
+ },
159
+ ],
160
+ },
161
+ });
162
+
163
+ // Handle the result
164
+ console.log(result);
165
+ }
166
+
167
+ run();
168
+ ```
169
+
170
+ ### Standalone function
171
+
172
+ The standalone function version of this method:
173
+
174
+ ```typescript
175
+ import { ApideckCore } from "@apideck/unify/core.js";
176
+ import { accountingBankFeedStatementsCreate } from "@apideck/unify/funcs/accountingBankFeedStatementsCreate.js";
177
+
178
+ // Use `ApideckCore` for best tree-shaking performance.
179
+ // You can create one instance of it to use across an application.
180
+ const apideck = new ApideckCore({
181
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
182
+ consumerId: "test-consumer",
183
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
184
+ });
185
+
186
+ async function run() {
187
+ const res = await accountingBankFeedStatementsCreate(apideck, {
188
+ serviceId: "salesforce",
189
+ bankFeedStatement: {
190
+ bankFeedAccountId: "acc_456",
191
+ status: "pending",
192
+ startDate: new Date("2021-05-01T12:00:00.000Z"),
193
+ endDate: new Date("2025-01-31T12:00:00.000Z"),
194
+ startBalance: 10500.25,
195
+ startBalanceCreditOrDebit: "debit",
196
+ endBalance: 9800.5,
197
+ endBalanceCreditOrDebit: "debit",
198
+ transactions: [
199
+ {
200
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
201
+ description: "Payment received from ACME Corp",
202
+ amount: 250,
203
+ creditOrDebit: "debit",
204
+ sourceTransactionId: "txn_987",
205
+ counterparty: "ACME Corp",
206
+ reference: "INV-2025-01",
207
+ transactionType: "payment",
208
+ },
209
+ {
210
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
211
+ description: "Payment received from ACME Corp",
212
+ amount: 250,
213
+ creditOrDebit: "debit",
214
+ sourceTransactionId: "txn_987",
215
+ counterparty: "ACME Corp",
216
+ reference: "INV-2025-01",
217
+ transactionType: "payment",
218
+ },
219
+ ],
220
+ },
221
+ });
222
+
223
+ if (!res.ok) {
224
+ throw res.error;
225
+ }
226
+
227
+ const { value: result } = res;
228
+
229
+ // Handle the result
230
+ console.log(result);
231
+ }
232
+
233
+ run();
234
+ ```
235
+
236
+ ### Parameters
237
+
238
+ | Parameter | Type | Required | Description |
239
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
240
+ | `request` | [operations.AccountingBankFeedStatementsAddRequest](../../models/operations/accountingbankfeedstatementsaddrequest.md) | :heavy_check_mark: | The request object to use for the request. |
241
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
242
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
243
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
244
+
245
+ ### Response
246
+
247
+ **Promise\<[operations.AccountingBankFeedStatementsAddResponse](../../models/operations/accountingbankfeedstatementsaddresponse.md)\>**
248
+
249
+ ### Errors
250
+
251
+ | Error Type | Status Code | Content Type |
252
+ | ------------------------------ | ------------------------------ | ------------------------------ |
253
+ | errors.BadRequestResponse | 400 | application/json |
254
+ | errors.UnauthorizedResponse | 401 | application/json |
255
+ | errors.PaymentRequiredResponse | 402 | application/json |
256
+ | errors.NotFoundResponse | 404 | application/json |
257
+ | errors.UnprocessableResponse | 422 | application/json |
258
+ | errors.APIError | 4XX, 5XX | \*/\* |
259
+
260
+ ## get
261
+
262
+ Get Bank Feed Statement
263
+
264
+ ### Example Usage
265
+
266
+ ```typescript
267
+ import { Apideck } from "@apideck/unify";
268
+
269
+ const apideck = new Apideck({
270
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
271
+ consumerId: "test-consumer",
272
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
273
+ });
274
+
275
+ async function run() {
276
+ const result = await apideck.accounting.bankFeedStatements.get({
277
+ id: "<id>",
278
+ serviceId: "salesforce",
279
+ fields: "id,updated_at",
280
+ });
281
+
282
+ // Handle the result
283
+ console.log(result);
284
+ }
285
+
286
+ run();
287
+ ```
288
+
289
+ ### Standalone function
290
+
291
+ The standalone function version of this method:
292
+
293
+ ```typescript
294
+ import { ApideckCore } from "@apideck/unify/core.js";
295
+ import { accountingBankFeedStatementsGet } from "@apideck/unify/funcs/accountingBankFeedStatementsGet.js";
296
+
297
+ // Use `ApideckCore` for best tree-shaking performance.
298
+ // You can create one instance of it to use across an application.
299
+ const apideck = new ApideckCore({
300
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
301
+ consumerId: "test-consumer",
302
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
303
+ });
304
+
305
+ async function run() {
306
+ const res = await accountingBankFeedStatementsGet(apideck, {
307
+ id: "<id>",
308
+ serviceId: "salesforce",
309
+ fields: "id,updated_at",
310
+ });
311
+
312
+ if (!res.ok) {
313
+ throw res.error;
314
+ }
315
+
316
+ const { value: result } = res;
317
+
318
+ // Handle the result
319
+ console.log(result);
320
+ }
321
+
322
+ run();
323
+ ```
324
+
325
+ ### Parameters
326
+
327
+ | Parameter | Type | Required | Description |
328
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
329
+ | `request` | [operations.AccountingBankFeedStatementsOneRequest](../../models/operations/accountingbankfeedstatementsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
330
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
331
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
332
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
333
+
334
+ ### Response
335
+
336
+ **Promise\<[operations.AccountingBankFeedStatementsOneResponse](../../models/operations/accountingbankfeedstatementsoneresponse.md)\>**
337
+
338
+ ### Errors
339
+
340
+ | Error Type | Status Code | Content Type |
341
+ | ------------------------------ | ------------------------------ | ------------------------------ |
342
+ | errors.BadRequestResponse | 400 | application/json |
343
+ | errors.UnauthorizedResponse | 401 | application/json |
344
+ | errors.PaymentRequiredResponse | 402 | application/json |
345
+ | errors.NotFoundResponse | 404 | application/json |
346
+ | errors.UnprocessableResponse | 422 | application/json |
347
+ | errors.APIError | 4XX, 5XX | \*/\* |
348
+
349
+ ## update
350
+
351
+ Update Bank Feed Statement
352
+
353
+ ### Example Usage
354
+
355
+ ```typescript
356
+ import { Apideck } from "@apideck/unify";
357
+
358
+ const apideck = new Apideck({
359
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
360
+ consumerId: "test-consumer",
361
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
362
+ });
363
+
364
+ async function run() {
365
+ const result = await apideck.accounting.bankFeedStatements.update({
366
+ id: "<id>",
367
+ serviceId: "salesforce",
368
+ bankFeedStatement: {
369
+ bankFeedAccountId: "acc_456",
370
+ status: "pending",
371
+ startDate: new Date("2021-05-01T12:00:00.000Z"),
372
+ endDate: new Date("2025-01-31T12:00:00.000Z"),
373
+ startBalance: 10500.25,
374
+ startBalanceCreditOrDebit: "debit",
375
+ endBalance: 9800.5,
376
+ endBalanceCreditOrDebit: "debit",
377
+ transactions: [
378
+ {
379
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
380
+ description: "Payment received from ACME Corp",
381
+ amount: 250,
382
+ creditOrDebit: "debit",
383
+ sourceTransactionId: "txn_987",
384
+ counterparty: "ACME Corp",
385
+ reference: "INV-2025-01",
386
+ transactionType: "payment",
387
+ },
388
+ {
389
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
390
+ description: "Payment received from ACME Corp",
391
+ amount: 250,
392
+ creditOrDebit: "debit",
393
+ sourceTransactionId: "txn_987",
394
+ counterparty: "ACME Corp",
395
+ reference: "INV-2025-01",
396
+ transactionType: "payment",
397
+ },
398
+ {
399
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
400
+ description: "Payment received from ACME Corp",
401
+ amount: 250,
402
+ creditOrDebit: "debit",
403
+ sourceTransactionId: "txn_987",
404
+ counterparty: "ACME Corp",
405
+ reference: "INV-2025-01",
406
+ transactionType: "payment",
407
+ },
408
+ ],
409
+ },
410
+ });
411
+
412
+ // Handle the result
413
+ console.log(result);
414
+ }
415
+
416
+ run();
417
+ ```
418
+
419
+ ### Standalone function
420
+
421
+ The standalone function version of this method:
422
+
423
+ ```typescript
424
+ import { ApideckCore } from "@apideck/unify/core.js";
425
+ import { accountingBankFeedStatementsUpdate } from "@apideck/unify/funcs/accountingBankFeedStatementsUpdate.js";
426
+
427
+ // Use `ApideckCore` for best tree-shaking performance.
428
+ // You can create one instance of it to use across an application.
429
+ const apideck = new ApideckCore({
430
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
431
+ consumerId: "test-consumer",
432
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
433
+ });
434
+
435
+ async function run() {
436
+ const res = await accountingBankFeedStatementsUpdate(apideck, {
437
+ id: "<id>",
438
+ serviceId: "salesforce",
439
+ bankFeedStatement: {
440
+ bankFeedAccountId: "acc_456",
441
+ status: "pending",
442
+ startDate: new Date("2021-05-01T12:00:00.000Z"),
443
+ endDate: new Date("2025-01-31T12:00:00.000Z"),
444
+ startBalance: 10500.25,
445
+ startBalanceCreditOrDebit: "debit",
446
+ endBalance: 9800.5,
447
+ endBalanceCreditOrDebit: "debit",
448
+ transactions: [
449
+ {
450
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
451
+ description: "Payment received from ACME Corp",
452
+ amount: 250,
453
+ creditOrDebit: "debit",
454
+ sourceTransactionId: "txn_987",
455
+ counterparty: "ACME Corp",
456
+ reference: "INV-2025-01",
457
+ transactionType: "payment",
458
+ },
459
+ {
460
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
461
+ description: "Payment received from ACME Corp",
462
+ amount: 250,
463
+ creditOrDebit: "debit",
464
+ sourceTransactionId: "txn_987",
465
+ counterparty: "ACME Corp",
466
+ reference: "INV-2025-01",
467
+ transactionType: "payment",
468
+ },
469
+ {
470
+ postedDate: new Date("2025-01-15T12:00:00.000Z"),
471
+ description: "Payment received from ACME Corp",
472
+ amount: 250,
473
+ creditOrDebit: "debit",
474
+ sourceTransactionId: "txn_987",
475
+ counterparty: "ACME Corp",
476
+ reference: "INV-2025-01",
477
+ transactionType: "payment",
478
+ },
479
+ ],
480
+ },
481
+ });
482
+
483
+ if (!res.ok) {
484
+ throw res.error;
485
+ }
486
+
487
+ const { value: result } = res;
488
+
489
+ // Handle the result
490
+ console.log(result);
491
+ }
492
+
493
+ run();
494
+ ```
495
+
496
+ ### Parameters
497
+
498
+ | Parameter | Type | Required | Description |
499
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
500
+ | `request` | [operations.AccountingBankFeedStatementsUpdateRequest](../../models/operations/accountingbankfeedstatementsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
501
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
502
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
503
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
504
+
505
+ ### Response
506
+
507
+ **Promise\<[operations.AccountingBankFeedStatementsUpdateResponse](../../models/operations/accountingbankfeedstatementsupdateresponse.md)\>**
508
+
509
+ ### Errors
510
+
511
+ | Error Type | Status Code | Content Type |
512
+ | ------------------------------ | ------------------------------ | ------------------------------ |
513
+ | errors.BadRequestResponse | 400 | application/json |
514
+ | errors.UnauthorizedResponse | 401 | application/json |
515
+ | errors.PaymentRequiredResponse | 402 | application/json |
516
+ | errors.NotFoundResponse | 404 | application/json |
517
+ | errors.UnprocessableResponse | 422 | application/json |
518
+ | errors.APIError | 4XX, 5XX | \*/\* |
519
+
520
+ ## delete
521
+
522
+ Delete Bank Feed Statement
523
+
524
+ ### Example Usage
525
+
526
+ ```typescript
527
+ import { Apideck } from "@apideck/unify";
528
+
529
+ const apideck = new Apideck({
530
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
531
+ consumerId: "test-consumer",
532
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
533
+ });
534
+
535
+ async function run() {
536
+ const result = await apideck.accounting.bankFeedStatements.delete({
537
+ id: "<id>",
538
+ serviceId: "salesforce",
539
+ });
540
+
541
+ // Handle the result
542
+ console.log(result);
543
+ }
544
+
545
+ run();
546
+ ```
547
+
548
+ ### Standalone function
549
+
550
+ The standalone function version of this method:
551
+
552
+ ```typescript
553
+ import { ApideckCore } from "@apideck/unify/core.js";
554
+ import { accountingBankFeedStatementsDelete } from "@apideck/unify/funcs/accountingBankFeedStatementsDelete.js";
555
+
556
+ // Use `ApideckCore` for best tree-shaking performance.
557
+ // You can create one instance of it to use across an application.
558
+ const apideck = new ApideckCore({
559
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
560
+ consumerId: "test-consumer",
561
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
562
+ });
563
+
564
+ async function run() {
565
+ const res = await accountingBankFeedStatementsDelete(apideck, {
566
+ id: "<id>",
567
+ serviceId: "salesforce",
568
+ });
569
+
570
+ if (!res.ok) {
571
+ throw res.error;
572
+ }
573
+
574
+ const { value: result } = res;
575
+
576
+ // Handle the result
577
+ console.log(result);
578
+ }
579
+
580
+ run();
581
+ ```
582
+
583
+ ### Parameters
584
+
585
+ | Parameter | Type | Required | Description |
586
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
587
+ | `request` | [operations.AccountingBankFeedStatementsDeleteRequest](../../models/operations/accountingbankfeedstatementsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
588
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
589
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
590
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
591
+
592
+ ### Response
593
+
594
+ **Promise\<[operations.AccountingBankFeedStatementsDeleteResponse](../../models/operations/accountingbankfeedstatementsdeleteresponse.md)\>**
595
+
596
+ ### Errors
597
+
598
+ | Error Type | Status Code | Content Type |
599
+ | ------------------------------ | ------------------------------ | ------------------------------ |
600
+ | errors.BadRequestResponse | 400 | application/json |
601
+ | errors.UnauthorizedResponse | 401 | application/json |
602
+ | errors.PaymentRequiredResponse | 402 | application/json |
603
+ | errors.NotFoundResponse | 404 | application/json |
604
+ | errors.UnprocessableResponse | 422 | application/json |
605
+ | errors.APIError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,17 @@
1
+ import { ApideckCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { APIError } from "../models/errors/apierror.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
+ import * as operations from "../models/operations/index.js";
8
+ import { APIPromise } from "../types/async.js";
9
+ import { Result } from "../types/fp.js";
10
+ /**
11
+ * Create Bank Feed Account
12
+ *
13
+ * @remarks
14
+ * Create Bank Feed Account
15
+ */
16
+ export declare function accountingBankFeedAccountsCreate(client: ApideckCore, request: operations.AccountingBankFeedAccountsAddRequest, options?: RequestOptions): APIPromise<Result<operations.AccountingBankFeedAccountsAddResponse, errors.BadRequestResponse | errors.UnauthorizedResponse | errors.PaymentRequiredResponse | errors.NotFoundResponse | errors.UnprocessableResponse | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
17
+ //# sourceMappingURL=accountingBankFeedAccountsCreate.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountingBankFeedAccountsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/accountingBankFeedAccountsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKzC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,WAAW,EACnB,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,qCAAqC,EAC9C,MAAM,CAAC,kBAAkB,GACzB,MAAM,CAAC,oBAAoB,GAC3B,MAAM,CAAC,uBAAuB,GAC9B,MAAM,CAAC,gBAAgB,GACvB,MAAM,CAAC,qBAAqB,GAC5B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}