@chrt-inc/typescript-sdk 1.662.0 → 1.675.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/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/Client.js +1 -1
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientUpdate1.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.d.ts +75 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/Client.js +313 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.ts +12 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseStatusReq.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/CaseStatusReq.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/index.js +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/index.js +41 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/Client.d.ts +83 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/Client.js +308 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/index.js +17 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.d.ts +13 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.js +5 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/index.d.ts +1 -0
- package/dist/cjs/api/resources/operations/resources/cases/resources/s3Objects/index.js +17 -0
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/shipping/resources/taskGroups/client/Client.js +1 -1
- package/dist/cjs/api/types/BillingLedger1.d.ts +1 -0
- package/dist/cjs/api/types/CallerCredentialTypeEnum.d.ts +1 -2
- package/dist/cjs/api/types/CallerCredentialTypeEnum.js +0 -1
- package/dist/cjs/api/types/Case1.d.ts +4 -0
- package/dist/cjs/api/types/CaseMessage1.d.ts +1 -0
- package/dist/cjs/api/types/CaseS3ObjectMetadata1.d.ts +19 -0
- package/dist/cjs/api/types/CaseS3ObjectMetadata1.js +5 -0
- package/dist/cjs/api/types/OrgPrivateData1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- 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/billing/resources/billingLedgers/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/Client.mjs +1 -1
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/billing/resources/billingLedgers/client/requests/BillingLedgerClientUpdate1.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.d.mts +75 -0
- package/dist/esm/api/resources/operations/resources/cases/client/Client.mjs +313 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.d.mts +12 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseNeedsActionReq.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseStatusReq.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/CaseStatusReq.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/index.mjs +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/Client.d.mts +83 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/Client.mjs +271 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/index.d.mts +2 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.d.mts +13 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost.mjs +4 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/index.d.mts +1 -0
- package/dist/esm/api/resources/operations/resources/cases/resources/s3Objects/index.mjs +1 -0
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/shipping/resources/taskGroups/client/Client.mjs +1 -1
- package/dist/esm/api/types/BillingLedger1.d.mts +1 -0
- package/dist/esm/api/types/CallerCredentialTypeEnum.d.mts +1 -2
- package/dist/esm/api/types/CallerCredentialTypeEnum.mjs +0 -1
- package/dist/esm/api/types/Case1.d.mts +4 -0
- package/dist/esm/api/types/CaseMessage1.d.mts +1 -0
- package/dist/esm/api/types/CaseS3ObjectMetadata1.d.mts +19 -0
- package/dist/esm/api/types/CaseS3ObjectMetadata1.mjs +4 -0
- package/dist/esm/api/types/OrgPrivateData1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +668 -61
package/reference.md
CHANGED
|
@@ -595,7 +595,7 @@ await client.billing.billingLedgers.createV1({
|
|
|
595
595
|
<dl>
|
|
596
596
|
<dd>
|
|
597
597
|
|
|
598
|
-
Updates a billing ledger's `comments`. Cycle and rate are per-period values supplied at `billing_ledger_periods/open/v1` time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)
|
|
598
|
+
Updates a billing ledger's `name` and `comments`. Cycle and rate are per-period values supplied at `billing_ledger_periods/open/v1` time; the ledger does not carry them. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[billing_ledger_owner_operators] | (BillingLedgerClientUpdate1) -> (bool)
|
|
599
599
|
|
|
600
600
|
</dd>
|
|
601
601
|
</dl>
|
|
@@ -11030,7 +11030,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11030
11030
|
</dl>
|
|
11031
11031
|
</details>
|
|
11032
11032
|
|
|
11033
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11033
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderRefV1</a>(orderRef) -> Chrt.Case1</code></summary>
|
|
11034
11034
|
<dl>
|
|
11035
11035
|
<dd>
|
|
11036
11036
|
|
|
@@ -11042,7 +11042,7 @@ await client.operations.cases.getByOrderV1("order_id");
|
|
|
11042
11042
|
<dl>
|
|
11043
11043
|
<dd>
|
|
11044
11044
|
|
|
11045
|
-
|
|
11045
|
+
Retrieves the case for a given order ID, short ID, or off-chrt reference ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11046
11046
|
|
|
11047
11047
|
</dd>
|
|
11048
11048
|
</dl>
|
|
@@ -11058,9 +11058,7 @@ Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) ->
|
|
|
11058
11058
|
<dd>
|
|
11059
11059
|
|
|
11060
11060
|
```typescript
|
|
11061
|
-
await client.operations.cases.
|
|
11062
|
-
operator_user_ids: ["operator_user_ids"],
|
|
11063
|
-
});
|
|
11061
|
+
await client.operations.cases.getByOrderRefV1("order_ref");
|
|
11064
11062
|
```
|
|
11065
11063
|
|
|
11066
11064
|
</dd>
|
|
@@ -11076,7 +11074,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11076
11074
|
<dl>
|
|
11077
11075
|
<dd>
|
|
11078
11076
|
|
|
11079
|
-
**
|
|
11077
|
+
**orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
|
|
11080
11078
|
|
|
11081
11079
|
</dd>
|
|
11082
11080
|
</dl>
|
|
@@ -11084,7 +11082,62 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11084
11082
|
<dl>
|
|
11085
11083
|
<dd>
|
|
11086
11084
|
|
|
11087
|
-
**
|
|
11085
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11086
|
+
|
|
11087
|
+
</dd>
|
|
11088
|
+
</dl>
|
|
11089
|
+
</dd>
|
|
11090
|
+
</dl>
|
|
11091
|
+
|
|
11092
|
+
</dd>
|
|
11093
|
+
</dl>
|
|
11094
|
+
</details>
|
|
11095
|
+
|
|
11096
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">getByOrderShortIdV1</a>(orderShortId) -> Chrt.Case1</code></summary>
|
|
11097
|
+
<dl>
|
|
11098
|
+
<dd>
|
|
11099
|
+
|
|
11100
|
+
#### 📝 Description
|
|
11101
|
+
|
|
11102
|
+
<dl>
|
|
11103
|
+
<dd>
|
|
11104
|
+
|
|
11105
|
+
<dl>
|
|
11106
|
+
<dd>
|
|
11107
|
+
|
|
11108
|
+
Retrieves the case for a given order short ID. | authz: min_org_role=operator | () -> (Case1)
|
|
11109
|
+
|
|
11110
|
+
</dd>
|
|
11111
|
+
</dl>
|
|
11112
|
+
</dd>
|
|
11113
|
+
</dl>
|
|
11114
|
+
|
|
11115
|
+
#### 🔌 Usage
|
|
11116
|
+
|
|
11117
|
+
<dl>
|
|
11118
|
+
<dd>
|
|
11119
|
+
|
|
11120
|
+
<dl>
|
|
11121
|
+
<dd>
|
|
11122
|
+
|
|
11123
|
+
```typescript
|
|
11124
|
+
await client.operations.cases.getByOrderShortIdV1("order_short_id");
|
|
11125
|
+
```
|
|
11126
|
+
|
|
11127
|
+
</dd>
|
|
11128
|
+
</dl>
|
|
11129
|
+
</dd>
|
|
11130
|
+
</dl>
|
|
11131
|
+
|
|
11132
|
+
#### ⚙️ Parameters
|
|
11133
|
+
|
|
11134
|
+
<dl>
|
|
11135
|
+
<dd>
|
|
11136
|
+
|
|
11137
|
+
<dl>
|
|
11138
|
+
<dd>
|
|
11139
|
+
|
|
11140
|
+
**orderShortId:** `string`
|
|
11088
11141
|
|
|
11089
11142
|
</dd>
|
|
11090
11143
|
</dl>
|
|
@@ -11103,7 +11156,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11103
11156
|
</dl>
|
|
11104
11157
|
</details>
|
|
11105
11158
|
|
|
11106
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11159
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateNeedsActionV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11107
11160
|
<dl>
|
|
11108
11161
|
<dd>
|
|
11109
11162
|
|
|
@@ -11115,7 +11168,7 @@ await client.operations.cases.assignV1("case_id", {
|
|
|
11115
11168
|
<dl>
|
|
11116
11169
|
<dd>
|
|
11117
11170
|
|
|
11118
|
-
|
|
11171
|
+
Updates whether a case needs action. | authz: min_org_role=operator | (CaseNeedsActionReq) -> (bool)
|
|
11119
11172
|
|
|
11120
11173
|
</dd>
|
|
11121
11174
|
</dl>
|
|
@@ -11131,8 +11184,8 @@ Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignR
|
|
|
11131
11184
|
<dd>
|
|
11132
11185
|
|
|
11133
11186
|
```typescript
|
|
11134
|
-
await client.operations.cases.
|
|
11135
|
-
|
|
11187
|
+
await client.operations.cases.updateNeedsActionV1("case_id", {
|
|
11188
|
+
needs_action: true,
|
|
11136
11189
|
});
|
|
11137
11190
|
```
|
|
11138
11191
|
|
|
@@ -11157,7 +11210,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11157
11210
|
<dl>
|
|
11158
11211
|
<dd>
|
|
11159
11212
|
|
|
11160
|
-
**request:** `Chrt.operations.
|
|
11213
|
+
**request:** `Chrt.operations.CaseNeedsActionReq`
|
|
11161
11214
|
|
|
11162
11215
|
</dd>
|
|
11163
11216
|
</dl>
|
|
@@ -11176,7 +11229,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11176
11229
|
</dl>
|
|
11177
11230
|
</details>
|
|
11178
11231
|
|
|
11179
|
-
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">
|
|
11232
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">updateStatusV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11180
11233
|
<dl>
|
|
11181
11234
|
<dd>
|
|
11182
11235
|
|
|
@@ -11188,7 +11241,7 @@ await client.operations.cases.unassignV1("case_id", {
|
|
|
11188
11241
|
<dl>
|
|
11189
11242
|
<dd>
|
|
11190
11243
|
|
|
11191
|
-
|
|
11244
|
+
Updates a case's status. Closing a case also clears needs_action. | authz: min_org_role=operator | (CaseStatusReq) -> (bool)
|
|
11192
11245
|
|
|
11193
11246
|
</dd>
|
|
11194
11247
|
</dl>
|
|
@@ -11204,8 +11257,8 @@ Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq
|
|
|
11204
11257
|
<dd>
|
|
11205
11258
|
|
|
11206
11259
|
```typescript
|
|
11207
|
-
await client.operations.cases.
|
|
11208
|
-
|
|
11260
|
+
await client.operations.cases.updateStatusV1("case_id", {
|
|
11261
|
+
status: "open",
|
|
11209
11262
|
});
|
|
11210
11263
|
```
|
|
11211
11264
|
|
|
@@ -11230,7 +11283,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11230
11283
|
<dl>
|
|
11231
11284
|
<dd>
|
|
11232
11285
|
|
|
11233
|
-
**request:** `Chrt.operations.
|
|
11286
|
+
**request:** `Chrt.operations.CaseStatusReq`
|
|
11234
11287
|
|
|
11235
11288
|
</dd>
|
|
11236
11289
|
</dl>
|
|
@@ -11249,9 +11302,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11249
11302
|
</dl>
|
|
11250
11303
|
</details>
|
|
11251
11304
|
|
|
11252
|
-
|
|
11253
|
-
|
|
11254
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11305
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">assignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11255
11306
|
<dl>
|
|
11256
11307
|
<dd>
|
|
11257
11308
|
|
|
@@ -11263,7 +11314,7 @@ await client.operations.cases.addMessageV1("case_id", {
|
|
|
11263
11314
|
<dl>
|
|
11264
11315
|
<dd>
|
|
11265
11316
|
|
|
11266
|
-
|
|
11317
|
+
Adds operator(s) to a case. | authz: min_org_role=operator | (CaseAssignReq) -> (bool)
|
|
11267
11318
|
|
|
11268
11319
|
</dd>
|
|
11269
11320
|
</dl>
|
|
@@ -11279,11 +11330,8 @@ Lists department configurations for the caller's organization. | authz: min_org_
|
|
|
11279
11330
|
<dd>
|
|
11280
11331
|
|
|
11281
11332
|
```typescript
|
|
11282
|
-
await client.operations.
|
|
11283
|
-
|
|
11284
|
-
sort_order: "asc",
|
|
11285
|
-
page: 1,
|
|
11286
|
-
page_size: 1,
|
|
11333
|
+
await client.operations.cases.assignV1("case_id", {
|
|
11334
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11287
11335
|
});
|
|
11288
11336
|
```
|
|
11289
11337
|
|
|
@@ -11300,7 +11348,7 @@ await client.operations.departments.listV1({
|
|
|
11300
11348
|
<dl>
|
|
11301
11349
|
<dd>
|
|
11302
11350
|
|
|
11303
|
-
**
|
|
11351
|
+
**caseId:** `string`
|
|
11304
11352
|
|
|
11305
11353
|
</dd>
|
|
11306
11354
|
</dl>
|
|
@@ -11308,7 +11356,15 @@ await client.operations.departments.listV1({
|
|
|
11308
11356
|
<dl>
|
|
11309
11357
|
<dd>
|
|
11310
11358
|
|
|
11311
|
-
**
|
|
11359
|
+
**request:** `Chrt.operations.CaseAssignReq`
|
|
11360
|
+
|
|
11361
|
+
</dd>
|
|
11362
|
+
</dl>
|
|
11363
|
+
|
|
11364
|
+
<dl>
|
|
11365
|
+
<dd>
|
|
11366
|
+
|
|
11367
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11312
11368
|
|
|
11313
11369
|
</dd>
|
|
11314
11370
|
</dl>
|
|
@@ -11319,7 +11375,7 @@ await client.operations.departments.listV1({
|
|
|
11319
11375
|
</dl>
|
|
11320
11376
|
</details>
|
|
11321
11377
|
|
|
11322
|
-
<details><summary><code>client.operations.
|
|
11378
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">unassignV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11323
11379
|
<dl>
|
|
11324
11380
|
<dd>
|
|
11325
11381
|
|
|
@@ -11331,7 +11387,7 @@ await client.operations.departments.listV1({
|
|
|
11331
11387
|
<dl>
|
|
11332
11388
|
<dd>
|
|
11333
11389
|
|
|
11334
|
-
|
|
11390
|
+
Removes operator(s) from a case. | authz: min_org_role=operator | (CaseUnassignReq) -> (bool)
|
|
11335
11391
|
|
|
11336
11392
|
</dd>
|
|
11337
11393
|
</dl>
|
|
@@ -11347,7 +11403,9 @@ Retrieves a single department configuration. | authz: min_org_role=operator | ()
|
|
|
11347
11403
|
<dd>
|
|
11348
11404
|
|
|
11349
11405
|
```typescript
|
|
11350
|
-
await client.operations.
|
|
11406
|
+
await client.operations.cases.unassignV1("case_id", {
|
|
11407
|
+
operator_user_ids: ["operator_user_ids"],
|
|
11408
|
+
});
|
|
11351
11409
|
```
|
|
11352
11410
|
|
|
11353
11411
|
</dd>
|
|
@@ -11363,7 +11421,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11363
11421
|
<dl>
|
|
11364
11422
|
<dd>
|
|
11365
11423
|
|
|
11366
|
-
**
|
|
11424
|
+
**caseId:** `string`
|
|
11367
11425
|
|
|
11368
11426
|
</dd>
|
|
11369
11427
|
</dl>
|
|
@@ -11371,7 +11429,15 @@ await client.operations.departments.getV1("department_id");
|
|
|
11371
11429
|
<dl>
|
|
11372
11430
|
<dd>
|
|
11373
11431
|
|
|
11374
|
-
**
|
|
11432
|
+
**request:** `Chrt.operations.CaseUnassignReq`
|
|
11433
|
+
|
|
11434
|
+
</dd>
|
|
11435
|
+
</dl>
|
|
11436
|
+
|
|
11437
|
+
<dl>
|
|
11438
|
+
<dd>
|
|
11439
|
+
|
|
11440
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11375
11441
|
|
|
11376
11442
|
</dd>
|
|
11377
11443
|
</dl>
|
|
@@ -11382,7 +11448,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11382
11448
|
</dl>
|
|
11383
11449
|
</details>
|
|
11384
11450
|
|
|
11385
|
-
<details><summary><code>client.operations.
|
|
11451
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">addMessageV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
11386
11452
|
<dl>
|
|
11387
11453
|
<dd>
|
|
11388
11454
|
|
|
@@ -11394,7 +11460,7 @@ await client.operations.departments.getV1("department_id");
|
|
|
11394
11460
|
<dl>
|
|
11395
11461
|
<dd>
|
|
11396
11462
|
|
|
11397
|
-
|
|
11463
|
+
Appends a message to a case. | authz: min_org_role=operator | (CaseAddMessageReq) -> (bool)
|
|
11398
11464
|
|
|
11399
11465
|
</dd>
|
|
11400
11466
|
</dl>
|
|
@@ -11410,7 +11476,9 @@ Deletes a department configuration. | authz: min_org_role=administrator | () ->
|
|
|
11410
11476
|
<dd>
|
|
11411
11477
|
|
|
11412
11478
|
```typescript
|
|
11413
|
-
await client.operations.
|
|
11479
|
+
await client.operations.cases.addMessageV1("case_id", {
|
|
11480
|
+
message: "message",
|
|
11481
|
+
});
|
|
11414
11482
|
```
|
|
11415
11483
|
|
|
11416
11484
|
</dd>
|
|
@@ -11426,7 +11494,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11426
11494
|
<dl>
|
|
11427
11495
|
<dd>
|
|
11428
11496
|
|
|
11429
|
-
**
|
|
11497
|
+
**caseId:** `string`
|
|
11430
11498
|
|
|
11431
11499
|
</dd>
|
|
11432
11500
|
</dl>
|
|
@@ -11434,7 +11502,15 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11434
11502
|
<dl>
|
|
11435
11503
|
<dd>
|
|
11436
11504
|
|
|
11437
|
-
**
|
|
11505
|
+
**request:** `Chrt.operations.CaseAddMessageReq`
|
|
11506
|
+
|
|
11507
|
+
</dd>
|
|
11508
|
+
</dl>
|
|
11509
|
+
|
|
11510
|
+
<dl>
|
|
11511
|
+
<dd>
|
|
11512
|
+
|
|
11513
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11438
11514
|
|
|
11439
11515
|
</dd>
|
|
11440
11516
|
</dl>
|
|
@@ -11445,7 +11521,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11445
11521
|
</dl>
|
|
11446
11522
|
</details>
|
|
11447
11523
|
|
|
11448
|
-
<details><summary><code>client.operations.
|
|
11524
|
+
<details><summary><code>client.operations.cases.<a href="/src/api/resources/operations/resources/cases/client/Client.ts">deleteMessageV1</a>(caseId, messageId) -> boolean</code></summary>
|
|
11449
11525
|
<dl>
|
|
11450
11526
|
<dd>
|
|
11451
11527
|
|
|
@@ -11457,7 +11533,7 @@ await client.operations.departments.deleteV1("department_id");
|
|
|
11457
11533
|
<dl>
|
|
11458
11534
|
<dd>
|
|
11459
11535
|
|
|
11460
|
-
|
|
11536
|
+
Deletes a message from a case. | authz: min_org_role=operator | () -> (bool)
|
|
11461
11537
|
|
|
11462
11538
|
</dd>
|
|
11463
11539
|
</dl>
|
|
@@ -11473,7 +11549,7 @@ Updates a department configuration. | authz: min_org_role=administrator | (Depar
|
|
|
11473
11549
|
<dd>
|
|
11474
11550
|
|
|
11475
11551
|
```typescript
|
|
11476
|
-
await client.operations.
|
|
11552
|
+
await client.operations.cases.deleteMessageV1("case_id", "message_id");
|
|
11477
11553
|
```
|
|
11478
11554
|
|
|
11479
11555
|
</dd>
|
|
@@ -11489,7 +11565,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11489
11565
|
<dl>
|
|
11490
11566
|
<dd>
|
|
11491
11567
|
|
|
11492
|
-
**
|
|
11568
|
+
**caseId:** `string`
|
|
11493
11569
|
|
|
11494
11570
|
</dd>
|
|
11495
11571
|
</dl>
|
|
@@ -11497,7 +11573,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11497
11573
|
<dl>
|
|
11498
11574
|
<dd>
|
|
11499
11575
|
|
|
11500
|
-
**
|
|
11576
|
+
**messageId:** `string`
|
|
11501
11577
|
|
|
11502
11578
|
</dd>
|
|
11503
11579
|
</dl>
|
|
@@ -11505,7 +11581,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11505
11581
|
<dl>
|
|
11506
11582
|
<dd>
|
|
11507
11583
|
|
|
11508
|
-
**requestOptions:** `
|
|
11584
|
+
**requestOptions:** `Cases.RequestOptions`
|
|
11509
11585
|
|
|
11510
11586
|
</dd>
|
|
11511
11587
|
</dl>
|
|
@@ -11516,7 +11592,9 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11516
11592
|
</dl>
|
|
11517
11593
|
</details>
|
|
11518
11594
|
|
|
11519
|
-
|
|
11595
|
+
## Operations Departments
|
|
11596
|
+
|
|
11597
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">listV1</a>({ ...params }) -> Chrt.DepartmentListRes</code></summary>
|
|
11520
11598
|
<dl>
|
|
11521
11599
|
<dd>
|
|
11522
11600
|
|
|
@@ -11528,7 +11606,7 @@ await client.operations.departments.updateV1("department_id");
|
|
|
11528
11606
|
<dl>
|
|
11529
11607
|
<dd>
|
|
11530
11608
|
|
|
11531
|
-
|
|
11609
|
+
Lists department configurations for the caller's organization. | authz: min_org_role=operator | () -> (DepartmentListRes)
|
|
11532
11610
|
|
|
11533
11611
|
</dd>
|
|
11534
11612
|
</dl>
|
|
@@ -11544,10 +11622,11 @@ Creates a new department configuration for the caller's organization. | authz: m
|
|
|
11544
11622
|
<dd>
|
|
11545
11623
|
|
|
11546
11624
|
```typescript
|
|
11547
|
-
await client.operations.departments.
|
|
11548
|
-
|
|
11549
|
-
|
|
11550
|
-
|
|
11625
|
+
await client.operations.departments.listV1({
|
|
11626
|
+
sort_by: "created_at",
|
|
11627
|
+
sort_order: "asc",
|
|
11628
|
+
page: 1,
|
|
11629
|
+
page_size: 1,
|
|
11551
11630
|
});
|
|
11552
11631
|
```
|
|
11553
11632
|
|
|
@@ -11564,7 +11643,7 @@ await client.operations.departments.createV1({
|
|
|
11564
11643
|
<dl>
|
|
11565
11644
|
<dd>
|
|
11566
11645
|
|
|
11567
|
-
**request:** `Chrt.operations.
|
|
11646
|
+
**request:** `Chrt.operations.DepartmentsListV1Request`
|
|
11568
11647
|
|
|
11569
11648
|
</dd>
|
|
11570
11649
|
</dl>
|
|
@@ -11583,7 +11662,7 @@ await client.operations.departments.createV1({
|
|
|
11583
11662
|
</dl>
|
|
11584
11663
|
</details>
|
|
11585
11664
|
|
|
11586
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">
|
|
11665
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">getV1</a>(departmentId) -> Chrt.Department1</code></summary>
|
|
11587
11666
|
<dl>
|
|
11588
11667
|
<dd>
|
|
11589
11668
|
|
|
@@ -11595,7 +11674,7 @@ await client.operations.departments.createV1({
|
|
|
11595
11674
|
<dl>
|
|
11596
11675
|
<dd>
|
|
11597
11676
|
|
|
11598
|
-
|
|
11677
|
+
Retrieves a single department configuration. | authz: min_org_role=operator | () -> (Department1)
|
|
11599
11678
|
|
|
11600
11679
|
</dd>
|
|
11601
11680
|
</dl>
|
|
@@ -11611,7 +11690,7 @@ Adds an operator to a department. | authz: min_org_role=administrator | () -> (b
|
|
|
11611
11690
|
<dd>
|
|
11612
11691
|
|
|
11613
11692
|
```typescript
|
|
11614
|
-
await client.operations.departments.
|
|
11693
|
+
await client.operations.departments.getV1("department_id");
|
|
11615
11694
|
```
|
|
11616
11695
|
|
|
11617
11696
|
</dd>
|
|
@@ -11635,7 +11714,62 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11635
11714
|
<dl>
|
|
11636
11715
|
<dd>
|
|
11637
11716
|
|
|
11638
|
-
**
|
|
11717
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11718
|
+
|
|
11719
|
+
</dd>
|
|
11720
|
+
</dl>
|
|
11721
|
+
</dd>
|
|
11722
|
+
</dl>
|
|
11723
|
+
|
|
11724
|
+
</dd>
|
|
11725
|
+
</dl>
|
|
11726
|
+
</details>
|
|
11727
|
+
|
|
11728
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">deleteV1</a>(departmentId) -> boolean</code></summary>
|
|
11729
|
+
<dl>
|
|
11730
|
+
<dd>
|
|
11731
|
+
|
|
11732
|
+
#### 📝 Description
|
|
11733
|
+
|
|
11734
|
+
<dl>
|
|
11735
|
+
<dd>
|
|
11736
|
+
|
|
11737
|
+
<dl>
|
|
11738
|
+
<dd>
|
|
11739
|
+
|
|
11740
|
+
Deletes a department configuration. | authz: min_org_role=administrator | () -> (bool)
|
|
11741
|
+
|
|
11742
|
+
</dd>
|
|
11743
|
+
</dl>
|
|
11744
|
+
</dd>
|
|
11745
|
+
</dl>
|
|
11746
|
+
|
|
11747
|
+
#### 🔌 Usage
|
|
11748
|
+
|
|
11749
|
+
<dl>
|
|
11750
|
+
<dd>
|
|
11751
|
+
|
|
11752
|
+
<dl>
|
|
11753
|
+
<dd>
|
|
11754
|
+
|
|
11755
|
+
```typescript
|
|
11756
|
+
await client.operations.departments.deleteV1("department_id");
|
|
11757
|
+
```
|
|
11758
|
+
|
|
11759
|
+
</dd>
|
|
11760
|
+
</dl>
|
|
11761
|
+
</dd>
|
|
11762
|
+
</dl>
|
|
11763
|
+
|
|
11764
|
+
#### ⚙️ Parameters
|
|
11765
|
+
|
|
11766
|
+
<dl>
|
|
11767
|
+
<dd>
|
|
11768
|
+
|
|
11769
|
+
<dl>
|
|
11770
|
+
<dd>
|
|
11771
|
+
|
|
11772
|
+
**departmentId:** `string`
|
|
11639
11773
|
|
|
11640
11774
|
</dd>
|
|
11641
11775
|
</dl>
|
|
@@ -11654,7 +11788,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11654
11788
|
</dl>
|
|
11655
11789
|
</details>
|
|
11656
11790
|
|
|
11657
|
-
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">
|
|
11791
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">updateV1</a>(departmentId, { ...params }) -> boolean</code></summary>
|
|
11658
11792
|
<dl>
|
|
11659
11793
|
<dd>
|
|
11660
11794
|
|
|
@@ -11666,7 +11800,7 @@ await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
|
11666
11800
|
<dl>
|
|
11667
11801
|
<dd>
|
|
11668
11802
|
|
|
11669
|
-
|
|
11803
|
+
Updates a department configuration. | authz: min_org_role=administrator | (DepartmentClientUpdate1) -> (bool)
|
|
11670
11804
|
|
|
11671
11805
|
</dd>
|
|
11672
11806
|
</dl>
|
|
@@ -11682,7 +11816,7 @@ Removes an operator from a department. | authz: min_org_role=administrator | ()
|
|
|
11682
11816
|
<dd>
|
|
11683
11817
|
|
|
11684
11818
|
```typescript
|
|
11685
|
-
await client.operations.departments.
|
|
11819
|
+
await client.operations.departments.updateV1("department_id");
|
|
11686
11820
|
```
|
|
11687
11821
|
|
|
11688
11822
|
</dd>
|
|
@@ -11706,7 +11840,7 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
11706
11840
|
<dl>
|
|
11707
11841
|
<dd>
|
|
11708
11842
|
|
|
11709
|
-
**
|
|
11843
|
+
**request:** `Chrt.operations.DepartmentClientUpdate1`
|
|
11710
11844
|
|
|
11711
11845
|
</dd>
|
|
11712
11846
|
</dl>
|
|
@@ -11725,6 +11859,479 @@ await client.operations.departments.removeOperatorV1("department_id", "user_id")
|
|
|
11725
11859
|
</dl>
|
|
11726
11860
|
</details>
|
|
11727
11861
|
|
|
11862
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">createV1</a>({ ...params }) -> string</code></summary>
|
|
11863
|
+
<dl>
|
|
11864
|
+
<dd>
|
|
11865
|
+
|
|
11866
|
+
#### 📝 Description
|
|
11867
|
+
|
|
11868
|
+
<dl>
|
|
11869
|
+
<dd>
|
|
11870
|
+
|
|
11871
|
+
<dl>
|
|
11872
|
+
<dd>
|
|
11873
|
+
|
|
11874
|
+
Creates a new department configuration for the caller's organization. | authz: min_org_role=administrator | (DepartmentClientCreate1) -> (PydanticObjectId)
|
|
11875
|
+
|
|
11876
|
+
</dd>
|
|
11877
|
+
</dl>
|
|
11878
|
+
</dd>
|
|
11879
|
+
</dl>
|
|
11880
|
+
|
|
11881
|
+
#### 🔌 Usage
|
|
11882
|
+
|
|
11883
|
+
<dl>
|
|
11884
|
+
<dd>
|
|
11885
|
+
|
|
11886
|
+
<dl>
|
|
11887
|
+
<dd>
|
|
11888
|
+
|
|
11889
|
+
```typescript
|
|
11890
|
+
await client.operations.departments.createV1({
|
|
11891
|
+
schema_version: 1,
|
|
11892
|
+
name: "name",
|
|
11893
|
+
department: "automotive",
|
|
11894
|
+
});
|
|
11895
|
+
```
|
|
11896
|
+
|
|
11897
|
+
</dd>
|
|
11898
|
+
</dl>
|
|
11899
|
+
</dd>
|
|
11900
|
+
</dl>
|
|
11901
|
+
|
|
11902
|
+
#### ⚙️ Parameters
|
|
11903
|
+
|
|
11904
|
+
<dl>
|
|
11905
|
+
<dd>
|
|
11906
|
+
|
|
11907
|
+
<dl>
|
|
11908
|
+
<dd>
|
|
11909
|
+
|
|
11910
|
+
**request:** `Chrt.operations.DepartmentClientCreate1`
|
|
11911
|
+
|
|
11912
|
+
</dd>
|
|
11913
|
+
</dl>
|
|
11914
|
+
|
|
11915
|
+
<dl>
|
|
11916
|
+
<dd>
|
|
11917
|
+
|
|
11918
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11919
|
+
|
|
11920
|
+
</dd>
|
|
11921
|
+
</dl>
|
|
11922
|
+
</dd>
|
|
11923
|
+
</dl>
|
|
11924
|
+
|
|
11925
|
+
</dd>
|
|
11926
|
+
</dl>
|
|
11927
|
+
</details>
|
|
11928
|
+
|
|
11929
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">addOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
11930
|
+
<dl>
|
|
11931
|
+
<dd>
|
|
11932
|
+
|
|
11933
|
+
#### 📝 Description
|
|
11934
|
+
|
|
11935
|
+
<dl>
|
|
11936
|
+
<dd>
|
|
11937
|
+
|
|
11938
|
+
<dl>
|
|
11939
|
+
<dd>
|
|
11940
|
+
|
|
11941
|
+
Adds an operator to a department. | authz: min_org_role=administrator | () -> (bool)
|
|
11942
|
+
|
|
11943
|
+
</dd>
|
|
11944
|
+
</dl>
|
|
11945
|
+
</dd>
|
|
11946
|
+
</dl>
|
|
11947
|
+
|
|
11948
|
+
#### 🔌 Usage
|
|
11949
|
+
|
|
11950
|
+
<dl>
|
|
11951
|
+
<dd>
|
|
11952
|
+
|
|
11953
|
+
<dl>
|
|
11954
|
+
<dd>
|
|
11955
|
+
|
|
11956
|
+
```typescript
|
|
11957
|
+
await client.operations.departments.addOperatorV1("department_id", "user_id");
|
|
11958
|
+
```
|
|
11959
|
+
|
|
11960
|
+
</dd>
|
|
11961
|
+
</dl>
|
|
11962
|
+
</dd>
|
|
11963
|
+
</dl>
|
|
11964
|
+
|
|
11965
|
+
#### ⚙️ Parameters
|
|
11966
|
+
|
|
11967
|
+
<dl>
|
|
11968
|
+
<dd>
|
|
11969
|
+
|
|
11970
|
+
<dl>
|
|
11971
|
+
<dd>
|
|
11972
|
+
|
|
11973
|
+
**departmentId:** `string`
|
|
11974
|
+
|
|
11975
|
+
</dd>
|
|
11976
|
+
</dl>
|
|
11977
|
+
|
|
11978
|
+
<dl>
|
|
11979
|
+
<dd>
|
|
11980
|
+
|
|
11981
|
+
**userId:** `string`
|
|
11982
|
+
|
|
11983
|
+
</dd>
|
|
11984
|
+
</dl>
|
|
11985
|
+
|
|
11986
|
+
<dl>
|
|
11987
|
+
<dd>
|
|
11988
|
+
|
|
11989
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
11990
|
+
|
|
11991
|
+
</dd>
|
|
11992
|
+
</dl>
|
|
11993
|
+
</dd>
|
|
11994
|
+
</dl>
|
|
11995
|
+
|
|
11996
|
+
</dd>
|
|
11997
|
+
</dl>
|
|
11998
|
+
</details>
|
|
11999
|
+
|
|
12000
|
+
<details><summary><code>client.operations.departments.<a href="/src/api/resources/operations/resources/departments/client/Client.ts">removeOperatorV1</a>(departmentId, userId) -> boolean</code></summary>
|
|
12001
|
+
<dl>
|
|
12002
|
+
<dd>
|
|
12003
|
+
|
|
12004
|
+
#### 📝 Description
|
|
12005
|
+
|
|
12006
|
+
<dl>
|
|
12007
|
+
<dd>
|
|
12008
|
+
|
|
12009
|
+
<dl>
|
|
12010
|
+
<dd>
|
|
12011
|
+
|
|
12012
|
+
Removes an operator from a department. | authz: min_org_role=administrator | () -> (bool)
|
|
12013
|
+
|
|
12014
|
+
</dd>
|
|
12015
|
+
</dl>
|
|
12016
|
+
</dd>
|
|
12017
|
+
</dl>
|
|
12018
|
+
|
|
12019
|
+
#### 🔌 Usage
|
|
12020
|
+
|
|
12021
|
+
<dl>
|
|
12022
|
+
<dd>
|
|
12023
|
+
|
|
12024
|
+
<dl>
|
|
12025
|
+
<dd>
|
|
12026
|
+
|
|
12027
|
+
```typescript
|
|
12028
|
+
await client.operations.departments.removeOperatorV1("department_id", "user_id");
|
|
12029
|
+
```
|
|
12030
|
+
|
|
12031
|
+
</dd>
|
|
12032
|
+
</dl>
|
|
12033
|
+
</dd>
|
|
12034
|
+
</dl>
|
|
12035
|
+
|
|
12036
|
+
#### ⚙️ Parameters
|
|
12037
|
+
|
|
12038
|
+
<dl>
|
|
12039
|
+
<dd>
|
|
12040
|
+
|
|
12041
|
+
<dl>
|
|
12042
|
+
<dd>
|
|
12043
|
+
|
|
12044
|
+
**departmentId:** `string`
|
|
12045
|
+
|
|
12046
|
+
</dd>
|
|
12047
|
+
</dl>
|
|
12048
|
+
|
|
12049
|
+
<dl>
|
|
12050
|
+
<dd>
|
|
12051
|
+
|
|
12052
|
+
**userId:** `string`
|
|
12053
|
+
|
|
12054
|
+
</dd>
|
|
12055
|
+
</dl>
|
|
12056
|
+
|
|
12057
|
+
<dl>
|
|
12058
|
+
<dd>
|
|
12059
|
+
|
|
12060
|
+
**requestOptions:** `Departments.RequestOptions`
|
|
12061
|
+
|
|
12062
|
+
</dd>
|
|
12063
|
+
</dl>
|
|
12064
|
+
</dd>
|
|
12065
|
+
</dl>
|
|
12066
|
+
|
|
12067
|
+
</dd>
|
|
12068
|
+
</dl>
|
|
12069
|
+
</details>
|
|
12070
|
+
|
|
12071
|
+
## Operations Cases S3Objects
|
|
12072
|
+
|
|
12073
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getS3ObjectMetadataV1</a>(caseS3ObjectMetadataId) -> Chrt.CaseS3ObjectMetadata1</code></summary>
|
|
12074
|
+
<dl>
|
|
12075
|
+
<dd>
|
|
12076
|
+
|
|
12077
|
+
#### 📝 Description
|
|
12078
|
+
|
|
12079
|
+
<dl>
|
|
12080
|
+
<dd>
|
|
12081
|
+
|
|
12082
|
+
<dl>
|
|
12083
|
+
<dd>
|
|
12084
|
+
|
|
12085
|
+
Retrieves metadata for a case S3 object. | authz: min_org_role=operator | () -> (CaseS3ObjectMetadata1)
|
|
12086
|
+
|
|
12087
|
+
</dd>
|
|
12088
|
+
</dl>
|
|
12089
|
+
</dd>
|
|
12090
|
+
</dl>
|
|
12091
|
+
|
|
12092
|
+
#### 🔌 Usage
|
|
12093
|
+
|
|
12094
|
+
<dl>
|
|
12095
|
+
<dd>
|
|
12096
|
+
|
|
12097
|
+
<dl>
|
|
12098
|
+
<dd>
|
|
12099
|
+
|
|
12100
|
+
```typescript
|
|
12101
|
+
await client.operations.cases.s3Objects.getS3ObjectMetadataV1("case_s3_object_metadata_id");
|
|
12102
|
+
```
|
|
12103
|
+
|
|
12104
|
+
</dd>
|
|
12105
|
+
</dl>
|
|
12106
|
+
</dd>
|
|
12107
|
+
</dl>
|
|
12108
|
+
|
|
12109
|
+
#### ⚙️ Parameters
|
|
12110
|
+
|
|
12111
|
+
<dl>
|
|
12112
|
+
<dd>
|
|
12113
|
+
|
|
12114
|
+
<dl>
|
|
12115
|
+
<dd>
|
|
12116
|
+
|
|
12117
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12118
|
+
|
|
12119
|
+
</dd>
|
|
12120
|
+
</dl>
|
|
12121
|
+
|
|
12122
|
+
<dl>
|
|
12123
|
+
<dd>
|
|
12124
|
+
|
|
12125
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12126
|
+
|
|
12127
|
+
</dd>
|
|
12128
|
+
</dl>
|
|
12129
|
+
</dd>
|
|
12130
|
+
</dl>
|
|
12131
|
+
|
|
12132
|
+
</dd>
|
|
12133
|
+
</dl>
|
|
12134
|
+
</details>
|
|
12135
|
+
|
|
12136
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">getV1</a>(caseS3ObjectMetadataId) -> core.BinaryResponse</code></summary>
|
|
12137
|
+
<dl>
|
|
12138
|
+
<dd>
|
|
12139
|
+
|
|
12140
|
+
#### 📝 Description
|
|
12141
|
+
|
|
12142
|
+
<dl>
|
|
12143
|
+
<dd>
|
|
12144
|
+
|
|
12145
|
+
<dl>
|
|
12146
|
+
<dd>
|
|
12147
|
+
|
|
12148
|
+
Streams a case S3 object file from storage. | authz: min_org_role=operator | () -> (binary)
|
|
12149
|
+
|
|
12150
|
+
</dd>
|
|
12151
|
+
</dl>
|
|
12152
|
+
</dd>
|
|
12153
|
+
</dl>
|
|
12154
|
+
|
|
12155
|
+
#### 🔌 Usage
|
|
12156
|
+
|
|
12157
|
+
<dl>
|
|
12158
|
+
<dd>
|
|
12159
|
+
|
|
12160
|
+
<dl>
|
|
12161
|
+
<dd>
|
|
12162
|
+
|
|
12163
|
+
```typescript
|
|
12164
|
+
await client.operations.cases.s3Objects.getV1("case_s3_object_metadata_id");
|
|
12165
|
+
```
|
|
12166
|
+
|
|
12167
|
+
</dd>
|
|
12168
|
+
</dl>
|
|
12169
|
+
</dd>
|
|
12170
|
+
</dl>
|
|
12171
|
+
|
|
12172
|
+
#### ⚙️ Parameters
|
|
12173
|
+
|
|
12174
|
+
<dl>
|
|
12175
|
+
<dd>
|
|
12176
|
+
|
|
12177
|
+
<dl>
|
|
12178
|
+
<dd>
|
|
12179
|
+
|
|
12180
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12181
|
+
|
|
12182
|
+
</dd>
|
|
12183
|
+
</dl>
|
|
12184
|
+
|
|
12185
|
+
<dl>
|
|
12186
|
+
<dd>
|
|
12187
|
+
|
|
12188
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12189
|
+
|
|
12190
|
+
</dd>
|
|
12191
|
+
</dl>
|
|
12192
|
+
</dd>
|
|
12193
|
+
</dl>
|
|
12194
|
+
|
|
12195
|
+
</dd>
|
|
12196
|
+
</dl>
|
|
12197
|
+
</details>
|
|
12198
|
+
|
|
12199
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">addV1</a>(caseId, { ...params }) -> boolean</code></summary>
|
|
12200
|
+
<dl>
|
|
12201
|
+
<dd>
|
|
12202
|
+
|
|
12203
|
+
#### 📝 Description
|
|
12204
|
+
|
|
12205
|
+
<dl>
|
|
12206
|
+
<dd>
|
|
12207
|
+
|
|
12208
|
+
<dl>
|
|
12209
|
+
<dd>
|
|
12210
|
+
|
|
12211
|
+
Uploads a file to a case. Automatic blurhash generation for images. | authz: min_org_role=operator | (UploadFile) -> (bool)
|
|
12212
|
+
|
|
12213
|
+
</dd>
|
|
12214
|
+
</dl>
|
|
12215
|
+
</dd>
|
|
12216
|
+
</dl>
|
|
12217
|
+
|
|
12218
|
+
#### 🔌 Usage
|
|
12219
|
+
|
|
12220
|
+
<dl>
|
|
12221
|
+
<dd>
|
|
12222
|
+
|
|
12223
|
+
<dl>
|
|
12224
|
+
<dd>
|
|
12225
|
+
|
|
12226
|
+
```typescript
|
|
12227
|
+
await client.operations.cases.s3Objects.addV1("case_id", {
|
|
12228
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
12229
|
+
});
|
|
12230
|
+
```
|
|
12231
|
+
|
|
12232
|
+
</dd>
|
|
12233
|
+
</dl>
|
|
12234
|
+
</dd>
|
|
12235
|
+
</dl>
|
|
12236
|
+
|
|
12237
|
+
#### ⚙️ Parameters
|
|
12238
|
+
|
|
12239
|
+
<dl>
|
|
12240
|
+
<dd>
|
|
12241
|
+
|
|
12242
|
+
<dl>
|
|
12243
|
+
<dd>
|
|
12244
|
+
|
|
12245
|
+
**caseId:** `string`
|
|
12246
|
+
|
|
12247
|
+
</dd>
|
|
12248
|
+
</dl>
|
|
12249
|
+
|
|
12250
|
+
<dl>
|
|
12251
|
+
<dd>
|
|
12252
|
+
|
|
12253
|
+
**request:** `Chrt.operations.cases.BodyPostCasesS3ObjectsAddV1OperationsCasesS3ObjectsAddV1CaseIdPost`
|
|
12254
|
+
|
|
12255
|
+
</dd>
|
|
12256
|
+
</dl>
|
|
12257
|
+
|
|
12258
|
+
<dl>
|
|
12259
|
+
<dd>
|
|
12260
|
+
|
|
12261
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12262
|
+
|
|
12263
|
+
</dd>
|
|
12264
|
+
</dl>
|
|
12265
|
+
</dd>
|
|
12266
|
+
</dl>
|
|
12267
|
+
|
|
12268
|
+
</dd>
|
|
12269
|
+
</dl>
|
|
12270
|
+
</details>
|
|
12271
|
+
|
|
12272
|
+
<details><summary><code>client.operations.cases.s3Objects.<a href="/src/api/resources/operations/resources/cases/resources/s3Objects/client/Client.ts">deleteV1</a>(caseS3ObjectMetadataId) -> boolean</code></summary>
|
|
12273
|
+
<dl>
|
|
12274
|
+
<dd>
|
|
12275
|
+
|
|
12276
|
+
#### 📝 Description
|
|
12277
|
+
|
|
12278
|
+
<dl>
|
|
12279
|
+
<dd>
|
|
12280
|
+
|
|
12281
|
+
<dl>
|
|
12282
|
+
<dd>
|
|
12283
|
+
|
|
12284
|
+
Deletes an S3 object metadata and the associated S3 object from a case. Only the uploader or an operator from the uploading org can delete. | () -> (bool)
|
|
12285
|
+
|
|
12286
|
+
</dd>
|
|
12287
|
+
</dl>
|
|
12288
|
+
</dd>
|
|
12289
|
+
</dl>
|
|
12290
|
+
|
|
12291
|
+
#### 🔌 Usage
|
|
12292
|
+
|
|
12293
|
+
<dl>
|
|
12294
|
+
<dd>
|
|
12295
|
+
|
|
12296
|
+
<dl>
|
|
12297
|
+
<dd>
|
|
12298
|
+
|
|
12299
|
+
```typescript
|
|
12300
|
+
await client.operations.cases.s3Objects.deleteV1("case_s3_object_metadata_id");
|
|
12301
|
+
```
|
|
12302
|
+
|
|
12303
|
+
</dd>
|
|
12304
|
+
</dl>
|
|
12305
|
+
</dd>
|
|
12306
|
+
</dl>
|
|
12307
|
+
|
|
12308
|
+
#### ⚙️ Parameters
|
|
12309
|
+
|
|
12310
|
+
<dl>
|
|
12311
|
+
<dd>
|
|
12312
|
+
|
|
12313
|
+
<dl>
|
|
12314
|
+
<dd>
|
|
12315
|
+
|
|
12316
|
+
**caseS3ObjectMetadataId:** `string`
|
|
12317
|
+
|
|
12318
|
+
</dd>
|
|
12319
|
+
</dl>
|
|
12320
|
+
|
|
12321
|
+
<dl>
|
|
12322
|
+
<dd>
|
|
12323
|
+
|
|
12324
|
+
**requestOptions:** `S3Objects.RequestOptions`
|
|
12325
|
+
|
|
12326
|
+
</dd>
|
|
12327
|
+
</dl>
|
|
12328
|
+
</dd>
|
|
12329
|
+
</dl>
|
|
12330
|
+
|
|
12331
|
+
</dd>
|
|
12332
|
+
</dl>
|
|
12333
|
+
</details>
|
|
12334
|
+
|
|
11728
12335
|
## Orgs Connections
|
|
11729
12336
|
|
|
11730
12337
|
<details><summary><code>client.orgs.connections.<a href="/src/api/resources/orgs/resources/connections/client/Client.ts">listShippersV1</a>({ ...params }) -> Chrt.ShipperConnectionListRes</code></summary>
|
|
@@ -17534,7 +18141,7 @@ await client.shipping.taskGroups.detachLigFromProviderPayDriverV1("task_group_id
|
|
|
17534
18141
|
<dl>
|
|
17535
18142
|
<dd>
|
|
17536
18143
|
|
|
17537
|
-
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider], min_org_role=operator, authz_personas=[task_group_coordinator_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
18144
|
+
Preview the LineItem materialization that would result from applying a rate sheet to the SPP vector of the named TaskGroup. Returns the resolved rate sheet, materialized LineItems (NOT inserted), the pre-adjustment total, and the requested parties (shipper -> coordinator). Auto-resolves the rate sheet via RateSheetMapping1 for the requested shipper unless body.rate_sheet_id is provided. No DB writes — operator can iterate freely. To commit, call from_rate_sheet/create_for_shipper_pay_provider/v1 then attach_lig_to_shipper_pay_provider/v1. | authz: allowed_org_types=[provider, shipper], min_org_role=operator, authz_personas=[task_group_coordinator_operators, shipper_org_operators] | (TaskGroupQuoteForShipperPayProviderClientReq) -> (TaskGroupQuoteResp)
|
|
17538
18145
|
|
|
17539
18146
|
</dd>
|
|
17540
18147
|
</dl>
|