@chrt-inc/typescript-sdk 1.710.0 → 1.719.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 (80) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/operations/resources/departments/client/Client.d.ts +1 -1
  3. package/dist/cjs/api/resources/operations/resources/departments/client/Client.js +6 -6
  4. package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentClientCreate1.d.ts +2 -2
  5. package/dist/cjs/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.ts +2 -2
  6. package/dist/cjs/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.ts +1 -0
  7. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.d.ts +3 -0
  8. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/client/Client.js +5 -0
  9. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/index.d.ts +2 -0
  10. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/index.js +3 -1
  11. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.d.ts +68 -0
  12. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.js +201 -0
  13. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/index.js +17 -0
  15. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/AddScanPayloadReq.d.ts +15 -0
  16. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/AddScanPayloadReq.js +5 -0
  17. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/ScanDeleteV1Request.d.ts +15 -0
  18. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/ScanDeleteV1Request.js +5 -0
  19. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/index.d.ts +2 -0
  20. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/index.js +2 -0
  21. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/shipping/resources/taskArtifacts/resources/scan/index.js +17 -0
  23. package/dist/cjs/api/types/Department1.d.ts +1 -1
  24. package/dist/cjs/api/types/DepartmentSortByEnum.d.ts +2 -2
  25. package/dist/cjs/api/types/DepartmentSortByEnum.js +1 -1
  26. package/dist/cjs/api/types/{DepartmentEnum.d.ts → DepartmentTypeEnum.d.ts} +7 -2
  27. package/dist/cjs/api/types/{DepartmentEnum.js → DepartmentTypeEnum.js} +7 -2
  28. package/dist/cjs/api/types/DeviceLimitedForList1.d.ts +2 -0
  29. package/dist/cjs/api/types/Driver1.d.ts +2 -0
  30. package/dist/cjs/api/types/ScanPayloadKindEnum.d.ts +8 -0
  31. package/dist/cjs/api/types/ScanPayloadKindEnum.js +10 -0
  32. package/dist/cjs/api/types/TaskArtifact1.d.ts +2 -0
  33. package/dist/cjs/api/types/TaskArtifactClientCreate1.d.ts +1 -0
  34. package/dist/cjs/api/types/TaskArtifactTypeEnum1.d.ts +2 -1
  35. package/dist/cjs/api/types/TaskArtifactTypeEnum1.js +1 -0
  36. package/dist/cjs/api/types/index.d.ts +2 -1
  37. package/dist/cjs/api/types/index.js +2 -1
  38. package/dist/cjs/version.d.ts +1 -1
  39. package/dist/cjs/version.js +1 -1
  40. package/dist/esm/Client.mjs +2 -2
  41. package/dist/esm/api/resources/operations/resources/departments/client/Client.d.mts +1 -1
  42. package/dist/esm/api/resources/operations/resources/departments/client/Client.mjs +6 -6
  43. package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentClientCreate1.d.mts +2 -2
  44. package/dist/esm/api/resources/operations/resources/departments/client/requests/DepartmentsListV1Request.d.mts +2 -2
  45. package/dist/esm/api/resources/shipping/resources/orderDrafts/resources/taskArtifact/client/requests/OrderDraftAddTaskArtifactReq.d.mts +1 -0
  46. package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.d.mts +3 -0
  47. package/dist/esm/api/resources/shipping/resources/taskArtifacts/client/Client.mjs +5 -0
  48. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/index.d.mts +2 -0
  49. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/index.mjs +2 -0
  50. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.d.mts +68 -0
  51. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.mjs +164 -0
  52. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/index.d.mts +2 -0
  53. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/index.mjs +1 -0
  54. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/AddScanPayloadReq.d.mts +15 -0
  55. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/AddScanPayloadReq.mjs +4 -0
  56. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/ScanDeleteV1Request.d.mts +15 -0
  57. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/ScanDeleteV1Request.mjs +4 -0
  58. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/index.d.mts +2 -0
  59. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/client/requests/index.mjs +1 -0
  60. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/index.d.mts +1 -0
  61. package/dist/esm/api/resources/shipping/resources/taskArtifacts/resources/scan/index.mjs +1 -0
  62. package/dist/esm/api/types/Department1.d.mts +1 -1
  63. package/dist/esm/api/types/DepartmentSortByEnum.d.mts +2 -2
  64. package/dist/esm/api/types/DepartmentSortByEnum.mjs +1 -1
  65. package/dist/esm/api/types/{DepartmentEnum.d.mts → DepartmentTypeEnum.d.mts} +7 -2
  66. package/dist/esm/api/types/{DepartmentEnum.mjs → DepartmentTypeEnum.mjs} +6 -1
  67. package/dist/esm/api/types/DeviceLimitedForList1.d.mts +2 -0
  68. package/dist/esm/api/types/Driver1.d.mts +2 -0
  69. package/dist/esm/api/types/ScanPayloadKindEnum.d.mts +8 -0
  70. package/dist/esm/api/types/ScanPayloadKindEnum.mjs +7 -0
  71. package/dist/esm/api/types/TaskArtifact1.d.mts +2 -0
  72. package/dist/esm/api/types/TaskArtifactClientCreate1.d.mts +1 -0
  73. package/dist/esm/api/types/TaskArtifactTypeEnum1.d.mts +2 -1
  74. package/dist/esm/api/types/TaskArtifactTypeEnum1.mjs +1 -0
  75. package/dist/esm/api/types/index.d.mts +2 -1
  76. package/dist/esm/api/types/index.mjs +2 -1
  77. package/dist/esm/version.d.mts +1 -1
  78. package/dist/esm/version.mjs +1 -1
  79. package/package.json +1 -1
  80. package/reference.md +151 -1
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type ScanPayloadKindEnum = "expected" | "observed";
5
+ export declare const ScanPayloadKindEnum: {
6
+ readonly Expected: "expected";
7
+ readonly Observed: "observed";
8
+ };
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export const ScanPayloadKindEnum = {
5
+ Expected: "expected",
6
+ Observed: "observed",
7
+ };
@@ -5,6 +5,7 @@ import * as Chrt from "../index.mjs";
5
5
  export interface TaskArtifact1 {
6
6
  schema_version: number;
7
7
  type: Chrt.TaskArtifactTypeEnum1;
8
+ expected_scan_payloads?: string[];
8
9
  _id: string;
9
10
  order_id: string;
10
11
  order_short_id: string;
@@ -26,6 +27,7 @@ export interface TaskArtifact1 {
26
27
  completed_by_org_id?: string | null;
27
28
  /** Must be a string starting with `user_` */
28
29
  completed_by_user_id?: string | null;
30
+ observed_scan_payloads?: string[];
29
31
  status?: Chrt.TaskArtifactStatusEnum1;
30
32
  draft_started_at_timestamp: string;
31
33
  staged_at_timestamp?: string | null;
@@ -5,4 +5,5 @@ import * as Chrt from "../index.mjs";
5
5
  export interface TaskArtifactClientCreate1 {
6
6
  schema_version: number;
7
7
  type: Chrt.TaskArtifactTypeEnum1;
8
+ expected_scan_payloads?: string[];
8
9
  }
@@ -1,9 +1,10 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export type TaskArtifactTypeEnum1 = "image" | "signature" | "other";
4
+ export type TaskArtifactTypeEnum1 = "image" | "signature" | "scan" | "other";
5
5
  export declare const TaskArtifactTypeEnum1: {
6
6
  readonly Image: "image";
7
7
  readonly Signature: "signature";
8
+ readonly Scan: "scan";
8
9
  readonly Other: "other";
9
10
  };
@@ -4,5 +4,6 @@
4
4
  export const TaskArtifactTypeEnum1 = {
5
5
  Image: "image",
6
6
  Signature: "signature",
7
+ Scan: "scan",
7
8
  Other: "other",
8
9
  };
@@ -119,9 +119,9 @@ export * from "./CreateStripeConnectAccountRes.mjs";
119
119
  export * from "./CredentialInfoRes.mjs";
120
120
  export * from "./DateTimeWindow1.mjs";
121
121
  export * from "./Department1.mjs";
122
- export * from "./DepartmentEnum.mjs";
123
122
  export * from "./DepartmentListRes.mjs";
124
123
  export * from "./DepartmentSortByEnum.mjs";
124
+ export * from "./DepartmentTypeEnum.mjs";
125
125
  export * from "./DeviceExpandedRes.mjs";
126
126
  export * from "./DeviceLimitedForList1.mjs";
127
127
  export * from "./DeviceListRes.mjs";
@@ -274,6 +274,7 @@ export * from "./ProviderOrgProfile1.mjs";
274
274
  export * from "./ProviderProviderConnection1.mjs";
275
275
  export * from "./RateSheetMapping1.mjs";
276
276
  export * from "./RateSheetMappingListRes.mjs";
277
+ export * from "./ScanPayloadKindEnum.mjs";
277
278
  export * from "./ScheduleCalendarSpec.mjs";
278
279
  export * from "./ScheduleIntervalSpec.mjs";
279
280
  export * from "./ScheduleRange.mjs";
@@ -119,9 +119,9 @@ export * from "./CreateStripeConnectAccountRes.mjs";
119
119
  export * from "./CredentialInfoRes.mjs";
120
120
  export * from "./DateTimeWindow1.mjs";
121
121
  export * from "./Department1.mjs";
122
- export * from "./DepartmentEnum.mjs";
123
122
  export * from "./DepartmentListRes.mjs";
124
123
  export * from "./DepartmentSortByEnum.mjs";
124
+ export * from "./DepartmentTypeEnum.mjs";
125
125
  export * from "./DeviceExpandedRes.mjs";
126
126
  export * from "./DeviceLimitedForList1.mjs";
127
127
  export * from "./DeviceListRes.mjs";
@@ -274,6 +274,7 @@ export * from "./ProviderOrgProfile1.mjs";
274
274
  export * from "./ProviderProviderConnection1.mjs";
275
275
  export * from "./RateSheetMapping1.mjs";
276
276
  export * from "./RateSheetMappingListRes.mjs";
277
+ export * from "./ScanPayloadKindEnum.mjs";
277
278
  export * from "./ScheduleCalendarSpec.mjs";
278
279
  export * from "./ScheduleIntervalSpec.mjs";
279
280
  export * from "./ScheduleRange.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.710.0";
1
+ export declare const SDK_VERSION = "1.719.0";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.710.0";
1
+ export const SDK_VERSION = "1.719.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chrt-inc/typescript-sdk",
3
- "version": "1.710.0",
3
+ "version": "1.719.0",
4
4
  "private": false,
5
5
  "repository": "github:chrt-inc/typescript-sdk",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -12871,7 +12871,7 @@ Creates a new department configuration for the caller's organization. | authz: m
12871
12871
  await client.operations.departments.createV1({
12872
12872
  schema_version: 1,
12873
12873
  name: "name",
12874
- department: "automotive",
12874
+ department_type: "automotive",
12875
12875
  });
12876
12876
  ```
12877
12877
 
@@ -24017,6 +24017,156 @@ await client.shipping.taskArtifacts.s3Object.writeAiImageDescriptionV1("task_art
24017
24017
  </dl>
24018
24018
  </details>
24019
24019
 
24020
+ ## Shipping TaskArtifacts Scan
24021
+
24022
+ <details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">addV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
24023
+ <dl>
24024
+ <dd>
24025
+
24026
+ #### 📝 Description
24027
+
24028
+ <dl>
24029
+ <dd>
24030
+
24031
+ <dl>
24032
+ <dd>
24033
+
24034
+ Appends a barcode/QR scan payload to a SCAN-type task artifact's expected or observed array (deduplicated). | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | (AddScanPayloadReq) -> (bool)
24035
+
24036
+ </dd>
24037
+ </dl>
24038
+ </dd>
24039
+ </dl>
24040
+
24041
+ #### 🔌 Usage
24042
+
24043
+ <dl>
24044
+ <dd>
24045
+
24046
+ <dl>
24047
+ <dd>
24048
+
24049
+ ```typescript
24050
+ await client.shipping.taskArtifacts.scan.addV1("task_artifact_id", {
24051
+ kind: "expected",
24052
+ payload: "payload",
24053
+ });
24054
+ ```
24055
+
24056
+ </dd>
24057
+ </dl>
24058
+ </dd>
24059
+ </dl>
24060
+
24061
+ #### ⚙️ Parameters
24062
+
24063
+ <dl>
24064
+ <dd>
24065
+
24066
+ <dl>
24067
+ <dd>
24068
+
24069
+ **taskArtifactId:** `string`
24070
+
24071
+ </dd>
24072
+ </dl>
24073
+
24074
+ <dl>
24075
+ <dd>
24076
+
24077
+ **request:** `Chrt.shipping.taskArtifacts.AddScanPayloadReq`
24078
+
24079
+ </dd>
24080
+ </dl>
24081
+
24082
+ <dl>
24083
+ <dd>
24084
+
24085
+ **requestOptions:** `Scan.RequestOptions`
24086
+
24087
+ </dd>
24088
+ </dl>
24089
+ </dd>
24090
+ </dl>
24091
+
24092
+ </dd>
24093
+ </dl>
24094
+ </details>
24095
+
24096
+ <details><summary><code>client.shipping.taskArtifacts.scan.<a href="/src/api/resources/shipping/resources/taskArtifacts/resources/scan/client/Client.ts">deleteV1</a>(taskArtifactId, { ...params }) -> boolean</code></summary>
24097
+ <dl>
24098
+ <dd>
24099
+
24100
+ #### 📝 Description
24101
+
24102
+ <dl>
24103
+ <dd>
24104
+
24105
+ <dl>
24106
+ <dd>
24107
+
24108
+ Removes a barcode/QR scan payload (by value) from a SCAN-type task artifact's expected or observed array. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, shipper_org_operators] | () -> (bool)
24109
+
24110
+ </dd>
24111
+ </dl>
24112
+ </dd>
24113
+ </dl>
24114
+
24115
+ #### 🔌 Usage
24116
+
24117
+ <dl>
24118
+ <dd>
24119
+
24120
+ <dl>
24121
+ <dd>
24122
+
24123
+ ```typescript
24124
+ await client.shipping.taskArtifacts.scan.deleteV1("task_artifact_id", {
24125
+ kind: "expected",
24126
+ payload: "payload",
24127
+ });
24128
+ ```
24129
+
24130
+ </dd>
24131
+ </dl>
24132
+ </dd>
24133
+ </dl>
24134
+
24135
+ #### ⚙️ Parameters
24136
+
24137
+ <dl>
24138
+ <dd>
24139
+
24140
+ <dl>
24141
+ <dd>
24142
+
24143
+ **taskArtifactId:** `string`
24144
+
24145
+ </dd>
24146
+ </dl>
24147
+
24148
+ <dl>
24149
+ <dd>
24150
+
24151
+ **request:** `Chrt.shipping.taskArtifacts.ScanDeleteV1Request`
24152
+
24153
+ </dd>
24154
+ </dl>
24155
+
24156
+ <dl>
24157
+ <dd>
24158
+
24159
+ **requestOptions:** `Scan.RequestOptions`
24160
+
24161
+ </dd>
24162
+ </dl>
24163
+ </dd>
24164
+ </dl>
24165
+
24166
+ </dd>
24167
+ </dl>
24168
+ </details>
24169
+
24020
24170
  ## Shipping TaskGroups TaskGroupId
24021
24171
 
24022
24172
  <details><summary><code>client.shipping.taskGroups.taskGroupId.<a href="/src/api/resources/shipping/resources/taskGroups/resources/taskGroupId/client/Client.ts">forExecutorOperatorsV1</a>(orderRef) -> string[]</code></summary>