@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.
Files changed (110) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/orgs/client/Client.d.ts +3 -2
  3. package/dist/cjs/api/resources/orgs/client/Client.js +7 -3
  4. package/dist/cjs/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.ts +4 -1
  5. package/dist/cjs/api/resources/orgs/resources/connections/client/Client.d.ts +6 -3
  6. package/dist/cjs/api/resources/orgs/resources/connections/client/Client.js +18 -6
  7. package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.ts +3 -0
  8. package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.ts +3 -0
  9. package/dist/cjs/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.ts +3 -0
  10. package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.ts +2 -1
  11. package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/Client.js +6 -2
  12. package/dist/cjs/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.ts +3 -0
  13. package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate1.d.ts +1 -0
  14. package/dist/cjs/api/resources/orgs/resources/orgProfiles/client/requests/ForwarderOrgProfileClientCreate1.d.ts +1 -0
  15. package/dist/cjs/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.ts +1 -0
  16. package/dist/cjs/api/resources/orgs/resources/publicData/client/requests/UpdateOrgPublicDataReq.d.ts +1 -0
  17. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts +2 -2
  18. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.d.ts +4 -1
  19. package/dist/cjs/api/resources/shipping/resources/drivers/client/Client.js +14 -2
  20. package/dist/cjs/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.ts +9 -0
  21. package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.ts +1 -0
  22. package/dist/cjs/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.ts +1 -0
  23. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +3 -3
  24. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +7 -7
  25. package/dist/cjs/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.ts +1 -0
  26. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +6 -6
  27. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +14 -14
  28. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.ts +6 -6
  29. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.js +14 -14
  30. package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.ts +1 -0
  31. package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.ts +1 -0
  32. package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.ts +1 -0
  33. package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.ts +1 -0
  34. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +4 -4
  35. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +8 -8
  36. package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.d.ts +2 -1
  37. package/dist/cjs/api/resources/users/resources/directoryEntries/client/Client.js +6 -2
  38. package/dist/cjs/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.ts +3 -0
  39. package/dist/cjs/api/types/CourierOrgProfile1.d.ts +1 -0
  40. package/dist/cjs/api/types/CreateConnectionReq.d.ts +1 -0
  41. package/dist/cjs/api/types/DeviceLimitedForList1.d.ts +1 -0
  42. package/dist/cjs/api/types/ForwarderOrgProfile1.d.ts +1 -0
  43. package/dist/cjs/api/types/LineItemGroup1.d.ts +1 -0
  44. package/dist/cjs/api/types/Order1.d.ts +1 -0
  45. package/dist/cjs/api/types/OrderDraftExpanded.d.ts +1 -0
  46. package/dist/cjs/api/types/OrderExpanded.d.ts +1 -0
  47. package/dist/cjs/api/types/OrdersDraftUpdateRes.d.ts +1 -0
  48. package/dist/cjs/api/types/OrdersUpdateOffChrtReferenceIdRes.d.ts +1 -0
  49. package/dist/cjs/api/types/OrgPublicData1.d.ts +1 -0
  50. package/dist/cjs/api/types/Session1.d.ts +1 -0
  51. package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
  52. package/dist/cjs/api/types/TaskGroupExpanded.d.ts +2 -0
  53. package/dist/cjs/version.d.ts +1 -1
  54. package/dist/cjs/version.js +1 -1
  55. package/dist/esm/Client.mjs +2 -2
  56. package/dist/esm/api/resources/orgs/client/Client.d.mts +3 -2
  57. package/dist/esm/api/resources/orgs/client/Client.mjs +7 -3
  58. package/dist/esm/api/resources/orgs/client/requests/OrgsListMembersV1Request.d.mts +4 -1
  59. package/dist/esm/api/resources/orgs/resources/connections/client/Client.d.mts +6 -3
  60. package/dist/esm/api/resources/orgs/resources/connections/client/Client.mjs +18 -6
  61. package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListCouriersV1Request.d.mts +3 -0
  62. package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListForwardersV1Request.d.mts +3 -0
  63. package/dist/esm/api/resources/orgs/resources/connections/client/requests/ConnectionsListShippersV1Request.d.mts +3 -0
  64. package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.d.mts +2 -1
  65. package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/Client.mjs +6 -2
  66. package/dist/esm/api/resources/orgs/resources/offChrtShipperOrg/client/requests/OffChrtShipperOrgListV1Request.d.mts +3 -0
  67. package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate1.d.mts +1 -0
  68. package/dist/esm/api/resources/orgs/resources/orgProfiles/client/requests/ForwarderOrgProfileClientCreate1.d.mts +1 -0
  69. package/dist/esm/api/resources/orgs/resources/publicData/client/requests/CreateOrgPublicDataReq.d.mts +1 -0
  70. package/dist/esm/api/resources/orgs/resources/publicData/client/requests/UpdateOrgPublicDataReq.d.mts +1 -0
  71. package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts +2 -2
  72. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.d.mts +4 -1
  73. package/dist/esm/api/resources/shipping/resources/drivers/client/Client.mjs +14 -2
  74. package/dist/esm/api/resources/shipping/resources/drivers/client/requests/DriversListOrgMembersAndDriversV1Request.d.mts +9 -0
  75. package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersDraftUpdateReq.d.mts +1 -0
  76. package/dist/esm/api/resources/shipping/resources/orderDrafts/client/requests/OrdersNewDraftReq.d.mts +1 -0
  77. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +3 -3
  78. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +7 -7
  79. package/dist/esm/api/resources/shipping/resources/orders/client/requests/OrdersUpdateOffChrtReferenceIdReq.d.mts +1 -0
  80. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +6 -6
  81. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +14 -14
  82. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.mts +6 -6
  83. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.mjs +14 -14
  84. package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientCreate1.d.mts +1 -0
  85. package/dist/esm/api/resources/tracking/resources/devices/client/requests/DeviceClientUpdate1.d.mts +1 -0
  86. package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientCreate1.d.mts +1 -0
  87. package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionClientUpdate1.d.mts +1 -0
  88. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +4 -4
  89. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +8 -8
  90. package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.d.mts +2 -1
  91. package/dist/esm/api/resources/users/resources/directoryEntries/client/Client.mjs +6 -2
  92. package/dist/esm/api/resources/users/resources/directoryEntries/client/requests/DirectoryEntriesListV1Request.d.mts +3 -0
  93. package/dist/esm/api/types/CourierOrgProfile1.d.mts +1 -0
  94. package/dist/esm/api/types/CreateConnectionReq.d.mts +1 -0
  95. package/dist/esm/api/types/DeviceLimitedForList1.d.mts +1 -0
  96. package/dist/esm/api/types/ForwarderOrgProfile1.d.mts +1 -0
  97. package/dist/esm/api/types/LineItemGroup1.d.mts +1 -0
  98. package/dist/esm/api/types/Order1.d.mts +1 -0
  99. package/dist/esm/api/types/OrderDraftExpanded.d.mts +1 -0
  100. package/dist/esm/api/types/OrderExpanded.d.mts +1 -0
  101. package/dist/esm/api/types/OrdersDraftUpdateRes.d.mts +1 -0
  102. package/dist/esm/api/types/OrdersUpdateOffChrtReferenceIdRes.d.mts +1 -0
  103. package/dist/esm/api/types/OrgPublicData1.d.mts +1 -0
  104. package/dist/esm/api/types/Session1.d.mts +1 -0
  105. package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
  106. package/dist/esm/api/types/TaskGroupExpanded.d.mts +2 -0
  107. package/dist/esm/version.d.mts +1 -1
  108. package/dist/esm/version.mjs +1 -1
  109. package/package.json +1 -1
  110. package/reference.md +36 -27
