@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.
- package/bin/mcp-server.js +79 -61
- package/bin/mcp-server.js.map +11 -10
- package/examples/package-lock.json +1 -1
- package/hooks/hooks.d.ts +3 -2
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js.map +1 -1
- package/hooks/moov-version-hook.d.ts +6 -0
- package/hooks/moov-version-hook.d.ts.map +1 -0
- package/hooks/moov-version-hook.js +12 -0
- package/hooks/moov-version-hook.js.map +1 -0
- package/hooks/registration.d.ts.map +1 -1
- package/hooks/registration.js +3 -1
- package/hooks/registration.js.map +1 -1
- package/hooks/types.d.ts +2 -6
- package/hooks/types.d.ts.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +5 -6
- package/lib/sdks.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/package.json +1 -1
- package/src/hooks/hooks.ts +2 -2
- package/src/hooks/moov-version-hook.ts +9 -0
- package/src/hooks/registration.ts +4 -1
- package/src/hooks/types.ts +2 -7
- package/src/lib/config.ts +3 -3
- package/src/lib/sdks.ts +6 -7
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/docs/sdks/accounts/README.md +0 -1038
- package/docs/sdks/accountterminalapplications/README.md +0 -371
- package/docs/sdks/adjustments/README.md +0 -185
- package/docs/sdks/applepay/README.md +0 -572
- package/docs/sdks/authentication/README.md +0 -191
- package/docs/sdks/avatars/README.md +0 -95
- package/docs/sdks/bankaccounts/README.md +0 -951
- package/docs/sdks/branding/README.md +0 -407
- package/docs/sdks/capabilities/README.md +0 -380
- package/docs/sdks/cardissuing/README.md +0 -533
- package/docs/sdks/cards/README.md +0 -544
- package/docs/sdks/disputes/README.md +0 -1085
- package/docs/sdks/endtoendencryption/README.md +0 -174
- package/docs/sdks/enrichedaddress/README.md +0 -95
- package/docs/sdks/enrichedprofile/README.md +0 -95
- package/docs/sdks/feeplans/README.md +0 -921
- package/docs/sdks/files/README.md +0 -293
- package/docs/sdks/images/README.md +0 -616
- package/docs/sdks/industries/README.md +0 -91
- package/docs/sdks/institutions/README.md +0 -184
- package/docs/sdks/issuingtransactions/README.md +0 -465
- package/docs/sdks/onboarding/README.md +0 -389
- package/docs/sdks/paymentlinks/README.md +0 -615
- package/docs/sdks/paymentmethods/README.md +0 -187
- package/docs/sdks/ping/README.md +0 -91
- package/docs/sdks/products/README.md +0 -616
- package/docs/sdks/receipts/README.md +0 -180
- package/docs/sdks/representatives/README.md +0 -603
- package/docs/sdks/scheduling/README.md +0 -1018
- package/docs/sdks/statements/README.md +0 -194
- package/docs/sdks/support/README.md +0 -505
- package/docs/sdks/sweeps/README.md +0 -571
- package/docs/sdks/terminalapplications/README.md +0 -460
- package/docs/sdks/transfers/README.md +0 -1136
- package/docs/sdks/underwriting/README.md +0 -331
- package/docs/sdks/wallets/README.md +0 -416
- package/docs/sdks/wallettransactions/README.md +0 -202
- package/examples/README.md +0 -31
- package/test/README.md +0 -14
|
@@ -1,616 +0,0 @@
|
|
|
1
|
-
# Products
|
|
2
|
-
(*products*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [list](#list) - List active (non-disabled) products for an account.
|
|
9
|
-
* [create](#create) - Creates a new product for the specified account.
|
|
10
|
-
* [get](#get) - Retrieve a product by ID.
|
|
11
|
-
* [update](#update) - Update a product and its options.
|
|
12
|
-
* [disable](#disable) - Disable a product by ID.
|
|
13
|
-
|
|
14
|
-
The product will no longer be available, but will remain in the system for historical and reporting purposes.
|
|
15
|
-
|
|
16
|
-
## list
|
|
17
|
-
|
|
18
|
-
List active (non-disabled) products for an account.
|
|
19
|
-
|
|
20
|
-
### Example Usage
|
|
21
|
-
|
|
22
|
-
<!-- UsageSnippet language="typescript" operationID="listProducts" method="get" path="/accounts/{accountID}/products" -->
|
|
23
|
-
```typescript
|
|
24
|
-
import { Moov } from "@moovio/sdk";
|
|
25
|
-
|
|
26
|
-
const moov = new Moov({
|
|
27
|
-
xMoovVersion: "v2024.01.00",
|
|
28
|
-
security: {
|
|
29
|
-
username: "",
|
|
30
|
-
password: "",
|
|
31
|
-
},
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
async function run() {
|
|
35
|
-
const result = await moov.products.list({
|
|
36
|
-
accountID: "cd696219-4308-446c-b0d8-1759254995c2",
|
|
37
|
-
skip: 60,
|
|
38
|
-
count: 20,
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
console.log(result);
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
run();
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Standalone function
|
|
48
|
-
|
|
49
|
-
The standalone function version of this method:
|
|
50
|
-
|
|
51
|
-
```typescript
|
|
52
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
53
|
-
import { productsList } from "@moovio/sdk/funcs/productsList.js";
|
|
54
|
-
|
|
55
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
56
|
-
// You can create one instance of it to use across an application.
|
|
57
|
-
const moov = new MoovCore({
|
|
58
|
-
xMoovVersion: "v2024.01.00",
|
|
59
|
-
security: {
|
|
60
|
-
username: "",
|
|
61
|
-
password: "",
|
|
62
|
-
},
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
async function run() {
|
|
66
|
-
const res = await productsList(moov, {
|
|
67
|
-
accountID: "cd696219-4308-446c-b0d8-1759254995c2",
|
|
68
|
-
skip: 60,
|
|
69
|
-
count: 20,
|
|
70
|
-
});
|
|
71
|
-
if (res.ok) {
|
|
72
|
-
const { value: result } = res;
|
|
73
|
-
console.log(result);
|
|
74
|
-
} else {
|
|
75
|
-
console.log("productsList failed:", res.error);
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
run();
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
### Parameters
|
|
83
|
-
|
|
84
|
-
| Parameter | Type | Required | Description |
|
|
85
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
86
|
-
| `request` | [operations.ListProductsRequest](../../models/operations/listproductsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
87
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
88
|
-
| `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. |
|
|
89
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
90
|
-
|
|
91
|
-
### Response
|
|
92
|
-
|
|
93
|
-
**Promise\<[operations.ListProductsResponse](../../models/operations/listproductsresponse.md)\>**
|
|
94
|
-
|
|
95
|
-
### Errors
|
|
96
|
-
|
|
97
|
-
| Error Type | Status Code | Content Type |
|
|
98
|
-
| --------------- | --------------- | --------------- |
|
|
99
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
100
|
-
|
|
101
|
-
## create
|
|
102
|
-
|
|
103
|
-
Creates a new product for the specified account.
|
|
104
|
-
|
|
105
|
-
### Example Usage
|
|
106
|
-
|
|
107
|
-
<!-- UsageSnippet language="typescript" operationID="createProduct" method="post" path="/accounts/{accountID}/products" -->
|
|
108
|
-
```typescript
|
|
109
|
-
import { Moov } from "@moovio/sdk";
|
|
110
|
-
|
|
111
|
-
const moov = new Moov({
|
|
112
|
-
xMoovVersion: "v2024.01.00",
|
|
113
|
-
security: {
|
|
114
|
-
username: "",
|
|
115
|
-
password: "",
|
|
116
|
-
},
|
|
117
|
-
});
|
|
118
|
-
|
|
119
|
-
async function run() {
|
|
120
|
-
const result = await moov.products.create({
|
|
121
|
-
accountID: "27cd3181-7c1c-4d81-b020-e7d55c33941f",
|
|
122
|
-
productRequest: {
|
|
123
|
-
title: "World's best lemonade",
|
|
124
|
-
description: "Really, the best.",
|
|
125
|
-
basePrice: {
|
|
126
|
-
currency: "USD",
|
|
127
|
-
valueDecimal: "4.99",
|
|
128
|
-
},
|
|
129
|
-
images: [
|
|
130
|
-
{
|
|
131
|
-
imageID: "fed91252-6f48-4b70-885e-520bf53a52ff",
|
|
132
|
-
},
|
|
133
|
-
{
|
|
134
|
-
imageID: "eb466644-0a58-4b87-af1e-94d03e223ad2",
|
|
135
|
-
},
|
|
136
|
-
],
|
|
137
|
-
optionGroups: [
|
|
138
|
-
{
|
|
139
|
-
name: "Flavor add-ins",
|
|
140
|
-
description: "Choose up to 3 flavor add-ins to enhance your lemonade.",
|
|
141
|
-
minSelect: 0,
|
|
142
|
-
maxSelect: 3,
|
|
143
|
-
options: [
|
|
144
|
-
{
|
|
145
|
-
name: "Strawberry puree",
|
|
146
|
-
description: "Fresh and fruity.",
|
|
147
|
-
priceModifier: {
|
|
148
|
-
currency: "USD",
|
|
149
|
-
valueDecimal: "0.99",
|
|
150
|
-
},
|
|
151
|
-
images: [
|
|
152
|
-
{
|
|
153
|
-
imageID: "d359808d-9896-4414-8d17-dac43f35842d",
|
|
154
|
-
},
|
|
155
|
-
],
|
|
156
|
-
},
|
|
157
|
-
{
|
|
158
|
-
name: "Passionfruit syrup",
|
|
159
|
-
priceModifier: {
|
|
160
|
-
currency: "USD",
|
|
161
|
-
valueDecimal: "0.49",
|
|
162
|
-
},
|
|
163
|
-
},
|
|
164
|
-
{
|
|
165
|
-
name: "Cherry syrup",
|
|
166
|
-
priceModifier: {
|
|
167
|
-
currency: "USD",
|
|
168
|
-
valueDecimal: "0.49",
|
|
169
|
-
},
|
|
170
|
-
},
|
|
171
|
-
],
|
|
172
|
-
},
|
|
173
|
-
{
|
|
174
|
-
name: "Sweetener",
|
|
175
|
-
description: "Choose a sweetener for your lemonade.",
|
|
176
|
-
minSelect: 1,
|
|
177
|
-
maxSelect: 1,
|
|
178
|
-
options: [
|
|
179
|
-
{
|
|
180
|
-
name: "Cane Sugar",
|
|
181
|
-
},
|
|
182
|
-
{
|
|
183
|
-
name: "Honey",
|
|
184
|
-
priceModifier: {
|
|
185
|
-
currency: "USD",
|
|
186
|
-
valueDecimal: "0.99",
|
|
187
|
-
},
|
|
188
|
-
},
|
|
189
|
-
{
|
|
190
|
-
name: "Stevia",
|
|
191
|
-
description: "Natural, zero-calorie sweetener.",
|
|
192
|
-
},
|
|
193
|
-
],
|
|
194
|
-
},
|
|
195
|
-
],
|
|
196
|
-
},
|
|
197
|
-
});
|
|
198
|
-
|
|
199
|
-
console.log(result);
|
|
200
|
-
}
|
|
201
|
-
|
|
202
|
-
run();
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
### Standalone function
|
|
206
|
-
|
|
207
|
-
The standalone function version of this method:
|
|
208
|
-
|
|
209
|
-
```typescript
|
|
210
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
211
|
-
import { productsCreate } from "@moovio/sdk/funcs/productsCreate.js";
|
|
212
|
-
|
|
213
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
214
|
-
// You can create one instance of it to use across an application.
|
|
215
|
-
const moov = new MoovCore({
|
|
216
|
-
xMoovVersion: "v2024.01.00",
|
|
217
|
-
security: {
|
|
218
|
-
username: "",
|
|
219
|
-
password: "",
|
|
220
|
-
},
|
|
221
|
-
});
|
|
222
|
-
|
|
223
|
-
async function run() {
|
|
224
|
-
const res = await productsCreate(moov, {
|
|
225
|
-
accountID: "27cd3181-7c1c-4d81-b020-e7d55c33941f",
|
|
226
|
-
productRequest: {
|
|
227
|
-
title: "World's best lemonade",
|
|
228
|
-
description: "Really, the best.",
|
|
229
|
-
basePrice: {
|
|
230
|
-
currency: "USD",
|
|
231
|
-
valueDecimal: "4.99",
|
|
232
|
-
},
|
|
233
|
-
images: [
|
|
234
|
-
{
|
|
235
|
-
imageID: "fed91252-6f48-4b70-885e-520bf53a52ff",
|
|
236
|
-
},
|
|
237
|
-
{
|
|
238
|
-
imageID: "eb466644-0a58-4b87-af1e-94d03e223ad2",
|
|
239
|
-
},
|
|
240
|
-
],
|
|
241
|
-
optionGroups: [
|
|
242
|
-
{
|
|
243
|
-
name: "Flavor add-ins",
|
|
244
|
-
description: "Choose up to 3 flavor add-ins to enhance your lemonade.",
|
|
245
|
-
minSelect: 0,
|
|
246
|
-
maxSelect: 3,
|
|
247
|
-
options: [
|
|
248
|
-
{
|
|
249
|
-
name: "Strawberry puree",
|
|
250
|
-
description: "Fresh and fruity.",
|
|
251
|
-
priceModifier: {
|
|
252
|
-
currency: "USD",
|
|
253
|
-
valueDecimal: "0.99",
|
|
254
|
-
},
|
|
255
|
-
images: [
|
|
256
|
-
{
|
|
257
|
-
imageID: "d359808d-9896-4414-8d17-dac43f35842d",
|
|
258
|
-
},
|
|
259
|
-
],
|
|
260
|
-
},
|
|
261
|
-
{
|
|
262
|
-
name: "Passionfruit syrup",
|
|
263
|
-
priceModifier: {
|
|
264
|
-
currency: "USD",
|
|
265
|
-
valueDecimal: "0.49",
|
|
266
|
-
},
|
|
267
|
-
},
|
|
268
|
-
{
|
|
269
|
-
name: "Cherry syrup",
|
|
270
|
-
priceModifier: {
|
|
271
|
-
currency: "USD",
|
|
272
|
-
valueDecimal: "0.49",
|
|
273
|
-
},
|
|
274
|
-
},
|
|
275
|
-
],
|
|
276
|
-
},
|
|
277
|
-
{
|
|
278
|
-
name: "Sweetener",
|
|
279
|
-
description: "Choose a sweetener for your lemonade.",
|
|
280
|
-
minSelect: 1,
|
|
281
|
-
maxSelect: 1,
|
|
282
|
-
options: [
|
|
283
|
-
{
|
|
284
|
-
name: "Cane Sugar",
|
|
285
|
-
},
|
|
286
|
-
{
|
|
287
|
-
name: "Honey",
|
|
288
|
-
priceModifier: {
|
|
289
|
-
currency: "USD",
|
|
290
|
-
valueDecimal: "0.99",
|
|
291
|
-
},
|
|
292
|
-
},
|
|
293
|
-
{
|
|
294
|
-
name: "Stevia",
|
|
295
|
-
description: "Natural, zero-calorie sweetener.",
|
|
296
|
-
},
|
|
297
|
-
],
|
|
298
|
-
},
|
|
299
|
-
],
|
|
300
|
-
},
|
|
301
|
-
});
|
|
302
|
-
if (res.ok) {
|
|
303
|
-
const { value: result } = res;
|
|
304
|
-
console.log(result);
|
|
305
|
-
} else {
|
|
306
|
-
console.log("productsCreate failed:", res.error);
|
|
307
|
-
}
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
run();
|
|
311
|
-
```
|
|
312
|
-
|
|
313
|
-
### Parameters
|
|
314
|
-
|
|
315
|
-
| Parameter | Type | Required | Description |
|
|
316
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
317
|
-
| `request` | [operations.CreateProductRequest](../../models/operations/createproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
318
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
319
|
-
| `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. |
|
|
320
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
321
|
-
|
|
322
|
-
### Response
|
|
323
|
-
|
|
324
|
-
**Promise\<[operations.CreateProductResponse](../../models/operations/createproductresponse.md)\>**
|
|
325
|
-
|
|
326
|
-
### Errors
|
|
327
|
-
|
|
328
|
-
| Error Type | Status Code | Content Type |
|
|
329
|
-
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
|
330
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
331
|
-
| errors.ProductRequestValidationError | 422 | application/json |
|
|
332
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
333
|
-
|
|
334
|
-
## get
|
|
335
|
-
|
|
336
|
-
Retrieve a product by ID.
|
|
337
|
-
|
|
338
|
-
### Example Usage
|
|
339
|
-
|
|
340
|
-
<!-- UsageSnippet language="typescript" operationID="getProduct" method="get" path="/accounts/{accountID}/products/{productID}" -->
|
|
341
|
-
```typescript
|
|
342
|
-
import { Moov } from "@moovio/sdk";
|
|
343
|
-
|
|
344
|
-
const moov = new Moov({
|
|
345
|
-
xMoovVersion: "v2024.01.00",
|
|
346
|
-
security: {
|
|
347
|
-
username: "",
|
|
348
|
-
password: "",
|
|
349
|
-
},
|
|
350
|
-
});
|
|
351
|
-
|
|
352
|
-
async function run() {
|
|
353
|
-
const result = await moov.products.get({
|
|
354
|
-
accountID: "a749d848-5ebc-42a4-9ae6-555804317835",
|
|
355
|
-
productID: "dd0b4873-5cf5-4aa8-aa86-e31d86f7e38a",
|
|
356
|
-
});
|
|
357
|
-
|
|
358
|
-
console.log(result);
|
|
359
|
-
}
|
|
360
|
-
|
|
361
|
-
run();
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
### Standalone function
|
|
365
|
-
|
|
366
|
-
The standalone function version of this method:
|
|
367
|
-
|
|
368
|
-
```typescript
|
|
369
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
370
|
-
import { productsGet } from "@moovio/sdk/funcs/productsGet.js";
|
|
371
|
-
|
|
372
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
373
|
-
// You can create one instance of it to use across an application.
|
|
374
|
-
const moov = new MoovCore({
|
|
375
|
-
xMoovVersion: "v2024.01.00",
|
|
376
|
-
security: {
|
|
377
|
-
username: "",
|
|
378
|
-
password: "",
|
|
379
|
-
},
|
|
380
|
-
});
|
|
381
|
-
|
|
382
|
-
async function run() {
|
|
383
|
-
const res = await productsGet(moov, {
|
|
384
|
-
accountID: "a749d848-5ebc-42a4-9ae6-555804317835",
|
|
385
|
-
productID: "dd0b4873-5cf5-4aa8-aa86-e31d86f7e38a",
|
|
386
|
-
});
|
|
387
|
-
if (res.ok) {
|
|
388
|
-
const { value: result } = res;
|
|
389
|
-
console.log(result);
|
|
390
|
-
} else {
|
|
391
|
-
console.log("productsGet failed:", res.error);
|
|
392
|
-
}
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
run();
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
### Parameters
|
|
399
|
-
|
|
400
|
-
| Parameter | Type | Required | Description |
|
|
401
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
402
|
-
| `request` | [operations.GetProductRequest](../../models/operations/getproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
403
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
404
|
-
| `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. |
|
|
405
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
406
|
-
|
|
407
|
-
### Response
|
|
408
|
-
|
|
409
|
-
**Promise\<[operations.GetProductResponse](../../models/operations/getproductresponse.md)\>**
|
|
410
|
-
|
|
411
|
-
### Errors
|
|
412
|
-
|
|
413
|
-
| Error Type | Status Code | Content Type |
|
|
414
|
-
| --------------- | --------------- | --------------- |
|
|
415
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
416
|
-
|
|
417
|
-
## update
|
|
418
|
-
|
|
419
|
-
Update a product and its options.
|
|
420
|
-
|
|
421
|
-
### Example Usage
|
|
422
|
-
|
|
423
|
-
<!-- UsageSnippet language="typescript" operationID="updateProduct" method="put" path="/accounts/{accountID}/products/{productID}" -->
|
|
424
|
-
```typescript
|
|
425
|
-
import { Moov } from "@moovio/sdk";
|
|
426
|
-
|
|
427
|
-
const moov = new Moov({
|
|
428
|
-
xMoovVersion: "v2024.01.00",
|
|
429
|
-
security: {
|
|
430
|
-
username: "",
|
|
431
|
-
password: "",
|
|
432
|
-
},
|
|
433
|
-
});
|
|
434
|
-
|
|
435
|
-
async function run() {
|
|
436
|
-
const result = await moov.products.update({
|
|
437
|
-
accountID: "7a7b55ed-d90d-4e83-a8f6-f146eaebd0cc",
|
|
438
|
-
productID: "fa407877-3b46-4484-814e-65b147d76a9e",
|
|
439
|
-
productRequest: {
|
|
440
|
-
title: "<value>",
|
|
441
|
-
basePrice: {
|
|
442
|
-
currency: "USD",
|
|
443
|
-
valueDecimal: "12.987654321",
|
|
444
|
-
},
|
|
445
|
-
optionGroups: [
|
|
446
|
-
{
|
|
447
|
-
name: "<value>",
|
|
448
|
-
minSelect: 328576,
|
|
449
|
-
maxSelect: 430951,
|
|
450
|
-
options: [],
|
|
451
|
-
},
|
|
452
|
-
],
|
|
453
|
-
},
|
|
454
|
-
});
|
|
455
|
-
|
|
456
|
-
console.log(result);
|
|
457
|
-
}
|
|
458
|
-
|
|
459
|
-
run();
|
|
460
|
-
```
|
|
461
|
-
|
|
462
|
-
### Standalone function
|
|
463
|
-
|
|
464
|
-
The standalone function version of this method:
|
|
465
|
-
|
|
466
|
-
```typescript
|
|
467
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
468
|
-
import { productsUpdate } from "@moovio/sdk/funcs/productsUpdate.js";
|
|
469
|
-
|
|
470
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
471
|
-
// You can create one instance of it to use across an application.
|
|
472
|
-
const moov = new MoovCore({
|
|
473
|
-
xMoovVersion: "v2024.01.00",
|
|
474
|
-
security: {
|
|
475
|
-
username: "",
|
|
476
|
-
password: "",
|
|
477
|
-
},
|
|
478
|
-
});
|
|
479
|
-
|
|
480
|
-
async function run() {
|
|
481
|
-
const res = await productsUpdate(moov, {
|
|
482
|
-
accountID: "7a7b55ed-d90d-4e83-a8f6-f146eaebd0cc",
|
|
483
|
-
productID: "fa407877-3b46-4484-814e-65b147d76a9e",
|
|
484
|
-
productRequest: {
|
|
485
|
-
title: "<value>",
|
|
486
|
-
basePrice: {
|
|
487
|
-
currency: "USD",
|
|
488
|
-
valueDecimal: "12.987654321",
|
|
489
|
-
},
|
|
490
|
-
optionGroups: [
|
|
491
|
-
{
|
|
492
|
-
name: "<value>",
|
|
493
|
-
minSelect: 328576,
|
|
494
|
-
maxSelect: 430951,
|
|
495
|
-
options: [],
|
|
496
|
-
},
|
|
497
|
-
],
|
|
498
|
-
},
|
|
499
|
-
});
|
|
500
|
-
if (res.ok) {
|
|
501
|
-
const { value: result } = res;
|
|
502
|
-
console.log(result);
|
|
503
|
-
} else {
|
|
504
|
-
console.log("productsUpdate failed:", res.error);
|
|
505
|
-
}
|
|
506
|
-
}
|
|
507
|
-
|
|
508
|
-
run();
|
|
509
|
-
```
|
|
510
|
-
|
|
511
|
-
### Parameters
|
|
512
|
-
|
|
513
|
-
| Parameter | Type | Required | Description |
|
|
514
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
515
|
-
| `request` | [operations.UpdateProductRequest](../../models/operations/updateproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
516
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
517
|
-
| `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. |
|
|
518
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
519
|
-
|
|
520
|
-
### Response
|
|
521
|
-
|
|
522
|
-
**Promise\<[operations.UpdateProductResponse](../../models/operations/updateproductresponse.md)\>**
|
|
523
|
-
|
|
524
|
-
### Errors
|
|
525
|
-
|
|
526
|
-
| Error Type | Status Code | Content Type |
|
|
527
|
-
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
|
|
528
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
529
|
-
| errors.ProductRequestValidationError | 422 | application/json |
|
|
530
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
531
|
-
|
|
532
|
-
## disable
|
|
533
|
-
|
|
534
|
-
Disable a product by ID.
|
|
535
|
-
|
|
536
|
-
The product will no longer be available, but will remain in the system for historical and reporting purposes.
|
|
537
|
-
|
|
538
|
-
### Example Usage
|
|
539
|
-
|
|
540
|
-
<!-- UsageSnippet language="typescript" operationID="disableProduct" method="delete" path="/accounts/{accountID}/products/{productID}" -->
|
|
541
|
-
```typescript
|
|
542
|
-
import { Moov } from "@moovio/sdk";
|
|
543
|
-
|
|
544
|
-
const moov = new Moov({
|
|
545
|
-
xMoovVersion: "v2024.01.00",
|
|
546
|
-
security: {
|
|
547
|
-
username: "",
|
|
548
|
-
password: "",
|
|
549
|
-
},
|
|
550
|
-
});
|
|
551
|
-
|
|
552
|
-
async function run() {
|
|
553
|
-
const result = await moov.products.disable({
|
|
554
|
-
accountID: "9fbe72c0-abba-4bb7-b1d0-d15ee702fe62",
|
|
555
|
-
productID: "1e11a7dc-4e86-41ed-b256-55c22f3bfd38",
|
|
556
|
-
});
|
|
557
|
-
|
|
558
|
-
console.log(result);
|
|
559
|
-
}
|
|
560
|
-
|
|
561
|
-
run();
|
|
562
|
-
```
|
|
563
|
-
|
|
564
|
-
### Standalone function
|
|
565
|
-
|
|
566
|
-
The standalone function version of this method:
|
|
567
|
-
|
|
568
|
-
```typescript
|
|
569
|
-
import { MoovCore } from "@moovio/sdk/core.js";
|
|
570
|
-
import { productsDisable } from "@moovio/sdk/funcs/productsDisable.js";
|
|
571
|
-
|
|
572
|
-
// Use `MoovCore` for best tree-shaking performance.
|
|
573
|
-
// You can create one instance of it to use across an application.
|
|
574
|
-
const moov = new MoovCore({
|
|
575
|
-
xMoovVersion: "v2024.01.00",
|
|
576
|
-
security: {
|
|
577
|
-
username: "",
|
|
578
|
-
password: "",
|
|
579
|
-
},
|
|
580
|
-
});
|
|
581
|
-
|
|
582
|
-
async function run() {
|
|
583
|
-
const res = await productsDisable(moov, {
|
|
584
|
-
accountID: "9fbe72c0-abba-4bb7-b1d0-d15ee702fe62",
|
|
585
|
-
productID: "1e11a7dc-4e86-41ed-b256-55c22f3bfd38",
|
|
586
|
-
});
|
|
587
|
-
if (res.ok) {
|
|
588
|
-
const { value: result } = res;
|
|
589
|
-
console.log(result);
|
|
590
|
-
} else {
|
|
591
|
-
console.log("productsDisable failed:", res.error);
|
|
592
|
-
}
|
|
593
|
-
}
|
|
594
|
-
|
|
595
|
-
run();
|
|
596
|
-
```
|
|
597
|
-
|
|
598
|
-
### Parameters
|
|
599
|
-
|
|
600
|
-
| Parameter | Type | Required | Description |
|
|
601
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
602
|
-
| `request` | [operations.DisableProductRequest](../../models/operations/disableproductrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
603
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
604
|
-
| `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. |
|
|
605
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
606
|
-
|
|
607
|
-
### Response
|
|
608
|
-
|
|
609
|
-
**Promise\<[operations.DisableProductResponse](../../models/operations/disableproductresponse.md)\>**
|
|
610
|
-
|
|
611
|
-
### Errors
|
|
612
|
-
|
|
613
|
-
| Error Type | Status Code | Content Type |
|
|
614
|
-
| ------------------- | ------------------- | ------------------- |
|
|
615
|
-
| errors.GenericError | 400, 409 | application/json |
|
|
616
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|