@moovio/sdk 0.21.1 → 0.21.4

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 (71) hide show
  1. package/bin/mcp-server.js +79 -61
  2. package/bin/mcp-server.js.map +11 -10
  3. package/examples/package-lock.json +1 -1
  4. package/hooks/hooks.d.ts +3 -2
  5. package/hooks/hooks.d.ts.map +1 -1
  6. package/hooks/hooks.js.map +1 -1
  7. package/hooks/moov-version-hook.d.ts +6 -0
  8. package/hooks/moov-version-hook.d.ts.map +1 -0
  9. package/hooks/moov-version-hook.js +12 -0
  10. package/hooks/moov-version-hook.js.map +1 -0
  11. package/hooks/registration.d.ts.map +1 -1
  12. package/hooks/registration.js +3 -1
  13. package/hooks/registration.js.map +1 -1
  14. package/hooks/types.d.ts +2 -6
  15. package/hooks/types.d.ts.map +1 -1
  16. package/jsr.json +1 -1
  17. package/lib/config.d.ts +2 -2
  18. package/lib/config.js +2 -2
  19. package/lib/sdks.d.ts.map +1 -1
  20. package/lib/sdks.js +5 -6
  21. package/lib/sdks.js.map +1 -1
  22. package/mcp-server/mcp-server.js +1 -1
  23. package/mcp-server/server.js +1 -1
  24. package/package.json +1 -1
  25. package/src/hooks/hooks.ts +2 -2
  26. package/src/hooks/moov-version-hook.ts +9 -0
  27. package/src/hooks/registration.ts +4 -1
  28. package/src/hooks/types.ts +2 -7
  29. package/src/lib/config.ts +2 -2
  30. package/src/lib/sdks.ts +6 -7
  31. package/src/mcp-server/mcp-server.ts +1 -1
  32. package/src/mcp-server/server.ts +1 -1
  33. package/docs/sdks/accounts/README.md +0 -1038
  34. package/docs/sdks/accountterminalapplications/README.md +0 -371
  35. package/docs/sdks/adjustments/README.md +0 -185
  36. package/docs/sdks/applepay/README.md +0 -572
  37. package/docs/sdks/authentication/README.md +0 -191
  38. package/docs/sdks/avatars/README.md +0 -95
  39. package/docs/sdks/bankaccounts/README.md +0 -951
  40. package/docs/sdks/branding/README.md +0 -407
  41. package/docs/sdks/capabilities/README.md +0 -380
  42. package/docs/sdks/cardissuing/README.md +0 -533
  43. package/docs/sdks/cards/README.md +0 -544
  44. package/docs/sdks/disputes/README.md +0 -1085
  45. package/docs/sdks/endtoendencryption/README.md +0 -174
  46. package/docs/sdks/enrichedaddress/README.md +0 -95
  47. package/docs/sdks/enrichedprofile/README.md +0 -95
  48. package/docs/sdks/feeplans/README.md +0 -921
  49. package/docs/sdks/files/README.md +0 -293
  50. package/docs/sdks/images/README.md +0 -616
  51. package/docs/sdks/industries/README.md +0 -91
  52. package/docs/sdks/institutions/README.md +0 -184
  53. package/docs/sdks/issuingtransactions/README.md +0 -465
  54. package/docs/sdks/onboarding/README.md +0 -389
  55. package/docs/sdks/paymentlinks/README.md +0 -615
  56. package/docs/sdks/paymentmethods/README.md +0 -187
  57. package/docs/sdks/ping/README.md +0 -91
  58. package/docs/sdks/products/README.md +0 -616
  59. package/docs/sdks/receipts/README.md +0 -180
  60. package/docs/sdks/representatives/README.md +0 -603
  61. package/docs/sdks/scheduling/README.md +0 -1018
  62. package/docs/sdks/statements/README.md +0 -194
  63. package/docs/sdks/support/README.md +0 -505
  64. package/docs/sdks/sweeps/README.md +0 -571
  65. package/docs/sdks/terminalapplications/README.md +0 -460
  66. package/docs/sdks/transfers/README.md +0 -1136
  67. package/docs/sdks/underwriting/README.md +0 -331
  68. package/docs/sdks/wallets/README.md +0 -416
  69. package/docs/sdks/wallettransactions/README.md +0 -202
  70. package/examples/README.md +0 -31
  71. package/test/README.md +0 -14