@@ -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} orderIdOrShortId
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("order_id_or_short_id")
41
+ * await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref")
42
42
  */
43
- forCourierOperatorsV1(orderIdOrShortId: string, requestOptions?: TaskGroupId.RequestOptions): core.HttpResponsePromise<string[]>;
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} orderIdOrShortId
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("order_id_or_short_id")
54
+ * await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref")
55
55
  */
56
- forCourierDriverV1(orderIdOrShortId: string, requestOptions?: TaskGroupId.RequestOptions): core.HttpResponsePromise<string[]>;
56
+ forCourierDriverV1(orderRef: string, requestOptions?: TaskGroupId.RequestOptions): core.HttpResponsePromise<string[]>;
57
57
  private __forCourierDriverV1;
58
58
  protected _getAuthorizationHeader(): Promise<string | undefined>;
59
59
  }
@@ -22,23 +22,23 @@ export class TaskGroupId {
22
22
  /**
23
23
  * Retrieves the task group IDs for the courier organization assigned to an order's task groups. | authz_personas=[courier_org_operators] | () -> (list[PydanticObjectId])
24
24
  *
25
- * @param {string} orderIdOrShortId
25
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
26
26
  * @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
27
27
  *
28
28
  * @throws {@link Chrt.UnprocessableEntityError}
29
29
  *
30
30
  * @example
31
- * await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_short_id")
31
+ * await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref")
32
32
  */
33
- forCourierOperatorsV1(orderIdOrShortId, requestOptions) {
34
- return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(orderIdOrShortId, requestOptions));
33
+ forCourierOperatorsV1(orderRef, requestOptions) {
34
+ return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(orderRef, requestOptions));
35
35
  }
