@gr4vy/sdk 1.5.8 → 1.6.1

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 (49) hide show
  1. package/examples/package-lock.json +1 -1
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +3 -3
  4. package/lib/config.js +3 -3
  5. package/models/components/checkoutsession.d.ts +15 -0
  6. package/models/components/checkoutsession.d.ts.map +1 -1
  7. package/models/components/checkoutsession.js +8 -0
  8. package/models/components/checkoutsession.js.map +1 -1
  9. package/models/components/checkoutsessioncreate.d.ts +15 -0
  10. package/models/components/checkoutsessioncreate.d.ts.map +1 -1
  11. package/models/components/checkoutsessioncreate.js +8 -0
  12. package/models/components/checkoutsessioncreate.js.map +1 -1
  13. package/package.json +1 -1
  14. package/src/lib/config.ts +3 -3
  15. package/src/models/components/checkoutsession.ts +23 -0
  16. package/src/models/components/checkoutsessioncreate.ts +23 -0
  17. package/docs/sdks/all/README.md +0 -98
  18. package/docs/sdks/auditlogs/README.md +0 -100
  19. package/docs/sdks/balances/README.md +0 -123
  20. package/docs/sdks/buyers/README.md +0 -461
  21. package/docs/sdks/cardschemedefinitions/README.md +0 -96
  22. package/docs/sdks/checkoutsessions/README.md +0 -367
  23. package/docs/sdks/cryptogram/README.md +0 -103
  24. package/docs/sdks/digitalwallets/README.md +0 -465
  25. package/docs/sdks/domains/README.md +0 -197
  26. package/docs/sdks/events/README.md +0 -99
  27. package/docs/sdks/executions/README.md +0 -285
  28. package/docs/sdks/giftcards/README.md +0 -376
  29. package/docs/sdks/gr4vygiftcards/README.md +0 -98
  30. package/docs/sdks/gr4vypaymentmethods/README.md +0 -96
  31. package/docs/sdks/gr4vyrefunds/README.md +0 -279
  32. package/docs/sdks/jobs/README.md +0 -107
  33. package/docs/sdks/merchantaccounts/README.md +0 -382
  34. package/docs/sdks/networktokens/README.md +0 -467
  35. package/docs/sdks/paymentlinks/README.md +0 -381
  36. package/docs/sdks/paymentmethods/README.md +0 -376
  37. package/docs/sdks/paymentoptions/README.md +0 -97
  38. package/docs/sdks/paymentservicedefinitions/README.md +0 -281
  39. package/docs/sdks/paymentservices/README.md +0 -706
  40. package/docs/sdks/paymentservicetokens/README.md +0 -286
  41. package/docs/sdks/payouts/README.md +0 -298
  42. package/docs/sdks/refunds/README.md +0 -97
  43. package/docs/sdks/reportexecutions/README.md +0 -100
  44. package/docs/sdks/reports/README.md +0 -403
  45. package/docs/sdks/sessions/README.md +0 -289
  46. package/docs/sdks/settlements/README.md +0 -188
  47. package/docs/sdks/shippingdetails/README.md +0 -462
  48. package/docs/sdks/transactions/README.md +0 -752
  49. package/examples/README.md +0 -31
