@chrt-inc/typescript-sdk 1.563.0 → 1.575.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 (26) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts +2 -2
  3. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts +3 -3
  4. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js +7 -7
  5. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts +6 -6
  6. package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.js +14 -14
  7. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.ts +6 -6
  8. package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.js +14 -14
  9. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +4 -4
  10. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +8 -8
  11. package/dist/cjs/version.d.ts +1 -1
  12. package/dist/cjs/version.js +1 -1
  13. package/dist/esm/Client.mjs +2 -2
  14. package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts +2 -2
  15. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts +3 -3
  16. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs +7 -7
  17. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts +6 -6
  18. package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs +14 -14
  19. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.mts +6 -6
  20. package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.mjs +14 -14
  21. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +4 -4
  22. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +8 -8
  23. package/dist/esm/version.d.mts +1 -1
  24. package/dist/esm/version.mjs +1 -1
  25. package/package.json +1 -1
  26. package/reference.md +20 -20
package/dist/cjs/Client.js CHANGED
@@ -53,8 +53,8 @@ class ChrtClient {
53
53
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
54
54
  "X-Fern-Language": "JavaScript",
55
55
  "X-Fern-SDK-Name": "@chrt-inc/typescript-sdk",
56
- "X-Fern-SDK-Version": "1.563.0",
57
- "User-Agent": "@chrt-inc/typescript-sdk/1.563.0",
56
+ "X-Fern-SDK-Version": "1.575.0",
57
+ "User-Agent": "@chrt-inc/typescript-sdk/1.575.0",
58
58
  "X-Fern-Runtime": core.RUNTIME.type,
59
59
  "X-Fern-Runtime-Version": core.RUNTIME.version,
60
60
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
package/dist/cjs/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.ts CHANGED
@@ -5,11 +5,11 @@ import * as Chrt from "../../../../../../index.js";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * order_id_or_short_id: "order_id_or_short_id",
8
+ * order_ref: "order_ref",
9
9
  * template: "pod"
10
10
  * }
11
11
  */
12
12
  export interface GenerateShippingDocReq {
13
- order_id_or_short_id: string;
13
+ order_ref: string;
14
14
  template: Chrt.ShippingDocTemplateEnum;
15
15
  }
package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.ts CHANGED
@@ -33,16 +33,16 @@ export declare class Expanded {
33
33
  /**
34
34
  * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
35
35
  *
36
- * @param {string} orderIdOrShortId
36
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
37
37
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
38
38
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
39
39
  *
40
40
  * @throws {@link Chrt.UnprocessableEntityError}
41
41
  *
42
42
  * @example
43
- * await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
43
+ * await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
44
44
  */
45
- retrieveV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
45
+ retrieveV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
46
46
  private __retrieveV1;
47
47
  /**
48
48
  * Lists expanded draft orders for the organization with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.js CHANGED
@@ -58,24 +58,24 @@ class Expanded {
58
58
  /**
59
59
  * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
60
60
  *
61
- * @param {string} orderIdOrShortId
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.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
68
+ * await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
69
69
  */
70
- retrieveV1(orderIdOrShortId, request, requestOptions) {
71
- return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderIdOrShortId, request, requestOptions));
70
+ retrieveV1(orderRef, request, requestOptions) {
71
+ return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderRef, request, requestOptions));
72
72
  }
