@chrt-inc/typescript-sdk 1.400.0 → 1.405.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/Client.js +1 -1
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgReq1.d.ts +1 -0
- package/dist/cjs/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.ts +2 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +56 -5
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +225 -18
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.ts +3 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.ts +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.ts +51 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.ts +17 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.ts +16 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.js +5 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/types/Device1.d.ts +1 -0
- package/dist/cjs/api/types/Session1.d.ts +3 -0
- package/dist/cjs/api/types/SessionListRes.d.ts +8 -0
- package/dist/cjs/api/types/SessionListRes.js +5 -0
- package/dist/cjs/api/types/SessionSearchRes.d.ts +8 -0
- package/dist/cjs/api/types/SessionSearchRes.js +5 -0
- package/dist/cjs/api/types/SessionSortByEnum.d.ts +8 -0
- package/dist/cjs/api/types/SessionSortByEnum.js +10 -0
- package/dist/cjs/api/types/index.d.ts +3 -0
- package/dist/cjs/api/types/index.js +3 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesRegisterToOrgReq1.d.mts +1 -0
- package/dist/esm/api/resources/tracking/resources/devices/client/requests/DevicesUpdateRequest1.d.mts +2 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +56 -5
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +225 -18
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionCreateSessionRequest1.d.mts +3 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionUpdateRequest1.d.mts +5 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.d.mts +51 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsListV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.d.mts +17 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsSearchV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.d.mts +16 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsTypeaheadOffChrtOrderIdV1Request.mjs +4 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/index.d.mts +3 -0
- package/dist/esm/api/types/Device1.d.mts +1 -0
- package/dist/esm/api/types/Session1.d.mts +3 -0
- package/dist/esm/api/types/SessionListRes.d.mts +8 -0
- package/dist/esm/api/types/SessionListRes.mjs +4 -0
- package/dist/esm/api/types/SessionSearchRes.d.mts +8 -0
- package/dist/esm/api/types/SessionSearchRes.mjs +4 -0
- package/dist/esm/api/types/SessionSortByEnum.d.mts +8 -0
- package/dist/esm/api/types/SessionSortByEnum.mjs +7 -0
- package/dist/esm/api/types/index.d.mts +3 -0
- package/dist/esm/api/types/index.mjs +3 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +162 -6
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type SessionSortByEnum = "session_created_at_timestamp" | "recording_initiated_at_timestamp";
|
|
5
|
+
export declare const SessionSortByEnum: {
|
|
6
|
+
readonly SessionCreatedAtTimestamp: "session_created_at_timestamp";
|
|
7
|
+
readonly RecordingInitiatedAtTimestamp: "recording_initiated_at_timestamp";
|
|
8
|
+
};
|
|
@@ -104,6 +104,9 @@ export * from "./SessionByDeviceDataPoint1.mjs";
|
|
|
104
104
|
export * from "./SessionByDeviceDataPointMetadata1.mjs";
|
|
105
105
|
export * from "./SessionByDeviceMarkOutliersResponse1.mjs";
|
|
106
106
|
export * from "./SessionDeleteResponse1.mjs";
|
|
107
|
+
export * from "./SessionListRes.mjs";
|
|
108
|
+
export * from "./SessionSearchRes.mjs";
|
|
109
|
+
export * from "./SessionSortByEnum.mjs";
|
|
107
110
|
export * from "./SetFlightInfoReq.mjs";
|
|
108
111
|
export * from "./SettlementTypeEnum1.mjs";
|
|
109
112
|
export * from "./ShipperConnectionRes.mjs";
|
|
@@ -104,6 +104,9 @@ export * from "./SessionByDeviceDataPoint1.mjs";
|
|
|
104
104
|
export * from "./SessionByDeviceDataPointMetadata1.mjs";
|
|
105
105
|
export * from "./SessionByDeviceMarkOutliersResponse1.mjs";
|
|
106
106
|
export * from "./SessionDeleteResponse1.mjs";
|
|
107
|
+
export * from "./SessionListRes.mjs";
|
|
108
|
+
export * from "./SessionSearchRes.mjs";
|
|
109
|
+
export * from "./SessionSortByEnum.mjs";
|
|
107
110
|
export * from "./SetFlightInfoReq.mjs";
|
|
108
111
|
export * from "./SettlementTypeEnum1.mjs";
|
|
109
112
|
export * from "./ShipperConnectionRes.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.
|
|
1
|
+
export declare const SDK_VERSION = "1.405.0";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.
|
|
1
|
+
export const SDK_VERSION = "1.405.0";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -13118,7 +13118,7 @@ await client.tracking.devices.registerToOrgV1({
|
|
|
13118
13118
|
<dl>
|
|
13119
13119
|
<dd>
|
|
13120
13120
|
|
|
13121
|
-
Updates a device's type and/or
|
|
13121
|
+
Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)
|
|
13122
13122
|
|
|
13123
13123
|
</dd>
|
|
13124
13124
|
</dl>
|
|
@@ -13565,7 +13565,7 @@ await client.tracking.driver.updateV1({
|
|
|
13565
13565
|
|
|
13566
13566
|
## Tracking Sessions
|
|
13567
13567
|
|
|
13568
|
-
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>() -> Chrt.
|
|
13568
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">listV1</a>({ ...params }) -> Chrt.SessionListRes</code></summary>
|
|
13569
13569
|
<dl>
|
|
13570
13570
|
<dd>
|
|
13571
13571
|
|
|
@@ -13577,7 +13577,7 @@ await client.tracking.driver.updateV1({
|
|
|
13577
13577
|
<dl>
|
|
13578
13578
|
<dd>
|
|
13579
13579
|
|
|
13580
|
-
|
|
13580
|
+
Lists sessions with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (SessionListRes)
|
|
13581
13581
|
|
|
13582
13582
|
</dd>
|
|
13583
13583
|
</dl>
|
|
@@ -13593,7 +13593,22 @@ Returns all tracking sessions for the caller's organization. | () -> (list[Sessi
|
|
|
13593
13593
|
<dd>
|
|
13594
13594
|
|
|
13595
13595
|
```typescript
|
|
13596
|
-
await client.tracking.sessions.listV1(
|
|
13596
|
+
await client.tracking.sessions.listV1({
|
|
13597
|
+
sort_by: "session_created_at_timestamp",
|
|
13598
|
+
sort_order: "asc",
|
|
13599
|
+
page: 1,
|
|
13600
|
+
page_size: 1,
|
|
13601
|
+
filter_recording: true,
|
|
13602
|
+
filter_terminated: true,
|
|
13603
|
+
filter_public: true,
|
|
13604
|
+
filter_device_id: "filter_device_id",
|
|
13605
|
+
filter_off_chrt_order_id: "filter_off_chrt_order_id",
|
|
13606
|
+
filter_flight_number: "filter_flight_number",
|
|
13607
|
+
filter_session_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13608
|
+
filter_session_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13609
|
+
filter_recording_initiated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
13610
|
+
filter_recording_initiated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
13611
|
+
});
|
|
13597
13612
|
```
|
|
13598
13613
|
|
|
13599
13614
|
</dd>
|
|
@@ -13609,6 +13624,14 @@ await client.tracking.sessions.listV1();
|
|
|
13609
13624
|
<dl>
|
|
13610
13625
|
<dd>
|
|
13611
13626
|
|
|
13627
|
+
**request:** `Chrt.tracking.SessionsListV1Request`
|
|
13628
|
+
|
|
13629
|
+
</dd>
|
|
13630
|
+
</dl>
|
|
13631
|
+
|
|
13632
|
+
<dl>
|
|
13633
|
+
<dd>
|
|
13634
|
+
|
|
13612
13635
|
**requestOptions:** `Sessions.RequestOptions`
|
|
13613
13636
|
|
|
13614
13637
|
</dd>
|
|
@@ -13632,7 +13655,7 @@ await client.tracking.sessions.listV1();
|
|
|
13632
13655
|
<dl>
|
|
13633
13656
|
<dd>
|
|
13634
13657
|
|
|
13635
|
-
Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)
|
|
13658
|
+
Retrieves a single session by its ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Session1)
|
|
13636
13659
|
|
|
13637
13660
|
</dd>
|
|
13638
13661
|
</dl>
|
|
@@ -13685,6 +13708,139 @@ await client.tracking.sessions.getV1({
|
|
|
13685
13708
|
</dl>
|
|
13686
13709
|
</details>
|
|
13687
13710
|
|
|
13711
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">typeaheadOffChrtOrderIdV1</a>({ ...params }) -> string[]</code></summary>
|
|
13712
|
+
<dl>
|
|
13713
|
+
<dd>
|
|
13714
|
+
|
|
13715
|
+
#### 📝 Description
|
|
13716
|
+
|
|
13717
|
+
<dl>
|
|
13718
|
+
<dd>
|
|
13719
|
+
|
|
13720
|
+
<dl>
|
|
13721
|
+
<dd>
|
|
13722
|
+
|
|
13723
|
+
Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching across both sessions and devices. | authz: min_org_role=operator | () -> (list[str])
|
|
13724
|
+
|
|
13725
|
+
</dd>
|
|
13726
|
+
</dl>
|
|
13727
|
+
</dd>
|
|
13728
|
+
</dl>
|
|
13729
|
+
|
|
13730
|
+
#### 🔌 Usage
|
|
13731
|
+
|
|
13732
|
+
<dl>
|
|
13733
|
+
<dd>
|
|
13734
|
+
|
|
13735
|
+
<dl>
|
|
13736
|
+
<dd>
|
|
13737
|
+
|
|
13738
|
+
```typescript
|
|
13739
|
+
await client.tracking.sessions.typeaheadOffChrtOrderIdV1({
|
|
13740
|
+
query: "query",
|
|
13741
|
+
limit: 1,
|
|
13742
|
+
});
|
|
13743
|
+
```
|
|
13744
|
+
|
|
13745
|
+
</dd>
|
|
13746
|
+
</dl>
|
|
13747
|
+
</dd>
|
|
13748
|
+
</dl>
|
|
13749
|
+
|
|
13750
|
+
#### ⚙️ Parameters
|
|
13751
|
+
|
|
13752
|
+
<dl>
|
|
13753
|
+
<dd>
|
|
13754
|
+
|
|
13755
|
+
<dl>
|
|
13756
|
+
<dd>
|
|
13757
|
+
|
|
13758
|
+
**request:** `Chrt.tracking.SessionsTypeaheadOffChrtOrderIdV1Request`
|
|
13759
|
+
|
|
13760
|
+
</dd>
|
|
13761
|
+
</dl>
|
|
13762
|
+
|
|
13763
|
+
<dl>
|
|
13764
|
+
<dd>
|
|
13765
|
+
|
|
13766
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13767
|
+
|
|
13768
|
+
</dd>
|
|
13769
|
+
</dl>
|
|
13770
|
+
</dd>
|
|
13771
|
+
</dl>
|
|
13772
|
+
|
|
13773
|
+
</dd>
|
|
13774
|
+
</dl>
|
|
13775
|
+
</details>
|
|
13776
|
+
|
|
13777
|
+
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">searchV1</a>({ ...params }) -> Chrt.SessionSearchRes</code></summary>
|
|
13778
|
+
<dl>
|
|
13779
|
+
<dd>
|
|
13780
|
+
|
|
13781
|
+
#### 📝 Description
|
|
13782
|
+
|
|
13783
|
+
<dl>
|
|
13784
|
+
<dd>
|
|
13785
|
+
|
|
13786
|
+
<dl>
|
|
13787
|
+
<dd>
|
|
13788
|
+
|
|
13789
|
+
Full-text search across session comments, device_mac_address, flight_number, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (SessionSearchRes)
|
|
13790
|
+
|
|
13791
|
+
</dd>
|
|
13792
|
+
</dl>
|
|
13793
|
+
</dd>
|
|
13794
|
+
</dl>
|
|
13795
|
+
|
|
13796
|
+
#### 🔌 Usage
|
|
13797
|
+
|
|
13798
|
+
<dl>
|
|
13799
|
+
<dd>
|
|
13800
|
+
|
|
13801
|
+
<dl>
|
|
13802
|
+
<dd>
|
|
13803
|
+
|
|
13804
|
+
```typescript
|
|
13805
|
+
await client.tracking.sessions.searchV1({
|
|
13806
|
+
query: "query",
|
|
13807
|
+
page: 1,
|
|
13808
|
+
page_size: 1,
|
|
13809
|
+
});
|
|
13810
|
+
```
|
|
13811
|
+
|
|
13812
|
+
</dd>
|
|
13813
|
+
</dl>
|
|
13814
|
+
</dd>
|
|
13815
|
+
</dl>
|
|
13816
|
+
|
|
13817
|
+
#### ⚙️ Parameters
|
|
13818
|
+
|
|
13819
|
+
<dl>
|
|
13820
|
+
<dd>
|
|
13821
|
+
|
|
13822
|
+
<dl>
|
|
13823
|
+
<dd>
|
|
13824
|
+
|
|
13825
|
+
**request:** `Chrt.tracking.SessionsSearchV1Request`
|
|
13826
|
+
|
|
13827
|
+
</dd>
|
|
13828
|
+
</dl>
|
|
13829
|
+
|
|
13830
|
+
<dl>
|
|
13831
|
+
<dd>
|
|
13832
|
+
|
|
13833
|
+
**requestOptions:** `Sessions.RequestOptions`
|
|
13834
|
+
|
|
13835
|
+
</dd>
|
|
13836
|
+
</dl>
|
|
13837
|
+
</dd>
|
|
13838
|
+
</dl>
|
|
13839
|
+
|
|
13840
|
+
</dd>
|
|
13841
|
+
</dl>
|
|
13842
|
+
</details>
|
|
13843
|
+
|
|
13688
13844
|
<details><summary><code>client.tracking.sessions.<a href="/src/api/resources/tracking/resources/sessions/client/Client.ts">createSessionV1</a>({ ...params }) -> string</code></summary>
|
|
13689
13845
|
<dl>
|
|
13690
13846
|
<dd>
|
|
@@ -13762,7 +13918,7 @@ await client.tracking.sessions.createSessionV1({
|
|
|
13762
13918
|
<dl>
|
|
13763
13919
|
<dd>
|
|
13764
13920
|
|
|
13765
|
-
Updates a session's comments
|
|
13921
|
+
Updates a session's mutable fields (comments, public, off_chrt_order_id, flight_number, fa_flight_ids). | (SessionUpdateRequest1) -> (bool)
|
|
13766
13922
|
|
|
13767
13923
|
</dd>
|
|
13768
13924
|
</dl>
|