@moovio/sdk 0.21.0 → 0.21.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 (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 +3 -3
  18. package/lib/config.js +3 -3
  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 +3 -3
  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/support/README.md DELETED
@@ -1,505 +0,0 @@
1
- # Support
2
- (*support*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [createTicket](#createticket) - Create a support ticket for a Moov account.
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}/tickets.write` scope.
12
-
13
- If you're creating the ticket on behalf of another account, then you'll need to
14
- specify the `/accounts/{partnerAccountID}/tickets.write` and `/accounts/{accountID}/profile.read` scopes.
15
- * [listTickets](#listtickets) - List all the support tickets created under a Moov account.
16
-
17
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
18
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
19
-
20
- If you're listing another account's tickets, then you'll need to
21
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
22
- * [getTicket](#getticket) - Retrieve a support ticket by ID.
23
-
24
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
25
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
26
-
27
- If you're retrieving another account's ticket, then you'll need to
28
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
29
- * [updateTicket](#updateticket) - Updates a support ticket.
30
-
31
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
32
- you'll need to specify the `/accounts/{accountID}/tickets.write` scope.
33
-
34
- If you're updating the ticket on behalf of another account, then you'll need to
35
- specify the `/accounts/{partnerAccountID}/tickets.write` and `/accounts/{accountID}/profile.read` scopes.
36
- * [listTicketMessages](#listticketmessages) - List all the messages for a support ticket.
37
-
38
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
39
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
40
-
41
- If you're listing another account's messages, then you'll need to
42
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
43
-
44
- ## createTicket
45
-
46
- Create a support ticket for a Moov account.
47
-
48
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
49
- you'll need to specify the `/accounts/{accountID}/tickets.write` scope.
50
-
51
- If you're creating the ticket on behalf of another account, then you'll need to
52
- specify the `/accounts/{partnerAccountID}/tickets.write` and `/accounts/{accountID}/profile.read` scopes.
53
-
54
- ### Example Usage
55
-
56
- <!-- UsageSnippet language="typescript" operationID="createTicket" method="post" path="/accounts/{accountID}/tickets" -->
57
- ```typescript
58
- import { Moov } from "@moovio/sdk";
59
-
60
- const moov = new Moov({
61
- xMoovVersion: "v2024.01.00",
62
- security: {
63
- username: "",
64
- password: "",
65
- },
66
- });
67
-
68
- async function run() {
69
- const result = await moov.support.createTicket({
70
- accountID: "4af4784a-c777-48f6-8211-063d5341f84b",
71
- createTicket: {
72
- title: "<value>",
73
- body: "<value>",
74
- contact: {
75
- email: "Melany.Roberts@yahoo.com",
76
- },
77
- },
78
- });
79
-
80
- console.log(result);
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Standalone function
87
-
88
- The standalone function version of this method:
89
-
90
- ```typescript
91
- import { MoovCore } from "@moovio/sdk/core.js";
92
- import { supportCreateTicket } from "@moovio/sdk/funcs/supportCreateTicket.js";
93
-
94
- // Use `MoovCore` for best tree-shaking performance.
95
- // You can create one instance of it to use across an application.
96
- const moov = new MoovCore({
97
- xMoovVersion: "v2024.01.00",
98
- security: {
99
- username: "",
100
- password: "",
101
- },
102
- });
103
-
104
- async function run() {
105
- const res = await supportCreateTicket(moov, {
106
- accountID: "4af4784a-c777-48f6-8211-063d5341f84b",
107
- createTicket: {
108
- title: "<value>",
109
- body: "<value>",
110
- contact: {
111
- email: "Melany.Roberts@yahoo.com",
112
- },
113
- },
114
- });
115
- if (res.ok) {
116
- const { value: result } = res;
117
- console.log(result);
118
- } else {
119
- console.log("supportCreateTicket failed:", res.error);
120
- }
121
- }
122
-
123
- run();
124
- ```
125
-
126
- ### Parameters
127
-
128
- | Parameter | Type | Required | Description |
129
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
130
- | `request` | [operations.CreateTicketRequest](../../models/operations/createticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
131
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
132
- | `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. |
133
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
134
-
135
- ### Response
136
-
137
- **Promise\<[operations.CreateTicketResponse](../../models/operations/createticketresponse.md)\>**
138
-
139
- ### Errors
140
-
141
- | Error Type | Status Code | Content Type |
142
- | ------------------------ | ------------------------ | ------------------------ |
143
- | errors.GenericError | 400, 409 | application/json |
144
- | errors.CreateTicketError | 422 | application/json |
145
- | errors.APIError | 4XX, 5XX | \*/\* |
146
-
147
- ## listTickets
148
-
149
- List all the support tickets created under a Moov account.
150
-
151
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
152
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
153
-
154
- If you're listing another account's tickets, then you'll need to
155
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
156
-
157
- ### Example Usage
158
-
159
- <!-- UsageSnippet language="typescript" operationID="listTickets" method="get" path="/accounts/{accountID}/tickets" -->
160
- ```typescript
161
- import { Moov } from "@moovio/sdk";
162
-
163
- const moov = new Moov({
164
- xMoovVersion: "v2024.01.00",
165
- security: {
166
- username: "",
167
- password: "",
168
- },
169
- });
170
-
171
- async function run() {
172
- const result = await moov.support.listTickets({
173
- count: 20,
174
- accountID: "8ef75c13-2a50-4438-b294-2a850eb4986d",
175
- });
176
-
177
- console.log(result);
178
- }
179
-
180
- run();
181
- ```
182
-
183
- ### Standalone function
184
-
185
- The standalone function version of this method:
186
-
187
- ```typescript
188
- import { MoovCore } from "@moovio/sdk/core.js";
189
- import { supportListTickets } from "@moovio/sdk/funcs/supportListTickets.js";
190
-
191
- // Use `MoovCore` for best tree-shaking performance.
192
- // You can create one instance of it to use across an application.
193
- const moov = new MoovCore({
194
- xMoovVersion: "v2024.01.00",
195
- security: {
196
- username: "",
197
- password: "",
198
- },
199
- });
200
-
201
- async function run() {
202
- const res = await supportListTickets(moov, {
203
- count: 20,
204
- accountID: "8ef75c13-2a50-4438-b294-2a850eb4986d",
205
- });
206
- if (res.ok) {
207
- const { value: result } = res;
208
- console.log(result);
209
- } else {
210
- console.log("supportListTickets failed:", res.error);
211
- }
212
- }
213
-
214
- run();
215
- ```
216
-
217
- ### Parameters
218
-
219
- | Parameter | Type | Required | Description |
220
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
221
- | `request` | [operations.ListTicketsRequest](../../models/operations/listticketsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
222
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
223
- | `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. |
224
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
225
-
226
- ### Response
227
-
228
- **Promise\<[operations.ListTicketsResponse](../../models/operations/listticketsresponse.md)\>**
229
-
230
- ### Errors
231
-
232
- | Error Type | Status Code | Content Type |
233
- | --------------- | --------------- | --------------- |
234
- | errors.APIError | 4XX, 5XX | \*/\* |
235
-
236
- ## getTicket
237
-
238
- Retrieve a support ticket by ID.
239
-
240
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
241
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
242
-
243
- If you're retrieving another account's ticket, then you'll need to
244
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
245
-
246
- ### Example Usage
247
-
248
- <!-- UsageSnippet language="typescript" operationID="getTicket" method="get" path="/accounts/{accountID}/tickets/{ticketID}" -->
249
- ```typescript
250
- import { Moov } from "@moovio/sdk";
251
-
252
- const moov = new Moov({
253
- xMoovVersion: "v2024.01.00",
254
- security: {
255
- username: "",
256
- password: "",
257
- },
258
- });
259
-
260
- async function run() {
261
- const result = await moov.support.getTicket({
262
- accountID: "873ccb78-88b3-4520-85f2-7cc2aef5704b",
263
- ticketID: "91fea9bf-b373-40f7-86e0-2c80690126e4",
264
- });
265
-
266
- console.log(result);
267
- }
268
-
269
- run();
270
- ```
271
-
272
- ### Standalone function
273
-
274
- The standalone function version of this method:
275
-
276
- ```typescript
277
- import { MoovCore } from "@moovio/sdk/core.js";
278
- import { supportGetTicket } from "@moovio/sdk/funcs/supportGetTicket.js";
279
-
280
- // Use `MoovCore` for best tree-shaking performance.
281
- // You can create one instance of it to use across an application.
282
- const moov = new MoovCore({
283
- xMoovVersion: "v2024.01.00",
284
- security: {
285
- username: "",
286
- password: "",
287
- },
288
- });
289
-
290
- async function run() {
291
- const res = await supportGetTicket(moov, {
292
- accountID: "873ccb78-88b3-4520-85f2-7cc2aef5704b",
293
- ticketID: "91fea9bf-b373-40f7-86e0-2c80690126e4",
294
- });
295
- if (res.ok) {
296
- const { value: result } = res;
297
- console.log(result);
298
- } else {
299
- console.log("supportGetTicket failed:", res.error);
300
- }
301
- }
302
-
303
- run();
304
- ```
305
-
306
- ### Parameters
307
-
308
- | Parameter | Type | Required | Description |
309
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
310
- | `request` | [operations.GetTicketRequest](../../models/operations/getticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
311
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
312
- | `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. |
313
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
314
-
315
- ### Response
316
-
317
- **Promise\<[operations.GetTicketResponse](../../models/operations/getticketresponse.md)\>**
318
-
319
- ### Errors
320
-
321
- | Error Type | Status Code | Content Type |
322
- | --------------- | --------------- | --------------- |
323
- | errors.APIError | 4XX, 5XX | \*/\* |
324
-
325
- ## updateTicket
326
-
327
- Updates a support ticket.
328
-
329
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
330
- you'll need to specify the `/accounts/{accountID}/tickets.write` scope.
331
-
332
- If you're updating the ticket on behalf of another account, then you'll need to
333
- specify the `/accounts/{partnerAccountID}/tickets.write` and `/accounts/{accountID}/profile.read` scopes.
334
-
335
- ### Example Usage
336
-
337
- <!-- UsageSnippet language="typescript" operationID="updateTicket" method="patch" path="/accounts/{accountID}/tickets/{ticketID}" -->
338
- ```typescript
339
- import { Moov } from "@moovio/sdk";
340
-
341
- const moov = new Moov({
342
- xMoovVersion: "v2024.01.00",
343
- security: {
344
- username: "",
345
- password: "",
346
- },
347
- });
348
-
349
- async function run() {
350
- const result = await moov.support.updateTicket({
351
- accountID: "7cce2b85-37c2-4c76-954c-03dcec2b12f0",
352
- ticketID: "1d621d17-8e7d-4ac0-9f7d-6e9fcebe8eef",
353
- updateTicket: {},
354
- });
355
-
356
- console.log(result);
357
- }
358
-
359
- run();
360
- ```
361
-
362
- ### Standalone function
363
-
364
- The standalone function version of this method:
365
-
366
- ```typescript
367
- import { MoovCore } from "@moovio/sdk/core.js";
368
- import { supportUpdateTicket } from "@moovio/sdk/funcs/supportUpdateTicket.js";
369
-
370
- // Use `MoovCore` for best tree-shaking performance.
371
- // You can create one instance of it to use across an application.
372
- const moov = new MoovCore({
373
- xMoovVersion: "v2024.01.00",
374
- security: {
375
- username: "",
376
- password: "",
377
- },
378
- });
379
-
380
- async function run() {
381
- const res = await supportUpdateTicket(moov, {
382
- accountID: "7cce2b85-37c2-4c76-954c-03dcec2b12f0",
383
- ticketID: "1d621d17-8e7d-4ac0-9f7d-6e9fcebe8eef",
384
- updateTicket: {},
385
- });
386
- if (res.ok) {
387
- const { value: result } = res;
388
- console.log(result);
389
- } else {
390
- console.log("supportUpdateTicket failed:", res.error);
391
- }
392
- }
393
-
394
- run();
395
- ```
396
-
397
- ### Parameters
398
-
399
- | Parameter | Type | Required | Description |
400
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
401
- | `request` | [operations.UpdateTicketRequest](../../models/operations/updateticketrequest.md) | :heavy_check_mark: | The request object to use for the request. |
402
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
403
- | `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. |
404
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
405
-
406
- ### Response
407
-
408
- **Promise\<[operations.UpdateTicketResponse](../../models/operations/updateticketresponse.md)\>**
409
-
410
- ### Errors
411
-
412
- | Error Type | Status Code | Content Type |
413
- | ------------------------ | ------------------------ | ------------------------ |
414
- | errors.GenericError | 400, 409 | application/json |
415
- | errors.UpdateTicketError | 422 | application/json |
416
- | errors.APIError | 4XX, 5XX | \*/\* |
417
-
418
- ## listTicketMessages
419
-
420
- List all the messages for a support ticket.
421
-
422
- To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
423
- you'll need to specify the `/accounts/{accountID}/tickets.read` scope.
424
-
425
- If you're listing another account's messages, then you'll need to
426
- specify the `/accounts/{partnerAccountID}/tickets.read` and `/accounts/{accountID}/profile.read` scopes.
427
-
428
- ### Example Usage
429
-
430
- <!-- UsageSnippet language="typescript" operationID="listTicketMessages" method="get" path="/accounts/{accountID}/tickets/{ticketID}/messages" -->
431
- ```typescript
432
- import { Moov } from "@moovio/sdk";
433
-
434
- const moov = new Moov({
435
- xMoovVersion: "v2024.01.00",
436
- security: {
437
- username: "",
438
- password: "",
439
- },
440
- });
441
-
442
- async function run() {
443
- const result = await moov.support.listTicketMessages({
444
- accountID: "72444918-8529-4986-b10c-41817e45d09e",
445
- ticketID: "edeaab65-c54c-45b8-881b-19138f125fb1",
446
- });
447
-
448
- console.log(result);
449
- }
450
-
451
- run();
452
- ```
453
-
454
- ### Standalone function
455
-
456
- The standalone function version of this method:
457
-
458
- ```typescript
459
- import { MoovCore } from "@moovio/sdk/core.js";
460
- import { supportListTicketMessages } from "@moovio/sdk/funcs/supportListTicketMessages.js";
461
-
462
- // Use `MoovCore` for best tree-shaking performance.
463
- // You can create one instance of it to use across an application.
464
- const moov = new MoovCore({
465
- xMoovVersion: "v2024.01.00",
466
- security: {
467
- username: "",
468
- password: "",
469
- },
470
- });
471
-
472
- async function run() {
473
- const res = await supportListTicketMessages(moov, {
474
- accountID: "72444918-8529-4986-b10c-41817e45d09e",
475
- ticketID: "edeaab65-c54c-45b8-881b-19138f125fb1",
476
- });
477
- if (res.ok) {
478
- const { value: result } = res;
479
- console.log(result);
480
- } else {
481
- console.log("supportListTicketMessages failed:", res.error);
482
- }
483
- }
484
-
485
- run();
486
- ```
487
-
488
- ### Parameters
489
-
490
- | Parameter | Type | Required | Description |
491
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
492
- | `request` | [operations.ListTicketMessagesRequest](../../models/operations/listticketmessagesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
493
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
494
- | `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. |
495
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
496
-
497
- ### Response
498
-
499
- **Promise\<[operations.ListTicketMessagesResponse](../../models/operations/listticketmessagesresponse.md)\>**
500
-
501
- ### Errors
502
-
503
- | Error Type | Status Code | Content Type |
504
- | --------------- | --------------- | --------------- |
505
- | errors.APIError | 4XX, 5XX | \*/\* |