73
- __retrieveV1(orderIdOrShortId, request, requestOptions) {
73
+ __retrieveV1(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/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderIdOrShortId)}`),
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/order_drafts/expanded/retrieve/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/order_drafts/expanded/retrieve/v1/{order_id_or_short_id}.");
112
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/expanded/retrieve/v1/{order_ref}.");
113
113
  case "unknown":
114
114
  throw new errors.ChrtError({
115
115
  message: _response.error.errorMessage,
package/dist/cjs/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.ts CHANGED
@@ -33,30 +33,30 @@ export declare class Expanded {
33
33
  /**
34
34
  * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
35
35
  *
36
- * @param {string} orderIdOrShortId
36
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
37
37
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
38
38
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
39
39
  *
40
40
  * @throws {@link Chrt.UnprocessableEntityError}
41
41
  *
42
42
  * @example
43
- * await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
43
+ * await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
44
44
  */
45
- forShipperOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
45
+ forShipperOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
46
46
  private __forShipperOperatorsV1;
47
47
  /**
48
48
  * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
49
49
  *
50
- * @param {string} orderIdOrShortId
50
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
51
51
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
52
52
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
53
53
  *
54
54
  * @throws {@link Chrt.UnprocessableEntityError}
55
55
  *
56
56
  * @example
57
- * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
57
+ * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
58
58
  */
59
- forForwarderOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
59
+ forForwarderOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
60
60
  private __forForwarderOperatorsV1;
61
61
  /**
62
62
  * Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
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} orderIdOrShortId
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("order_id_or_short_id", {})
68
+ * await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
69
69
  */
70
- forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
71
- return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderIdOrShortId, request, requestOptions));
70
+ forShipperOperatorsV1(orderRef, request, requestOptions) {
71
+ return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderRef, request, requestOptions));
72
72
  }
73
- __forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
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(orderIdOrShortId)}`),
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/{order_id_or_short_id}.");
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} orderIdOrShortId
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("order_id_or_short_id", {})
131
+ * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
132
132
  */
133
- forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
134
- return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions));
133
+ forForwarderOperatorsV1(orderRef, request, requestOptions) {
134
+ return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderRef, request, requestOptions));
135
135
  }
136
- __forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
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(orderIdOrShortId)}`),
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/{order_id_or_short_id}.");
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,
package/dist/cjs/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.ts CHANGED
@@ -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
  }
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} orderIdOrShortId
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("order_id_or_short_id")
67
+ * await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref")
68
68
  */
69
- forCourierOperatorsV1(orderIdOrShortId, requestOptions) {
70
- return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(orderIdOrShortId, requestOptions));
69
+ forCourierOperatorsV1(orderRef, requestOptions) {
70
+ return core.HttpResponsePromise.fromPromise(this.__forCourierOperatorsV1(orderRef, requestOptions));
71
71
  }
72
- __forCourierOperatorsV1(orderIdOrShortId, requestOptions) {
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(orderIdOrShortId)}`),
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/{order_id_or_short_id}.");
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} orderIdOrShortId
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("order_id_or_short_id")
126
+ * await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref")
127
127
  */
128
- forCourierDriverV1(orderIdOrShortId, requestOptions) {
129
- return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(orderIdOrShortId, requestOptions));
128
+ forCourierDriverV1(orderRef, requestOptions) {
129
+ return core.HttpResponsePromise.fromPromise(this.__forCourierDriverV1(orderRef, requestOptions));
130
130
  }
131
- __forCourierDriverV1(orderIdOrShortId, requestOptions) {
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(orderIdOrShortId)}`),
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/{order_id_or_short_id}.");
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/sharingSettings/client/Client.d.ts CHANGED
@@ -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
  }
package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js CHANGED
@@ -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} orderIdOrShortId
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("order_id_or_short_id")
270
+ * await client.tracking.sharingSettings.getSettingsV1("order_ref")
271
271
  */
272
- getSettingsV1(orderIdOrShortId, requestOptions) {
273
- return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(orderIdOrShortId, requestOptions));
272
+ getSettingsV1(orderRef, requestOptions) {
273
+ return core.HttpResponsePromise.fromPromise(this.__getSettingsV1(orderRef, requestOptions));
274
274
  }
275
- __getSettingsV1(orderIdOrShortId, requestOptions) {
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(orderIdOrShortId)}`),
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/{order_id_or_short_id}.");
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,
package/dist/cjs/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.563.0";
1
+ export declare const SDK_VERSION = "1.575.0";
package/dist/cjs/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.563.0";
4
+ exports.SDK_VERSION = "1.575.0";
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.563.0",
21
- "User-Agent": "@chrt-inc/typescript-sdk/1.563.0",
20
+ "X-Fern-SDK-Version": "1.575.0",
21
+ "User-Agent": "@chrt-inc/typescript-sdk/1.575.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) });
package/dist/esm/api/resources/shipping/resources/docs/client/requests/GenerateShippingDocReq.d.mts CHANGED
@@ -5,11 +5,11 @@ import * as Chrt from "../../../../../../index.mjs";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * order_id_or_short_id: "order_id_or_short_id",
8
+ * order_ref: "order_ref",
9
9
  * template: "pod"
