@chrt-inc/typescript-sdk 1.344.0 → 1.352.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 (40) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/billing/resources/statements/client/Client.d.ts +7 -9
  3. package/dist/cjs/api/resources/billing/resources/statements/client/Client.js +10 -18
  4. package/dist/cjs/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.ts +1 -7
  5. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.d.ts +13 -13
  6. package/dist/cjs/api/resources/tracking/resources/sharingSettings/client/Client.js +48 -48
  7. package/dist/cjs/api/types/LineItemGroupStatusEnum1.d.ts +1 -2
  8. package/dist/cjs/api/types/LineItemGroupStatusEnum1.js +0 -1
  9. package/dist/cjs/api/types/Statement1.d.ts +0 -3
  10. package/dist/cjs/api/types/StatementSortByEnum.d.ts +1 -2
  11. package/dist/cjs/api/types/StatementSortByEnum.js +0 -1
  12. package/dist/cjs/api/types/StatementStatusEnum1.d.ts +1 -2
  13. package/dist/cjs/api/types/StatementStatusEnum1.js +0 -1
  14. package/dist/cjs/api/types/index.d.ts +0 -1
  15. package/dist/cjs/api/types/index.js +0 -1
  16. package/dist/cjs/version.d.ts +1 -1
  17. package/dist/cjs/version.js +1 -1
  18. package/dist/esm/Client.mjs +2 -2
  19. package/dist/esm/api/resources/billing/resources/statements/client/Client.d.mts +7 -9
  20. package/dist/esm/api/resources/billing/resources/statements/client/Client.mjs +10 -18
  21. package/dist/esm/api/resources/billing/resources/statements/client/requests/StatementsListV1Request.d.mts +1 -7
  22. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.d.mts +13 -13
  23. package/dist/esm/api/resources/tracking/resources/sharingSettings/client/Client.mjs +48 -48
  24. package/dist/esm/api/types/LineItemGroupStatusEnum1.d.mts +1 -2
  25. package/dist/esm/api/types/LineItemGroupStatusEnum1.mjs +0 -1
  26. package/dist/esm/api/types/Statement1.d.mts +0 -3
  27. package/dist/esm/api/types/StatementSortByEnum.d.mts +1 -2
  28. package/dist/esm/api/types/StatementSortByEnum.mjs +0 -1
  29. package/dist/esm/api/types/StatementStatusEnum1.d.mts +1 -2
  30. package/dist/esm/api/types/StatementStatusEnum1.mjs +0 -1
  31. package/dist/esm/api/types/index.d.mts +0 -1
  32. package/dist/esm/api/types/index.mjs +0 -1
  33. package/dist/esm/version.d.mts +1 -1
  34. package/dist/esm/version.mjs +1 -1
  35. package/package.json +1 -1
  36. package/reference.md +27 -29
  37. package/dist/cjs/api/types/SyncInvoiceRes.d.ts +0 -10
  38. package/dist/cjs/api/types/SyncInvoiceRes.js +0 -5
  39. package/dist/esm/api/types/SyncInvoiceRes.d.mts +0 -10
  40. package/dist/esm/api/types/SyncInvoiceRes.mjs +0 -4
package/reference.md CHANGED
@@ -6712,8 +6712,6 @@ await client.billing.statements.listV1({
6712
6712
  filter_opened_at_timestamp_lte: "2024-01-15T09:30:00Z",
6713
6713
  filter_paid_at_timestamp_gte: "2024-01-15T09:30:00Z",
6714
6714
  filter_paid_at_timestamp_lte: "2024-01-15T09:30:00Z",
6715
- filter_voided_at_timestamp_gte: "2024-01-15T09:30:00Z",
6716
- filter_voided_at_timestamp_lte: "2024-01-15T09:30:00Z",
6717
6715
  });
