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