package/docs/sdks/networktokens/README.md DELETED
@@ -1,467 +0,0 @@
1
- # NetworkTokens
2
- (*paymentMethods.networkTokens*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List network tokens
9
- * [create](#create) - Provision network token
10
- * [suspend](#suspend) - Suspend network token
11
- * [resume](#resume) - Resume network token
12
- * [delete](#delete) - Delete network token
13
-
14
- ## list
15
-
16
- List all network tokens stored for a payment method.
17
-
18
- ### Example Usage
19
-
20
- <!-- UsageSnippet language="typescript" operationID="list_payment_method_network_tokens" method="get" path="/payment-methods/{payment_method_id}/network-tokens" -->
21
- ```typescript
22
- import { Gr4vy, withToken } from "@gr4vy/sdk";
23
- import fs from "fs";
24
-
25
- const gr4vy = new Gr4vy({
26
- id: "example",
27
- server: "sandbox",
28
- merchantAccountId: "default",
29
- bearerAuth: withToken({
30
- privateKey: fs.readFileSync("private_key.pem", "utf8"),
31
- }),
32
- });
33
-
34
- async function run() {
35
- const result = await gr4vy.paymentMethods.networkTokens.list("ef9496d8-53a5-4aad-8ca2-00eb68334389");
36
-
37
- console.log(result);
38
- }
39
-
40
- run();
41
- ```
42
-
43
- ### Standalone function
44
-
45
- The standalone function version of this method:
46
-
47
- ```typescript
48
- import { Gr4vyCore } from "@gr4vy/sdk/core.js";
49
- import { paymentMethodsNetworkTokensList } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensList.js";
50
-
51
- // Use `Gr4vyCore` for best tree-shaking performance.
52
- // You can create one instance of it to use across an application.
53
- const gr4vy = new Gr4vyCore({
54
- merchantAccountId: "<id>",
55
- bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
56
- });
57
-
58
- async function run() {
59
- const res = await paymentMethodsNetworkTokensList(gr4vy, "ef9496d8-53a5-4aad-8ca2-00eb68334389");
60
- if (res.ok) {
61
- const { value: result } = res;
62
- console.log(result);
63
- } else {
64
- console.log("paymentMethodsNetworkTokensList failed:", res.error);
65
- }
66
- }
67
-
68
- run();
69
- ```
70
-
71
- ### Parameters
72
-
73
- | Parameter | Type | Required | Description | Example |
74
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
- | `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
76
- | `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
77
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
78
- | `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. | |
79
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
80
-
81
- ### Response
82
-
83
- **Promise\<[components.NetworkTokens](../../models/components/networktokens.md)\>**
84
-
85
- ### Errors
86
-
87
- | Error Type | Status Code | Content Type |
88
- | -------------------------- | -------------------------- | -------------------------- |
89
- | errors.Error400 | 400 | application/json |
90
- | errors.Error401 | 401 | application/json |
91
- | errors.Error403 | 403 | application/json |
92
- | errors.Error404 | 404 | application/json |
93
- | errors.Error405 | 405 | application/json |
94
- | errors.Error409 | 409 | application/json |
95
- | errors.HTTPValidationError | 422 | application/json |
96
- | errors.Error425 | 425 | application/json |
97
- | errors.Error429 | 429 | application/json |
98
- | errors.Error500 | 500 | application/json |
99
- | errors.Error502 | 502 | application/json |
100
- | errors.Error504 | 504 | application/json |
101
- | errors.SDKError | 4XX, 5XX | \*/\* |
102
-
103
- ## create
104
-
105
- Provision a network token for a payment method.
106
-
107
- ### Example Usage
108
-
109
- <!-- UsageSnippet language="typescript" operationID="create_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens" -->
110
- ```typescript
111
- import { Gr4vy, withToken } from "@gr4vy/sdk";
112
- import fs from "fs";
113
-
114
- const gr4vy = new Gr4vy({
115
- id: "example",
116
- server: "sandbox",
117
- merchantAccountId: "default",
118
- bearerAuth: withToken({
119
- privateKey: fs.readFileSync("private_key.pem", "utf8"),
120
- }),
121
- });
122
-
123
- async function run() {
124
- const result = await gr4vy.paymentMethods.networkTokens.create({
125
- merchantInitiated: false,
126
- isSubsequentPayment: false,
127
- }, "ef9496d8-53a5-4aad-8ca2-00eb68334389");
128
-
129
- console.log(result);
130
- }
131
-
132
- run();
133
- ```
134
-
135
- ### Standalone function
136
-
137
- The standalone function version of this method:
138
-
139
- ```typescript
140
- import { Gr4vyCore } from "@gr4vy/sdk/core.js";
141
- import { paymentMethodsNetworkTokensCreate } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensCreate.js";
142
-
143
- // Use `Gr4vyCore` for best tree-shaking performance.
144
- // You can create one instance of it to use across an application.
145
- const gr4vy = new Gr4vyCore({
146
- merchantAccountId: "<id>",
147
- bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
148
- });
149
-
150
- async function run() {
151
- const res = await paymentMethodsNetworkTokensCreate(gr4vy, {
152
- merchantInitiated: false,
153
- isSubsequentPayment: false,
154
- }, "ef9496d8-53a5-4aad-8ca2-00eb68334389");
155
- if (res.ok) {
156
- const { value: result } = res;
157
- console.log(result);
158
- } else {
159
- console.log("paymentMethodsNetworkTokensCreate failed:", res.error);
160
- }
161
- }
162
-
163
- run();
164
- ```
165
-
166
- ### Parameters
167
-
168
- | Parameter | Type | Required | Description | Example |
169
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
170
- | `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
171
- | `networkTokenCreate` | [components.NetworkTokenCreate](../../models/components/networktokencreate.md) | :heavy_check_mark: | N/A | |
172
- | `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
173
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
174
- | `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. | |
175
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
176
-
177
- ### Response
178
-
179
- **Promise\<[components.NetworkToken](../../models/components/networktoken.md)\>**
180
-
181
- ### Errors
182
-
183
- | Error Type | Status Code | Content Type |
184
- | -------------------------- | -------------------------- | -------------------------- |
185
- | errors.Error400 | 400 | application/json |
186
- | errors.Error401 | 401 | application/json |
187
- | errors.Error403 | 403 | application/json |
188
- | errors.Error404 | 404 | application/json |
189
- | errors.Error405 | 405 | application/json |
190
- | errors.Error409 | 409 | application/json |
191
- | errors.HTTPValidationError | 422 | application/json |
192
- | errors.Error425 | 425 | application/json |
193
- | errors.Error429 | 429 | application/json |
194
- | errors.Error500 | 500 | application/json |
195
- | errors.Error502 | 502 | application/json |
196
- | errors.Error504 | 504 | application/json |
197
- | errors.SDKError | 4XX, 5XX | \*/\* |
198
-
199
- ## suspend
200
-
201
- Suspend a network token for a payment method.
202
-
203
- ### Example Usage
204
-
205
- <!-- UsageSnippet language="typescript" operationID="suspend_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}/suspend" -->
206
- ```typescript
207
- import { Gr4vy, withToken } from "@gr4vy/sdk";
208
- import fs from "fs";
209
-
210
- const gr4vy = new Gr4vy({
211
- id: "example",
212
- server: "sandbox",
213
- merchantAccountId: "default",
214
- bearerAuth: withToken({
215
- privateKey: fs.readFileSync("private_key.pem", "utf8"),
216
- }),
217
- });
218
-
219
- async function run() {
220
- const result = await gr4vy.paymentMethods.networkTokens.suspend("ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
221
-
222
- console.log(result);
223
- }
224
-
225
- run();
226
- ```
227
-
228
- ### Standalone function
229
-
230
- The standalone function version of this method:
231
-
232
- ```typescript
233
- import { Gr4vyCore } from "@gr4vy/sdk/core.js";
234
- import { paymentMethodsNetworkTokensSuspend } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensSuspend.js";
235
-
236
- // Use `Gr4vyCore` for best tree-shaking performance.
237
- // You can create one instance of it to use across an application.
238
- const gr4vy = new Gr4vyCore({
239
- merchantAccountId: "<id>",
240
- bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
241
- });
242
-
243
- async function run() {
244
- const res = await paymentMethodsNetworkTokensSuspend(gr4vy, "ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
245
- if (res.ok) {
246
- const { value: result } = res;
247
- console.log(result);
248
- } else {
249
- console.log("paymentMethodsNetworkTokensSuspend failed:", res.error);
250
- }
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Parameters
257
-
258
- | Parameter | Type | Required | Description | Example |
259
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
260
- | `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
261
- | `networkTokenId` | *string* | :heavy_check_mark: | The ID of the network token | [object Object] |
262
- | `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
263
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
264
- | `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. | |
265
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
266
-
267
- ### Response
268
-
269
- **Promise\<[components.NetworkToken](../../models/components/networktoken.md)\>**
270
-
271
- ### Errors
272
-
273
- | Error Type | Status Code | Content Type |
274
- | -------------------------- | -------------------------- | -------------------------- |
275
- | errors.Error400 | 400 | application/json |
276
- | errors.Error401 | 401 | application/json |
277
- | errors.Error403 | 403 | application/json |
278
- | errors.Error404 | 404 | application/json |
279
- | errors.Error405 | 405 | application/json |
280
- | errors.Error409 | 409 | application/json |
281
- | errors.HTTPValidationError | 422 | application/json |
282
- | errors.Error425 | 425 | application/json |
283
- | errors.Error429 | 429 | application/json |
284
- | errors.Error500 | 500 | application/json |
285
- | errors.Error502 | 502 | application/json |
286
- | errors.Error504 | 504 | application/json |
287
- | errors.SDKError | 4XX, 5XX | \*/\* |
288
-
289
- ## resume
290
-
291
- Resume a suspended network token for a payment method.
292
-
293
- ### Example Usage
294
-
295
- <!-- UsageSnippet language="typescript" operationID="resume_payment_method_network_token" method="post" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}/resume" -->
296
- ```typescript
297
- import { Gr4vy, withToken } from "@gr4vy/sdk";
298
- import fs from "fs";
299
-
300
- const gr4vy = new Gr4vy({
301
- id: "example",
302
- server: "sandbox",
303
- merchantAccountId: "default",
304
- bearerAuth: withToken({
305
- privateKey: fs.readFileSync("private_key.pem", "utf8"),
306
- }),
307
- });
308
-
309
- async function run() {
310
- const result = await gr4vy.paymentMethods.networkTokens.resume("ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
311
-
312
- console.log(result);
313
- }
314
-
315
- run();
316
- ```
317
-
318
- ### Standalone function
319
-
320
- The standalone function version of this method:
321
-
322
- ```typescript
323
- import { Gr4vyCore } from "@gr4vy/sdk/core.js";
324
- import { paymentMethodsNetworkTokensResume } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensResume.js";
325
-
326
- // Use `Gr4vyCore` for best tree-shaking performance.
327
- // You can create one instance of it to use across an application.
328
- const gr4vy = new Gr4vyCore({
329
- merchantAccountId: "<id>",
330
- bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
331
- });
332
-
333
- async function run() {
334
- const res = await paymentMethodsNetworkTokensResume(gr4vy, "ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
335
- if (res.ok) {
336
- const { value: result } = res;
337
- console.log(result);
338
- } else {
339
- console.log("paymentMethodsNetworkTokensResume failed:", res.error);
340
- }
341
- }
342
-
343
- run();
344
- ```
345
-
346
- ### Parameters
347
-
348
- | Parameter | Type | Required | Description | Example |
349
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
350
- | `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
351
- | `networkTokenId` | *string* | :heavy_check_mark: | The ID of the network token | [object Object] |
352
- | `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
353
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
354
- | `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. | |
355
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
356
-
357
- ### Response
358
-
359
- **Promise\<[components.NetworkToken](../../models/components/networktoken.md)\>**
360
-
361
- ### Errors
362
-
363
- | Error Type | Status Code | Content Type |
364
- | -------------------------- | -------------------------- | -------------------------- |
365
- | errors.Error400 | 400 | application/json |
366
- | errors.Error401 | 401 | application/json |
367
- | errors.Error403 | 403 | application/json |
368
- | errors.Error404 | 404 | application/json |
369
- | errors.Error405 | 405 | application/json |
370
- | errors.Error409 | 409 | application/json |
371
- | errors.HTTPValidationError | 422 | application/json |
372
- | errors.Error425 | 425 | application/json |
373
- | errors.Error429 | 429 | application/json |
374
- | errors.Error500 | 500 | application/json |
375
- | errors.Error502 | 502 | application/json |
376
- | errors.Error504 | 504 | application/json |
377
- | errors.SDKError | 4XX, 5XX | \*/\* |
378
-
379
- ## delete
380
-
381
- Delete a network token for a payment method.
382
-
383
- ### Example Usage
384
-
385
- <!-- UsageSnippet language="typescript" operationID="delete_payment_method_network_token" method="delete" path="/payment-methods/{payment_method_id}/network-tokens/{network_token_id}" -->
386
- ```typescript
387
- import { Gr4vy, withToken } from "@gr4vy/sdk";
388
- import fs from "fs";
389
-
390
- const gr4vy = new Gr4vy({
391
- id: "example",
392
- server: "sandbox",
393
- merchantAccountId: "default",
394
- bearerAuth: withToken({
395
- privateKey: fs.readFileSync("private_key.pem", "utf8"),
396
- }),
397
- });
398
-
399
- async function run() {
400
- await gr4vy.paymentMethods.networkTokens.delete("ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
401
-
402
-
403
- }
404
-
405
- run();
406
- ```
407
-
408
- ### Standalone function
409
-
410
- The standalone function version of this method:
411
-
412
- ```typescript
413
- import { Gr4vyCore } from "@gr4vy/sdk/core.js";
414
- import { paymentMethodsNetworkTokensDelete } from "@gr4vy/sdk/funcs/paymentMethodsNetworkTokensDelete.js";
415
-
416
- // Use `Gr4vyCore` for best tree-shaking performance.
417
- // You can create one instance of it to use across an application.
418
- const gr4vy = new Gr4vyCore({
419
- merchantAccountId: "<id>",
420
- bearerAuth: process.env["GR4VY_BEARER_AUTH"] ?? "",
421
- });
422
-
423
- async function run() {
424
- const res = await paymentMethodsNetworkTokensDelete(gr4vy, "ef9496d8-53a5-4aad-8ca2-00eb68334389", "f8dd5cfc-7834-4847-95dc-f75a360e2298");
425
- if (res.ok) {
426
- const { value: result } = res;
427
-
428
- } else {
429
- console.log("paymentMethodsNetworkTokensDelete failed:", res.error);
430
- }
431
- }
432
-
433
- run();
434
- ```
435
-
436
- ### Parameters
437
-
438
- | Parameter | Type | Required | Description | Example |
439
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
440
- | `paymentMethodId` | *string* | :heavy_check_mark: | The ID of the payment method | [object Object] |
441
- | `networkTokenId` | *string* | :heavy_check_mark: | The ID of the network token | [object Object] |
442
- | `merchantAccountId` | *string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | |
443
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
444
- | `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. | |
445
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | |
446
-
447
- ### Response
448
-
449
- **Promise\<void\>**
450
-
451
- ### Errors
452
-
453
- | Error Type | Status Code | Content Type |
454
- | -------------------------- | -------------------------- | -------------------------- |
455
- | errors.Error400 | 400 | application/json |
456
- | errors.Error401 | 401 | application/json |
457
- | errors.Error403 | 403 | application/json |
458
- | errors.Error404 | 404 | application/json |
459
- | errors.Error405 | 405 | application/json |
460
- | errors.Error409 | 409 | application/json |
461
- | errors.HTTPValidationError | 422 | application/json |
462
- | errors.Error425 | 425 | application/json |
463
- | errors.Error429 | 429 | application/json |
464
- | errors.Error500 | 500 | application/json |
465
- | errors.Error502 | 502 | application/json |
466
- | errors.Error504 | 504 | application/json |
467
- | errors.SDKError | 4XX, 5XX | \*/\* |