@chrt-inc/typescript-sdk 1.305.0 → 1.306.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/orderDrafts/resources/taskGroup/client/Client.d.ts +14 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/Client.js +63 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.d.ts +13 -0
- package/dist/cjs/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/client/Client.d.ts +18 -5
- package/dist/cjs/api/resources/orgs/client/Client.js +69 -7
- package/dist/cjs/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.ts +1 -5
- package/dist/cjs/api/resources/orgs/client/requests/SetOrgTypeReq.d.ts +13 -0
- package/dist/cjs/api/resources/orgs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/taskGroups/client/Client.d.ts +47 -19
- package/dist/cjs/api/resources/taskGroups/client/Client.js +157 -31
- package/dist/cjs/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.ts +12 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/SetFlightNumberReq.js +5 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/SetTaskOrderingReq.d.ts +12 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/SetTaskOrderingReq.js +5 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.d.ts +12 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.js +5 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.d.ts +11 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.js +5 -0
- package/dist/cjs/api/resources/taskGroups/client/requests/index.d.ts +4 -2
- package/dist/cjs/api/types/ClerkOrgData.d.ts +2 -1
- package/dist/cjs/api/types/CreateOrgPublicDataRes.d.ts +7 -0
- package/dist/cjs/api/types/CreateOrgPublicDataRes.js +5 -0
- package/dist/cjs/api/types/OrderDraftExpandedRes.d.ts +1 -0
- package/dist/cjs/api/types/OrgRoleEnum.d.ts +28 -0
- package/dist/cjs/api/types/OrgRoleEnum.js +12 -0
- package/dist/cjs/api/types/TaskClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -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/orderDrafts/resources/taskGroup/client/Client.d.mts +14 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/Client.mjs +63 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.d.mts +13 -0
- package/dist/esm/api/resources/orderDrafts/resources/taskGroup/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/orgs/client/Client.d.mts +18 -5
- package/dist/esm/api/resources/orgs/client/Client.mjs +69 -7
- package/dist/esm/api/resources/orgs/client/requests/CreateOrgPublicDataReq.d.mts +1 -5
- package/dist/esm/api/resources/orgs/client/requests/SetOrgTypeReq.d.mts +13 -0
- package/dist/esm/api/resources/orgs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/taskGroups/client/Client.d.mts +47 -19
- package/dist/esm/api/resources/taskGroups/client/Client.mjs +157 -31
- package/dist/esm/api/resources/taskGroups/client/requests/SetFlightNumberReq.d.mts +12 -0
- package/dist/esm/api/resources/taskGroups/client/requests/SetFlightNumberReq.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/client/requests/SetTaskOrderingReq.d.mts +12 -0
- package/dist/esm/api/resources/taskGroups/client/requests/SetTaskOrderingReq.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.d.mts +12 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupCourierOrgReq.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.d.mts +11 -0
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupDriverReq.mjs +4 -0
- package/dist/esm/api/resources/taskGroups/client/requests/index.d.mts +4 -2
- package/dist/esm/api/types/ClerkOrgData.d.mts +2 -1
- package/dist/esm/api/types/CreateOrgPublicDataRes.d.mts +7 -0
- package/dist/esm/api/types/CreateOrgPublicDataRes.mjs +4 -0
- package/dist/esm/api/types/OrderDraftExpandedRes.d.mts +1 -0
- package/dist/esm/api/types/OrgRoleEnum.d.mts +28 -0
- package/dist/esm/api/types/OrgRoleEnum.mjs +9 -0
- package/dist/esm/api/types/TaskClientUpdate1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +304 -21
- package/dist/cjs/api/resources/taskGroups/client/requests/SetTaskGroupPauseReq.d.ts +0 -14
- package/dist/cjs/api/resources/taskGroups/client/requests/UpdateTaskGroupReq.d.ts +0 -14
- package/dist/esm/api/resources/taskGroups/client/requests/SetTaskGroupPauseReq.d.mts +0 -14
- package/dist/esm/api/resources/taskGroups/client/requests/UpdateTaskGroupReq.d.mts +0 -14
- /package/dist/cjs/api/resources/{taskGroups/client/requests/SetTaskGroupPauseReq.js → orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.js} +0 -0
- /package/dist/cjs/api/resources/{taskGroups/client/requests/UpdateTaskGroupReq.js → orgs/client/requests/SetOrgTypeReq.js} +0 -0
- /package/dist/esm/api/resources/{taskGroups/client/requests/SetTaskGroupPauseReq.mjs → orderDrafts/resources/taskGroup/client/requests/UpdateTaskGroupDraftReq.mjs} +0 -0
- /package/dist/esm/api/resources/{taskGroups/client/requests/UpdateTaskGroupReq.mjs → orgs/client/requests/SetOrgTypeReq.mjs} +0 -0
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as Chrt from "../index.mjs";
|
|
4
5
|
export interface ClerkOrgData {
|
|
5
6
|
/** Must be a string starting with `org_` */
|
|
6
7
|
id?: string | null;
|
|
7
|
-
rol?:
|
|
8
|
+
rol?: Chrt.OrgRoleEnum | null;
|
|
8
9
|
slg?: string | null;
|
|
9
10
|
/** Accepts any additional properties */
|
|
10
11
|
[key: string]: any;
|
|
@@ -5,6 +5,7 @@ import * as Chrt from "../index.mjs";
|
|
|
5
5
|
export interface OrderDraftExpandedRes {
|
|
6
6
|
order: Chrt.Order1;
|
|
7
7
|
task_groups_expanded?: Chrt.TaskGroupDraftExpanded[] | null;
|
|
8
|
+
cargos?: Chrt.Cargo1[] | null;
|
|
8
9
|
shipper_org_company_name?: string | null;
|
|
9
10
|
shipper_org_handle?: string | null;
|
|
10
11
|
off_chrt_shipper_org_company_name?: string | null;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Organization roles used by Clerk in `jwt.o.rol` field
|
|
6
|
+
*
|
|
7
|
+
* Hierarchy (highest to lowest):
|
|
8
|
+
* owner > administrator > operator > driver
|
|
9
|
+
*
|
|
10
|
+
* Role availability by org type:
|
|
11
|
+
* {owner, administrator, operator} → COURIER | SHIPPER | FORWARDER
|
|
12
|
+
* {driver} → COURIER only
|
|
13
|
+
*
|
|
14
|
+
* Note: Hierarchical enforcement depends on utils_oort_authz helper functions.
|
|
15
|
+
*
|
|
16
|
+
* Clerk dashboard with roles settings:
|
|
17
|
+
* - prod: https://dashboard.clerk.com/apps/app_2rDeFYQ7SBioYoMhG38FgirTE4Q/instances/ins_2rDmMgzRGFXd6Ml6N8eV8pOXeyI/organizations-settings/roles
|
|
18
|
+
* - dev: https://dashboard.clerk.com/apps/app_2rDeFYQ7SBioYoMhG38FgirTE4Q/instances/ins_2rDeFZFEZ3nIC9VQt3zYfvzL14Z/organizations-settings/roles
|
|
19
|
+
*
|
|
20
|
+
* Clerk includes the "org:" prefix automatically, so we use it in the enum.
|
|
21
|
+
*/
|
|
22
|
+
export type OrgRoleEnum = "org:owner" | "org:administrator" | "org:operator" | "org:driver";
|
|
23
|
+
export declare const OrgRoleEnum: {
|
|
24
|
+
readonly OrgOwner: "org:owner";
|
|
25
|
+
readonly OrgAdministrator: "org:administrator";
|
|
26
|
+
readonly OrgOperator: "org:operator";
|
|
27
|
+
readonly OrgDriver: "org:driver";
|
|
28
|
+
};
|
|
@@ -6,6 +6,7 @@ export interface TaskClientUpdate1 {
|
|
|
6
6
|
location?: Chrt.LocationFeature | null;
|
|
7
7
|
action?: TaskClientUpdate1.Action | null;
|
|
8
8
|
time_windows?: Chrt.TimeWindow1[] | null;
|
|
9
|
+
order_placer_comments?: string | null;
|
|
9
10
|
shipper_contact_info_ids?: string[] | null;
|
|
10
11
|
flight_number?: string | null;
|
|
11
12
|
}
|
|
@@ -21,6 +21,7 @@ export * from "./CreateCheckoutSessionRes.mjs";
|
|
|
21
21
|
export * from "./CreateConnectAccountLinkRes.mjs";
|
|
22
22
|
export * from "./CreateConnectAccountRes.mjs";
|
|
23
23
|
export * from "./CreateConnectionReq.mjs";
|
|
24
|
+
export * from "./CreateOrgPublicDataRes.mjs";
|
|
24
25
|
export * from "./CreateShipperPayCourierPaymentReq.mjs";
|
|
25
26
|
export * from "./CreateShipperPayCourierStatementReq.mjs";
|
|
26
27
|
export * from "./DecodedJwtWithOrgAndUserId.mjs";
|
|
@@ -69,6 +70,7 @@ export * from "./OrgMemberDetails.mjs";
|
|
|
69
70
|
export * from "./OrgMembersAndDrivers.mjs";
|
|
70
71
|
export * from "./OrgProfileRes1.mjs";
|
|
71
72
|
export * from "./OrgPublicData1.mjs";
|
|
73
|
+
export * from "./OrgRoleEnum.mjs";
|
|
72
74
|
export * from "./OrgTypeEnum.mjs";
|
|
73
75
|
export * from "./OutlierLabellerEnum.mjs";
|
|
74
76
|
export * from "./PaymentPreviewResponse.mjs";
|
|
@@ -21,6 +21,7 @@ export * from "./CreateCheckoutSessionRes.mjs";
|
|
|
21
21
|
export * from "./CreateConnectAccountLinkRes.mjs";
|
|
22
22
|
export * from "./CreateConnectAccountRes.mjs";
|
|
23
23
|
export * from "./CreateConnectionReq.mjs";
|
|
24
|
+
export * from "./CreateOrgPublicDataRes.mjs";
|
|
24
25
|
export * from "./CreateShipperPayCourierPaymentReq.mjs";
|
|
25
26
|
export * from "./CreateShipperPayCourierStatementReq.mjs";
|
|
26
27
|
export * from "./DecodedJwtWithOrgAndUserId.mjs";
|
|
@@ -69,6 +70,7 @@ export * from "./OrgMemberDetails.mjs";
|
|
|
69
70
|
export * from "./OrgMembersAndDrivers.mjs";
|
|
70
71
|
export * from "./OrgProfileRes1.mjs";
|
|
71
72
|
export * from "./OrgPublicData1.mjs";
|
|
73
|
+
export * from "./OrgRoleEnum.mjs";
|
|
72
74
|
export * from "./OrgTypeEnum.mjs";
|
|
73
75
|
export * from "./OutlierLabellerEnum.mjs";
|
|
74
76
|
export * from "./PaymentPreviewResponse.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.306.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.306.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -5889,7 +5889,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5889
5889
|
|
|
5890
5890
|
## TaskGroups
|
|
5891
5891
|
|
|
5892
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
5892
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5893
5893
|
<dl>
|
|
5894
5894
|
<dd>
|
|
5895
5895
|
|
|
@@ -5901,7 +5901,7 @@ await client.orderDrafts.validateV1("order_id");
|
|
|
5901
5901
|
<dl>
|
|
5902
5902
|
<dd>
|
|
5903
5903
|
|
|
5904
|
-
Updates task group
|
|
5904
|
+
Updates the ordering of tasks in a task group. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetTaskOrderingReq) -> (bool)
|
|
5905
5905
|
|
|
5906
5906
|
</dd>
|
|
5907
5907
|
</dl>
|
|
@@ -5917,8 +5917,8 @@ Updates task group driver assignments by adding or removing drivers. | (UpdateTa
|
|
|
5917
5917
|
<dd>
|
|
5918
5918
|
|
|
5919
5919
|
```typescript
|
|
5920
|
-
await client.taskGroups.
|
|
5921
|
-
|
|
5920
|
+
await client.taskGroups.setTaskOrderingV1("task_group_id", {
|
|
5921
|
+
task_ordering: ["task_ordering"],
|
|
5922
5922
|
});
|
|
5923
5923
|
```
|
|
5924
5924
|
|
|
@@ -5935,7 +5935,15 @@ await client.taskGroups.updateV1({
|
|
|
5935
5935
|
<dl>
|
|
5936
5936
|
<dd>
|
|
5937
5937
|
|
|
5938
|
-
**
|
|
5938
|
+
**taskGroupId:** `string`
|
|
5939
|
+
|
|
5940
|
+
</dd>
|
|
5941
|
+
</dl>
|
|
5942
|
+
|
|
5943
|
+
<dl>
|
|
5944
|
+
<dd>
|
|
5945
|
+
|
|
5946
|
+
**request:** `Chrt.SetTaskOrderingReq`
|
|
5939
5947
|
|
|
5940
5948
|
</dd>
|
|
5941
5949
|
</dl>
|
|
@@ -5954,7 +5962,7 @@ await client.taskGroups.updateV1({
|
|
|
5954
5962
|
</dl>
|
|
5955
5963
|
</details>
|
|
5956
5964
|
|
|
5957
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
5965
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">setFlightNumberV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
5958
5966
|
<dl>
|
|
5959
5967
|
<dd>
|
|
5960
5968
|
|
|
@@ -5966,7 +5974,7 @@ await client.taskGroups.updateV1({
|
|
|
5966
5974
|
<dl>
|
|
5967
5975
|
<dd>
|
|
5968
5976
|
|
|
5969
|
-
|
|
5977
|
+
Updates the flight number on both task group and all its tasks. Task group must be in STAGED or IN_PROGRESS status. | authz_personas=[lig_org_operators] | (SetFlightNumberReq) -> (bool)
|
|
5970
5978
|
|
|
5971
5979
|
</dd>
|
|
5972
5980
|
</dl>
|
|
@@ -5982,7 +5990,9 @@ Starts a task group by changing its status to in-progress and updating the order
|
|
|
5982
5990
|
<dd>
|
|
5983
5991
|
|
|
5984
5992
|
```typescript
|
|
5985
|
-
await client.taskGroups.
|
|
5993
|
+
await client.taskGroups.setFlightNumberV1("task_group_id", {
|
|
5994
|
+
flight_number: "flight_number",
|
|
5995
|
+
});
|
|
5986
5996
|
```
|
|
5987
5997
|
|
|
5988
5998
|
</dd>
|
|
@@ -6006,6 +6016,14 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6006
6016
|
<dl>
|
|
6007
6017
|
<dd>
|
|
6008
6018
|
|
|
6019
|
+
**request:** `Chrt.SetFlightNumberReq`
|
|
6020
|
+
|
|
6021
|
+
</dd>
|
|
6022
|
+
</dl>
|
|
6023
|
+
|
|
6024
|
+
<dl>
|
|
6025
|
+
<dd>
|
|
6026
|
+
|
|
6009
6027
|
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6010
6028
|
|
|
6011
6029
|
</dd>
|
|
@@ -6017,7 +6035,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6017
6035
|
</dl>
|
|
6018
6036
|
</details>
|
|
6019
6037
|
|
|
6020
|
-
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">
|
|
6038
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6021
6039
|
<dl>
|
|
6022
6040
|
<dd>
|
|
6023
6041
|
|
|
@@ -6029,7 +6047,7 @@ await client.taskGroups.startV1("task_group_id");
|
|
|
6029
6047
|
<dl>
|
|
6030
6048
|
<dd>
|
|
6031
6049
|
|
|
6032
|
-
|
|
6050
|
+
Sets or removes the driver assigned to a task group. | authz_personas=[courier_org_operators] | (UpdateTaskGroupDriverReq) -> (bool)
|
|
6033
6051
|
|
|
6034
6052
|
</dd>
|
|
6035
6053
|
</dl>
|
|
@@ -6045,10 +6063,7 @@ Toggles the pause status of an in-progress task group. | (SetTaskGroupPauseReq)
|
|
|
6045
6063
|
<dd>
|
|
6046
6064
|
|
|
6047
6065
|
```typescript
|
|
6048
|
-
await client.taskGroups.
|
|
6049
|
-
task_group_id: "task_group_id",
|
|
6050
|
-
paused: true,
|
|
6051
|
-
});
|
|
6066
|
+
await client.taskGroups.updateDriverV1("task_group_id");
|
|
6052
6067
|
```
|
|
6053
6068
|
|
|
6054
6069
|
</dd>
|
|
@@ -6064,15 +6079,149 @@ await client.taskGroups.togglePauseV1("id", {
|
|
|
6064
6079
|
<dl>
|
|
6065
6080
|
<dd>
|
|
6066
6081
|
|
|
6067
|
-
**
|
|
6082
|
+
**taskGroupId:** `string`
|
|
6083
|
+
|
|
6084
|
+
</dd>
|
|
6085
|
+
</dl>
|
|
6086
|
+
|
|
6087
|
+
<dl>
|
|
6088
|
+
<dd>
|
|
6089
|
+
|
|
6090
|
+
**request:** `Chrt.UpdateTaskGroupDriverReq`
|
|
6091
|
+
|
|
6092
|
+
</dd>
|
|
6093
|
+
</dl>
|
|
6094
|
+
|
|
6095
|
+
<dl>
|
|
6096
|
+
<dd>
|
|
6097
|
+
|
|
6098
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6099
|
+
|
|
6100
|
+
</dd>
|
|
6101
|
+
</dl>
|
|
6102
|
+
</dd>
|
|
6103
|
+
</dl>
|
|
6104
|
+
|
|
6105
|
+
</dd>
|
|
6106
|
+
</dl>
|
|
6107
|
+
</details>
|
|
6108
|
+
|
|
6109
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">updateCourierOrgV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
6110
|
+
<dl>
|
|
6111
|
+
<dd>
|
|
6112
|
+
|
|
6113
|
+
#### 📝 Description
|
|
6114
|
+
|
|
6115
|
+
<dl>
|
|
6116
|
+
<dd>
|
|
6117
|
+
|
|
6118
|
+
<dl>
|
|
6119
|
+
<dd>
|
|
6120
|
+
|
|
6121
|
+
Sets or removes the courier organization assigned to a task group. | authz_personas=[forwarder_org_operators] | (UpdateTaskGroupCourierOrgReq) -> (bool)
|
|
6122
|
+
|
|
6123
|
+
</dd>
|
|
6124
|
+
</dl>
|
|
6125
|
+
</dd>
|
|
6126
|
+
</dl>
|
|
6127
|
+
|
|
6128
|
+
#### 🔌 Usage
|
|
6129
|
+
|
|
6130
|
+
<dl>
|
|
6131
|
+
<dd>
|
|
6132
|
+
|
|
6133
|
+
<dl>
|
|
6134
|
+
<dd>
|
|
6135
|
+
|
|
6136
|
+
```typescript
|
|
6137
|
+
await client.taskGroups.updateCourierOrgV1("task_group_id");
|
|
6138
|
+
```
|
|
6139
|
+
|
|
6140
|
+
</dd>
|
|
6141
|
+
</dl>
|
|
6142
|
+
</dd>
|
|
6143
|
+
</dl>
|
|
6144
|
+
|
|
6145
|
+
#### ⚙️ Parameters
|
|
6146
|
+
|
|
6147
|
+
<dl>
|
|
6148
|
+
<dd>
|
|
6149
|
+
|
|
6150
|
+
<dl>
|
|
6151
|
+
<dd>
|
|
6152
|
+
|
|
6153
|
+
**taskGroupId:** `string`
|
|
6154
|
+
|
|
6155
|
+
</dd>
|
|
6156
|
+
</dl>
|
|
6157
|
+
|
|
6158
|
+
<dl>
|
|
6159
|
+
<dd>
|
|
6160
|
+
|
|
6161
|
+
**request:** `Chrt.UpdateTaskGroupCourierOrgReq`
|
|
6162
|
+
|
|
6163
|
+
</dd>
|
|
6164
|
+
</dl>
|
|
6165
|
+
|
|
6166
|
+
<dl>
|
|
6167
|
+
<dd>
|
|
6168
|
+
|
|
6169
|
+
**requestOptions:** `TaskGroups.RequestOptions`
|
|
6170
|
+
|
|
6171
|
+
</dd>
|
|
6172
|
+
</dl>
|
|
6173
|
+
</dd>
|
|
6174
|
+
</dl>
|
|
6175
|
+
|
|
6176
|
+
</dd>
|
|
6177
|
+
</dl>
|
|
6178
|
+
</details>
|
|
6179
|
+
|
|
6180
|
+
<details><summary><code>client.taskGroups.<a href="/src/api/resources/taskGroups/client/Client.ts">startV1</a>(taskGroupId) -> boolean</code></summary>
|
|
6181
|
+
<dl>
|
|
6182
|
+
<dd>
|
|
6183
|
+
|
|
6184
|
+
#### 📝 Description
|
|
6185
|
+
|
|
6186
|
+
<dl>
|
|
6187
|
+
<dd>
|
|
6188
|
+
|
|
6189
|
+
<dl>
|
|
6190
|
+
<dd>
|
|
6191
|
+
|
|
6192
|
+
Starts a task group by changing its status to in-progress and updating the order status. | authz_personas=[courier_driver, lig_org_operators] | () -> (bool)
|
|
6193
|
+
|
|
6194
|
+
</dd>
|
|
6195
|
+
</dl>
|
|
6196
|
+
</dd>
|
|
6197
|
+
</dl>
|
|
6198
|
+
|
|
6199
|
+
#### 🔌 Usage
|
|
6200
|
+
|
|
6201
|
+
<dl>
|
|
6202
|
+
<dd>
|
|
6203
|
+
|
|
6204
|
+
<dl>
|
|
6205
|
+
<dd>
|
|
6206
|
+
|
|
6207
|
+
```typescript
|
|
6208
|
+
await client.taskGroups.startV1("task_group_id");
|
|
6209
|
+
```
|
|
6068
6210
|
|
|
6069
6211
|
</dd>
|
|
6070
6212
|
</dl>
|
|
6213
|
+
</dd>
|
|
6214
|
+
</dl>
|
|
6215
|
+
|
|
6216
|
+
#### ⚙️ Parameters
|
|
6217
|
+
|
|
6218
|
+
<dl>
|
|
6219
|
+
<dd>
|
|
6071
6220
|
|
|
6072
6221
|
<dl>
|
|
6073
6222
|
<dd>
|
|
6074
6223
|
|
|
6075
|
-
**
|
|
6224
|
+
**taskGroupId:** `string`
|
|
6076
6225
|
|
|
6077
6226
|
</dd>
|
|
6078
6227
|
</dl>
|
|
@@ -6823,7 +6972,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
6823
6972
|
</dl>
|
|
6824
6973
|
</details>
|
|
6825
6974
|
|
|
6826
|
-
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) ->
|
|
6975
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">createOrgPublicDataV1</a>({ ...params }) -> Chrt.CreateOrgPublicDataRes</code></summary>
|
|
6827
6976
|
<dl>
|
|
6828
6977
|
<dd>
|
|
6829
6978
|
|
|
@@ -6835,7 +6984,7 @@ await client.orgs.getOrgPublicDataV1();
|
|
|
6835
6984
|
<dl>
|
|
6836
6985
|
<dd>
|
|
6837
6986
|
|
|
6838
|
-
Creates
|
|
6987
|
+
Creates org_public_data and org_private_data documents for the authenticated organization using org_type from JWT. | (CreateOrgPublicDataReq) -> (CreateOrgPublicDataRes)
|
|
6839
6988
|
|
|
6840
6989
|
</dd>
|
|
6841
6990
|
</dl>
|
|
@@ -6851,9 +7000,7 @@ Creates an org_public_data document for the authenticated organization. | (Creat
|
|
|
6851
7000
|
<dd>
|
|
6852
7001
|
|
|
6853
7002
|
```typescript
|
|
6854
|
-
await client.orgs.createOrgPublicDataV1(
|
|
6855
|
-
org_type: "courier",
|
|
6856
|
-
});
|
|
7003
|
+
await client.orgs.createOrgPublicDataV1();
|
|
6857
7004
|
```
|
|
6858
7005
|
|
|
6859
7006
|
</dd>
|
|
@@ -7077,6 +7224,71 @@ await client.orgs.getOrgPublicDataHandleAvailabilityV1("handle");
|
|
|
7077
7224
|
</dl>
|
|
7078
7225
|
</details>
|
|
7079
7226
|
|
|
7227
|
+
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">setOrgTypeV1</a>({ ...params }) -> boolean</code></summary>
|
|
7228
|
+
<dl>
|
|
7229
|
+
<dd>
|
|
7230
|
+
|
|
7231
|
+
#### 📝 Description
|
|
7232
|
+
|
|
7233
|
+
<dl>
|
|
7234
|
+
<dd>
|
|
7235
|
+
|
|
7236
|
+
<dl>
|
|
7237
|
+
<dd>
|
|
7238
|
+
|
|
7239
|
+
Sets the org_type in Clerk's JWT public metadata. Returns True if already set and matching, sets it if not present, or raises exception if conflicting. | (SetOrgTypeReq) -> (bool)
|
|
7240
|
+
|
|
7241
|
+
</dd>
|
|
7242
|
+
</dl>
|
|
7243
|
+
</dd>
|
|
7244
|
+
</dl>
|
|
7245
|
+
|
|
7246
|
+
#### 🔌 Usage
|
|
7247
|
+
|
|
7248
|
+
<dl>
|
|
7249
|
+
<dd>
|
|
7250
|
+
|
|
7251
|
+
<dl>
|
|
7252
|
+
<dd>
|
|
7253
|
+
|
|
7254
|
+
```typescript
|
|
7255
|
+
await client.orgs.setOrgTypeV1({
|
|
7256
|
+
org_type: "courier",
|
|
7257
|
+
});
|
|
7258
|
+
```
|
|
7259
|
+
|
|
7260
|
+
</dd>
|
|
7261
|
+
</dl>
|
|
7262
|
+
</dd>
|
|
7263
|
+
</dl>
|
|
7264
|
+
|
|
7265
|
+
#### ⚙️ Parameters
|
|
7266
|
+
|
|
7267
|
+
<dl>
|
|
7268
|
+
<dd>
|
|
7269
|
+
|
|
7270
|
+
<dl>
|
|
7271
|
+
<dd>
|
|
7272
|
+
|
|
7273
|
+
**request:** `Chrt.SetOrgTypeReq`
|
|
7274
|
+
|
|
7275
|
+
</dd>
|
|
7276
|
+
</dl>
|
|
7277
|
+
|
|
7278
|
+
<dl>
|
|
7279
|
+
<dd>
|
|
7280
|
+
|
|
7281
|
+
**requestOptions:** `Orgs.RequestOptions`
|
|
7282
|
+
|
|
7283
|
+
</dd>
|
|
7284
|
+
</dl>
|
|
7285
|
+
</dd>
|
|
7286
|
+
</dl>
|
|
7287
|
+
|
|
7288
|
+
</dd>
|
|
7289
|
+
</dl>
|
|
7290
|
+
</details>
|
|
7291
|
+
|
|
7080
7292
|
<details><summary><code>client.orgs.<a href="/src/api/resources/orgs/client/Client.ts">getStripeConnectAccountIdV1</a>() -> string</code></summary>
|
|
7081
7293
|
<dl>
|
|
7082
7294
|
<dd>
|
|
@@ -8204,6 +8416,77 @@ await client.orderDrafts.taskGroup.addV1({
|
|
|
8204
8416
|
</dl>
|
|
8205
8417
|
</details>
|
|
8206
8418
|
|
|
8419
|
+
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">updateV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
8420
|
+
<dl>
|
|
8421
|
+
<dd>
|
|
8422
|
+
|
|
8423
|
+
#### 📝 Description
|
|
8424
|
+
|
|
8425
|
+
<dl>
|
|
8426
|
+
<dd>
|
|
8427
|
+
|
|
8428
|
+
<dl>
|
|
8429
|
+
<dd>
|
|
8430
|
+
|
|
8431
|
+
Sets or removes courier org. Sets task ordering (must provide all task ids). | (UpdateTaskGroupDraftReq) -> (bool)
|
|
8432
|
+
|
|
8433
|
+
</dd>
|
|
8434
|
+
</dl>
|
|
8435
|
+
</dd>
|
|
8436
|
+
</dl>
|
|
8437
|
+
|
|
8438
|
+
#### 🔌 Usage
|
|
8439
|
+
|
|
8440
|
+
<dl>
|
|
8441
|
+
<dd>
|
|
8442
|
+
|
|
8443
|
+
<dl>
|
|
8444
|
+
<dd>
|
|
8445
|
+
|
|
8446
|
+
```typescript
|
|
8447
|
+
await client.orderDrafts.taskGroup.updateV1("task_group_id");
|
|
8448
|
+
```
|
|
8449
|
+
|
|
8450
|
+
</dd>
|
|
8451
|
+
</dl>
|
|
8452
|
+
</dd>
|
|
8453
|
+
</dl>
|
|
8454
|
+
|
|
8455
|
+
#### ⚙️ Parameters
|
|
8456
|
+
|
|
8457
|
+
<dl>
|
|
8458
|
+
<dd>
|
|
8459
|
+
|
|
8460
|
+
<dl>
|
|
8461
|
+
<dd>
|
|
8462
|
+
|
|
8463
|
+
**taskGroupId:** `string`
|
|
8464
|
+
|
|
8465
|
+
</dd>
|
|
8466
|
+
</dl>
|
|
8467
|
+
|
|
8468
|
+
<dl>
|
|
8469
|
+
<dd>
|
|
8470
|
+
|
|
8471
|
+
**request:** `Chrt.orderDrafts.UpdateTaskGroupDraftReq`
|
|
8472
|
+
|
|
8473
|
+
</dd>
|
|
8474
|
+
</dl>
|
|
8475
|
+
|
|
8476
|
+
<dl>
|
|
8477
|
+
<dd>
|
|
8478
|
+
|
|
8479
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
8480
|
+
|
|
8481
|
+
</dd>
|
|
8482
|
+
</dl>
|
|
8483
|
+
</dd>
|
|
8484
|
+
</dl>
|
|
8485
|
+
|
|
8486
|
+
</dd>
|
|
8487
|
+
</dl>
|
|
8488
|
+
</details>
|
|
8489
|
+
|
|
8207
8490
|
<details><summary><code>client.orderDrafts.taskGroup.<a href="/src/api/resources/orderDrafts/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
8208
8491
|
<dl>
|
|
8209
8492
|
<dd>
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* task_group_id: "task_group_id",
|
|
8
|
-
* paused: true
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
11
|
-
export interface SetTaskGroupPauseReq {
|
|
12
|
-
task_group_id: string;
|
|
13
|
-
paused: boolean;
|
|
14
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* task_group_id: "task_group_id"
|
|
8
|
-
* }
|
|
9
|
-
*/
|
|
10
|
-
export interface UpdateTaskGroupReq {
|
|
11
|
-
task_group_id: string;
|
|
12
|
-
set_driver_id?: string | null;
|
|
13
|
-
remove_driver?: boolean;
|
|
14
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* task_group_id: "task_group_id",
|
|
8
|
-
* paused: true
|
|
9
|
-
* }
|
|
10
|
-
*/
|
|
11
|
-
export interface SetTaskGroupPauseReq {
|
|
12
|
-
task_group_id: string;
|
|
13
|
-
paused: boolean;
|
|
14
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
-
*/
|
|
4
|
-
/**
|
|
5
|
-
* @example
|
|
6
|
-
* {
|
|
7
|
-
* task_group_id: "task_group_id"
|
|
8
|
-
* }
|
|
9
|
-
*/
|
|
10
|
-
export interface UpdateTaskGroupReq {
|
|
11
|
-
task_group_id: string;
|
|
12
|
-
set_driver_id?: string | null;
|
|
13
|
-
remove_driver?: boolean;
|
|
14
|
-
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|