@chrt-inc/typescript-sdk 1.325.0 → 1.326.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/cargos/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/cargos/client/Client.js +1 -1
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/Client.d.ts +2 -9
- package/dist/cjs/api/resources/taskArtifacts/resources/s3Object/client/Client.js +2 -8
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.d.ts +2 -9
- package/dist/cjs/api/resources/taskGroups/resources/s3Object/client/Client.js +2 -8
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/cargos/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/cargos/client/Client.mjs +1 -1
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/Client.d.mts +2 -9
- package/dist/esm/api/resources/taskArtifacts/resources/s3Object/client/Client.mjs +2 -8
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.d.mts +2 -9
- package/dist/esm/api/resources/taskGroups/resources/s3Object/client/Client.mjs +2 -8
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +5 -5
package/README.md
CHANGED
|
@@ -84,7 +84,7 @@ try {
|
|
|
84
84
|
You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
|
|
85
85
|
|
|
86
86
|
```typescript
|
|
87
|
-
const response = await client.taskArtifacts.
|
|
87
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
88
88
|
const stream: ReadableStream<Uint8Array> = response.stream();
|
|
89
89
|
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
|
|
90
90
|
// const blob: Blob = response.blob();
|
|
@@ -110,7 +110,7 @@ import { createWriteStream } from 'fs';
|
|
|
110
110
|
import { Readable } from 'stream';
|
|
111
111
|
import { pipeline } from 'stream/promises';
|
|
112
112
|
|
|
113
|
-
const response = await client.taskArtifacts.
|
|
113
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
114
114
|
|
|
115
115
|
const stream = response.stream();
|
|
116
116
|
const nodeStream = Readable.fromWeb(stream);
|
|
@@ -129,7 +129,7 @@ await pipeline(nodeStream, writeStream);
|
|
|
129
129
|
```ts
|
|
130
130
|
import { writeFile } from 'fs/promises';
|
|
131
131
|
|
|
132
|
-
const response = await client.taskArtifacts.
|
|
132
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
133
133
|
|
|
134
134
|
const arrayBuffer = await response.arrayBuffer();
|
|
135
135
|
await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
@@ -145,7 +145,7 @@ await writeFile('path/to/file', Buffer.from(arrayBuffer));
|
|
|
145
145
|
```ts
|
|
146
146
|
import { writeFile } from 'fs/promises';
|
|
147
147
|
|
|
148
|
-
const response = await client.taskArtifacts.
|
|
148
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
149
149
|
|
|
150
150
|
const blob = await response.blob();
|
|
151
151
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -162,7 +162,7 @@ await writeFile('output.bin', Buffer.from(arrayBuffer));
|
|
|
162
162
|
```ts
|
|
163
163
|
import { writeFile } from 'fs/promises';
|
|
164
164
|
|
|
165
|
-
const response = await client.taskArtifacts.
|
|
165
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
166
166
|
|
|
167
167
|
const bytes = await response.bytes();
|
|
168
168
|
await writeFile('path/to/file', bytes);
|
|
@@ -183,7 +183,7 @@ await writeFile('path/to/file', bytes);
|
|
|
183
183
|
<summary>ReadableStream (most-efficient)</summary>
|
|
184
184
|
|
|
185
185
|
```ts
|
|
186
|
-
const response = await client.taskArtifacts.
|
|
186
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
187
187
|
|
|
188
188
|
const stream = response.stream();
|
|
189
189
|
await Bun.write('path/to/file', stream);
|
|
@@ -197,7 +197,7 @@ await Bun.write('path/to/file', stream);
|
|
|
197
197
|
<summary>ArrayBuffer</summary>
|
|
198
198
|
|
|
199
199
|
```ts
|
|
200
|
-
const response = await client.taskArtifacts.
|
|
200
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
201
201
|
|
|
202
202
|
const arrayBuffer = await response.arrayBuffer();
|
|
203
203
|
await Bun.write('path/to/file', arrayBuffer);
|
|
@@ -211,7 +211,7 @@ await Bun.write('path/to/file', arrayBuffer);
|
|
|
211
211
|
<summary>Blob</summary>
|
|
212
212
|
|
|
213
213
|
```ts
|
|
214
|
-
const response = await client.taskArtifacts.
|
|
214
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
215
215
|
|
|
216
216
|
const blob = await response.blob();
|
|
217
217
|
await Bun.write('path/to/file', blob);
|
|
@@ -225,7 +225,7 @@ await Bun.write('path/to/file', blob);
|
|
|
225
225
|
<summary>Bytes (UIntArray8)</summary>
|
|
226
226
|
|
|
227
227
|
```ts
|
|
228
|
-
const response = await client.taskArtifacts.
|
|
228
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
229
229
|
|
|
230
230
|
const bytes = await response.bytes();
|
|
231
231
|
await Bun.write('path/to/file', bytes);
|
|
@@ -246,7 +246,7 @@ await Bun.write('path/to/file', bytes);
|
|
|
246
246
|
<summary>ReadableStream (most-efficient)</summary>
|
|
247
247
|
|
|
248
248
|
```ts
|
|
249
|
-
const response = await client.taskArtifacts.
|
|
249
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
250
250
|
|
|
251
251
|
const stream = response.stream();
|
|
252
252
|
const file = await Deno.open('path/to/file', { write: true, create: true });
|
|
@@ -261,7 +261,7 @@ await stream.pipeTo(file.writable);
|
|
|
261
261
|
<summary>ArrayBuffer</summary>
|
|
262
262
|
|
|
263
263
|
```ts
|
|
264
|
-
const response = await client.taskArtifacts.
|
|
264
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
265
265
|
|
|
266
266
|
const arrayBuffer = await response.arrayBuffer();
|
|
267
267
|
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
@@ -275,7 +275,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
275
275
|
<summary>Blob</summary>
|
|
276
276
|
|
|
277
277
|
```ts
|
|
278
|
-
const response = await client.taskArtifacts.
|
|
278
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
279
279
|
|
|
280
280
|
const blob = await response.blob();
|
|
281
281
|
const arrayBuffer = await blob.arrayBuffer();
|
|
@@ -290,7 +290,7 @@ await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));
|
|
|
290
290
|
<summary>Bytes (UIntArray8)</summary>
|
|
291
291
|
|
|
292
292
|
```ts
|
|
293
|
-
const response = await client.taskArtifacts.
|
|
293
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
294
294
|
|
|
295
295
|
const bytes = await response.bytes();
|
|
296
296
|
await Deno.writeFile('path/to/file', bytes);
|
|
@@ -311,7 +311,7 @@ await Deno.writeFile('path/to/file', bytes);
|
|
|
311
311
|
<summary>Blob (most-efficient)</summary>
|
|
312
312
|
|
|
313
313
|
```ts
|
|
314
|
-
const response = await client.taskArtifacts.
|
|
314
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
315
315
|
|
|
316
316
|
const blob = await response.blob();
|
|
317
317
|
const url = URL.createObjectURL(blob);
|
|
@@ -332,7 +332,7 @@ URL.revokeObjectURL(url);
|
|
|
332
332
|
<summary>ReadableStream</summary>
|
|
333
333
|
|
|
334
334
|
```ts
|
|
335
|
-
const response = await client.taskArtifacts.
|
|
335
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
336
336
|
|
|
337
337
|
const stream = response.stream();
|
|
338
338
|
const reader = stream.getReader();
|
|
@@ -363,7 +363,7 @@ URL.revokeObjectURL(url);
|
|
|
363
363
|
<summary>ArrayBuffer</summary>
|
|
364
364
|
|
|
365
365
|
```ts
|
|
366
|
-
const response = await client.taskArtifacts.
|
|
366
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
367
367
|
|
|
368
368
|
const arrayBuffer = await response.arrayBuffer();
|
|
369
369
|
const blob = new Blob([arrayBuffer]);
|
|
@@ -385,7 +385,7 @@ URL.revokeObjectURL(url);
|
|
|
385
385
|
<summary>Bytes (UIntArray8)</summary>
|
|
386
386
|
|
|
387
387
|
```ts
|
|
388
|
-
const response = await client.taskArtifacts.
|
|
388
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
389
389
|
|
|
390
390
|
const bytes = await response.bytes();
|
|
391
391
|
const blob = new Blob([bytes]);
|
|
@@ -416,7 +416,7 @@ URL.revokeObjectURL(url);
|
|
|
416
416
|
<summary>ReadableStream</summary>
|
|
417
417
|
|
|
418
418
|
```ts
|
|
419
|
-
const response = await client.taskArtifacts.
|
|
419
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
420
420
|
|
|
421
421
|
const stream = response.stream();
|
|
422
422
|
const text = await new Response(stream).text();
|
|
@@ -430,7 +430,7 @@ const text = await new Response(stream).text();
|
|
|
430
430
|
<summary>ArrayBuffer</summary>
|
|
431
431
|
|
|
432
432
|
```ts
|
|
433
|
-
const response = await client.taskArtifacts.
|
|
433
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
434
434
|
|
|
435
435
|
const arrayBuffer = await response.arrayBuffer();
|
|
436
436
|
const text = new TextDecoder().decode(arrayBuffer);
|
|
@@ -444,7 +444,7 @@ const text = new TextDecoder().decode(arrayBuffer);
|
|
|
444
444
|
<summary>Blob</summary>
|
|
445
445
|
|
|
446
446
|
```ts
|
|
447
|
-
const response = await client.taskArtifacts.
|
|
447
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
448
448
|
|
|
449
449
|
const blob = await response.blob();
|
|
450
450
|
const text = await blob.text();
|
|
@@ -458,7 +458,7 @@ const text = await blob.text();
|
|
|
458
458
|
<summary>Bytes (UIntArray8)</summary>
|
|
459
459
|
|
|
460
460
|
```ts
|
|
461
|
-
const response = await client.taskArtifacts.
|
|
461
|
+
const response = await client.taskArtifacts.s3Object.getV1(...);
|
|
462
462
|
|
|
463
463
|
const bytes = await response.bytes();
|
|
464
464
|
const text = new TextDecoder().decode(bytes);
|
package/dist/cjs/Client.js
CHANGED
|
@@ -73,8 +73,8 @@ class ChrtClient {
|
|
|
73
73
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
74
74
|
"X-Fern-Language": "JavaScript",
|
|
75
75
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
76
|
-
"X-Fern-SDK-Version": "1.
|
|
77
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
76
|
+
"X-Fern-SDK-Version": "1.326.0",
|
|
77
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.326.0",
|
|
78
78
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
79
79
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
80
80
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -31,7 +31,7 @@ export declare class Cargos {
|
|
|
31
31
|
protected readonly _options: Cargos.Options;
|
|
32
32
|
constructor(_options?: Cargos.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
34
|
+
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {string} cargoId
|
|
37
37
|
* @param {Chrt.CargoClientUpdate1} request
|
|
@@ -56,7 +56,7 @@ class Cargos {
|
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
59
|
+
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
60
60
|
*
|
|
61
61
|
* @param {string} cargoId
|
|
62
62
|
* @param {Chrt.CargoClientUpdate1} request
|
|
@@ -44,17 +44,10 @@ export declare class S3Object {
|
|
|
44
44
|
getS3ObjectMetadataV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.TaskArtifactS3ObjectMetadata1>;
|
|
45
45
|
private __getS3ObjectMetadataV1;
|
|
46
46
|
/**
|
|
47
|
-
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
48
|
-
*
|
|
49
|
-
* @param {string} taskArtifactS3ObjectMetadataId
|
|
50
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
-
*
|
|
47
|
+
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
52
48
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
53
|
-
*
|
|
54
|
-
* @example
|
|
55
|
-
* await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
|
|
56
49
|
*/
|
|
57
|
-
getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<
|
|
50
|
+
getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
|
|
58
51
|
private __getV1;
|
|
59
52
|
/**
|
|
60
53
|
* Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
@@ -115,15 +115,8 @@ class S3Object {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
119
|
-
*
|
|
120
|
-
* @param {string} taskArtifactS3ObjectMetadataId
|
|
121
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
122
|
-
*
|
|
118
|
+
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
123
119
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
124
|
-
*
|
|
125
|
-
* @example
|
|
126
|
-
* await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
|
|
127
120
|
*/
|
|
128
121
|
getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
|
|
129
122
|
return core.HttpResponsePromise.fromPromise(this.__getV1(taskArtifactS3ObjectMetadataId, requestOptions));
|
|
@@ -137,6 +130,7 @@ class S3Object {
|
|
|
137
130
|
method: "GET",
|
|
138
131
|
headers: _headers,
|
|
139
132
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
133
|
+
responseType: "binary-response",
|
|
140
134
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
141
135
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
142
136
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -44,17 +44,10 @@ export declare class S3Object {
|
|
|
44
44
|
getS3ObjectMetadataV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupS3ObjectMetadata1>;
|
|
45
45
|
private __getS3ObjectMetadataV1;
|
|
46
46
|
/**
|
|
47
|
-
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
48
|
-
*
|
|
49
|
-
* @param {string} taskGroupS3ObjectMetadataId
|
|
50
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
-
*
|
|
47
|
+
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
52
48
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
53
|
-
*
|
|
54
|
-
* @example
|
|
55
|
-
* await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id")
|
|
56
49
|
*/
|
|
57
|
-
getV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<
|
|
50
|
+
getV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
|
|
58
51
|
private __getV1;
|
|
59
52
|
/**
|
|
60
53
|
* Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
@@ -115,15 +115,8 @@ class S3Object {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
119
|
-
*
|
|
120
|
-
* @param {string} taskGroupS3ObjectMetadataId
|
|
121
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
122
|
-
*
|
|
118
|
+
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
123
119
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
124
|
-
*
|
|
125
|
-
* @example
|
|
126
|
-
* await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id")
|
|
127
120
|
*/
|
|
128
121
|
getV1(taskGroupS3ObjectMetadataId, requestOptions) {
|
|
129
122
|
return core.HttpResponsePromise.fromPromise(this.__getV1(taskGroupS3ObjectMetadataId, requestOptions));
|
|
@@ -137,6 +130,7 @@ class S3Object {
|
|
|
137
130
|
method: "GET",
|
|
138
131
|
headers: _headers,
|
|
139
132
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
133
|
+
responseType: "binary-response",
|
|
140
134
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
141
135
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
142
136
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.326.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -37,8 +37,8 @@ export class ChrtClient {
|
|
|
37
37
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
38
38
|
"X-Fern-Language": "JavaScript",
|
|
39
39
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
40
|
-
"X-Fern-SDK-Version": "1.
|
|
41
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
40
|
+
"X-Fern-SDK-Version": "1.326.0",
|
|
41
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.326.0",
|
|
42
42
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
43
43
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
44
44
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -31,7 +31,7 @@ export declare class Cargos {
|
|
|
31
31
|
protected readonly _options: Cargos.Options;
|
|
32
32
|
constructor(_options?: Cargos.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
34
|
+
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
35
35
|
*
|
|
36
36
|
* @param {string} cargoId
|
|
37
37
|
* @param {Chrt.CargoClientUpdate1} request
|
|
@@ -20,7 +20,7 @@ export class Cargos {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
23
|
+
* Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
24
24
|
*
|
|
25
25
|
* @param {string} cargoId
|
|
26
26
|
* @param {Chrt.CargoClientUpdate1} request
|
|
@@ -44,17 +44,10 @@ export declare class S3Object {
|
|
|
44
44
|
getS3ObjectMetadataV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.TaskArtifactS3ObjectMetadata1>;
|
|
45
45
|
private __getS3ObjectMetadataV1;
|
|
46
46
|
/**
|
|
47
|
-
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
48
|
-
*
|
|
49
|
-
* @param {string} taskArtifactS3ObjectMetadataId
|
|
50
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
-
*
|
|
47
|
+
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
52
48
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
53
|
-
*
|
|
54
|
-
* @example
|
|
55
|
-
* await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
|
|
56
49
|
*/
|
|
57
|
-
getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<
|
|
50
|
+
getV1(taskArtifactS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
|
|
58
51
|
private __getV1;
|
|
59
52
|
/**
|
|
60
53
|
* Uploads an image file to a task artifact with automatic blurhash generation. | authz_personas=[courier_driver, forwarder_org_operators, courier_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
@@ -79,15 +79,8 @@ export class S3Object {
|
|
|
79
79
|
});
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
|
-
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
83
|
-
*
|
|
84
|
-
* @param {string} taskArtifactS3ObjectMetadataId
|
|
85
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
|
-
*
|
|
82
|
+
* Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
87
83
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* await client.taskArtifacts.s3Object.getV1("task_artifact_s3_object_metadata_id")
|
|
91
84
|
*/
|
|
92
85
|
getV1(taskArtifactS3ObjectMetadataId, requestOptions) {
|
|
93
86
|
return core.HttpResponsePromise.fromPromise(this.__getV1(taskArtifactS3ObjectMetadataId, requestOptions));
|
|
@@ -101,6 +94,7 @@ export class S3Object {
|
|
|
101
94
|
method: "GET",
|
|
102
95
|
headers: _headers,
|
|
103
96
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
97
|
+
responseType: "binary-response",
|
|
104
98
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
105
99
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
106
100
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -44,17 +44,10 @@ export declare class S3Object {
|
|
|
44
44
|
getS3ObjectMetadataV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<Chrt.TaskGroupS3ObjectMetadata1>;
|
|
45
45
|
private __getS3ObjectMetadataV1;
|
|
46
46
|
/**
|
|
47
|
-
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
48
|
-
*
|
|
49
|
-
* @param {string} taskGroupS3ObjectMetadataId
|
|
50
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
51
|
-
*
|
|
47
|
+
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
52
48
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
53
|
-
*
|
|
54
|
-
* @example
|
|
55
|
-
* await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id")
|
|
56
49
|
*/
|
|
57
|
-
getV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<
|
|
50
|
+
getV1(taskGroupS3ObjectMetadataId: string, requestOptions?: S3Object.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
|
|
58
51
|
private __getV1;
|
|
59
52
|
/**
|
|
60
53
|
* Uploads an image file to a task group with automatic blurhash generation. | authz_personas=[courier_driver, courier_org_operators, forwarder_org_operators, shipper_org_operators] | (UploadFile) -> (bool)
|
|
@@ -79,15 +79,8 @@ export class S3Object {
|
|
|
79
79
|
});
|
|
80
80
|
}
|
|
81
81
|
/**
|
|
82
|
-
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
83
|
-
*
|
|
84
|
-
* @param {string} taskGroupS3ObjectMetadataId
|
|
85
|
-
* @param {S3Object.RequestOptions} requestOptions - Request-specific configuration.
|
|
86
|
-
*
|
|
82
|
+
* Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
87
83
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
88
|
-
*
|
|
89
|
-
* @example
|
|
90
|
-
* await client.taskGroups.s3Object.getV1("task_group_s3_object_metadata_id")
|
|
91
84
|
*/
|
|
92
85
|
getV1(taskGroupS3ObjectMetadataId, requestOptions) {
|
|
93
86
|
return core.HttpResponsePromise.fromPromise(this.__getV1(taskGroupS3ObjectMetadataId, requestOptions));
|
|
@@ -101,6 +94,7 @@ export class S3Object {
|
|
|
101
94
|
method: "GET",
|
|
102
95
|
headers: _headers,
|
|
103
96
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
97
|
+
responseType: "binary-response",
|
|
104
98
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
105
99
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
106
100
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.326.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.326.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -5025,7 +5025,7 @@ await client.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
|
|
|
5025
5025
|
<dl>
|
|
5026
5026
|
<dd>
|
|
5027
5027
|
|
|
5028
|
-
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
5028
|
+
Updates a cargo's details. Cargo must be in STAGED, IN_TRANSIT, DELIVERED, SKIPPED, or EXCEPTION status. | authz_personas=[lig_org_operators] | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
5029
5029
|
|
|
5030
5030
|
</dd>
|
|
5031
5031
|
</dl>
|
|
@@ -11594,7 +11594,7 @@ await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_obje
|
|
|
11594
11594
|
</dl>
|
|
11595
11595
|
</details>
|
|
11596
11596
|
|
|
11597
|
-
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) ->
|
|
11597
|
+
<details><summary><code>client.taskArtifacts.s3Object.<a href="/src/api/resources/taskArtifacts/resources/s3Object/client/Client.ts">getV1</a>(taskArtifactS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
11598
11598
|
<dl>
|
|
11599
11599
|
<dd>
|
|
11600
11600
|
|
|
@@ -11606,7 +11606,7 @@ await client.taskArtifacts.s3Object.getS3ObjectMetadataV1("task_artifact_s3_obje
|
|
|
11606
11606
|
<dl>
|
|
11607
11607
|
<dd>
|
|
11608
11608
|
|
|
11609
|
-
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
11609
|
+
Streams a task artifact S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
11610
11610
|
|
|
11611
11611
|
</dd>
|
|
11612
11612
|
</dl>
|
|
@@ -11986,7 +11986,7 @@ await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_met
|
|
|
11986
11986
|
</dl>
|
|
11987
11987
|
</details>
|
|
11988
11988
|
|
|
11989
|
-
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) ->
|
|
11989
|
+
<details><summary><code>client.taskGroups.s3Object.<a href="/src/api/resources/taskGroups/resources/s3Object/client/Client.ts">getV1</a>(taskGroupS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
11990
11990
|
<dl>
|
|
11991
11991
|
<dd>
|
|
11992
11992
|
|
|
@@ -11998,7 +11998,7 @@ await client.taskGroups.s3Object.getS3ObjectMetadataV1("task_group_s3_object_met
|
|
|
11998
11998
|
<dl>
|
|
11999
11999
|
<dd>
|
|
12000
12000
|
|
|
12001
|
-
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (
|
|
12001
|
+
Streams a task group S3 object file from storage. | authz_personas=[courier_driver, courier_org_operators, shipper_org_operators, forwarder_org_operators] | () -> (binary)
|
|
12002
12002
|
|
|
12003
12003
|
</dd>
|
|
12004
12004
|
</dl>
|