@moovio/sdk 0.15.5 → 0.15.7
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/README.md +54 -43
- package/bin/mcp-server.js +1399 -647
- package/bin/mcp-server.js.map +24 -11
- package/docs/sdks/images/README.md +328 -0
- package/examples/package-lock.json +1 -1
- package/funcs/imagesDelete.d.ts +15 -0
- package/funcs/imagesDelete.d.ts.map +1 -0
- package/funcs/imagesDelete.js +137 -0
- package/funcs/imagesDelete.js.map +1 -0
- package/funcs/imagesGetMetadata.d.ts +14 -0
- package/funcs/imagesGetMetadata.d.ts.map +1 -0
- package/funcs/imagesGetMetadata.js +126 -0
- package/funcs/imagesGetMetadata.js.map +1 -0
- package/funcs/imagesGetPublic.d.ts +21 -0
- package/funcs/imagesGetPublic.d.ts.map +1 -0
- package/funcs/imagesGetPublic.js +144 -0
- package/funcs/imagesGetPublic.js.map +1 -0
- package/funcs/imagesList.d.ts +14 -0
- package/funcs/imagesList.d.ts.map +1 -0
- package/funcs/imagesList.js +122 -0
- package/funcs/imagesList.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +9 -1
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/imagesDelete.d.ts +8 -0
- package/mcp-server/tools/imagesDelete.d.ts.map +1 -0
- package/mcp-server/tools/imagesDelete.js +61 -0
- package/mcp-server/tools/imagesDelete.js.map +1 -0
- package/mcp-server/tools/imagesGetMetadata.d.ts +8 -0
- package/mcp-server/tools/imagesGetMetadata.d.ts.map +1 -0
- package/mcp-server/tools/imagesGetMetadata.js +62 -0
- package/mcp-server/tools/imagesGetMetadata.js.map +1 -0
- package/mcp-server/tools/imagesGetPublic.d.ts +8 -0
- package/mcp-server/tools/imagesGetPublic.d.ts.map +1 -0
- package/mcp-server/tools/imagesGetPublic.js +62 -0
- package/mcp-server/tools/imagesGetPublic.js.map +1 -0
- package/mcp-server/tools/imagesList.d.ts +8 -0
- package/mcp-server/tools/imagesList.d.ts.map +1 -0
- package/mcp-server/tools/imagesList.js +62 -0
- package/mcp-server/tools/imagesList.js.map +1 -0
- package/models/components/imagemetadata.d.ts +49 -0
- package/models/components/imagemetadata.d.ts.map +1 -0
- package/models/components/imagemetadata.js +77 -0
- package/models/components/imagemetadata.js.map +1 -0
- package/models/components/index.d.ts +1 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -0
- package/models/components/index.js.map +1 -1
- package/models/components/paymentmethodswallet.d.ts +12 -0
- package/models/components/paymentmethodswallet.d.ts.map +1 -1
- package/models/components/paymentmethodswallet.js +5 -0
- package/models/components/paymentmethodswallet.js.map +1 -1
- package/models/components/security.d.ts +4 -4
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +4 -4
- package/models/components/security.js.map +1 -1
- package/models/operations/deleteimage.d.ts +98 -0
- package/models/operations/deleteimage.d.ts.map +1 -0
- package/models/operations/deleteimage.js +142 -0
- package/models/operations/deleteimage.js.map +1 -0
- package/models/operations/getimagemetadata.d.ts +101 -0
- package/models/operations/getimagemetadata.d.ts.map +1 -0
- package/models/operations/getimagemetadata.js +147 -0
- package/models/operations/getimagemetadata.js.map +1 -0
- package/models/operations/getpublicimage.d.ts +94 -0
- package/models/operations/getpublicimage.d.ts.map +1 -0
- package/models/operations/getpublicimage.js +160 -0
- package/models/operations/getpublicimage.js.map +1 -0
- package/models/operations/index.d.ts +4 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/listimagemetadata.d.ts +99 -0
- package/models/operations/listimagemetadata.d.ts.map +1 -0
- package/models/operations/listimagemetadata.js +145 -0
- package/models/operations/listimagemetadata.js.map +1 -0
- package/package.json +1 -1
- package/sdk/images.d.ts +25 -0
- package/sdk/images.d.ts.map +1 -0
- package/sdk/images.js +42 -0
- package/sdk/images.js.map +1 -0
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/imagesDelete.ts +195 -0
- package/src/funcs/imagesGetMetadata.ts +180 -0
- package/src/funcs/imagesGetPublic.ts +196 -0
- package/src/funcs/imagesList.ts +176 -0
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +9 -1
- package/src/mcp-server/tools/imagesDelete.ts +33 -0
- package/src/mcp-server/tools/imagesGetMetadata.ts +35 -0
- package/src/mcp-server/tools/imagesGetPublic.ts +35 -0
- package/src/mcp-server/tools/imagesList.ts +35 -0
- package/src/models/components/imagemetadata.ts +90 -0
- package/src/models/components/index.ts +1 -0
- package/src/models/components/paymentmethodswallet.ts +20 -0
- package/src/models/components/security.ts +8 -8
- package/src/models/operations/deleteimage.ts +216 -0
- package/src/models/operations/getimagemetadata.ts +223 -0
- package/src/models/operations/getpublicimage.ts +244 -0
- package/src/models/operations/index.ts +4 -0
- package/src/models/operations/listimagemetadata.ts +219 -0
- package/src/sdk/images.ts +74 -0
- package/src/sdk/sdk.ts +6 -0
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
# Images
|
|
2
|
+
(*images*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List metadata for all images in the specified account.
|
|
9
|
+
* [getMetadata](#getmetadata) - Retrieve metadata for a specific image by its ID.
|
|
10
|
+
* [delete](#delete) - Permanently delete an image by its ID.
|
|
11
|
+
* [getPublic](#getpublic) - Get an image by its public ID.
|
|
12
|
+
|
|
13
|
+
## list
|
|
14
|
+
|
|
15
|
+
List metadata for all images in the specified account.
|
|
16
|
+
|
|
17
|
+
### Example Usage
|
|
18
|
+
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="listImageMetadata" method="get" path="/accounts/{accountID}/images" -->
|
|
20
|
+
```typescript
|
|
21
|
+
import { Moov } from "@moovio/sdk";
|
|
22
|
+
|
|
23
|
+
const moov = new Moov({
|
|
24
|
+
xMoovVersion: "v2024.01.00",
|
|
25
|
+
security: {
|
|
26
|
+
username: "",
|
|
27
|
+
password: "",
|
|
28
|
+
},
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
async function run() {
|
|
32
|
+
const result = await moov.images.list({
|
|
33
|
+
accountID: "3a4ed2d9-03e1-4b0e-b45f-2a9ca72f8adb",
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
console.log(result);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
run();
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Standalone function
|
|
43
|
+
|
|
44
|
+
The standalone function version of this method:
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
import { MoovCore } from "@moovio/sdk/core.js";
|
|
48
|
+
import { imagesList } from "@moovio/sdk/funcs/imagesList.js";
|
|
49
|
+
|
|
50
|
+
// Use `MoovCore` for best tree-shaking performance.
|
|
51
|
+
// You can create one instance of it to use across an application.
|
|
52
|
+
const moov = new MoovCore({
|
|
53
|
+
xMoovVersion: "v2024.01.00",
|
|
54
|
+
security: {
|
|
55
|
+
username: "",
|
|
56
|
+
password: "",
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
async function run() {
|
|
61
|
+
const res = await imagesList(moov, {
|
|
62
|
+
accountID: "3a4ed2d9-03e1-4b0e-b45f-2a9ca72f8adb",
|
|
63
|
+
});
|
|
64
|
+
if (res.ok) {
|
|
65
|
+
const { value: result } = res;
|
|
66
|
+
console.log(result);
|
|
67
|
+
} else {
|
|
68
|
+
console.log("imagesList failed:", res.error);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
run();
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
| Parameter | Type | Required | Description |
|
|
78
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
+
| `request` | [operations.ListImageMetadataRequest](../../models/operations/listimagemetadatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
80
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
81
|
+
| `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. |
|
|
82
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
83
|
+
|
|
84
|
+
### Response
|
|
85
|
+
|
|
86
|
+
**Promise\<[operations.ListImageMetadataResponse](../../models/operations/listimagemetadataresponse.md)\>**
|
|
87
|
+
|
|
88
|
+
### Errors
|
|
89
|
+
|
|
90
|
+
| Error Type | Status Code | Content Type |
|
|
91
|
+
| --------------- | --------------- | --------------- |
|
|
92
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
93
|
+
|
|
94
|
+
## getMetadata
|
|
95
|
+
|
|
96
|
+
Retrieve metadata for a specific image by its ID.
|
|
97
|
+
|
|
98
|
+
### Example Usage
|
|
99
|
+
|
|
100
|
+
<!-- UsageSnippet language="typescript" operationID="getImageMetadata" method="get" path="/accounts/{accountID}/images/{imageID}" -->
|
|
101
|
+
```typescript
|
|
102
|
+
import { Moov } from "@moovio/sdk";
|
|
103
|
+
|
|
104
|
+
const moov = new Moov({
|
|
105
|
+
xMoovVersion: "v2024.01.00",
|
|
106
|
+
security: {
|
|
107
|
+
username: "",
|
|
108
|
+
password: "",
|
|
109
|
+
},
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
async function run() {
|
|
113
|
+
const result = await moov.images.getMetadata({
|
|
114
|
+
accountID: "6cf66a43-31ce-4d27-8dd4-130fa57f0a6f",
|
|
115
|
+
imageID: "7cec5bd3-6340-4de4-a923-bf6ec0f7e921",
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
console.log(result);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
run();
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Standalone function
|
|
125
|
+
|
|
126
|
+
The standalone function version of this method:
|
|
127
|
+
|
|
128
|
+
```typescript
|
|
129
|
+
import { MoovCore } from "@moovio/sdk/core.js";
|
|
130
|
+
import { imagesGetMetadata } from "@moovio/sdk/funcs/imagesGetMetadata.js";
|
|
131
|
+
|
|
132
|
+
// Use `MoovCore` for best tree-shaking performance.
|
|
133
|
+
// You can create one instance of it to use across an application.
|
|
134
|
+
const moov = new MoovCore({
|
|
135
|
+
xMoovVersion: "v2024.01.00",
|
|
136
|
+
security: {
|
|
137
|
+
username: "",
|
|
138
|
+
password: "",
|
|
139
|
+
},
|
|
140
|
+
});
|
|
141
|
+
|
|
142
|
+
async function run() {
|
|
143
|
+
const res = await imagesGetMetadata(moov, {
|
|
144
|
+
accountID: "6cf66a43-31ce-4d27-8dd4-130fa57f0a6f",
|
|
145
|
+
imageID: "7cec5bd3-6340-4de4-a923-bf6ec0f7e921",
|
|
146
|
+
});
|
|
147
|
+
if (res.ok) {
|
|
148
|
+
const { value: result } = res;
|
|
149
|
+
console.log(result);
|
|
150
|
+
} else {
|
|
151
|
+
console.log("imagesGetMetadata failed:", res.error);
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
run();
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
| Parameter | Type | Required | Description |
|
|
161
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
162
|
+
| `request` | [operations.GetImageMetadataRequest](../../models/operations/getimagemetadatarequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
163
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
164
|
+
| `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. |
|
|
165
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
166
|
+
|
|
167
|
+
### Response
|
|
168
|
+
|
|
169
|
+
**Promise\<[operations.GetImageMetadataResponse](../../models/operations/getimagemetadataresponse.md)\>**
|
|
170
|
+
|
|
171
|
+
### Errors
|
|
172
|
+
|
|
173
|
+
| Error Type | Status Code | Content Type |
|
|
174
|
+
| --------------- | --------------- | --------------- |
|
|
175
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
176
|
+
|
|
177
|
+
## delete
|
|
178
|
+
|
|
179
|
+
Permanently delete an image by its ID.
|
|
180
|
+
|
|
181
|
+
### Example Usage
|
|
182
|
+
|
|
183
|
+
<!-- UsageSnippet language="typescript" operationID="deleteImage" method="delete" path="/accounts/{accountID}/images/{imageID}" -->
|
|
184
|
+
```typescript
|
|
185
|
+
import { Moov } from "@moovio/sdk";
|
|
186
|
+
|
|
187
|
+
const moov = new Moov({
|
|
188
|
+
xMoovVersion: "v2024.01.00",
|
|
189
|
+
security: {
|
|
190
|
+
username: "",
|
|
191
|
+
password: "",
|
|
192
|
+
},
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
async function run() {
|
|
196
|
+
const result = await moov.images.delete({
|
|
197
|
+
accountID: "866c32ce-2536-4b21-8e12-f8c474fb2a9b",
|
|
198
|
+
imageID: "ca048253-31d2-4bfb-9077-1f07a2a09f26",
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
console.log(result);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
run();
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Standalone function
|
|
208
|
+
|
|
209
|
+
The standalone function version of this method:
|
|
210
|
+
|
|
211
|
+
```typescript
|
|
212
|
+
import { MoovCore } from "@moovio/sdk/core.js";
|
|
213
|
+
import { imagesDelete } from "@moovio/sdk/funcs/imagesDelete.js";
|
|
214
|
+
|
|
215
|
+
// Use `MoovCore` for best tree-shaking performance.
|
|
216
|
+
// You can create one instance of it to use across an application.
|
|
217
|
+
const moov = new MoovCore({
|
|
218
|
+
xMoovVersion: "v2024.01.00",
|
|
219
|
+
security: {
|
|
220
|
+
username: "",
|
|
221
|
+
password: "",
|
|
222
|
+
},
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
async function run() {
|
|
226
|
+
const res = await imagesDelete(moov, {
|
|
227
|
+
accountID: "866c32ce-2536-4b21-8e12-f8c474fb2a9b",
|
|
228
|
+
imageID: "ca048253-31d2-4bfb-9077-1f07a2a09f26",
|
|
229
|
+
});
|
|
230
|
+
if (res.ok) {
|
|
231
|
+
const { value: result } = res;
|
|
232
|
+
console.log(result);
|
|
233
|
+
} else {
|
|
234
|
+
console.log("imagesDelete failed:", res.error);
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
run();
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
### Parameters
|
|
242
|
+
|
|
243
|
+
| Parameter | Type | Required | Description |
|
|
244
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
245
|
+
| `request` | [operations.DeleteImageRequest](../../models/operations/deleteimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
246
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
247
|
+
| `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. |
|
|
248
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
249
|
+
|
|
250
|
+
### Response
|
|
251
|
+
|
|
252
|
+
**Promise\<[operations.DeleteImageResponse](../../models/operations/deleteimageresponse.md)\>**
|
|
253
|
+
|
|
254
|
+
### Errors
|
|
255
|
+
|
|
256
|
+
| Error Type | Status Code | Content Type |
|
|
257
|
+
| ------------------- | ------------------- | ------------------- |
|
|
258
|
+
| errors.GenericError | 400, 409 | application/json |
|
|
259
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
260
|
+
|
|
261
|
+
## getPublic
|
|
262
|
+
|
|
263
|
+
Get an image by its public ID.
|
|
264
|
+
|
|
265
|
+
### Example Usage
|
|
266
|
+
|
|
267
|
+
<!-- UsageSnippet language="typescript" operationID="getPublicImage" method="get" path="/images/{publicID}" -->
|
|
268
|
+
```typescript
|
|
269
|
+
import { Moov } from "@moovio/sdk";
|
|
270
|
+
|
|
271
|
+
const moov = new Moov();
|
|
272
|
+
|
|
273
|
+
async function run() {
|
|
274
|
+
const result = await moov.images.getPublic({
|
|
275
|
+
publicID: "<id>",
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
console.log(result);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
run();
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Standalone function
|
|
285
|
+
|
|
286
|
+
The standalone function version of this method:
|
|
287
|
+
|
|
288
|
+
```typescript
|
|
289
|
+
import { MoovCore } from "@moovio/sdk/core.js";
|
|
290
|
+
import { imagesGetPublic } from "@moovio/sdk/funcs/imagesGetPublic.js";
|
|
291
|
+
|
|
292
|
+
// Use `MoovCore` for best tree-shaking performance.
|
|
293
|
+
// You can create one instance of it to use across an application.
|
|
294
|
+
const moov = new MoovCore();
|
|
295
|
+
|
|
296
|
+
async function run() {
|
|
297
|
+
const res = await imagesGetPublic(moov, {
|
|
298
|
+
publicID: "<id>",
|
|
299
|
+
});
|
|
300
|
+
if (res.ok) {
|
|
301
|
+
const { value: result } = res;
|
|
302
|
+
console.log(result);
|
|
303
|
+
} else {
|
|
304
|
+
console.log("imagesGetPublic failed:", res.error);
|
|
305
|
+
}
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
run();
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
| Parameter | Type | Required | Description |
|
|
314
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
315
|
+
| `request` | [operations.GetPublicImageRequest](../../models/operations/getpublicimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
316
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
317
|
+
| `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. |
|
|
318
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
319
|
+
|
|
320
|
+
### Response
|
|
321
|
+
|
|
322
|
+
**Promise\<[operations.GetPublicImageResponse](../../models/operations/getpublicimageresponse.md)\>**
|
|
323
|
+
|
|
324
|
+
### Errors
|
|
325
|
+
|
|
326
|
+
| Error Type | Status Code | Content Type |
|
|
327
|
+
| --------------- | --------------- | --------------- |
|
|
328
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -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
|
+
* Permanently delete an image by its ID.
|
|
13
|
+
*/
|
|
14
|
+
export declare function imagesDelete(client: MoovCore, request: operations.DeleteImageRequest, options?: RequestOptions): APIPromise<Result<operations.DeleteImageResponse | undefined, errors.GenericError | MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
|
+
//# sourceMappingURL=imagesDelete.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"imagesDelete.d.ts","sourceRoot":"","sources":["../src/funcs/imagesDelete.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,YAAY,CAC1B,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,mBAAmB,GAAG,SAAS,EACxC,MAAM,CAAC,YAAY,GACnB,SAAS,GACT,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.imagesDelete = imagesDelete;
|
|
40
|
+
const encodings_js_1 = require("../lib/encodings.js");
|
|
41
|
+
const M = __importStar(require("../lib/matchers.js"));
|
|
42
|
+
const primitives_js_1 = require("../lib/primitives.js");
|
|
43
|
+
const schemas_js_1 = require("../lib/schemas.js");
|
|
44
|
+
const security_js_1 = require("../lib/security.js");
|
|
45
|
+
const url_js_1 = require("../lib/url.js");
|
|
46
|
+
const errors = __importStar(require("../models/errors/index.js"));
|
|
47
|
+
const operations = __importStar(require("../models/operations/index.js"));
|
|
48
|
+
const async_js_1 = require("../types/async.js");
|
|
49
|
+
/**
|
|
50
|
+
* Permanently delete an image by its ID.
|
|
51
|
+
*/
|
|
52
|
+
function imagesDelete(client, request, options) {
|
|
53
|
+
return new async_js_1.APIPromise($do(client, request, options));
|
|
54
|
+
}
|
|
55
|
+
async function $do(client, request, options) {
|
|
56
|
+
const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.DeleteImageRequest$outboundSchema.parse(value), "Input validation failed");
|
|
57
|
+
if (!parsed.ok) {
|
|
58
|
+
return [parsed, { status: "invalid" }];
|
|
59
|
+
}
|
|
60
|
+
const payload = parsed.value;
|
|
61
|
+
const body = null;
|
|
62
|
+
const pathParams = {
|
|
63
|
+
accountID: (0, encodings_js_1.encodeSimple)("accountID", payload.accountID, {
|
|
64
|
+
explode: false,
|
|
65
|
+
charEncoding: "percent",
|
|
66
|
+
}),
|
|
67
|
+
imageID: (0, encodings_js_1.encodeSimple)("imageID", payload.imageID, {
|
|
68
|
+
explode: false,
|
|
69
|
+
charEncoding: "percent",
|
|
70
|
+
}),
|
|
71
|
+
};
|
|
72
|
+
const path = (0, url_js_1.pathToFunc)("/accounts/{accountID}/images/{imageID}")(pathParams);
|
|
73
|
+
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
74
|
+
Accept: "application/json",
|
|
75
|
+
"x-moov-version": (0, encodings_js_1.encodeSimple)("x-moov-version", client._options.xMoovVersion, { explode: false, charEncoding: "none" }),
|
|
76
|
+
}));
|
|
77
|
+
const securityInput = await (0, security_js_1.extractSecurity)(client._options.security);
|
|
78
|
+
const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
|
|
79
|
+
const context = {
|
|
80
|
+
options: client._options,
|
|
81
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
82
|
+
operationID: "deleteImage",
|
|
83
|
+
oAuth2Scopes: [],
|
|
84
|
+
resolvedSecurity: requestSecurity,
|
|
85
|
+
securitySource: client._options.security,
|
|
86
|
+
retryConfig: options?.retries
|
|
87
|
+
|| client._options.retryConfig
|
|
88
|
+
|| { strategy: "none" },
|
|
89
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
90
|
+
};
|
|
91
|
+
const requestRes = client._createRequest(context, {
|
|
92
|
+
security: requestSecurity,
|
|
93
|
+
method: "DELETE",
|
|
94
|
+
baseURL: options?.serverURL,
|
|
95
|
+
path: path,
|
|
96
|
+
headers: headers,
|
|
97
|
+
body: body,
|
|
98
|
+
userAgent: client._options.userAgent,
|
|
99
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
|
|
100
|
+
}, options);
|
|
101
|
+
if (!requestRes.ok) {
|
|
102
|
+
return [requestRes, { status: "invalid" }];
|
|
103
|
+
}
|
|
104
|
+
const req = requestRes.value;
|
|
105
|
+
const doResult = await client._do(req, {
|
|
106
|
+
context,
|
|
107
|
+
errorCodes: [
|
|
108
|
+
"400",
|
|
109
|
+
"401",
|
|
110
|
+
"403",
|
|
111
|
+
"404",
|
|
112
|
+
"409",
|
|
113
|
+
"429",
|
|
114
|
+
"4XX",
|
|
115
|
+
"500",
|
|
116
|
+
"504",
|
|
117
|
+
"5XX",
|
|
118
|
+
],
|
|
119
|
+
retryConfig: context.retryConfig,
|
|
120
|
+
retryCodes: context.retryCodes,
|
|
121
|
+
});
|
|
122
|
+
if (!doResult.ok) {
|
|
123
|
+
return [doResult, { status: "request-error", request: req }];
|
|
124
|
+
}
|
|
125
|
+
const response = doResult.value;
|
|
126
|
+
const responseFields = {
|
|
127
|
+
HttpMeta: { Response: response, Request: req },
|
|
128
|
+
};
|
|
129
|
+
const [result] = await M.match(M.nil(204, operations.DeleteImageResponse$inboundSchema.optional(), {
|
|
130
|
+
hdrs: true,
|
|
131
|
+
}), M.jsonErr([400, 409], errors.GenericError$inboundSchema, { hdrs: true }), M.fail([401, 403, 404, 429]), M.fail([500, 504]), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
132
|
+
if (!result.ok) {
|
|
133
|
+
return [result, { status: "complete", request: req, response }];
|
|
134
|
+
}
|
|
135
|
+
return [result, { status: "complete", request: req, response }];
|
|
136
|
+
}
|
|
137
|
+
//# sourceMappingURL=imagesDelete.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"imagesDelete.js","sourceRoot":"","sources":["../src/funcs/imagesDelete.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BH,oCAuBC;AAhDD,sDAAmD;AACnD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;GAEG;AACH,SAAgB,YAAY,CAC1B,MAAgB,EAChB,OAAsC,EACtC,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAgB,EAChB,OAAsC,EACtC,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,iCAAiC,CAAC,KAAK,CAAC,KAAK,CAAC,EACpE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,SAAS,EAAE,IAAA,2BAAY,EAAC,WAAW,EAAE,OAAO,CAAC,SAAS,EAAE;YACtD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;QACF,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,wCAAwC,CAAC,CAAC,UAAU,CAAC,CAAC;IAE9E,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;QAC1B,gBAAgB,EAAE,IAAA,2BAAY,EAC5B,gBAAgB,EAChB,MAAM,CAAC,QAAQ,CAAC,YAAY,EAC5B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IAEJ,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;QACxC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE;YACV,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;QACD,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,iCAAiC,CAAC,QAAQ,EAAE,EAAE;QAClE,IAAI,EAAE,IAAI;KACX,CAAC,EACF,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACxE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAC5B,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAClB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
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 { MoovError } from "../models/errors/mooverror.js";
|
|
5
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
6
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
7
|
+
import * as operations from "../models/operations/index.js";
|
|
8
|
+
import { APIPromise } from "../types/async.js";
|
|
9
|
+
import { Result } from "../types/fp.js";
|
|
10
|
+
/**
|
|
11
|
+
* Retrieve metadata for a specific image by its ID.
|
|
12
|
+
*/
|
|
13
|
+
export declare function imagesGetMetadata(client: MoovCore, request: operations.GetImageMetadataRequest, options?: RequestOptions): APIPromise<Result<operations.GetImageMetadataResponse, MoovError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
14
|
+
//# sourceMappingURL=imagesGetMetadata.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"imagesGetMetadata.d.ts","sourceRoot":"","sources":["../src/funcs/imagesGetMetadata.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,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,iBAAiB,CAC/B,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,wBAAwB,EACjC,SAAS,GACT,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|