@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
package/README.md CHANGED
@@ -150,6 +150,22 @@ run();
150
150
 
151
151
  * [get](docs/sdks/balancesheet/README.md#get) - Get BalanceSheet
152
152
 
153
+ #### [accounting.bankFeedAccounts](docs/sdks/bankfeedaccounts/README.md)
154
+
155
+ * [list](docs/sdks/bankfeedaccounts/README.md#list) - List Bank Feed Accounts
156
+ * [create](docs/sdks/bankfeedaccounts/README.md#create) - Create Bank Feed Account
157
+ * [get](docs/sdks/bankfeedaccounts/README.md#get) - Get Bank Feed Account
158
+ * [update](docs/sdks/bankfeedaccounts/README.md#update) - Update Bank Feed Account
159
+ * [delete](docs/sdks/bankfeedaccounts/README.md#delete) - Delete Bank Feed Account
160
+
161
+ #### [accounting.bankFeedStatements](docs/sdks/bankfeedstatements/README.md)
162
+
163
+ * [list](docs/sdks/bankfeedstatements/README.md#list) - List Bank Feed Statements
164
+ * [create](docs/sdks/bankfeedstatements/README.md#create) - Create Bank Feed Statement
165
+ * [get](docs/sdks/bankfeedstatements/README.md#get) - Get Bank Feed Statement
166
+ * [update](docs/sdks/bankfeedstatements/README.md#update) - Update Bank Feed Statement
167
+ * [delete](docs/sdks/bankfeedstatements/README.md#delete) - Delete Bank Feed Statement
168
+
153
169
  #### [accounting.billPayments](docs/sdks/billpayments/README.md)
154
170
 
155
171
  * [list](docs/sdks/billpayments/README.md#list) - List Bill Payments
@@ -681,6 +697,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
681
697
  - [`accountingAttachmentsList`](docs/sdks/attachments/README.md#list) - List Attachments
682
698
  - [`accountingAttachmentsUpload`](docs/sdks/attachments/README.md#upload) - Upload attachment
683
699
  - [`accountingBalanceSheetGet`](docs/sdks/balancesheet/README.md#get) - Get BalanceSheet
700
+ - [`accountingBankFeedAccountsCreate`](docs/sdks/bankfeedaccounts/README.md#create) - Create Bank Feed Account
701
+ - [`accountingBankFeedAccountsDelete`](docs/sdks/bankfeedaccounts/README.md#delete) - Delete Bank Feed Account
702
+ - [`accountingBankFeedAccountsGet`](docs/sdks/bankfeedaccounts/README.md#get) - Get Bank Feed Account
703
+ - [`accountingBankFeedAccountsList`](docs/sdks/bankfeedaccounts/README.md#list) - List Bank Feed Accounts
704
+ - [`accountingBankFeedAccountsUpdate`](docs/sdks/bankfeedaccounts/README.md#update) - Update Bank Feed Account
705
+ - [`accountingBankFeedStatementsCreate`](docs/sdks/bankfeedstatements/README.md#create) - Create Bank Feed Statement
706
+ - [`accountingBankFeedStatementsDelete`](docs/sdks/bankfeedstatements/README.md#delete) - Delete Bank Feed Statement
707
+ - [`accountingBankFeedStatementsGet`](docs/sdks/bankfeedstatements/README.md#get) - Get Bank Feed Statement
708
+ - [`accountingBankFeedStatementsList`](docs/sdks/bankfeedstatements/README.md#list) - List Bank Feed Statements
709
+ - [`accountingBankFeedStatementsUpdate`](docs/sdks/bankfeedstatements/README.md#update) - Update Bank Feed Statement
684
710
  - [`accountingBillPaymentsCreate`](docs/sdks/billpayments/README.md#create) - Create Bill Payment
685
711
  - [`accountingBillPaymentsDelete`](docs/sdks/billpayments/README.md#delete) - Delete Bill Payment
686
712
  - [`accountingBillPaymentsGet`](docs/sdks/billpayments/README.md#get) - Get Bill Payment
@@ -0,0 +1,571 @@
1
+ # BankFeedAccounts
2
+ (*accounting.bankFeedAccounts*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [list](#list) - List Bank Feed Accounts
9
+ * [create](#create) - Create Bank Feed Account
10
+ * [get](#get) - Get Bank Feed Account
11
+ * [update](#update) - Update Bank Feed Account
12
+ * [delete](#delete) - Delete Bank Feed Account
13
+
14
+ ## list
15
+
16
+ List Bank Feed Accounts
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.bankFeedAccounts.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 { accountingBankFeedAccountsList } from "@apideck/unify/funcs/accountingBankFeedAccountsList.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 accountingBankFeedAccountsList(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.AccountingBankFeedAccountsAllRequest](../../models/operations/accountingbankfeedaccountsallrequest.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.AccountingBankFeedAccountsAllResponse](../../models/operations/accountingbankfeedaccountsallresponse.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 Account
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.bankFeedAccounts.create({
128
+ serviceId: "salesforce",
129
+ bankFeedAccount: {
130
+ bankAccountType: "bank",
131
+ sourceAccountId: "src_456",
132
+ targetAccountId: "tgt_789",
133
+ targetAccountName: "Main Company Checking",
134
+ targetAccountNumber: "NL91ABNA0417164300",
135
+ currency: "USD",
136
+ feedStatus: "pending",
137
+ country: "US",
138
+ customFields: [
139
+ {
140
+ id: "2389328923893298",
141
+ name: "employee_level",
142
+ description: "Employee Level",
143
+ value: {},
144
+ },
145
+ {
146
+ id: "2389328923893298",
147
+ name: "employee_level",
148
+ description: "Employee Level",
149
+ value: true,
150
+ },
151
+ ],
152
+ },
153
+ });
154
+
155
+ // Handle the result
156
+ console.log(result);
157
+ }
158
+
159
+ run();
160
+ ```
161
+
162
+ ### Standalone function
163
+
164
+ The standalone function version of this method:
165
+
166
+ ```typescript
167
+ import { ApideckCore } from "@apideck/unify/core.js";
168
+ import { accountingBankFeedAccountsCreate } from "@apideck/unify/funcs/accountingBankFeedAccountsCreate.js";
169
+
170
+ // Use `ApideckCore` for best tree-shaking performance.
171
+ // You can create one instance of it to use across an application.
172
+ const apideck = new ApideckCore({
173
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
174
+ consumerId: "test-consumer",
175
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
176
+ });
177
+
178
+ async function run() {
179
+ const res = await accountingBankFeedAccountsCreate(apideck, {
180
+ serviceId: "salesforce",
181
+ bankFeedAccount: {
182
+ bankAccountType: "bank",
183
+ sourceAccountId: "src_456",
184
+ targetAccountId: "tgt_789",
185
+ targetAccountName: "Main Company Checking",
186
+ targetAccountNumber: "NL91ABNA0417164300",
187
+ currency: "USD",
188
+ feedStatus: "pending",
189
+ country: "US",
190
+ customFields: [
191
+ {
192
+ id: "2389328923893298",
193
+ name: "employee_level",
194
+ description: "Employee Level",
195
+ value: {},
196
+ },
197
+ {
198
+ id: "2389328923893298",
199
+ name: "employee_level",
200
+ description: "Employee Level",
201
+ value: true,
202
+ },
203
+ ],
204
+ },
205
+ });
206
+
207
+ if (!res.ok) {
208
+ throw res.error;
209
+ }
210
+
211
+ const { value: result } = res;
212
+
213
+ // Handle the result
214
+ console.log(result);
215
+ }
216
+
217
+ run();
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ | Parameter | Type | Required | Description |
223
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
224
+ | `request` | [operations.AccountingBankFeedAccountsAddRequest](../../models/operations/accountingbankfeedaccountsaddrequest.md) | :heavy_check_mark: | The request object to use for the request. |
225
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
226
+ | `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. |
227
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
228
+
229
+ ### Response
230
+
231
+ **Promise\<[operations.AccountingBankFeedAccountsAddResponse](../../models/operations/accountingbankfeedaccountsaddresponse.md)\>**
232
+
233
+ ### Errors
234
+
235
+ | Error Type | Status Code | Content Type |
236
+ | ------------------------------ | ------------------------------ | ------------------------------ |
237
+ | errors.BadRequestResponse | 400 | application/json |
238
+ | errors.UnauthorizedResponse | 401 | application/json |
239
+ | errors.PaymentRequiredResponse | 402 | application/json |
240
+ | errors.NotFoundResponse | 404 | application/json |
241
+ | errors.UnprocessableResponse | 422 | application/json |
242
+ | errors.APIError | 4XX, 5XX | \*/\* |
243
+
244
+ ## get
245
+
246
+ Get Bank Feed Account
247
+
248
+ ### Example Usage
249
+
250
+ ```typescript
251
+ import { Apideck } from "@apideck/unify";
252
+
253
+ const apideck = new Apideck({
254
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
255
+ consumerId: "test-consumer",
256
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
257
+ });
258
+
259
+ async function run() {
260
+ const result = await apideck.accounting.bankFeedAccounts.get({
261
+ id: "<id>",
262
+ serviceId: "salesforce",
263
+ fields: "id,updated_at",
264
+ });
265
+
266
+ // Handle the result
267
+ console.log(result);
268
+ }
269
+
270
+ run();
271
+ ```
272
+
273
+ ### Standalone function
274
+
275
+ The standalone function version of this method:
276
+
277
+ ```typescript
278
+ import { ApideckCore } from "@apideck/unify/core.js";
279
+ import { accountingBankFeedAccountsGet } from "@apideck/unify/funcs/accountingBankFeedAccountsGet.js";
280
+
281
+ // Use `ApideckCore` for best tree-shaking performance.
282
+ // You can create one instance of it to use across an application.
283
+ const apideck = new ApideckCore({
284
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
285
+ consumerId: "test-consumer",
286
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
287
+ });
288
+
289
+ async function run() {
290
+ const res = await accountingBankFeedAccountsGet(apideck, {
291
+ id: "<id>",
292
+ serviceId: "salesforce",
293
+ fields: "id,updated_at",
294
+ });
295
+
296
+ if (!res.ok) {
297
+ throw res.error;
298
+ }
299
+
300
+ const { value: result } = res;
301
+
302
+ // Handle the result
303
+ console.log(result);
304
+ }
305
+
306
+ run();
307
+ ```
308
+
309
+ ### Parameters
310
+
311
+ | Parameter | Type | Required | Description |
312
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
313
+ | `request` | [operations.AccountingBankFeedAccountsOneRequest](../../models/operations/accountingbankfeedaccountsonerequest.md) | :heavy_check_mark: | The request object to use for the request. |
314
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
315
+ | `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. |
316
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
317
+
318
+ ### Response
319
+
320
+ **Promise\<[operations.AccountingBankFeedAccountsOneResponse](../../models/operations/accountingbankfeedaccountsoneresponse.md)\>**
321
+
322
+ ### Errors
323
+
324
+ | Error Type | Status Code | Content Type |
325
+ | ------------------------------ | ------------------------------ | ------------------------------ |
326
+ | errors.BadRequestResponse | 400 | application/json |
327
+ | errors.UnauthorizedResponse | 401 | application/json |
328
+ | errors.PaymentRequiredResponse | 402 | application/json |
329
+ | errors.NotFoundResponse | 404 | application/json |
330
+ | errors.UnprocessableResponse | 422 | application/json |
331
+ | errors.APIError | 4XX, 5XX | \*/\* |
332
+
333
+ ## update
334
+
335
+ Update Bank Feed Account
336
+
337
+ ### Example Usage
338
+
339
+ ```typescript
340
+ import { Apideck } from "@apideck/unify";
341
+
342
+ const apideck = new Apideck({
343
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
344
+ consumerId: "test-consumer",
345
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
346
+ });
347
+
348
+ async function run() {
349
+ const result = await apideck.accounting.bankFeedAccounts.update({
350
+ id: "<id>",
351
+ serviceId: "salesforce",
352
+ bankFeedAccount: {
353
+ bankAccountType: "bank",
354
+ sourceAccountId: "src_456",
355
+ targetAccountId: "tgt_789",
356
+ targetAccountName: "Main Company Checking",
357
+ targetAccountNumber: "NL91ABNA0417164300",
358
+ currency: "USD",
359
+ feedStatus: "pending",
360
+ country: "US",
361
+ customFields: [
362
+ {
363
+ id: "2389328923893298",
364
+ name: "employee_level",
365
+ description: "Employee Level",
366
+ value: {},
367
+ },
368
+ {
369
+ id: "2389328923893298",
370
+ name: "employee_level",
371
+ description: "Employee Level",
372
+ value: true,
373
+ },
374
+ {
375
+ id: "2389328923893298",
376
+ name: "employee_level",
377
+ description: "Employee Level",
378
+ value: [
379
+ {},
380
+ {},
381
+ ],
382
+ },
383
+ ],
384
+ },
385
+ });
386
+
387
+ // Handle the result
388
+ console.log(result);
389
+ }
390
+
391
+ run();
392
+ ```
393
+
394
+ ### Standalone function
395
+
396
+ The standalone function version of this method:
397
+
398
+ ```typescript
399
+ import { ApideckCore } from "@apideck/unify/core.js";
400
+ import { accountingBankFeedAccountsUpdate } from "@apideck/unify/funcs/accountingBankFeedAccountsUpdate.js";
401
+
402
+ // Use `ApideckCore` for best tree-shaking performance.
403
+ // You can create one instance of it to use across an application.
404
+ const apideck = new ApideckCore({
405
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
406
+ consumerId: "test-consumer",
407
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
408
+ });
409
+
410
+ async function run() {
411
+ const res = await accountingBankFeedAccountsUpdate(apideck, {
412
+ id: "<id>",
413
+ serviceId: "salesforce",
414
+ bankFeedAccount: {
415
+ bankAccountType: "bank",
416
+ sourceAccountId: "src_456",
417
+ targetAccountId: "tgt_789",
418
+ targetAccountName: "Main Company Checking",
419
+ targetAccountNumber: "NL91ABNA0417164300",
420
+ currency: "USD",
421
+ feedStatus: "pending",
422
+ country: "US",
423
+ customFields: [
424
+ {
425
+ id: "2389328923893298",
426
+ name: "employee_level",
427
+ description: "Employee Level",
428
+ value: {},
429
+ },
430
+ {
431
+ id: "2389328923893298",
432
+ name: "employee_level",
433
+ description: "Employee Level",
434
+ value: true,
435
+ },
436
+ {
437
+ id: "2389328923893298",
438
+ name: "employee_level",
439
+ description: "Employee Level",
440
+ value: [
441
+ {},
442
+ {},
443
+ ],
444
+ },
445
+ ],
446
+ },
447
+ });
448
+
449
+ if (!res.ok) {
450
+ throw res.error;
451
+ }
452
+
453
+ const { value: result } = res;
454
+
455
+ // Handle the result
456
+ console.log(result);
457
+ }
458
+
459
+ run();
460
+ ```
461
+
462
+ ### Parameters
463
+
464
+ | Parameter | Type | Required | Description |
465
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
466
+ | `request` | [operations.AccountingBankFeedAccountsUpdateRequest](../../models/operations/accountingbankfeedaccountsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
467
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
468
+ | `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. |
469
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
470
+
471
+ ### Response
472
+
473
+ **Promise\<[operations.AccountingBankFeedAccountsUpdateResponse](../../models/operations/accountingbankfeedaccountsupdateresponse.md)\>**
474
+
475
+ ### Errors
476
+
477
+ | Error Type | Status Code | Content Type |
478
+ | ------------------------------ | ------------------------------ | ------------------------------ |
479
+ | errors.BadRequestResponse | 400 | application/json |
480
+ | errors.UnauthorizedResponse | 401 | application/json |
481
+ | errors.PaymentRequiredResponse | 402 | application/json |
482
+ | errors.NotFoundResponse | 404 | application/json |
483
+ | errors.UnprocessableResponse | 422 | application/json |
484
+ | errors.APIError | 4XX, 5XX | \*/\* |
485
+
486
+ ## delete
487
+
488
+ Delete Bank Feed Account
489
+
490
+ ### Example Usage
491
+
492
+ ```typescript
493
+ import { Apideck } from "@apideck/unify";
494
+
495
+ const apideck = new Apideck({
496
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
497
+ consumerId: "test-consumer",
498
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
499
+ });
500
+
501
+ async function run() {
502
+ const result = await apideck.accounting.bankFeedAccounts.delete({
503
+ id: "<id>",
504
+ serviceId: "salesforce",
505
+ });
506
+
507
+ // Handle the result
508
+ console.log(result);
509
+ }
510
+
511
+ run();
512
+ ```
513
+
514
+ ### Standalone function
515
+
516
+ The standalone function version of this method:
517
+
518
+ ```typescript
519
+ import { ApideckCore } from "@apideck/unify/core.js";
520
+ import { accountingBankFeedAccountsDelete } from "@apideck/unify/funcs/accountingBankFeedAccountsDelete.js";
521
+
522
+ // Use `ApideckCore` for best tree-shaking performance.
523
+ // You can create one instance of it to use across an application.
524
+ const apideck = new ApideckCore({
525
+ apiKey: process.env["APIDECK_API_KEY"] ?? "",
526
+ consumerId: "test-consumer",
527
+ appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
528
+ });
529
+
530
+ async function run() {
531
+ const res = await accountingBankFeedAccountsDelete(apideck, {
532
+ id: "<id>",
533
+ serviceId: "salesforce",
534
+ });
535
+
536
+ if (!res.ok) {
537
+ throw res.error;
538
+ }
539
+
540
+ const { value: result } = res;
541
+
542
+ // Handle the result
543
+ console.log(result);
544
+ }
545
+
546
+ run();
547
+ ```
548
+
549
+ ### Parameters
550
+
551
+ | Parameter | Type | Required | Description |
552
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
553
+ | `request` | [operations.AccountingBankFeedAccountsDeleteRequest](../../models/operations/accountingbankfeedaccountsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. |
554
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
555
+ | `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. |
556
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
557
+
558
+ ### Response
559
+
560
+ **Promise\<[operations.AccountingBankFeedAccountsDeleteResponse](../../models/operations/accountingbankfeedaccountsdeleteresponse.md)\>**
561
+
562
+ ### Errors
563
+
564
+ | Error Type | Status Code | Content Type |
565
+ | ------------------------------ | ------------------------------ | ------------------------------ |
566
+ | errors.BadRequestResponse | 400 | application/json |
567
+ | errors.UnauthorizedResponse | 401 | application/json |
568
+ | errors.PaymentRequiredResponse | 402 | application/json |
569
+ | errors.NotFoundResponse | 404 | application/json |
570
+ | errors.UnprocessableResponse | 422 | application/json |
571
+ | errors.APIError | 4XX, 5XX | \*/\* |