@chrt-inc/typescript-sdk 1.575.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/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/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.ts +1 -0
- 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/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/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/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.mts +1 -0
- 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/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 +16 -7
|
@@ -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
|
}
|
|
@@ -31,7 +31,7 @@ export declare class Connections {
|
|
|
31
31
|
protected readonly _options: Connections.Options;
|
|
32
32
|
constructor(_options?: Connections.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Lists shipper organizations based on the caller's organization type
|
|
34
|
+
* Lists shipper organizations based on the caller's organization type with optional search by company name or handle. | () -> (ShipperConnectionListRes)
|
|
35
35
|
*
|
|
36
36
|
* @param {Chrt.orgs.ConnectionsListShippersV1Request} request
|
|
37
37
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -40,6 +40,7 @@ export declare class Connections {
|
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
42
|
* await client.orgs.connections.listShippersV1({
|
|
43
|
+
* search: "search",
|
|
43
44
|
* page: 1,
|
|
44
45
|
* page_size: 1
|
|
45
46
|
* })
|
|
@@ -47,7 +48,7 @@ export declare class Connections {
|
|
|
47
48
|
listShippersV1(request?: Chrt.orgs.ConnectionsListShippersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.ShipperConnectionListRes>;
|
|
48
49
|
private __listShippersV1;
|
|
49
50
|
/**
|
|
50
|
-
* Lists courier organizations based on the caller's organization type
|
|
51
|
+
* Lists courier organizations based on the caller's organization type with optional search by company name or handle. | () -> (CourierConnectionListRes)
|
|
51
52
|
*
|
|
52
53
|
* @param {Chrt.orgs.ConnectionsListCouriersV1Request} request
|
|
53
54
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,6 +57,7 @@ export declare class Connections {
|
|
|
56
57
|
*
|
|
57
58
|
* @example
|
|
58
59
|
* await client.orgs.connections.listCouriersV1({
|
|
60
|
+
* search: "search",
|
|
59
61
|
* page: 1,
|
|
60
62
|
* page_size: 1
|
|
61
63
|
* })
|
|
@@ -63,7 +65,7 @@ export declare class Connections {
|
|
|
63
65
|
listCouriersV1(request?: Chrt.orgs.ConnectionsListCouriersV1Request, requestOptions?: Connections.RequestOptions): core.HttpResponsePromise<Chrt.CourierConnectionListRes>;
|
|
64
66
|
private __listCouriersV1;
|
|
65
67
|
/**
|
|
66
|
-
* Lists forwarder organizations based on the caller's organization type
|
|
68
|
+
* Lists forwarder organizations based on the caller's organization type with optional search by company name or handle. | () -> (ForwarderConnectionListRes)
|
|
67
69
|
*
|
|
68
70
|
* @param {Chrt.orgs.ConnectionsListForwardersV1Request} request
|
|
69
71
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -72,6 +74,7 @@ export declare class Connections {
|
|
|
72
74
|
*
|
|
73
75
|
* @example
|
|
74
76
|
* await client.orgs.connections.listForwardersV1({
|
|
77
|
+
* search: "search",
|
|
75
78
|
* page: 1,
|
|
76
79
|
* page_size: 1
|
|
77
80
|
* })
|
|
@@ -20,7 +20,7 @@ export class Connections {
|
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Lists shipper organizations based on the caller's organization type
|
|
23
|
+
* Lists shipper organizations based on the caller's organization type with optional search by company name or handle. | () -> (ShipperConnectionListRes)
|
|
24
24
|
*
|
|
25
25
|
* @param {Chrt.orgs.ConnectionsListShippersV1Request} request
|
|
26
26
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -29,6 +29,7 @@ export class Connections {
|
|
|
29
29
|
*
|
|
30
30
|
* @example
|
|
31
31
|
* await client.orgs.connections.listShippersV1({
|
|
32
|
+
* search: "search",
|
|
32
33
|
* page: 1,
|
|
33
34
|
* page_size: 1
|
|
34
35
|
* })
|
|
@@ -39,8 +40,11 @@ export class Connections {
|
|
|
39
40
|
__listShippersV1() {
|
|
40
41
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
41
42
|
var _a, _b, _c, _d, _e, _f;
|
|
42
|
-
const { page, page_size: pageSize } = request;
|
|
43
|
+
const { search, page, page_size: pageSize } = request;
|
|
43
44
|
const _queryParams = {};
|
|
45
|
+
if (search !== undefined) {
|
|
46
|
+
_queryParams["search"] = search;
|
|
47
|
+
}
|
|
44
48
|
if (page !== undefined) {
|
|
45
49
|
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
46
50
|
}
|
|
@@ -90,7 +94,7 @@ export class Connections {
|
|
|
90
94
|
});
|
|
91
95
|
}
|
|
92
96
|
/**
|
|
93
|
-
* Lists courier organizations based on the caller's organization type
|
|
97
|
+
* Lists courier organizations based on the caller's organization type with optional search by company name or handle. | () -> (CourierConnectionListRes)
|
|
94
98
|
*
|
|
95
99
|
* @param {Chrt.orgs.ConnectionsListCouriersV1Request} request
|
|
96
100
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -99,6 +103,7 @@ export class Connections {
|
|
|
99
103
|
*
|
|
100
104
|
* @example
|
|
101
105
|
* await client.orgs.connections.listCouriersV1({
|
|
106
|
+
* search: "search",
|
|
102
107
|
* page: 1,
|
|
103
108
|
* page_size: 1
|
|
104
109
|
* })
|
|
@@ -109,8 +114,11 @@ export class Connections {
|
|
|
109
114
|
__listCouriersV1() {
|
|
110
115
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
111
116
|
var _a, _b, _c, _d, _e, _f;
|
|
112
|
-
const { page, page_size: pageSize } = request;
|
|
117
|
+
const { search, page, page_size: pageSize } = request;
|
|
113
118
|
const _queryParams = {};
|
|
119
|
+
if (search !== undefined) {
|
|
120
|
+
_queryParams["search"] = search;
|
|
121
|
+
}
|
|
114
122
|
if (page !== undefined) {
|
|
115
123
|
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
116
124
|
}
|
|
@@ -160,7 +168,7 @@ export class Connections {
|
|
|
160
168
|
});
|
|
161
169
|
}
|
|
162
170
|
/**
|
|
163
|
-
* Lists forwarder organizations based on the caller's organization type
|
|
171
|
+
* Lists forwarder organizations based on the caller's organization type with optional search by company name or handle. | () -> (ForwarderConnectionListRes)
|
|
164
172
|
*
|
|
165
173
|
* @param {Chrt.orgs.ConnectionsListForwardersV1Request} request
|
|
166
174
|
* @param {Connections.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -169,6 +177,7 @@ export class Connections {
|
|
|
169
177
|
*
|
|
170
178
|
* @example
|
|
171
179
|
* await client.orgs.connections.listForwardersV1({
|
|
180
|
+
* search: "search",
|
|
172
181
|
* page: 1,
|
|
173
182
|
* page_size: 1
|
|
174
183
|
* })
|
|
@@ -179,8 +188,11 @@ export class Connections {
|
|
|
179
188
|
__listForwardersV1() {
|
|
180
189
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
181
190
|
var _a, _b, _c, _d, _e, _f;
|
|
182
|
-
const { page, page_size: pageSize } = request;
|
|
191
|
+
const { search, page, page_size: pageSize } = request;
|
|
183
192
|
const _queryParams = {};
|
|
193
|
+
if (search !== undefined) {
|
|
194
|
+
_queryParams["search"] = search;
|
|
195
|
+
}
|
|
184
196
|
if (page !== undefined) {
|
|
185
197
|
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
186
198
|
}
|
|
@@ -4,11 +4,14 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
+
* search: "search",
|
|
7
8
|
* page: 1,
|
|
8
9
|
* page_size: 1
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface ConnectionsListCouriersV1Request {
|
|
13
|
+
/** Search by company name or handle */
|
|
14
|
+
search?: string | null;
|
|
12
15
|
page?: number | null;
|
|
13
16
|
page_size?: number | null;
|
|
14
17
|
}
|
|
@@ -4,11 +4,14 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
+
* search: "search",
|
|
7
8
|
* page: 1,
|
|
8
9
|
* page_size: 1
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface ConnectionsListForwardersV1Request {
|
|
13
|
+
/** Search by company name or handle */
|
|
14
|
+
search?: string | null;
|
|
12
15
|
page?: number | null;
|
|
13
16
|
page_size?: number | null;
|
|
14
17
|
}
|
|
@@ -4,11 +4,14 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
+
* search: "search",
|
|
7
8
|
* page: 1,
|
|
8
9
|
* page_size: 1
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface ConnectionsListShippersV1Request {
|
|
13
|
+
/** Search by company name or handle */
|
|
14
|
+
search?: string | null;
|
|
12
15
|
page?: number | null;
|
|
13
16
|
page_size?: number | null;
|
|
14
17
|
}
|
|
@@ -47,7 +47,7 @@ export declare class OffChrtShipperOrg {
|
|
|
47
47
|
createV1(request: Chrt.orgs.OffChrtShipperOrgClientCreate1, requestOptions?: OffChrtShipperOrg.RequestOptions): core.HttpResponsePromise<string>;
|
|
48
48
|
private __createV1;
|
|
49
49
|
/**
|
|
50
|
-
* Lists all off-platform shipper organizations created by the caller's organization. | () -> (OffChrtShipperOrgListRes)
|
|
50
|
+
* Lists all off-platform shipper organizations created by the caller's organization with optional search by company name. | () -> (OffChrtShipperOrgListRes)
|
|
51
51
|
*
|
|
52
52
|
* @param {Chrt.orgs.OffChrtShipperOrgListV1Request} request
|
|
53
53
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -56,6 +56,7 @@ export declare class OffChrtShipperOrg {
|
|
|
56
56
|
*
|
|
57
57
|
* @example
|
|
58
58
|
* await client.orgs.offChrtShipperOrg.listV1({
|
|
59
|
+
* search: "search",
|
|
59
60
|
* page: 1,
|
|
60
61
|
* page_size: 1
|
|
61
62
|
* })
|
|
@@ -85,7 +85,7 @@ export class OffChrtShipperOrg {
|
|
|
85
85
|
});
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* Lists all off-platform shipper organizations created by the caller's organization. | () -> (OffChrtShipperOrgListRes)
|
|
88
|
+
* Lists all off-platform shipper organizations created by the caller's organization with optional search by company name. | () -> (OffChrtShipperOrgListRes)
|
|
89
89
|
*
|
|
90
90
|
* @param {Chrt.orgs.OffChrtShipperOrgListV1Request} request
|
|
91
91
|
* @param {OffChrtShipperOrg.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -94,6 +94,7 @@ export class OffChrtShipperOrg {
|
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
96
96
|
* await client.orgs.offChrtShipperOrg.listV1({
|
|
97
|
+
* search: "search",
|
|
97
98
|
* page: 1,
|
|
98
99
|
* page_size: 1
|
|
99
100
|
* })
|
|
@@ -104,8 +105,11 @@ export class OffChrtShipperOrg {
|
|
|
104
105
|
__listV1() {
|
|
105
106
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
106
107
|
var _a, _b, _c, _d, _e, _f;
|
|
107
|
-
const { page, page_size: pageSize } = request;
|
|
108
|
+
const { search, page, page_size: pageSize } = request;
|
|
108
109
|
const _queryParams = {};
|
|
110
|
+
if (search !== undefined) {
|
|
111
|
+
_queryParams["search"] = search;
|
|
112
|
+
}
|
|
109
113
|
if (page !== undefined) {
|
|
110
114
|
_queryParams["page"] = (_a = page === null || page === void 0 ? void 0 : page.toString()) !== null && _a !== void 0 ? _a : null;
|
|
111
115
|
}
|
|
@@ -4,11 +4,14 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
+
* search: "search",
|
|
7
8
|
* page: 1,
|
|
8
9
|
* page_size: 1
|
|
9
10
|
* }
|
|
10
11
|
*/
|
|
11
12
|
export interface OffChrtShipperOrgListV1Request {
|
|
13
|
+
/** Search by company name */
|
|
14
|
+
search?: string | null;
|
|
12
15
|
page?: number | null;
|
|
13
16
|
page_size?: number | null;
|
|
14
17
|
}
|
|
@@ -14,5 +14,6 @@ export interface CourierOrgProfileClientCreate1 {
|
|
|
14
14
|
schema_version: number;
|
|
15
15
|
description: string;
|
|
16
16
|
email_address_primary: string;
|
|
17
|
+
/** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
|
|
17
18
|
phone_number_primary: string;
|
|
18
19
|
}
|
|
@@ -14,5 +14,6 @@ export interface ForwarderOrgProfileClientCreate1 {
|
|
|
14
14
|
schema_version: number;
|
|
15
15
|
description: string;
|
|
16
16
|
email_address_primary: string;
|
|
17
|
+
/** E.164 formatted phone number (e.g. +16505551234). Assumes US country code if none provided. */
|
|
17
18
|
phone_number_primary: string;
|
|
18
19
|
}
|
|
@@ -54,7 +54,7 @@ export declare class Drivers {
|
|
|
54
54
|
getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
|
|
55
55
|
private __getByDriverIdV1;
|
|
56
56
|
/**
|
|
57
|
-
* Lists all organization members paired with their driver information if they are drivers.
|
|
57
|
+
* Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
58
58
|
*
|
|
59
59
|
* @param {Chrt.shipping.DriversListOrgMembersAndDriversV1Request} request
|
|
60
60
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,8 +63,11 @@ export declare class Drivers {
|
|
|
63
63
|
*
|
|
64
64
|
* @example
|
|
65
65
|
* await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
66
|
+
* search: "search",
|
|
66
67
|
* filter_available_according_to_driver: true,
|
|
67
68
|
* filter_available_according_to_operators: true,
|
|
69
|
+
* sort_by: "first_name",
|
|
70
|
+
* sort_order: "asc",
|
|
68
71
|
* page: 1,
|
|
69
72
|
* page_size: 1
|
|
70
73
|
* })
|
|
@@ -141,7 +141,7 @@ export class Drivers {
|
|
|
141
141
|
});
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* Lists all organization members paired with their driver information if they are drivers.
|
|
144
|
+
* Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)
|
|
145
145
|
*
|
|
146
146
|
* @param {Chrt.shipping.DriversListOrgMembersAndDriversV1Request} request
|
|
147
147
|
* @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -150,8 +150,11 @@ export class Drivers {
|
|
|
150
150
|
*
|
|
151
151
|
* @example
|
|
152
152
|
* await client.shipping.drivers.listOrgMembersAndDriversV1({
|
|
153
|
+
* search: "search",
|
|
153
154
|
* filter_available_according_to_driver: true,
|
|
154
155
|
* filter_available_according_to_operators: true,
|
|
156
|
+
* sort_by: "first_name",
|
|
157
|
+
* sort_order: "asc",
|
|
155
158
|
* page: 1,
|
|
156
159
|
* page_size: 1
|
|
157
160
|
* })
|
|
@@ -162,8 +165,11 @@ export class Drivers {
|
|
|
162
165
|
__listOrgMembersAndDriversV1() {
|
|
163
166
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
164
167
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
165
|
-
const { filter_role: filterRole, filter_available_according_to_driver: filterAvailableAccordingToDriver, filter_available_according_to_operators: filterAvailableAccordingToOperators, page, page_size: pageSize, } = request;
|
|
168
|
+
const { search, filter_role: filterRole, filter_available_according_to_driver: filterAvailableAccordingToDriver, filter_available_according_to_operators: filterAvailableAccordingToOperators, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
|
|
166
169
|
const _queryParams = {};
|
|
170
|
+
if (search !== undefined) {
|
|
171
|
+
_queryParams["search"] = search;
|
|
172
|
+
}
|
|
167
173
|
if (filterRole !== undefined) {
|
|
168
174
|
if (Array.isArray(filterRole)) {
|
|
169
175
|
_queryParams["filter_role"] = filterRole.map((item) => item);
|
|
@@ -179,6 +185,12 @@ export class Drivers {
|
|
|
179
185
|
_queryParams["filter_available_according_to_operators"] =
|
|
180
186
|
(_b = filterAvailableAccordingToOperators === null || filterAvailableAccordingToOperators === void 0 ? void 0 : filterAvailableAccordingToOperators.toString()) !== null && _b !== void 0 ? _b : null;
|
|
181
187
|
}
|
|
188
|
+
if (sortBy !== undefined) {
|
|
189
|
+
_queryParams["sort_by"] = sortBy;
|
|
190
|
+
}
|
|
191
|
+
if (sortOrder !== undefined) {
|
|
192
|
+
_queryParams["sort_order"] = sortOrder;
|
|
193
|
+
}
|
|
182
194
|
if (page !== undefined) {
|
|
183
195
|
_queryParams["page"] = (_c = page === null || page === void 0 ? void 0 : page.toString()) !== null && _c !== void 0 ? _c : null;
|
|
184
196
|
}
|
|
@@ -5,19 +5,28 @@ import * as Chrt from "../../../../../../index.mjs";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
+
* search: "search",
|
|
8
9
|
* filter_available_according_to_driver: true,
|
|
9
10
|
* filter_available_according_to_operators: true,
|
|
11
|
+
* sort_by: "first_name",
|
|
12
|
+
* sort_order: "asc",
|
|
10
13
|
* page: 1,
|
|
11
14
|
* page_size: 1
|
|
12
15
|
* }
|
|
13
16
|
*/
|
|
14
17
|
export interface DriversListOrgMembersAndDriversV1Request {
|
|
18
|
+
/** Search by first or last name */
|
|
19
|
+
search?: string | null;
|
|
15
20
|
/** Filter by organization role(s) */
|
|
16
21
|
filter_role?: (Chrt.OrgRoleEnum | null) | (Chrt.OrgRoleEnum | null)[];
|
|
17
22
|
/** Filter by driver's self-reported availability. */
|
|
18
23
|
filter_available_according_to_driver?: boolean | null;
|
|
19
24
|
/** Filter by operator-set availability. */
|
|
20
25
|
filter_available_according_to_operators?: boolean | null;
|
|
26
|
+
/** Field to sort by */
|
|
27
|
+
sort_by?: Chrt.OrgMemberSortByEnum | null;
|
|
28
|
+
/** Sort order (asc or desc) */
|
|
29
|
+
sort_order?: Chrt.SortOrderEnum | null;
|
|
21
30
|
page?: number | null;
|
|
22
31
|
page_size?: number | null;
|
|
23
32
|
}
|
|
@@ -14,6 +14,7 @@ export interface OrdersDraftUpdateReq {
|
|
|
14
14
|
shipper_org_id__set_to_None?: boolean;
|
|
15
15
|
off_chrt_shipper_org_id?: string | null;
|
|
16
16
|
off_chrt_shipper_org_id__set_to_None?: boolean;
|
|
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
|
off_chrt_reference_id__set_to_None?: boolean;
|
|
19
20
|
}
|
|
@@ -11,5 +11,6 @@ export interface OrdersNewDraftReq {
|
|
|
11
11
|
/** Must be a string starting with `org_` */
|
|
12
12
|
shipper_org_id?: string | null;
|
|
13
13
|
off_chrt_shipper_org_id?: string | null;
|
|
14
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
14
15
|
off_chrt_reference_id?: string | null;
|
|
15
16
|
}
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
* {}
|
|
7
7
|
*/
|
|
8
8
|
export interface OrdersUpdateOffChrtReferenceIdReq {
|
|
9
|
+
/** Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved). */
|
|
9
10
|
off_chrt_reference_id?: string | null;
|
|
10
11
|
off_chrt_reference_id__set_to_None?: boolean;
|
|
11
12
|
}
|
package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.mts
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/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.mts
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;
|
|
@@ -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;
|
|
@@ -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;
|