10
10
  * }
11
11
  */
12
12
  export interface GenerateShippingDocReq {
13
- order_id_or_short_id: string;
13
+ order_ref: string;
14
14
  template: Chrt.ShippingDocTemplateEnum;
15
15
  }
package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.d.mts CHANGED
@@ -33,16 +33,16 @@ export declare class Expanded {
33
33
  /**
34
34
  * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
35
35
  *
36
- * @param {string} orderIdOrShortId
36
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
37
37
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
38
38
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
39
39
  *
40
40
  * @throws {@link Chrt.UnprocessableEntityError}
41
41
  *
42
42
  * @example
43
- * await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
43
+ * await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
44
44
  */
45
- retrieveV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
45
+ retrieveV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderDraftExpanded>;
46
46
  private __retrieveV1;
47
47
  /**
48
48
  * Lists expanded draft orders for the organization with filtering, sorting, and pagination. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpandedListRes)
package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.mjs CHANGED
@@ -22,24 +22,24 @@ export class Expanded {
22
22
  /**
23
23
  * Fetches a single draft order with optional expanded related data. Any user in the org (with operator+ role) can access it. | (OrderAndTaskGroupExpandedReq) -> (OrderDraftExpanded)
24
24
  *
25
- * @param {string} orderIdOrShortId
25
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
26
26
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
27
27
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
28
28
  *
29
29
  * @throws {@link Chrt.UnprocessableEntityError}
30
30
  *
31
31
  * @example
32
- * await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {})
32
+ * await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {})
33
33
  */
34
- retrieveV1(orderIdOrShortId, request, requestOptions) {
35
- return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderIdOrShortId, request, requestOptions));
34
+ retrieveV1(orderRef, request, requestOptions) {
35
+ return core.HttpResponsePromise.fromPromise(this.__retrieveV1(orderRef, request, requestOptions));
36
36
  }
37
- __retrieveV1(orderIdOrShortId, request, requestOptions) {
37
+ __retrieveV1(orderRef, request, requestOptions) {
38
38
  return __awaiter(this, void 0, void 0, function* () {
39
39
  var _a, _b, _c, _d;
40
40
  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);
41
41
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
42
- 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/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderIdOrShortId)}`),
42
+ 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/order_drafts/expanded/retrieve/v1/${encodeURIComponent(orderRef)}`),
43
43
  method: "POST",
44
44
  headers: _headers,
45
45
  contentType: "application/json",
@@ -73,7 +73,7 @@ export class Expanded {
73
73
  rawResponse: _response.rawResponse,
74
74
  });
75
75
  case "timeout":
76
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/expanded/retrieve/v1/{order_id_or_short_id}.");
76
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/order_drafts/expanded/retrieve/v1/{order_ref}.");
77
77
  case "unknown":
