@moovio/sdk 0.16.3 → 0.16.5

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