@chrt-inc/typescript-sdk 1.563.0 → 1.576.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/orgs/client/Client.d.ts +3 -2
- package/dist/cjs/api/resources/orgs/client/Client.js +7 -3
- package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +4 -1
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +18 -6
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.js +6 -2
- package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.ts +3 -0
- package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/requests/ForwarderOrgProfileClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.ts +1 -0
- package/dist/cjs/api/resources/orgs/resources/publicData/client/requests/UpdateOrgPublicDataReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts +2 -2
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +4 -1
- package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +14 -2
- package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +9 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +7 -7
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +14 -14
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.js +14 -14
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +8 -8
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.js +6 -2
- package/dist/cjs/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.ts +3 -0
- package/dist/cjs/api/types/CourierOrgProfile1.d.ts +1 -0
- package/dist/cjs/api/types/CreateConnectionReq.d.ts +1 -0
- package/dist/cjs/api/types/DeviceLimitedForList1.d.ts +1 -0
- package/dist/cjs/api/types/ForwarderOrgProfile1.d.ts +1 -0
- package/dist/cjs/api/types/LineItemGroup1.d.ts +1 -0
- package/dist/cjs/api/types/Order1.d.ts +1 -0
- package/dist/cjs/api/types/OrderDraftExpanded.d.ts +1 -0
- package/dist/cjs/api/types/OrderExpanded.d.ts +1 -0
- package/dist/cjs/api/types/OrdersDraftUpdateRes.d.ts +1 -0
- package/dist/cjs/api/types/OrdersUpdateOffChrtReferenceIdRes.d.ts +1 -0
- package/dist/cjs/api/types/OrgPublicData1.d.ts +1 -0
- package/dist/cjs/api/types/Session1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
- package/dist/cjs/api/types/TaskGroupExpanded.d.ts +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/orgs/client/Client.d.mts +3 -2
- package/dist/esm/api/resources/orgs/client/Client.mjs +7 -3
- package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +4 -1
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +18 -6
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.mjs +6 -2
- package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.mts +3 -0
- package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/ForwarderOrgProfileClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.mts +1 -0
- package/dist/esm/api/resources/orgs/resources/publicData/client/requests/UpdateOrgPublicDataReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts +2 -2
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +4 -1
- package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +14 -2
- package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +9 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +7 -7
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +14 -14
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.mjs +14 -14
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +8 -8
- package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.mjs +6 -2
- package/dist/esm/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.mts +3 -0
- package/dist/esm/api/types/CourierOrgProfile1.d.mts +1 -0
- package/dist/esm/api/types/CreateConnectionReq.d.mts +1 -0
- package/dist/esm/api/types/DeviceLimitedForList1.d.mts +1 -0
- package/dist/esm/api/types/ForwarderOrgProfile1.d.mts +1 -0
- package/dist/esm/api/types/LineItemGroup1.d.mts +1 -0
- package/dist/esm/api/types/Order1.d.mts +1 -0
- package/dist/esm/api/types/OrderDraftExpanded.d.mts +1 -0
- package/dist/esm/api/types/OrderExpanded.d.mts +1 -0
- package/dist/esm/api/types/OrdersDraftUpdateRes.d.mts +1 -0
- package/dist/esm/api/types/OrdersUpdateOffChrtReferenceIdRes.d.mts +1 -0
- package/dist/esm/api/types/OrgPublicData1.d.mts +1 -0
- package/dist/esm/api/types/Session1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
- package/dist/esm/api/types/TaskGroupExpanded.d.mts +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 +36 -27
package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js
CHANGED
|
@@ -58,24 +58,24 @@ class Expanded {
|
|
|
58
58
|
/**
|
|
59
59
|
* Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
60
60
|
*
|
|
61
|
-
* @param {string}
|
|
61
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
62
62
|
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
63
63
|
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
66
66
|
*
|
|
67
67
|
* @example
|
|
68
|
-
* await client.shipping.orders.expanded.forShipperOperatorsV1("
|
|
68
|
+
* await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
|
|
69
69
|
*/
|
|
70
|
-
forShipperOperatorsV1(
|
|
71
|
-
return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(
|
|
70
|
+
forShipperOperatorsV1(orderRef, request, requestOptions) {
|
|
71
|
+
return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderRef, request, requestOptions));
|
|
72
72
|
}
|
|
73
|
-
__forShipperOperatorsV1(
|
|
73
|
+
__forShipperOperatorsV1(orderRef, request, requestOptions) {
|
|
74
74
|
return __awaiter(this, void 0, void 0, function* () {
|
|
75
75
|
var _a, _b, _c, _d;
|
|
76
76
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
77
77
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
78
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_shipper_operators/v1/${encodeURIComponent(
|
|
78
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_shipper_operators/v1/${encodeURIComponent(orderRef)}`),
|
|
79
79
|
method: "POST",
|
|
80
80
|
headers: _headers,
|
|
81
81
|
contentType: "application/json",
|
|
@@ -109,7 +109,7 @@ class Expanded {
|
|
|
109
109
|
rawResponse: _response.rawResponse,
|
|
110
110
|
});
|
|
111
111
|
case "timeout":
|
|
112
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{
|
|
112
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{order_ref}.");
|
|
113
113
|
case "unknown":
|
|
114
114
|
throw new errors.ChrtError({
|
|
115
115
|
message: _response.error.errorMessage,
|
|
@@ -121,24 +121,24 @@ class Expanded {
|
|
|
121
121
|
/**
|
|
122
122
|
* Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
|
|
123
123
|
*
|
|
124
|
-
* @param {string}
|
|
124
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
125
125
|
* @param {Chrt.OrderAndTaskGroupExpandedReq} request
|
|
126
126
|
* @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
|
|
127
127
|
*
|
|
128
128
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
129
129
|
*
|
|
130
130
|
* @example
|
|
131
|
-
* await client.shipping.orders.expanded.forForwarderOperatorsV1("
|
|
131
|
+
* await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
|
|
132
132
|
*/
|
|
133
|
-
forForwarderOperatorsV1(
|
|
134
|
-
return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(
|
|
133
|
+
forForwarderOperatorsV1(orderRef, request, requestOptions) {
|
|
134
|
+
return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderRef, request, requestOptions));
|
|
135
135
|
}
|
|
136
|
-
__forForwarderOperatorsV1(
|
|
136
|
+
__forForwarderOperatorsV1(orderRef, request, requestOptions) {
|
|
137
137
|
return __awaiter(this, void 0, void 0, function* () {
|
|
138
138
|
var _a, _b, _c, _d;
|
|
139
139
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
140
140
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
141
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_forwarder_operators/v1/${encodeURIComponent(
|
|
141
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/orders/expanded/for_forwarder_operators/v1/${encodeURIComponent(orderRef)}`),
|
|
142
142
|
method: "POST",
|
|
143
143
|
headers: _headers,
|
|
144
144
|
contentType: "application/json",
|
|
@@ -172,7 +172,7 @@ class Expanded {
|
|
|
172
172
|
rawResponse: _response.rawResponse,
|
|
173
173
|
});
|
|
174
174
|
case "timeout":
|
|
175
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{
|
|
175
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{order_ref}.");
|
|
176
176
|
case "unknown":
|
|
177
177
|
throw new errors.ChrtError({
|
|
178
178
|
message: _response.error.errorMessage,
|
|
@@ -32,28 +32,28 @@ export declare class TaskGroupId {
|
|
|
32
32
|
/**
|
|
33
33
|
* Retrieves the task group IDs for the courier organization assigned to an order's task groups. | authz_personas=[courier_org_operators] | () -> (list[PydanticObjectId])
|
|
34
34
|
*
|
|
35
|
-
* @param {string}
|
|
35
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
36
36
|
* @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
37
|
*
|
|
38
38
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
39
39
|
*
|
|
40
40
|
* @example
|
|
41
|
-
* await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("
|
|
41
|
+
* await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref")
|
|
42
42
|
*/
|
|
43
|
-
forCourierOperatorsV1(
|
|
43
|
+
forCourierOperatorsV1(orderRef: string, requestOptions?: TaskGroupId.RequestOptions): core.HttpResponsePromise<string[]>;
|
|
44
44
|
private __forCourierOperatorsV1;
|
|
45
45
|
/**
|
|
46
46
|
* Retrieves the task group IDs for the courier driver assigned to an order's task groups. | authz_personas=[courier_driver] | () -> (list[PydanticObjectId])
|
|
47
47
|
*
|
|
48
|
-
* @param {string}
|
|
48
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
49
49
|
* @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
|
|
50
50
|
*
|
|
51
51
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
52
52
|
*
|
|
53
53
|
* @example
|
|
54
|
-
* await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("
|
|
54
|
+
* await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref")
|
|
55
55
|
*/
|
|
56
|
-
forCourierDriverV1(
|
|
56
|
+
forCourierDriverV1(orderRef: string, requestOptions?: TaskGroupId.RequestOptions): core.HttpResponsePromise<string[]>;
|
|
57
57
|
private __forCourierDriverV1;
|
|
58
58
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
59
59
|
}
|
package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.js
CHANGED
|
@@ -58,23 +58,23 @@ class TaskGroupId {
|
|
|
58
58
|
/**
|
|
59
59
|
* Retrieves the task group IDs for the courier organization assigned to an order's task groups. | authz_personas=[courier_org_operators] | () -> (list[PydanticObjectId])
|
|
60
60
|
*
|
|
61
|
-
* @param {string}
|
|
61
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
62
62
|
* @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
|
-
* await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("
|
|
67
|
+
* await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref")
|
|
68
68
|
*/
|
|
69
|
-
forCourierOperatorsV1(
|
|
70
|
-
return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(
|
|
69
|
+
forCourierOperatorsV1(orderRef, requestOptions) {
|
|
70
|
+
return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(orderRef, requestOptions));
|
|
71
71
|
}
|
|
72
|
-
__forCourierOperatorsV1(
|
|
72
|
+
__forCourierOperatorsV1(orderRef, requestOptions) {
|
|
73
73
|
return __awaiter(this, void 0, void 0, function* () {
|
|
74
74
|
var _a, _b, _c, _d;
|
|
75
75
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
76
76
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
77
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/task_groups/task_group_id/for_courier_operators/v1/${encodeURIComponent(
|
|
77
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/task_groups/task_group_id/for_courier_operators/v1/${encodeURIComponent(orderRef)}`),
|
|
78
78
|
method: "GET",
|
|
79
79
|
headers: _headers,
|
|
80
80
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -105,7 +105,7 @@ class TaskGroupId {
|
|
|
105
105
|
rawResponse: _response.rawResponse,
|
|
106
106
|
});
|
|
107
107
|
case "timeout":
|
|
108
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_operators/v1/{
|
|
108
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_operators/v1/{order_ref}.");
|
|
109
109
|
case "unknown":
|
|
110
110
|
throw new errors.ChrtError({
|
|
111
111
|
message: _response.error.errorMessage,
|
|
@@ -117,23 +117,23 @@ class TaskGroupId {
|
|
|
117
117
|
/**
|
|
118
118
|
* Retrieves the task group IDs for the courier driver assigned to an order's task groups. | authz_personas=[courier_driver] | () -> (list[PydanticObjectId])
|
|
119
119
|
*
|
|
120
|
-
* @param {string}
|
|
120
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
121
121
|
* @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
|
|
122
122
|
*
|
|
123
123
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
124
124
|
*
|
|
125
125
|
* @example
|
|
126
|
-
* await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("
|
|
126
|
+
* await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref")
|
|
127
127
|
*/
|
|
128
|
-
forCourierDriverV1(
|
|
129
|
-
return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(
|
|
128
|
+
forCourierDriverV1(orderRef, requestOptions) {
|
|
129
|
+
return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(orderRef, requestOptions));
|
|
130
130
|
}
|
|
131
|
-
__forCourierDriverV1(
|
|
131
|
+
__forCourierDriverV1(orderRef, requestOptions) {
|
|
132
132
|
return __awaiter(this, void 0, void 0, function* () {
|
|
133
133
|
var _a, _b, _c, _d;
|
|
134
134
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
135
135
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
136
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/task_groups/task_group_id/for_courier_driver/v1/${encodeURIComponent(
|
|
136
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `shipping/task_groups/task_group_id/for_courier_driver/v1/${encodeURIComponent(orderRef)}`),
|
|
137
137
|
method: "GET",
|
|
138
138
|
headers: _headers,
|
|
139
139
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -164,7 +164,7 @@ class TaskGroupId {
|
|
|
164
164
|
rawResponse: _response.rawResponse,
|
|
165
165
|
});
|
|
166
166
|
case "timeout":
|
|
167
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_driver/v1/{
|
|
167
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_driver/v1/{order_ref}.");
|
|
168
168
|
case "unknown":
|
|
169
169
|
throw new errors.ChrtError({
|
|
170
170
|
message: _response.error.errorMessage,
|
package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.ts
CHANGED
|
@@ -14,5 +14,6 @@ export interface DeviceClientCreate1 {
|
|
|
14
14
|
device_mac_address: string;
|
|
15
15
|
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
16
16
|
comments?: string | null;
|
|
17
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
17
18
|
off_chrt_reference_id?: string | null;
|
|
18
19
|
}
|
package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ export interface DeviceClientUpdate1 {
|
|
|
12
12
|
device_id: string;
|
|
13
13
|
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
14
14
|
comments?: string | null;
|
|
15
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
15
16
|
off_chrt_reference_id?: string | null;
|
|
16
17
|
type__set_to_None?: boolean;
|
|
17
18
|
comments__set_to_None?: boolean;
|
package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export interface SessionClientCreate1 {
|
|
|
13
13
|
device_id: string;
|
|
14
14
|
no_auto_termination?: boolean | null;
|
|
15
15
|
schema_version: number;
|
|
16
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
16
17
|
off_chrt_reference_id?: string | null;
|
|
17
18
|
comments?: string | null;
|
|
18
19
|
public?: boolean;
|
package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
export interface SessionClientUpdate1 {
|
|
11
11
|
session_id: string;
|
|
12
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
12
13
|
off_chrt_reference_id?: string | null;
|
|
13
14
|
comments?: string | null;
|
|
14
15
|
public?: boolean | null;
|
|
@@ -84,17 +84,17 @@ export declare class SharingSettings {
|
|
|
84
84
|
cargoByDeviceSettingsV1(request: Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.CargoByDeviceSharingSettings1>;
|
|
85
85
|
private __cargoByDeviceSettingsV1;
|
|
86
86
|
/**
|
|
87
|
-
* Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. | () -> (list[TrackingSharingSettingsRes])
|
|
87
|
+
* Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. Note: looking up by off_chrt_reference_id requires authentication because it is only org-level unique and needs the caller's org_id to resolve unambiguously. | () -> (list[TrackingSharingSettingsRes])
|
|
88
88
|
*
|
|
89
|
-
* @param {string}
|
|
89
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
90
90
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
91
91
|
*
|
|
92
92
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
93
93
|
*
|
|
94
94
|
* @example
|
|
95
|
-
* await client.tracking.sharingSettings.getSettingsV1("
|
|
95
|
+
* await client.tracking.sharingSettings.getSettingsV1("order_ref")
|
|
96
96
|
*/
|
|
97
|
-
getSettingsV1(
|
|
97
|
+
getSettingsV1(orderRef: string, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSharingSettingsRes[]>;
|
|
98
98
|
private __getSettingsV1;
|
|
99
99
|
protected _getAuthorizationHeader(): Promise<string | undefined>;
|
|
100
100
|
}
|
|
@@ -259,25 +259,25 @@ class SharingSettings {
|
|
|
259
259
|
});
|
|
260
260
|
}
|
|
261
261
|
/**
|
|
262
|
-
* Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. | () -> (list[TrackingSharingSettingsRes])
|
|
262
|
+
* Get all tracking datasets and their sharing settings for a given order. If authenticated, returns datasets the user has direct access to plus public datasets. If unauthenticated, returns only datasets with public=True. Note: looking up by off_chrt_reference_id requires authentication because it is only org-level unique and needs the caller's org_id to resolve unambiguously. | () -> (list[TrackingSharingSettingsRes])
|
|
263
263
|
*
|
|
264
|
-
* @param {string}
|
|
264
|
+
* @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
|
|
265
265
|
* @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
|
|
266
266
|
*
|
|
267
267
|
* @throws {@link Chrt.UnprocessableEntityError}
|
|
268
268
|
*
|
|
269
269
|
* @example
|
|
270
|
-
* await client.tracking.sharingSettings.getSettingsV1("
|
|
270
|
+
* await client.tracking.sharingSettings.getSettingsV1("order_ref")
|
|
271
271
|
*/
|
|
272
|
-
getSettingsV1(
|
|
273
|
-
return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(
|
|
272
|
+
getSettingsV1(orderRef, requestOptions) {
|
|
273
|
+
return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(orderRef, requestOptions));
|
|
274
274
|
}
|
|
275
|
-
__getSettingsV1(
|
|
275
|
+
__getSettingsV1(orderRef, requestOptions) {
|
|
276
276
|
return __awaiter(this, void 0, void 0, function* () {
|
|
277
277
|
var _a, _b, _c, _d;
|
|
278
278
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
279
279
|
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
280
|
-
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `tracking/sharing_settings/by_order/v1/${encodeURIComponent(
|
|
280
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ChrtEnvironment.Local, `tracking/sharing_settings/by_order/v1/${encodeURIComponent(orderRef)}`),
|
|
281
281
|
method: "GET",
|
|
282
282
|
headers: _headers,
|
|
283
283
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -308,7 +308,7 @@ class SharingSettings {
|
|
|
308
308
|
rawResponse: _response.rawResponse,
|
|
309
309
|
});
|
|
310
310
|
case "timeout":
|
|
311
|
-
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sharing_settings/by_order/v1/{
|
|
311
|
+
throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sharing_settings/by_order/v1/{order_ref}.");
|
|
312
312
|
case "unknown":
|
|
313
313
|
throw new errors.ChrtError({
|
|
314
314
|
message: _response.error.errorMessage,
|
|
@@ -44,7 +44,7 @@ export declare class DirectoryEntries {
|
|
|
44
44
|
getV1(directoryEntryId: string, requestOptions?: DirectoryEntries.RequestOptions): core.HttpResponsePromise<Chrt.DirectoryEntry1>;
|
|
45
45
|
private __getV1;
|
|
46
46
|
/**
|
|
47
|
-
* Lists directory entries with pagination and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
47
|
+
* Lists directory entries with pagination, optional filtering by entry_org_id, and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
48
48
|
*
|
|
49
49
|
* @param {Chrt.users.DirectoryEntriesListV1Request} request
|
|
50
50
|
* @param {DirectoryEntries.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -54,6 +54,7 @@ export declare class DirectoryEntries {
|
|
|
54
54
|
* @example
|
|
55
55
|
* await client.users.directoryEntries.listV1({
|
|
56
56
|
* search: "search",
|
|
57
|
+
* filter_entry_org_id: "filter_entry_org_id",
|
|
57
58
|
* sort_by: "company_name",
|
|
58
59
|
* sort_order: "asc",
|
|
59
60
|
* page: 1,
|
|
@@ -115,7 +115,7 @@ class DirectoryEntries {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Lists directory entries with pagination and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
118
|
+
* Lists directory entries with pagination, optional filtering by entry_org_id, and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
|
|
119
119
|
*
|
|
120
120
|
* @param {Chrt.users.DirectoryEntriesListV1Request} request
|
|
121
121
|
* @param {DirectoryEntries.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -125,6 +125,7 @@ class DirectoryEntries {
|
|
|
125
125
|
* @example
|
|
126
126
|
* await client.users.directoryEntries.listV1({
|
|
127
127
|
* search: "search",
|
|
128
|
+
* filter_entry_org_id: "filter_entry_org_id",
|
|
128
129
|
* sort_by: "company_name",
|
|
129
130
|
* sort_order: "asc",
|
|
130
131
|
* page: 1,
|
|
@@ -137,11 +138,14 @@ class DirectoryEntries {
|
|
|
137
138
|
__listV1() {
|
|
138
139
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
139
140
|
var _a, _b, _c, _d, _e, _f;
|
|
140
|
-
const { search, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize } = request;
|
|
141
|
+
const { search, filter_entry_org_id: filterEntryOrgId, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
|
|
141
142
|
const _queryParams = {};
|
|
142
143
|
if (search !== undefined) {
|
|
143
144
|
_queryParams["search"] = search;
|
|
144
145
|
}
|
|
146
|
+
if (filterEntryOrgId !== undefined) {
|
|
147
|
+
_queryParams["filter_entry_org_id"] = filterEntryOrgId;
|
|
148
|
+
}
|
|
145
149
|
if (sortBy !== undefined) {
|
|
146
150
|
_queryParams["sort_by"] = sortBy;
|
|
147
151
|
}
|
|
@@ -6,6 +6,7 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
8
|
* search: "search",
|
|
9
|
+
* filter_entry_org_id: "filter_entry_org_id",
|
|
9
10
|
* sort_by: "company_name",
|
|
10
11
|
* sort_order: "asc",
|
|
11
12
|
* page: 1,
|
|
@@ -15,6 +16,8 @@ import * as Chrt from "../../../../../../index.js";
|
|
|
15
16
|
export interface DirectoryEntriesListV1Request {
|
|
16
17
|
/** Full-text search query */
|
|
17
18
|
search?: string | null;
|
|
19
|
+
/** Filter by the org this entry belongs to */
|
|
20
|
+
filter_entry_org_id?: string | null;
|
|
18
21
|
/** Field to sort by */
|
|
19
22
|
sort_by?: Chrt.DirectoryEntrySortByEnum | null;
|
|
20
23
|
/** Sort order (asc or desc) */
|
|
@@ -5,6 +5,7 @@ export interface CourierOrgProfile1 {
|
|
|
5
5
|
schema_version: number;
|
|
6
6
|
description: string;
|
|
7
7
|
email_address_primary: string;
|
|
8
|
+
/** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
|
|
8
9
|
phone_number_primary: string;
|
|
9
10
|
/** Must be a string starting with `org_` */
|
|
10
11
|
org_id: string;
|
|
@@ -18,6 +18,7 @@ export interface DeviceLimitedForList1 {
|
|
|
18
18
|
device_token?: string | null;
|
|
19
19
|
type?: Chrt.TrackingDeviceTypeEnum1 | null;
|
|
20
20
|
comments?: string | null;
|
|
21
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
21
22
|
off_chrt_reference_id?: string | null;
|
|
22
23
|
registered_at_timestamp?: string | null;
|
|
23
24
|
first_seen_at_timestamp?: string | null;
|
|
@@ -5,6 +5,7 @@ export interface ForwarderOrgProfile1 {
|
|
|
5
5
|
schema_version: number;
|
|
6
6
|
description: string;
|
|
7
7
|
email_address_primary: string;
|
|
8
|
+
/** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
|
|
8
9
|
phone_number_primary: string;
|
|
9
10
|
/** Must be a string starting with `org_` */
|
|
10
11
|
org_id: string;
|
|
@@ -9,6 +9,7 @@ export interface LineItemGroup1 {
|
|
|
9
9
|
task_group_id?: string | null;
|
|
10
10
|
order_id?: string | null;
|
|
11
11
|
order_short_id?: string | null;
|
|
12
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
12
13
|
order_off_chrt_reference_id?: string | null;
|
|
13
14
|
rate_sheet_id?: string | null;
|
|
14
15
|
line_items: Chrt.LineItem1[];
|
|
@@ -7,6 +7,7 @@ export interface Order1 {
|
|
|
7
7
|
_id: string;
|
|
8
8
|
short_id: string;
|
|
9
9
|
task_group_ids?: string[];
|
|
10
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
10
11
|
off_chrt_reference_id?: string | null;
|
|
11
12
|
created_by_org_type: Chrt.OrgTypeEnum;
|
|
12
13
|
/** Must be a string starting with `org_` */
|
|
@@ -5,6 +5,7 @@ import * as Chrt from "../index.js";
|
|
|
5
5
|
export interface OrderDraftExpanded {
|
|
6
6
|
order: Chrt.Order1;
|
|
7
7
|
forwarder_org_company_name?: string | null;
|
|
8
|
+
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
8
9
|
forwarder_org_handle?: string | null;
|
|
9
10
|
shipper_org_company_name?: string | null;
|
|
10
11
|
off_chrt_shipper_org_company_name?: string | null;
|
|
@@ -5,6 +5,7 @@ import * as Chrt from "../index.js";
|
|
|
5
5
|
export interface OrderExpanded {
|
|
6
6
|
order: Chrt.Order1;
|
|
7
7
|
forwarder_org_company_name?: string | null;
|
|
8
|
+
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
8
9
|
forwarder_org_handle?: string | null;
|
|
9
10
|
shipper_org_company_name?: string | null;
|
|
10
11
|
off_chrt_shipper_org_company_name?: string | null;
|
|
@@ -9,5 +9,6 @@ export interface OrdersDraftUpdateRes {
|
|
|
9
9
|
/** Must be a string starting with `org_` */
|
|
10
10
|
shipper_org_id?: string | null;
|
|
11
11
|
off_chrt_shipper_org_id?: string | null;
|
|
12
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
12
13
|
off_chrt_reference_id?: string | null;
|
|
13
14
|
}
|
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface OrdersUpdateOffChrtReferenceIdRes {
|
|
5
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
5
6
|
off_chrt_reference_id?: string | null;
|
|
6
7
|
}
|
|
@@ -8,6 +8,7 @@ export interface OrgPublicData1 {
|
|
|
8
8
|
/** Must be a string starting with `org_` */
|
|
9
9
|
org_id: string;
|
|
10
10
|
company_name?: string | null;
|
|
11
|
+
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
11
12
|
handle?: string | null;
|
|
12
13
|
_id: string;
|
|
13
14
|
}
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
import * as Chrt from "../index.js";
|
|
5
5
|
export interface Session1 {
|
|
6
6
|
schema_version: number;
|
|
7
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
7
8
|
off_chrt_reference_id?: string | null;
|
|
8
9
|
comments?: string | null;
|
|
9
10
|
public?: boolean;
|
|
@@ -7,6 +7,7 @@ export interface TaskGroup1 {
|
|
|
7
7
|
_id: string;
|
|
8
8
|
order_id: string;
|
|
9
9
|
order_short_id: string;
|
|
10
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
10
11
|
order_off_chrt_reference_id?: string | null;
|
|
11
12
|
task_ids?: string[];
|
|
12
13
|
/** Must be a string starting with `org_` */
|
|
@@ -7,8 +7,10 @@ export interface TaskGroupExpanded {
|
|
|
7
7
|
tasks_expanded?: Chrt.TaskExpanded[] | null;
|
|
8
8
|
driver?: Chrt.Driver1 | null;
|
|
9
9
|
courier_org_company_name?: string | null;
|
|
10
|
+
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
10
11
|
courier_org_handle?: string | null;
|
|
11
12
|
forwarder_org_company_name?: string | null;
|
|
13
|
+
/** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
|
|
12
14
|
forwarder_org_handle?: string | null;
|
|
13
15
|
shipper_org_company_name?: string | null;
|
|
14
16
|
off_chrt_shipper_org_company_name?: string | null;
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.576.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -17,8 +17,8 @@ export class ChrtClient {
|
|
|
17
17
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
18
18
|
"X-Fern-Language": "JavaScript",
|
|
19
19
|
"X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
|
|
20
|
-
"X-Fern-SDK-Version": "1.
|
|
21
|
-
"User-Agent": "@chrt-inc/typescript-sdk/1.
|
|
20
|
+
"X-Fern-SDK-Version": "1.576.0",
|
|
21
|
+
"User-Agent": "@chrt-inc/typescript-sdk/1.576.0",
|
|
22
22
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
23
23
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
24
24
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -59,7 +59,7 @@ export declare class Orgs {
|
|
|
59
59
|
getInfoV1(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgInfoResponse>;
|
|
60
60
|
private __getInfoV1;
|
|
61
61
|
/**
|
|
62
|
-
* Lists all members of the caller's organization with their roles and details. | () -> (OrgMemberListRes)
|
|
62
|
+
* Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
|
|
63
63
|
*
|
|
64
64
|
* @param {Chrt.OrgsListMembersV1Request} request
|
|
65
65
|
* @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -71,7 +71,8 @@ export declare class Orgs {
|
|
|
71
71
|
* sort_by: "first_name",
|
|
72
72
|
* sort_order: "asc",
|
|
73
73
|
* page: 1,
|
|
74
|
-
* page_size: 1
|
|
74
|
+
* page_size: 1,
|
|
75
|
+
* search: "search"
|
|
75
76
|
* })
|
|
76
77
|
*/
|
|
77
78
|
listMembersV1(request?: Chrt.OrgsListMembersV1Request, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgMemberListRes>;
|
|
@@ -101,7 +101,7 @@ export class Orgs {
|
|
|
101
101
|
});
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
* Lists all members of the caller's organization with their roles and details. | () -> (OrgMemberListRes)
|
|
104
|
+
* Lists all members of the caller's organization with their roles and details. Supports search by name, filtering by role, sorting, and pagination. | () -> (OrgMemberListRes)
|
|
105
105
|
*
|
|
106
106
|
* @param {Chrt.OrgsListMembersV1Request} request
|
|
107
107
|
* @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -113,7 +113,8 @@ export class Orgs {
|
|
|
113
113
|
* sort_by: "first_name",
|
|
114
114
|
* sort_order: "asc",
|
|
115
115
|
* page: 1,
|
|
116
|
-
* page_size: 1
|
|
116
|
+
* page_size: 1,
|
|
117
|
+
* search: "search"
|
|
117
118
|
* })
|
|
118
119
|
*/
|
|
119
120
|
listMembersV1(request = {}, requestOptions) {
|
|
@@ -122,7 +123,7 @@ export class Orgs {
|
|
|
122
123
|
__listMembersV1() {
|
|
123
124
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
124
125
|
var _a, _b, _c, _d, _e, _f;
|
|
125
|
-
const { filter_role: filterRole, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize } = request;
|
|
126
|
+
const { filter_role: filterRole, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, search, } = request;
|
|
126
127
|
const _queryParams = {};
|
|
127
128
|
if (filterRole !== undefined) {
|
|
128
129
|
if (Array.isArray(filterRole)) {
|
|
@@ -144,6 +145,9 @@ export class Orgs {
|
|
|
144
145
|
if (pageSize !== undefined) {
|
|
145
146
|
_queryParams["page_size"] = (_b = pageSize === null || pageSize === void 0 ? void 0 : pageSize.toString()) !== null && _b !== void 0 ? _b : null;
|
|
146
147
|
}
|
|
148
|
+
if (search !== undefined) {
|
|
149
|
+
_queryParams["search"] = search;
|
|
150
|
+
}
|
|
147
151
|
let _headers = mergeHeaders((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
148
152
|
const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
|
|
149
153
|
url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ChrtEnvironment.Local, "orgs/members/list/v1"),
|
|
@@ -8,7 +8,8 @@ import * as Chrt from "../../../../index.mjs";
|
|
|
8
8
|
* sort_by: "first_name",
|
|
9
9
|
* sort_order: "asc",
|
|
10
10
|
* page: 1,
|
|
11
|
-
* page_size: 1
|
|
11
|
+
* page_size: 1,
|
|
12
|
+
* search: "search"
|
|
12
13
|
* }
|
|
13
14
|
*/
|
|
14
15
|
export interface OrgsListMembersV1Request {
|
|
@@ -20,4 +21,6 @@ export interface OrgsListMembersV1Request {
|
|
|
20
21
|
sort_order?: Chrt.SortOrderEnum | null;
|
|
21
22
|
page?: number | null;
|
|
22
23
|
page_size?: number | null;
|
|
24
|
+
/** Search by first or last name */
|
|
25
|
+
search?: string | null;
|
|
23
26
|
}
|