6718
6716
  ```
6719
6717
 
@@ -7095,7 +7093,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7095
7093
  </dl>
7096
7094
  </details>
7097
7095
 
7098
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.SyncInvoiceRes</code></summary>
7096
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">syncInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
7099
7097
  <dl>
7100
7098
  <dd>
7101
7099
 
@@ -7107,7 +7105,7 @@ await client.billing.statements.openInvoiceV1("statement_id");
7107
7105
  <dl>
7108
7106
  <dd>
7109
7107
 
7110
- Syncs invoice state from Stripe to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: min_org_role=operator | () -> (SyncInvoiceRes)
7108
+ Syncs invoice state from Stripe Connect to the Statement and LineItemGroups. The webhook usually keeps invoices up to date, but users can manually trigger a sync. | authz: org_type=[courier, forwarder, shipper], min_org_role=operator, authz_personas=[statement_org_operators] | () -> (Statement1)
7111
7109
 
7112
7110
  </dd>
7113
7111
  </dl>
@@ -7158,7 +7156,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7158
7156
  </dl>
7159
7157
  </details>
7160
7158
 
7161
- <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">cancelInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
7159
+ <details><summary><code>client.billing.statements.<a href="/src/api/resources/billing/resources/statements/client/Client.ts">voidInvoiceV1</a>(statementId) -> Chrt.Statement1</code></summary>
7162
7160
  <dl>
7163
7161
  <dd>
7164
7162
 
@@ -7170,7 +7168,7 @@ await client.billing.statements.syncInvoiceV1("statement_id");
7170
7168
  <dl>
7171
7169
  <dd>
7172
7170
 
7173
- Cancels/voids a Stripe Connect invoice. Statement must be OPEN or VOID. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN, VOID | () -> (Statement1)
7171
+ Voids a Stripe Connect invoice. Statement reverts to STAGED and LIGs revert to FINALIZED. | authz: org_type=[courier, forwarder], min_org_role=operator, authz_personas=[statement_owner_operators], statement_status=OPEN | () -> (Statement1)
7174
7172
 
7175
7173
  </dd>
7176
7174
  </dl>
@@ -7186,7 +7184,7 @@ Cancels/voids a Stripe Connect invoice. Statement must be OPEN or VOID. | authz:
7186
7184
  <dd>
7187
7185
 
7188
7186
  ```typescript
7189
- await client.billing.statements.cancelInvoiceV1("statement_id");
7187
+ await client.billing.statements.voidInvoiceV1("statement_id");
7190
7188
  ```
7191
7189
 
7192
7190
  </dd>
@@ -12818,7 +12816,7 @@ await client.tracking.sessions.deleteV1({
12818
12816
 
12819
12817
  ## Tracking SharingSettings
12820
12818
 
12821
- <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
12819
+ <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
12822
12820
  <dl>
12823
12821
  <dd>
12824
12822
 
@@ -12830,7 +12828,7 @@ await client.tracking.sessions.deleteV1({
12830
12828
  <dl>
12831
12829
  <dd>
12832
12830
 
12833
- Get all tracking datasets and their sharing settings for a given order. | authz_personas=[shipper_org_operators, forwarder_org_operators, courier_org_operators] | () -> (list[TrackingSharingSettingsRes])
12831
+ Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
12834
12832
 
12835
12833
  </dd>
12836
12834
  </dl>
@@ -12846,7 +12844,11 @@ Get all tracking datasets and their sharing settings for a given order. | authz_
12846
12844
  <dd>
12847
12845
 
12848
12846
  ```typescript
12849
- await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
12847
+ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
12848
+ task_group_id: "task_group_id",
12849
+ driver_id: "driver_id",
12850
+ public: true,
12851
+ });
12850
12852
  ```
12851
12853
 
12852
12854
  </dd>
@@ -12862,7 +12864,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
12862
12864
  <dl>
12863
12865
  <dd>
12864
12866
 
12865
- **orderIdOrShortId:** `string`
12867
+ **request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
12866
12868
 
12867
12869
  </dd>
12868
12870
  </dl>
@@ -12881,7 +12883,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
12881
12883
  </dl>
12882
12884
  </details>
12883
12885
 
12884
- <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">taskGroupByDriverSharingSettingsV1</a>({ ...params }) -> Chrt.TaskGroupByDriverSharingSettings1</code></summary>
12886
+ <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
12885
12887
  <dl>
12886
12888
  <dd>
12887
12889
 
@@ -12893,7 +12895,7 @@ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
12893
12895
  <dl>
12894
12896
  <dd>
12895
12897
 
12896
- Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)
12898
+ Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
12897
12899
 
12898
12900
  </dd>
12899
12901
  </dl>
@@ -12909,8 +12911,9 @@ Updates the sharing settings for a task group by driver tracking dataset. | auth
12909
12911
  <dd>
12910
12912
 
12911
12913
  ```typescript
12912
- await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
12914
+ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
12913
12915
  task_group_id: "task_group_id",
12916
+ cargo_id: "cargo_id",
12914
12917
  driver_id: "driver_id",
12915
12918
  public: true,
12916
12919
  });
@@ -12929,7 +12932,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
12929
12932
  <dl>
12930
12933
  <dd>
12931
12934
 