36
- __forCourierOperatorsV1(orderIdOrShortId, requestOptions) {
36
+ __forCourierOperatorsV1(orderRef, requestOptions) {
37
37
  return __awaiter(this, void 0, void 0, function* () {
38
38
  var _a, _b, _c, _d;
39
39
  let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
40
40
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
41
- 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(orderIdOrShortId)}`),
41
+ 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)}`),
42
42
  method: "GET",
43
43
  headers: _headers,
44
44
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -69,7 +69,7 @@ export class TaskGroupId {
69
69
  rawResponse: _response.rawResponse,
70
70
  });
71
71
  case "timeout":
72
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_operators/v1/{order_id_or_short_id}.");
72
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_operators/v1/{order_ref}.");
73
73
  case "unknown":
74
74
  throw new errors.ChrtError({
75
75
  message: _response.error.errorMessage,
@@ -81,23 +81,23 @@ export class TaskGroupId {
81
81
  /**
82
82
  * Retrieves the task group IDs for the courier driver assigned to an order's task groups. | authz_personas=[courier_driver] | () -> (list[PydanticObjectId])
83
83
  *
84
- * @param {string} orderIdOrShortId
84
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
85
85
  * @param {TaskGroupId.RequestOptions} requestOptions - Request-specific configuration.
86
86
  *
87
87
  * @throws {@link Chrt.UnprocessableEntityError}
88
88
  *
89
89
  * @example
90
- * await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id")
90
+ * await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref")
91
91
  */
92
- forCourierDriverV1(orderIdOrShortId, requestOptions) {
93
- return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(orderIdOrShortId, requestOptions));
92
+ forCourierDriverV1(orderRef, requestOptions) {
93
+ return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(orderRef, requestOptions));
94
94
  }
95
- __forCourierDriverV1(orderIdOrShortId, requestOptions) {
95
+ __forCourierDriverV1(orderRef, requestOptions) {
96
96
  return __awaiter(this, void 0, void 0, function* () {
97
97
  var _a, _b, _c, _d;
98
98
  let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
99
99
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
100
- 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(orderIdOrShortId)}`),
100
+ 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)}`),
101
101
  method: "GET",
102
102
  headers: _headers,
103
103
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -128,7 +128,7 @@ export class TaskGroupId {
128
128
  rawResponse: _response.rawResponse,
129
129
  });
130
130
  case "timeout":
131
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_driver/v1/{order_id_or_short_id}.");
131
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /shipping/task_groups/task_group_id/for_courier_driver/v1/{order_ref}.");
132
132
  case "unknown":
133
133
  throw new errors.ChrtError({
134
134
  message: _response.error.errorMessage,
@@ -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
  }
@@ -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;
@@ -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} orderIdOrShortId
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("order_id_or_short_id")
95
+ * await client.tracking.sharingSettings.getSettingsV1("order_ref")
96
96
  */
97
- getSettingsV1(orderIdOrShortId: string, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSharingSettingsRes[]>;
97
+ getSettingsV1(orderRef: string, requestOptions?: SharingSettings.RequestOptions): core.HttpResponsePromise<Chrt.TrackingSharingSettingsRes[]>;
98
98
  private __getSettingsV1;
99
99
  protected _getAuthorizationHeader(): Promise<string | undefined>;
100
100
  }
@@ -223,25 +223,25 @@ export class SharingSettings {
223
223
  });
224
224
  }
225
225
  /**
226
- * 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])
226
+ * 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])
227
227
  *
228
- * @param {string} orderIdOrShortId
228
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
229
229
  * @param {SharingSettings.RequestOptions} requestOptions - Request-specific configuration.
230
230
  *
231
231
  * @throws {@link Chrt.UnprocessableEntityError}
232
232
  *
233
233
  * @example
234
- * await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id")
234
+ * await client.tracking.sharingSettings.getSettingsV1("order_ref")
235
235
  */
236
- getSettingsV1(orderIdOrShortId, requestOptions) {
237
- return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(orderIdOrShortId, requestOptions));
236
+ getSettingsV1(orderRef, requestOptions) {
237
+ return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(orderRef, requestOptions));
238
238
  }
239
- __getSettingsV1(orderIdOrShortId, requestOptions) {
239
+ __getSettingsV1(orderRef, requestOptions) {
240
240
  return __awaiter(this, void 0, void 0, function* () {
241
241
  var _a, _b, _c, _d;
242
242
  let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
243
243
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
244
- 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(orderIdOrShortId)}`),
244
+ 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)}`),
245
245
  method: "GET",
246
246
  headers: _headers,
247
247
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -272,7 +272,7 @@ export class SharingSettings {
272
272
  rawResponse: _response.rawResponse,
273
273
  });
274
274
  case "timeout":
275
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sharing_settings/by_order/v1/{order_id_or_short_id}.");
275
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /tracking/sharing_settings/by_order/v1/{order_ref}.");
276
276
  case "unknown":
277
277
  throw new errors.ChrtError({
278
278
  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,
@@ -79,7 +79,7 @@ export class DirectoryEntries {
79
79
  });
80
80
  }
81
81
  /**
82
- * Lists directory entries with pagination and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
82
+ * Lists directory entries with pagination, optional filtering by entry_org_id, and optional full-text search. | authz: min_org_role=operator | () -> (DirectoryEntryListRes)
83
83
  *
84
84
  * @param {Chrt.users.DirectoryEntriesListV1Request} request
85
85
  * @param {DirectoryEntries.RequestOptions} requestOptions - Request-specific configuration.
@@ -89,6 +89,7 @@ export class DirectoryEntries {
89
89
  * @example
90
90
  * await client.users.directoryEntries.listV1({
91
91
  * search: "search",
92
+ * filter_entry_org_id: "filter_entry_org_id",
92
93
  * sort_by: "company_name",
93
94
  * sort_order: "asc",
94
95
  * page: 1,
@@ -101,11 +102,14 @@ export class DirectoryEntries {
101
102
  __listV1() {
102
103
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
103
104
  var _a, _b, _c, _d, _e, _f;
104
- const { search, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize } = request;
105
+ const { search, filter_entry_org_id: filterEntryOrgId, sort_by: sortBy, sort_order: sortOrder, page, page_size: pageSize, } = request;
105
106
  const _queryParams = {};
106
107
  if (search !== undefined) {
107
108
  _queryParams["search"] = search;
108
109
  }
110
+ if (filterEntryOrgId !== undefined) {
111
+ _queryParams["filter_entry_org_id"] = filterEntryOrgId;
112
+ }
109
113
  if (sortBy !== undefined) {
110
114
  _queryParams["sort_by"] = sortBy;
111
115
  }
@@ -6,6 +6,7 @@ import * as Chrt from "../../../../../../index.mjs";
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.mjs";
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;
@@ -2,5 +2,6 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  export interface CreateConnectionReq {
5
+ /** Must be a string starting with `@`. May only contain a-z, A-Z, 0-9, _, -. May not be longer than 30 characters. */
5
6
  handle: string;
6
7
  }
@@ -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.mjs";
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.mjs";
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.mjs";
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;
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.563.0";
1
+ export declare const SDK_VERSION = "1.576.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.563.0";
1
+ export const SDK_VERSION = "1.576.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chrt-inc/typescript-sdk",
3
- "version": "1.563.0",
3
+ "version": "1.576.0",
4
4
  "private": false,
5
5
  "repository": "github:chrt-inc/typescript-sdk",
6
6
  "type": "commonjs",