78
78
  throw new errors.ChrtError({
79
79
  message: _response.error.errorMessage,
package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.d.mts CHANGED
@@ -33,30 +33,30 @@ export declare class Expanded {
33
33
  /**
34
34
  * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
35
35
  *
36
- * @param {string} orderIdOrShortId
36
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
37
37
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
38
38
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
39
39
  *
40
40
  * @throws {@link Chrt.UnprocessableEntityError}
41
41
  *
42
42
  * @example
43
- * await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
43
+ * await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
44
44
  */
45
- forShipperOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
45
+ forShipperOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
46
46
  private __forShipperOperatorsV1;
47
47
  /**
48
48
  * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
49
49
  *
50
- * @param {string} orderIdOrShortId
50
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
51
51
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
52
52
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
53
53
  *
54
54
  * @throws {@link Chrt.UnprocessableEntityError}
55
55
  *
56
56
  * @example
57
- * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
57
+ * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
58
58
  */
59
- forForwarderOperatorsV1(orderIdOrShortId: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
59
+ forForwarderOperatorsV1(orderRef: string, request: Chrt.OrderAndTaskGroupExpandedReq, requestOptions?: Expanded.RequestOptions): core.HttpResponsePromise<Chrt.OrderExpanded>;
60
60
  private __forForwarderOperatorsV1;
61
61
  /**
62
62
  * Lists expanded orders for forwarder operators with filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[forwarder], min_org_role=operator | (OrderAndTaskGroupExpandedReq) -> (OrdersExpandedListRes)
package/dist/esm/api/resources/shipping/resources/orders/resources/expanded/client/Client.mjs CHANGED
@@ -22,24 +22,24 @@ export class Expanded {
22
22
  /**
23
23
  * Retrieves an expanded order with optional related data for shipper operators. | authz_personas=[shipper_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
24
24
  *
25
- * @param {string} orderIdOrShortId
25
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
26
26
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
27
27
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
28
28
  *
29
29
  * @throws {@link Chrt.UnprocessableEntityError}
30
30
  *
31
31
  * @example
32
- * await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {})
32
+ * await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {})
33
33
  */
34
- forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
35
- return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderIdOrShortId, request, requestOptions));
34
+ forShipperOperatorsV1(orderRef, request, requestOptions) {
35
+ return core.HttpResponsePromise.fromPromise(this.__forShipperOperatorsV1(orderRef, request, requestOptions));
36
36
  }
37
- __forShipperOperatorsV1(orderIdOrShortId, request, requestOptions) {
37
+ __forShipperOperatorsV1(orderRef, request, requestOptions) {
38
38
  return __awaiter(this, void 0, void 0, function* () {
39
39
  var _a, _b, _c, _d;
40
40
  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);
41
41
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
42
- 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(orderIdOrShortId)}`),
42
+ 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)}`),
43
43
  method: "POST",
44
44
  headers: _headers,
45
45
  contentType: "application/json",
@@ -73,7 +73,7 @@ export class Expanded {
73
73
  rawResponse: _response.rawResponse,
74
74
  });
75
75
  case "timeout":
76
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{order_id_or_short_id}.");
76
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_shipper_operators/v1/{order_ref}.");
77
77
  case "unknown":
78
78
  throw new errors.ChrtError({
79
79
  message: _response.error.errorMessage,
@@ -85,24 +85,24 @@ export class Expanded {
85
85
  /**
86
86
  * Retrieves an expanded order with optional related data for forwarder operators. | authz_personas=[forwarder_org_operators] | (OrderAndTaskGroupExpandedReq) -> (OrderExpanded)
87
87
  *
88
- * @param {string} orderIdOrShortId
88
+ * @param {string} orderRef - Order ID, short ID, or off-chrt reference ID
89
89
  * @param {Chrt.OrderAndTaskGroupExpandedReq} request
90
90
  * @param {Expanded.RequestOptions} requestOptions - Request-specific configuration.
91
91
  *
92
92
  * @throws {@link Chrt.UnprocessableEntityError}
93
93
  *
94
94
  * @example
95
- * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {})
95
+ * await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {})
96
96
  */
97
- forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
98
- return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions));
97
+ forForwarderOperatorsV1(orderRef, request, requestOptions) {
98
+ return core.HttpResponsePromise.fromPromise(this.__forForwarderOperatorsV1(orderRef, request, requestOptions));
99
99
  }
100
- __forForwarderOperatorsV1(orderIdOrShortId, request, requestOptions) {
100
+ __forForwarderOperatorsV1(orderRef, request, requestOptions) {
101
101
  return __awaiter(this, void 0, void 0, function* () {
102
102
  var _a, _b, _c, _d;
103
103
  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);
104
104
  const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
105
- 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(orderIdOrShortId)}`),
105
+ 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)}`),
106
106
  method: "POST",
107
107
  headers: _headers,
108
108
  contentType: "application/json",
@@ -136,7 +136,7 @@ export class Expanded {
136
136
  rawResponse: _response.rawResponse,
137
137
  });
138
138
  case "timeout":
139
- throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{order_id_or_short_id}.");
139
+ throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /shipping/orders/expanded/for_forwarder_operators/v1/{order_ref}.");
140
140
  case "unknown":
141
141
  throw new errors.ChrtError({
142
142
  message: _response.error.errorMessage,
package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.d.mts CHANGED
@@ -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
  }
package/dist/esm/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.mjs CHANGED
@@ -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,
package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts CHANGED
@@ -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
  }
package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs CHANGED
@@ -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,
package/dist/esm/version.d.mts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.563.0";
1
+ export declare const SDK_VERSION = "1.575.0";
package/dist/esm/version.mjs CHANGED
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.563.0";
1
+ export const SDK_VERSION = "1.575.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.575.0",
4
4
  "private": false,
5
5
  "repository": "github:chrt-inc/typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -7639,7 +7639,7 @@ Generates a shipping document (BOL or POD) as a PDF for the given order. | authz
7639
7639
 
7640
7640
  ```typescript
7641
7641
  await client.shipping.docs.postGenerateV1({
7642
- order_id_or_short_id: "order_id_or_short_id",
7642
+ order_ref: "order_ref",
7643
7643
  template: "pod",
7644
7644
  });
7645
7645
  ```
@@ -11186,7 +11186,7 @@ await client.shipping.orderDrafts.cargo.deleteV1("cargo_id");
11186
11186
 
11187
11187
  ## Shipping OrderDrafts Expanded
11188
11188
 
11189
- <details><summary><code>client.shipping.orderDrafts.expanded.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.ts">retrieveV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
11189
+ <details><summary><code>client.shipping.orderDrafts.expanded.<a href="/src/api/resources/shipping/resources/orderDrafts/resources/expanded/client/Client.ts">retrieveV1</a>(orderRef, { ...params }) -> Chrt.OrderDraftExpanded</code></summary>
11190
11190
  <dl>
11191
11191
  <dd>
11192
11192
 
@@ -11214,7 +11214,7 @@ Fetches a single draft order with optional expanded related data. Any user in th
11214
11214
  <dd>
11215
11215
 
11216
11216
  ```typescript
11217
- await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {});
11217
+ await client.shipping.orderDrafts.expanded.retrieveV1("order_ref", {});
11218
11218
  ```
11219
11219
 
11220
11220
  </dd>
@@ -11230,7 +11230,7 @@ await client.shipping.orderDrafts.expanded.retrieveV1("order_id_or_short_id", {}
11230
11230
  <dl>
11231
11231
  <dd>
11232
11232
 
11233
- **orderIdOrShortId:** `string`
11233
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
11234
11234
 
11235
11235
  </dd>
11236
11236
  </dl>
@@ -11330,7 +11330,7 @@ await client.shipping.orderDrafts.expanded.listV1({
11330
11330
 
11331
11331
  ## Shipping Orders Expanded
11332
11332
 
11333
- <details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
11333
+ <details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forShipperOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpanded</code></summary>
11334
11334
  <dl>
11335
11335
  <dd>
11336
11336
 
@@ -11358,7 +11358,7 @@ Retrieves an expanded order with optional related data for shipper operators. |
11358
11358
  <dd>
11359
11359
 
11360
11360
  ```typescript
11361
- await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_id", {});
11361
+ await client.shipping.orders.expanded.forShipperOperatorsV1("order_ref", {});
11362
11362
  ```
11363
11363
 
11364
11364
  </dd>
@@ -11374,7 +11374,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_i
11374
11374
  <dl>
11375
11375
  <dd>
11376
11376
 
11377
- **orderIdOrShortId:** `string`
11377
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
11378
11378
 
11379
11379
  </dd>
11380
11380
  </dl>
@@ -11401,7 +11401,7 @@ await client.shipping.orders.expanded.forShipperOperatorsV1("order_id_or_short_i
11401
11401
  </dl>
11402
11402
  </details>
11403
11403
 
11404
- <details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderIdOrShortId, { ...params }) -> Chrt.OrderExpanded</code></summary>
11404
+ <details><summary><code>client.shipping.orders.expanded.<a href="/src/api/resources/shipping/resources/orders/resources/expanded/client/Client.ts">forForwarderOperatorsV1</a>(orderRef, { ...params }) -> Chrt.OrderExpanded</code></summary>
11405
11405
  <dl>
11406
11406
  <dd>
11407
11407
 
@@ -11429,7 +11429,7 @@ Retrieves an expanded order with optional related data for forwarder operators.
11429
11429
  <dd>
11430
11430
 
11431
11431
  ```typescript
11432
- await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short_id", {});
11432
+ await client.shipping.orders.expanded.forForwarderOperatorsV1("order_ref", {});
11433
11433
  ```
11434
11434
 
11435
11435
  </dd>
@@ -11445,7 +11445,7 @@ await client.shipping.orders.expanded.forForwarderOperatorsV1("order_id_or_short
11445
11445
  <dl>
11446
11446
  <dd>
11447
11447
 
11448
- **orderIdOrShortId:** `string`
11448
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
11449
11449
 
11450
11450
  </dd>
11451
11451
  </dl>
@@ -11970,7 +11970,7 @@ await client.shipping.taskArtifacts.s3Object.deleteV1("task_artifact_s3_object_m
11970
11970
 
11971
11971
  ## Shipping TaskGroups TaskGroupId
11972
11972
 
11973
- <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderIdOrShortId) -> string[]</code></summary>
11973
+ <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierOperatorsV1</a>(orderRef) -> string[]</code></summary>
11974
11974
  <dl>
11975
11975
  <dd>
11976
11976
 
@@ -11998,7 +11998,7 @@ Retrieves the task group IDs for the courier organization assigned to an order's
11998
11998
  <dd>
11999
11999
 
12000
12000
  ```typescript
12001
- await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_short_id");
12001
+ await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_ref");
12002
12002
  ```
12003
12003
 
12004
12004
  </dd>
@@ -12014,7 +12014,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_
12014
12014
  <dl>
12015
12015
  <dd>
12016
12016
 
12017
- **orderIdOrShortId:** `string`
12017
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
12018
12018
 
12019
12019
  </dd>
12020
12020
  </dl>
@@ -12033,7 +12033,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierOperatorsV1("order_id_or_
12033
12033
  </dl>
12034
12034
  </details>
12035
12035
 
12036
- <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierDriverV1</a>(orderIdOrShortId) -> string[]</code></summary>
12036
+ <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forCourierDriverV1</a>(orderRef) -> string[]</code></summary>
12037
12037
  <dl>
12038
12038
  <dd>
12039
12039
 
@@ -12061,7 +12061,7 @@ Retrieves the task group IDs for the courier driver assigned to an order's task
12061
12061
  <dd>
12062
12062
 
12063
12063
  ```typescript
12064
- await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_short_id");
12064
+ await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_ref");
12065
12065
  ```
12066
12066
 
12067
12067
  </dd>
@@ -12077,7 +12077,7 @@ await client.shipping.taskGroups.taskGroupId.forCourierDriverV1("order_id_or_sho
12077
12077
  <dl>
12078
12078
  <dd>
12079
12079
 
12080
- **orderIdOrShortId:** `string`
12080
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
12081
12081
 
12082
12082
  </dd>
12083
12083
  </dl>
@@ -14445,7 +14445,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
14445
14445
  </dl>
14446
14446
  </details>
14447
14447
 
14448
- <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
14448
+ <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderRef) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
14449
14449
  <dl>
14450
14450
  <dd>
14451
14451
 
@@ -14457,7 +14457,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
14457
14457
  <dl>
14458
14458
  <dd>
14459
14459
 
14460
- 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])
14460
+ 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])
14461
14461
 
14462
14462
  </dd>
14463
14463
  </dl>
@@ -14473,7 +14473,7 @@ Get all tracking datasets and their sharing settings for a given order. If authe
14473
14473
  <dd>
14474
14474
 
14475
14475
  ```typescript
14476
- await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
14476
+ await client.tracking.sharingSettings.getSettingsV1("order_ref");
14477
14477
  ```
14478
14478
 
14479
14479
  </dd>
@@ -14489,7 +14489,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
14489
14489
  <dl>
14490
14490
  <dd>
14491
14491
 
14492
- **orderIdOrShortId:** `string`
14492
+ **orderRef:** `string` — Order ID, short ID, or off-chrt reference ID
14493
14493
 
14494
14494
  </dd>
14495
14495
  </dl>