package/docs/sdks/scheduling/README.md DELETED
@@ -1,1018 +0,0 @@
1
- # Scheduling
2
- (*scheduling*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [create](#create) - Describes the schedule to create or modify.
9
-
10
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
11
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
12
- * [list](#list) - Describes a list of schedules associated with an account. Append the `hydrate=accounts` query parameter to include partial account details in the response.
13
-
14
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
15
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
16
- * [update](#update) - Describes the schedule to modify.
17
-
18
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
19
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
20
- * [get](#get) - Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.
21
-
22
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
23
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
24
- * [cancel](#cancel) - Describes the schedule to cancel.
25
-
26
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
27
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
28
- * [getOccurrance](#getoccurrance) - Gets a specific occurrence.
29
-
30
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
31
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
32
-
33
- ## create
34
-
35
- Describes the schedule to create or modify.
36
-
37
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
38
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
39
-
40
- ### Example Usage
41
-
42
- <!-- UsageSnippet language="typescript" operationID="createSchedule" method="post" path="/accounts/{accountID}/schedules" -->
43
- ```typescript
44
- import { Moov } from "@moovio/sdk";
45
-
46
- const moov = new Moov({
47
- xMoovVersion: "v2024.01.00",
48
- security: {
49
- username: "",
50
- password: "",
51
- },
52
- });
53
-
54
- async function run() {
55
- const result = await moov.scheduling.create({
56
- accountID: "38fd6ae1-0e70-4162-9359-d64482d61854",
57
- upsertSchedule: {
58
- occurrences: [
59
- {
60
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
61
- runOn: new Date("2009-11-10T23:00:00Z"),
62
- runTransfer: {
63
- amount: {
64
- currency: "USD",
65
- value: 1204,
66
- },
67
- destination: {
68
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
69
- achDetails: {
70
- companyEntryDescription: "Gym dues",
71
- originatingCompanyName: "Whole Body Fit",
72
- },
73
- cardDetails: {
74
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
75
- },
76
- },
77
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
78
- source: {
79
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
80
- achDetails: {
81
- companyEntryDescription: "Gym dues",
82
- originatingCompanyName: "Whole Body Fit",
83
- },
84
- cardDetails: {
85
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
86
- },
87
- },
88
- description: "sediment yahoo a rudely mmm massive helpful brr",
89
- },
90
- },
91
- {
92
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
93
- runOn: new Date("2009-11-10T23:00:00Z"),
94
- runTransfer: {
95
- amount: {
96
- currency: "USD",
97
- value: 1204,
98
- },
99
- destination: {
100
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
101
- achDetails: {
102
- companyEntryDescription: "Gym dues",
103
- originatingCompanyName: "Whole Body Fit",
104
- },
105
- cardDetails: {
106
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
107
- },
108
- },
109
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
110
- source: {
111
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
112
- achDetails: {
113
- companyEntryDescription: "Gym dues",
114
- originatingCompanyName: "Whole Body Fit",
115
- },
116
- cardDetails: {
117
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
118
- },
119
- },
120
- description: "sediment yahoo a rudely mmm massive helpful brr",
121
- },
122
- },
123
- ],
124
- recur: {
125
- recurrenceRule: "<value>",
126
- runTransfer: {
127
- amount: {
128
- currency: "USD",
129
- value: 1204,
130
- },
131
- destination: {
132
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
133
- achDetails: {
134
- companyEntryDescription: "Gym dues",
135
- originatingCompanyName: "Whole Body Fit",
136
- },
137
- cardDetails: {
138
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
139
- },
140
- },
141
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
142
- source: {
143
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
144
- achDetails: {
145
- companyEntryDescription: "Gym dues",
146
- originatingCompanyName: "Whole Body Fit",
147
- },
148
- cardDetails: {
149
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
150
- },
151
- },
152
- description: "sediment yahoo a rudely mmm massive helpful brr",
153
- },
154
- start: new Date("2009-11-10T23:00:00Z"),
155
- },
156
- },
157
- });
158
-
159
- console.log(result);
160
- }
161
-
162
- run();
163
- ```
164
-
165
- ### Standalone function
166
-
167
- The standalone function version of this method:
168
-
169
- ```typescript
170
- import { MoovCore } from "@moovio/sdk/core.js";
171
- import { schedulingCreate } from "@moovio/sdk/funcs/schedulingCreate.js";
172
-
173
- // Use `MoovCore` for best tree-shaking performance.
174
- // You can create one instance of it to use across an application.
175
- const moov = new MoovCore({
176
- xMoovVersion: "v2024.01.00",
177
- security: {
178
- username: "",
179
- password: "",
180
- },
181
- });
182
-
183
- async function run() {
184
- const res = await schedulingCreate(moov, {
185
- accountID: "38fd6ae1-0e70-4162-9359-d64482d61854",
186
- upsertSchedule: {
187
- occurrences: [
188
- {
189
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
190
- runOn: new Date("2009-11-10T23:00:00Z"),
191
- runTransfer: {
192
- amount: {
193
- currency: "USD",
194
- value: 1204,
195
- },
196
- destination: {
197
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
198
- achDetails: {
199
- companyEntryDescription: "Gym dues",
200
- originatingCompanyName: "Whole Body Fit",
201
- },
202
- cardDetails: {
203
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
204
- },
205
- },
206
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
207
- source: {
208
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
209
- achDetails: {
210
- companyEntryDescription: "Gym dues",
211
- originatingCompanyName: "Whole Body Fit",
212
- },
213
- cardDetails: {
214
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
215
- },
216
- },
217
- description: "sediment yahoo a rudely mmm massive helpful brr",
218
- },
219
- },
220
- {
221
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
222
- runOn: new Date("2009-11-10T23:00:00Z"),
223
- runTransfer: {
224
- amount: {
225
- currency: "USD",
226
- value: 1204,
227
- },
228
- destination: {
229
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
230
- achDetails: {
231
- companyEntryDescription: "Gym dues",
232
- originatingCompanyName: "Whole Body Fit",
233
- },
234
- cardDetails: {
235
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
236
- },
237
- },
238
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
239
- source: {
240
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
241
- achDetails: {
242
- companyEntryDescription: "Gym dues",
243
- originatingCompanyName: "Whole Body Fit",
244
- },
245
- cardDetails: {
246
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
247
- },
248
- },
249
- description: "sediment yahoo a rudely mmm massive helpful brr",
250
- },
251
- },
252
- ],
253
- recur: {
254
- recurrenceRule: "<value>",
255
- runTransfer: {
256
- amount: {
257
- currency: "USD",
258
- value: 1204,
259
- },
260
- destination: {
261
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
262
- achDetails: {
263
- companyEntryDescription: "Gym dues",
264
- originatingCompanyName: "Whole Body Fit",
265
- },
266
- cardDetails: {
267
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
268
- },
269
- },
270
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
271
- source: {
272
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
273
- achDetails: {
274
- companyEntryDescription: "Gym dues",
275
- originatingCompanyName: "Whole Body Fit",
276
- },
277
- cardDetails: {
278
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
279
- },
280
- },
281
- description: "sediment yahoo a rudely mmm massive helpful brr",
282
- },
283
- start: new Date("2009-11-10T23:00:00Z"),
284
- },
285
- },
286
- });
287
- if (res.ok) {
288
- const { value: result } = res;
289
- console.log(result);
290
- } else {
291
- console.log("schedulingCreate failed:", res.error);
292
- }
293
- }
294
-
295
- run();
296
- ```
297
-
298
- ### Parameters
299
-
300
- | Parameter | Type | Required | Description |
301
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
302
- | `request` | [operations.CreateScheduleRequest](../../models/operations/createschedulerequest.md) | :heavy_check_mark: | The request object to use for the request. |
303
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
304
- | `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. |
305
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
306
-
307
- ### Response
308
-
309
- **Promise\<[operations.CreateScheduleResponse](../../models/operations/createscheduleresponse.md)\>**
310
-
311
- ### Errors
312
-
313
- | Error Type | Status Code | Content Type |
314
- | ------------------------------ | ------------------------------ | ------------------------------ |
315
- | errors.GenericError | 400, 409 | application/json |
316
- | errors.ScheduleValidationError | 422 | application/json |
317
- | errors.APIError | 4XX, 5XX | \*/\* |
318
-
319
- ## list
320
-
321
- Describes a list of schedules associated with an account. Append the `hydrate=accounts` query parameter to include partial account details in the response.
322
-
323
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
324
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
325
-
326
- ### Example Usage
327
-
328
- <!-- UsageSnippet language="typescript" operationID="listSchedules" method="get" path="/accounts/{accountID}/schedules" -->
329
- ```typescript
330
- import { Moov } from "@moovio/sdk";
331
-
332
- const moov = new Moov({
333
- xMoovVersion: "v2024.01.00",
334
- security: {
335
- username: "",
336
- password: "",
337
- },
338
- });
339
-
340
- async function run() {
341
- const result = await moov.scheduling.list({
342
- skip: 60,
343
- count: 20,
344
- accountID: "b69f6366-984e-40f9-82a0-65335a43431d",
345
- });
346
-
347
- console.log(result);
348
- }
349
-
350
- run();
351
- ```
352
-
353
- ### Standalone function
354
-
355
- The standalone function version of this method:
356
-
357
- ```typescript
358
- import { MoovCore } from "@moovio/sdk/core.js";
359
- import { schedulingList } from "@moovio/sdk/funcs/schedulingList.js";
360
-
361
- // Use `MoovCore` for best tree-shaking performance.
362
- // You can create one instance of it to use across an application.
363
- const moov = new MoovCore({
364
- xMoovVersion: "v2024.01.00",
365
- security: {
366
- username: "",
367
- password: "",
368
- },
369
- });
370
-
371
- async function run() {
372
- const res = await schedulingList(moov, {
373
- skip: 60,
374
- count: 20,
375
- accountID: "b69f6366-984e-40f9-82a0-65335a43431d",
376
- });
377
- if (res.ok) {
378
- const { value: result } = res;
379
- console.log(result);
380
- } else {
381
- console.log("schedulingList failed:", res.error);
382
- }
383
- }
384
-
385
- run();
386
- ```
387
-
388
- ### Parameters
389
-
390
- | Parameter | Type | Required | Description |
391
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
392
- | `request` | [operations.ListSchedulesRequest](../../models/operations/listschedulesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
393
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
394
- | `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. |
395
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
396
-
397
- ### Response
398
-
399
- **Promise\<[operations.ListSchedulesResponse](../../models/operations/listschedulesresponse.md)\>**
400
-
401
- ### Errors
402
-
403
- | Error Type | Status Code | Content Type |
404
- | --------------- | --------------- | --------------- |
405
- | errors.APIError | 4XX, 5XX | \*/\* |
406
-
407
- ## update
408
-
409
- Describes the schedule to modify.
410
-
411
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
412
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
413
-
414
- ### Example Usage
415
-
416
- <!-- UsageSnippet language="typescript" operationID="updateSchedule" method="put" path="/accounts/{accountID}/schedules/{scheduleID}" -->
417
- ```typescript
418
- import { Moov } from "@moovio/sdk";
419
-
420
- const moov = new Moov({
421
- xMoovVersion: "v2024.01.00",
422
- security: {
423
- username: "",
424
- password: "",
425
- },
426
- });
427
-
428
- async function run() {
429
- const result = await moov.scheduling.update({
430
- accountID: "becca38e-c01f-4cfc-8f7c-187c7cf6a7a3",
431
- scheduleID: "1b29a8ad-60ee-4c90-90e7-fda62cd24154",
432
- upsertSchedule: {
433
- occurrences: [
434
- {
435
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
436
- runOn: new Date("2009-11-10T23:00:00Z"),
437
- runTransfer: {
438
- amount: {
439
- currency: "USD",
440
- value: 1204,
441
- },
442
- destination: {
443
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
444
- achDetails: {
445
- companyEntryDescription: "Gym dues",
446
- originatingCompanyName: "Whole Body Fit",
447
- },
448
- cardDetails: {
449
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
450
- },
451
- },
452
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
453
- source: {
454
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
455
- achDetails: {
456
- companyEntryDescription: "Gym dues",
457
- originatingCompanyName: "Whole Body Fit",
458
- },
459
- cardDetails: {
460
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
461
- },
462
- },
463
- description: "er reasoning following veto oof fervently ha how till now",
464
- },
465
- },
466
- {
467
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
468
- runOn: new Date("2009-11-10T23:00:00Z"),
469
- runTransfer: {
470
- amount: {
471
- currency: "USD",
472
- value: 1204,
473
- },
474
- destination: {
475
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
476
- achDetails: {
477
- companyEntryDescription: "Gym dues",
478
- originatingCompanyName: "Whole Body Fit",
479
- },
480
- cardDetails: {
481
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
482
- },
483
- },
484
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
485
- source: {
486
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
487
- achDetails: {
488
- companyEntryDescription: "Gym dues",
489
- originatingCompanyName: "Whole Body Fit",
490
- },
491
- cardDetails: {
492
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
493
- },
494
- },
495
- description: "er reasoning following veto oof fervently ha how till now",
496
- },
497
- },
498
- {
499
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
500
- runOn: new Date("2009-11-10T23:00:00Z"),
501
- runTransfer: {
502
- amount: {
503
- currency: "USD",
504
- value: 1204,
505
- },
506
- destination: {
507
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
508
- achDetails: {
509
- companyEntryDescription: "Gym dues",
510
- originatingCompanyName: "Whole Body Fit",
511
- },
512
- cardDetails: {
513
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
514
- },
515
- },
516
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
517
- source: {
518
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
519
- achDetails: {
520
- companyEntryDescription: "Gym dues",
521
- originatingCompanyName: "Whole Body Fit",
522
- },
523
- cardDetails: {
524
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
525
- },
526
- },
527
- description: "er reasoning following veto oof fervently ha how till now",
528
- },
529
- },
530
- ],
531
- recur: {
532
- recurrenceRule: "<value>",
533
- runTransfer: {
534
- amount: {
535
- currency: "USD",
536
- value: 1204,
537
- },
538
- destination: {
539
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
540
- achDetails: {
541
- companyEntryDescription: "Gym dues",
542
- originatingCompanyName: "Whole Body Fit",
543
- },
544
- cardDetails: {
545
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
546
- },
547
- },
548
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
549
- source: {
550
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
551
- achDetails: {
552
- companyEntryDescription: "Gym dues",
553
- originatingCompanyName: "Whole Body Fit",
554
- },
555
- cardDetails: {
556
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
557
- },
558
- },
559
- description: "er reasoning following veto oof fervently ha how till now",
560
- },
561
- start: new Date("2009-11-10T23:00:00Z"),
562
- },
563
- },
564
- });
565
-
566
- console.log(result);
567
- }
568
-
569
- run();
570
- ```
571
-
572
- ### Standalone function
573
-
574
- The standalone function version of this method:
575
-
576
- ```typescript
577
- import { MoovCore } from "@moovio/sdk/core.js";
578
- import { schedulingUpdate } from "@moovio/sdk/funcs/schedulingUpdate.js";
579
-
580
- // Use `MoovCore` for best tree-shaking performance.
581
- // You can create one instance of it to use across an application.
582
- const moov = new MoovCore({
583
- xMoovVersion: "v2024.01.00",
584
- security: {
585
- username: "",
586
- password: "",
587
- },
588
- });
589
-
590
- async function run() {
591
- const res = await schedulingUpdate(moov, {
592
- accountID: "becca38e-c01f-4cfc-8f7c-187c7cf6a7a3",
593
- scheduleID: "1b29a8ad-60ee-4c90-90e7-fda62cd24154",
594
- upsertSchedule: {
595
- occurrences: [
596
- {
597
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
598
- runOn: new Date("2009-11-10T23:00:00Z"),
599
- runTransfer: {
600
- amount: {
601
- currency: "USD",
602
- value: 1204,
603
- },
604
- destination: {
605
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
606
- achDetails: {
607
- companyEntryDescription: "Gym dues",
608
- originatingCompanyName: "Whole Body Fit",
609
- },
610
- cardDetails: {
611
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
612
- },
613
- },
614
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
615
- source: {
616
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
617
- achDetails: {
618
- companyEntryDescription: "Gym dues",
619
- originatingCompanyName: "Whole Body Fit",
620
- },
621
- cardDetails: {
622
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
623
- },
624
- },
625
- description: "er reasoning following veto oof fervently ha how till now",
626
- },
627
- },
628
- {
629
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
630
- runOn: new Date("2009-11-10T23:00:00Z"),
631
- runTransfer: {
632
- amount: {
633
- currency: "USD",
634
- value: 1204,
635
- },
636
- destination: {
637
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
638
- achDetails: {
639
- companyEntryDescription: "Gym dues",
640
- originatingCompanyName: "Whole Body Fit",
641
- },
642
- cardDetails: {
643
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
644
- },
645
- },
646
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
647
- source: {
648
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
649
- achDetails: {
650
- companyEntryDescription: "Gym dues",
651
- originatingCompanyName: "Whole Body Fit",
652
- },
653
- cardDetails: {
654
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
655
- },
656
- },
657
- description: "er reasoning following veto oof fervently ha how till now",
658
- },
659
- },
660
- {
661
- occurrenceID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
662
- runOn: new Date("2009-11-10T23:00:00Z"),
663
- runTransfer: {
664
- amount: {
665
- currency: "USD",
666
- value: 1204,
667
- },
668
- destination: {
669
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
670
- achDetails: {
671
- companyEntryDescription: "Gym dues",
672
- originatingCompanyName: "Whole Body Fit",
673
- },
674
- cardDetails: {
675
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
676
- },
677
- },
678
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
679
- source: {
680
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
681
- achDetails: {
682
- companyEntryDescription: "Gym dues",
683
- originatingCompanyName: "Whole Body Fit",
684
- },
685
- cardDetails: {
686
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
687
- },
688
- },
689
- description: "er reasoning following veto oof fervently ha how till now",
690
- },
691
- },
692
- ],
693
- recur: {
694
- recurrenceRule: "<value>",
695
- runTransfer: {
696
- amount: {
697
- currency: "USD",
698
- value: 1204,
699
- },
700
- destination: {
701
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
702
- achDetails: {
703
- companyEntryDescription: "Gym dues",
704
- originatingCompanyName: "Whole Body Fit",
705
- },
706
- cardDetails: {
707
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
708
- },
709
- },
710
- partnerAccountID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
711
- source: {
712
- paymentMethodID: "c520f1b9-0ba7-42f5-b977-248cdbe41c69",
713
- achDetails: {
714
- companyEntryDescription: "Gym dues",
715
- originatingCompanyName: "Whole Body Fit",
716
- },
717
- cardDetails: {
718
- dynamicDescriptor: "WhlBdy *Yoga 11-12",
719
- },
720
- },
721
- description: "er reasoning following veto oof fervently ha how till now",
722
- },
723
- start: new Date("2009-11-10T23:00:00Z"),
724
- },
725
- },
726
- });
727
- if (res.ok) {
728
- const { value: result } = res;
729
- console.log(result);
730
- } else {
731
- console.log("schedulingUpdate failed:", res.error);
732
- }
733
- }
734
-
735
- run();
736
- ```
737
-
738
- ### Parameters
739
-
740
- | Parameter | Type | Required | Description |
741
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
742
- | `request` | [operations.UpdateScheduleRequest](../../models/operations/updateschedulerequest.md) | :heavy_check_mark: | The request object to use for the request. |
743
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
744
- | `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. |
745
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
746
-
747
- ### Response
748
-
749
- **Promise\<[operations.UpdateScheduleResponse](../../models/operations/updatescheduleresponse.md)\>**
750
-
751
- ### Errors
752
-
753
- | Error Type | Status Code | Content Type |
754
- | ------------------------------ | ------------------------------ | ------------------------------ |
755
- | errors.GenericError | 400, 409 | application/json |
756
- | errors.ScheduleValidationError | 422 | application/json |
757
- | errors.APIError | 4XX, 5XX | \*/\* |
758
-
759
- ## get
760
-
761
- Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.
762
-
763
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
764
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
765
-
766
- ### Example Usage
767
-
768
- <!-- UsageSnippet language="typescript" operationID="getSchedules" method="get" path="/accounts/{accountID}/schedules/{scheduleID}" -->
769
- ```typescript
770
- import { Moov } from "@moovio/sdk";
771
-
772
- const moov = new Moov({
773
- xMoovVersion: "v2024.01.00",
774
- security: {
775
- username: "",
776
- password: "",
777
- },
778
- });
779
-
780
- async function run() {
781
- const result = await moov.scheduling.get({
782
- accountID: "31afd98b-eb55-41b3-8a4f-0ee8ea69e4e0",
783
- scheduleID: "55487e07-f3b7-44e8-b6f3-64fc85701c34",
784
- });
785
-
786
- console.log(result);
787
- }
788
-
789
- run();
790
- ```
791
-
792
- ### Standalone function
793
-
794
- The standalone function version of this method:
795
-
796
- ```typescript
797
- import { MoovCore } from "@moovio/sdk/core.js";
798
- import { schedulingGet } from "@moovio/sdk/funcs/schedulingGet.js";
799
-
800
- // Use `MoovCore` for best tree-shaking performance.
801
- // You can create one instance of it to use across an application.
802
- const moov = new MoovCore({
803
- xMoovVersion: "v2024.01.00",
804
- security: {
805
- username: "",
806
- password: "",
807
- },
808
- });
809
-
810
- async function run() {
811
- const res = await schedulingGet(moov, {
812
- accountID: "31afd98b-eb55-41b3-8a4f-0ee8ea69e4e0",
813
- scheduleID: "55487e07-f3b7-44e8-b6f3-64fc85701c34",
814
- });
815
- if (res.ok) {
816
- const { value: result } = res;
817
- console.log(result);
818
- } else {
819
- console.log("schedulingGet failed:", res.error);
820
- }
821
- }
822
-
823
- run();
824
- ```
825
-
826
- ### Parameters
827
-
828
- | Parameter | Type | Required | Description |
829
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
830
- | `request` | [operations.GetSchedulesRequest](../../models/operations/getschedulesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
831
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
832
- | `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. |
833
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
834
-
835
- ### Response
836
-
837
- **Promise\<[operations.GetSchedulesResponse](../../models/operations/getschedulesresponse.md)\>**
838
-
839
- ### Errors
840
-
841
- | Error Type | Status Code | Content Type |
842
- | --------------- | --------------- | --------------- |
843
- | errors.APIError | 4XX, 5XX | \*/\* |
844
-
845
- ## cancel
846
-
847
- Describes the schedule to cancel.
848
-
849
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
850
- you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
851
-
852
- ### Example Usage
853
-
854
- <!-- UsageSnippet language="typescript" operationID="cancelSchedule" method="delete" path="/accounts/{accountID}/schedules/{scheduleID}" -->
855
- ```typescript
856
- import { Moov } from "@moovio/sdk";
857
-
858
- const moov = new Moov({
859
- xMoovVersion: "v2024.01.00",
860
- security: {
861
- username: "",
862
- password: "",
863
- },
864
- });
865
-
866
- async function run() {
867
- const result = await moov.scheduling.cancel({
868
- accountID: "e89edcfc-19ca-40eb-802b-a35100dea24d",
869
- scheduleID: "5ca67de0-63f6-4cb7-b94a-6c84616ffe03",
870
- });
871
-
872
- console.log(result);
873
- }
874
-
875
- run();
876
- ```
877
-
878
- ### Standalone function
879
-
880
- The standalone function version of this method:
881
-
882
- ```typescript
883
- import { MoovCore } from "@moovio/sdk/core.js";
884
- import { schedulingCancel } from "@moovio/sdk/funcs/schedulingCancel.js";
885
-
886
- // Use `MoovCore` for best tree-shaking performance.
887
- // You can create one instance of it to use across an application.
888
- const moov = new MoovCore({
889
- xMoovVersion: "v2024.01.00",
890
- security: {
891
- username: "",
892
- password: "",
893
- },
894
- });
895
-
896
- async function run() {
897
- const res = await schedulingCancel(moov, {
898
- accountID: "e89edcfc-19ca-40eb-802b-a35100dea24d",
899
- scheduleID: "5ca67de0-63f6-4cb7-b94a-6c84616ffe03",
900
- });
901
- if (res.ok) {
902
- const { value: result } = res;
903
- console.log(result);
904
- } else {
905
- console.log("schedulingCancel failed:", res.error);
906
- }
907
- }
908
-
909
- run();
910
- ```
911
-
912
- ### Parameters
913
-
914
- | Parameter | Type | Required | Description |
915
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
916
- | `request` | [operations.CancelScheduleRequest](../../models/operations/cancelschedulerequest.md) | :heavy_check_mark: | The request object to use for the request. |
917
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
918
- | `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. |
919
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
920
-
921
- ### Response
922
-
923
- **Promise\<[operations.CancelScheduleResponse](../../models/operations/cancelscheduleresponse.md)\>**
924
-
925
- ### Errors
926
-
927
- | Error Type | Status Code | Content Type |
928
- | ------------------- | ------------------- | ------------------- |
929
- | errors.GenericError | 400, 409 | application/json |
930
- | errors.APIError | 4XX, 5XX | \*/\* |
931
-
932
- ## getOccurrance
933
-
934
- Gets a specific occurrence.
935
-
936
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
937
- you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
938
-
939
- ### Example Usage
940
-
941
- <!-- UsageSnippet language="typescript" operationID="getScheduledOccurrence" method="get" path="/accounts/{accountID}/schedules/{scheduleID}/occurrences/{occurrenceFilter}" -->
942
- ```typescript
943
- import { Moov } from "@moovio/sdk";
944
-
945
- const moov = new Moov({
946
- xMoovVersion: "v2024.01.00",
947
- security: {
948
- username: "",
949
- password: "",
950
- },
951
- });
952
-
953
- async function run() {
954
- const result = await moov.scheduling.getOccurrance({
955
- accountID: "ea12b5d5-6249-4af2-ae48-6141a5251090",
956
- scheduleID: "289e94cd-66f1-4df5-999f-46d0f40b4ce9",
957
- occurrenceFilter: "<value>",
958
- });
959
-
960
- console.log(result);
961
- }
962
-
963
- run();
964
- ```
965
-
966
- ### Standalone function
967
-
968
- The standalone function version of this method:
969
-
970
- ```typescript
971
- import { MoovCore } from "@moovio/sdk/core.js";
972
- import { schedulingGetOccurrance } from "@moovio/sdk/funcs/schedulingGetOccurrance.js";
973
-
974
- // Use `MoovCore` for best tree-shaking performance.
975
- // You can create one instance of it to use across an application.
976
- const moov = new MoovCore({
977
- xMoovVersion: "v2024.01.00",
978
- security: {
979
- username: "",
980
- password: "",
981
- },
982
- });
983
-
984
- async function run() {
985
- const res = await schedulingGetOccurrance(moov, {
986
- accountID: "ea12b5d5-6249-4af2-ae48-6141a5251090",
987
- scheduleID: "289e94cd-66f1-4df5-999f-46d0f40b4ce9",
988
- occurrenceFilter: "<value>",
989
- });
990
- if (res.ok) {
991
- const { value: result } = res;
992
- console.log(result);
993
- } else {
994
- console.log("schedulingGetOccurrance failed:", res.error);
995
- }
996
- }
997
-
998
- run();
999
- ```
1000
-
1001
- ### Parameters
1002
-
1003
- | Parameter | Type | Required | Description |
1004
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1005
- | `request` | [operations.GetScheduledOccurrenceRequest](../../models/operations/getscheduledoccurrencerequest.md) | :heavy_check_mark: | The request object to use for the request. |
1006
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1007
- | `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. |
1008
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1009
-
1010
- ### Response
1011
-
1012
- **Promise\<[operations.GetScheduledOccurrenceResponse](../../models/operations/getscheduledoccurrenceresponse.md)\>**
1013
-
1014
- ### Errors
1015
-
1016
- | Error Type | Status Code | Content Type |
1017
- | --------------- | --------------- | --------------- |
1018
- | errors.APIError | 4XX, 5XX | \*/\* |