12932
- **request:** `Chrt.tracking.TaskGroupByDriverSharingSettingsUpdateReq`
12935
+ **request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
12933
12936
 
12934
12937
  </dd>
12935
12938
  </dl>
@@ -12948,7 +12951,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
12948
12951
  </dl>
12949
12952
  </details>
12950
12953
 
12951
- <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDriverSettingsV1</a>({ ...params }) -> Chrt.CargoByDriverSharingSettings1</code></summary>
12954
+ <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
12952
12955
  <dl>
12953
12956
  <dd>
12954
12957
 
@@ -12960,7 +12963,7 @@ await client.tracking.sharingSettings.taskGroupByDriverSharingSettingsV1({
12960
12963
  <dl>
12961
12964
  <dd>
12962
12965
 
12963
- Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)
12966
+ Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
12964
12967
 
12965
12968
  </dd>
12966
12969
  </dl>
@@ -12976,10 +12979,10 @@ Updates the sharing settings for a cargo by driver tracking dataset. | authz_per
12976
12979
  <dd>
12977
12980
 
12978
12981
  ```typescript
12979
- await client.tracking.sharingSettings.cargoByDriverSettingsV1({
12982
+ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
12980
12983
  task_group_id: "task_group_id",
12981
12984
  cargo_id: "cargo_id",
12982
- driver_id: "driver_id",
12985
+ device_id: "device_id",
12983
12986
  public: true,
12984
12987
  });
12985
12988
  ```
@@ -12997,7 +13000,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
12997
13000
  <dl>
12998
13001
  <dd>
12999
13002
 
13000
- **request:** `Chrt.tracking.CargoByDriverSharingSettingsUpdateReq`
13003
+ **request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
13001
13004
 
13002
13005
  </dd>
13003
13006
  </dl>
@@ -13016,7 +13019,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
13016
13019
  </dl>
13017
13020
  </details>
13018
13021
 
13019
- <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">cargoByDeviceSettingsV1</a>({ ...params }) -> Chrt.CargoByDeviceSharingSettings1</code></summary>
13022
+ <details><summary><code>client.tracking.sharingSettings.<a href="/src/api/resources/tracking/resources/sharingSettings/client/Client.ts">getSettingsV1</a>(orderIdOrShortId) -> Chrt.TrackingSharingSettingsRes[]</code></summary>
13020
13023
  <dl>
13021
13024
  <dd>
13022
13025
 
@@ -13028,7 +13031,7 @@ await client.tracking.sharingSettings.cargoByDriverSettingsV1({
13028
13031
  <dl>
13029
13032
  <dd>
13030
13033
 
13031
- Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)
13034
+ 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])
13032
13035
 
13033
13036
  </dd>
13034
13037
  </dl>
@@ -13044,12 +13047,7 @@ Updates the sharing settings for a cargo by device tracking dataset. | authz_per
13044
13047
  <dd>
13045
13048
 
13046
13049
  ```typescript
13047
- await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
13048
- task_group_id: "task_group_id",
13049
- cargo_id: "cargo_id",
13050
- device_id: "device_id",
13051
- public: true,
13052
- });
13050
+ await client.tracking.sharingSettings.getSettingsV1("order_id_or_short_id");
13053
13051
  ```
13054
13052
 
13055
13053
  </dd>
@@ -13065,7 +13063,7 @@ await client.tracking.sharingSettings.cargoByDeviceSettingsV1({
13065
13063
  <dl>
13066
13064
  <dd>
13067
13065
 
13068
- **request:** `Chrt.tracking.CargoByDeviceSharingSettingsUpdateReq`
13066
+ **orderIdOrShortId:** `string`
13069
13067
 
13070
13068
  </dd>
13071
13069
  </dl>
@@ -1,10 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.js";
5
- export interface SyncInvoiceRes {
6
- statement: Chrt.Statement1;
7
- /** True if any changes were synced from Stripe */
8
- synced: boolean;
9
- stripe_invoice_status?: Chrt.StripeConnectInvoiceStatusEnum | null;
10
- }
@@ -1,5 +0,0 @@
1
- "use strict";
2
- /**
3
- * This file was auto-generated by Fern from our API Definition.
4
- */
5
- Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,10 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as Chrt from "../index.mjs";
5
- export interface SyncInvoiceRes {
6
- statement: Chrt.Statement1;
7
- /** True if any changes were synced from Stripe */
8
- synced: boolean;
9
- stripe_invoice_status?: Chrt.StripeConnectInvoiceStatusEnum | null;
10
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- export {};