@chrt-inc/typescript-sdk 1.689.0 → 1.692.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 (70) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.d.ts +14 -0
  3. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/Client.js +63 -0
  4. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.ts +1 -0
  5. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.d.ts +11 -0
  6. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.js +5 -0
  7. package/dist/cjs/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.ts +1 -0
  8. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.ts +14 -0
  9. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.js +63 -0
  10. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.ts +1 -0
  11. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.d.ts +11 -0
  12. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.js +5 -0
  13. package/dist/cjs/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.ts +1 -0
  14. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +66 -0
  15. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +299 -0
  16. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.d.ts +12 -0
  17. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.js +5 -0
  18. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/index.d.ts +1 -0
  19. package/dist/cjs/api/types/Driver1.d.ts +1 -0
  20. package/dist/cjs/api/types/DriverComplianceDocument1.d.ts +1 -0
  21. package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.d.ts +16 -1
  22. package/dist/cjs/api/types/DriverComplianceDocumentTypeEnum1.js +15 -0
  23. package/dist/cjs/api/types/OrgComplianceDocument1.d.ts +1 -0
  24. package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.d.ts +11 -1
  25. package/dist/cjs/api/types/OrgComplianceDocumentTypeEnum1.js +10 -0
  26. package/dist/cjs/api/types/Task1.d.ts +7 -0
  27. package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -0
  28. package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
  29. package/dist/cjs/api/types/TaskWaitTimeGeofenceRes.d.ts +9 -0
  30. package/dist/cjs/api/types/TaskWaitTimeGeofenceRes.js +5 -0
  31. package/dist/cjs/api/types/index.d.ts +1 -0
  32. package/dist/cjs/api/types/index.js +1 -0
  33. package/dist/cjs/version.d.ts +1 -1
  34. package/dist/cjs/version.js +1 -1
  35. package/dist/esm/Client.mjs +2 -2
  36. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.d.mts +14 -0
  37. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/Client.mjs +63 -0
  38. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientCreate1.d.mts +1 -0
  39. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.d.mts +11 -0
  40. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/OrgComplianceDocumentClientUpdate1.mjs +4 -0
  41. package/dist/esm/api/resources/orgs/resources/complianceDocuments/client/requests/index.d.mts +1 -0
  42. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.d.mts +14 -0
  43. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.mjs +63 -0
  44. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientCreate1.d.mts +1 -0
  45. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.d.mts +11 -0
  46. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/DriverComplianceDocumentClientUpdate1.mjs +4 -0
  47. package/dist/esm/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/requests/index.d.mts +1 -0
  48. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +66 -0
  49. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +299 -0
  50. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.d.mts +12 -0
  51. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.mjs +4 -0
  52. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/index.d.mts +1 -0
  53. package/dist/esm/api/types/Driver1.d.mts +1 -0
  54. package/dist/esm/api/types/DriverComplianceDocument1.d.mts +1 -0
  55. package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.d.mts +16 -1
  56. package/dist/esm/api/types/DriverComplianceDocumentTypeEnum1.mjs +15 -0
  57. package/dist/esm/api/types/OrgComplianceDocument1.d.mts +1 -0
  58. package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.d.mts +11 -1
  59. package/dist/esm/api/types/OrgComplianceDocumentTypeEnum1.mjs +10 -0
  60. package/dist/esm/api/types/Task1.d.mts +7 -0
  61. package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -0
  62. package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
  63. package/dist/esm/api/types/TaskWaitTimeGeofenceRes.d.mts +9 -0
  64. package/dist/esm/api/types/TaskWaitTimeGeofenceRes.mjs +4 -0
  65. package/dist/esm/api/types/index.d.mts +1 -0
  66. package/dist/esm/api/types/index.mjs +1 -0
  67. package/dist/esm/version.d.mts +1 -1
  68. package/dist/esm/version.mjs +1 -1
  69. package/package.json +1 -1
  70. package/reference.md +465 -0
package/reference.md CHANGED
@@ -13654,6 +13654,77 @@ await client.orgs.complianceDocuments.createV1({
13654
13654
  </dl>
13655
13655
  </details>
13656
13656
 
13657
+ <details><summary><code>client.orgs.complianceDocuments.<a href="/src/api/resources/orgs/resources/complianceDocuments/client/Client.ts">updateV1</a>(orgComplianceDocumentId, { ...params }) -> Chrt.OrgComplianceDocument1</code></summary>
13658
+ <dl>
13659
+ <dd>
13660
+
13661
+ #### 📝 Description
13662
+
13663
+ <dl>
13664
+ <dd>
13665
+
13666
+ <dl>
13667
+ <dd>
13668
+
13669
+ Updates an organization compliance document for the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (OrgComplianceDocumentClientUpdate1) -> (OrgComplianceDocument1)
13670
+
13671
+ </dd>
13672
+ </dl>
13673
+ </dd>
13674
+ </dl>
13675
+
13676
+ #### 🔌 Usage
13677
+
13678
+ <dl>
13679
+ <dd>
13680
+
13681
+ <dl>
13682
+ <dd>
13683
+
13684
+ ```typescript
13685
+ await client.orgs.complianceDocuments.updateV1("org_compliance_document_id");
13686
+ ```
13687
+
13688
+ </dd>
13689
+ </dl>
13690
+ </dd>
13691
+ </dl>
13692
+
13693
+ #### ⚙️ Parameters
13694
+
13695
+ <dl>
13696
+ <dd>
13697
+
13698
+ <dl>
13699
+ <dd>
13700
+
13701
+ **orgComplianceDocumentId:** `string`
13702
+
13703
+ </dd>
13704
+ </dl>
13705
+
13706
+ <dl>
13707
+ <dd>
13708
+
13709
+ **request:** `Chrt.orgs.OrgComplianceDocumentClientUpdate1`
13710
+
13711
+ </dd>
13712
+ </dl>
13713
+
13714
+ <dl>
13715
+ <dd>
13716
+
13717
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
13718
+
13719
+ </dd>
13720
+ </dl>
13721
+ </dd>
13722
+ </dl>
13723
+
13724
+ </dd>
13725
+ </dl>
13726
+ </details>
13727
+
13657
13728
  ## Orgs PrivateData
13658
13729
 
13659
13730
  <details><summary><code>client.orgs.privateData.<a href="/src/api/resources/orgs/resources/privateData/client/Client.ts">getV1</a>() -> Chrt.OrgPrivateData1</code></summary>
@@ -18796,6 +18867,329 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18796
18867
 
18797
18868
  ## Shipping Tasks
18798
18869
 
18870
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeGeofenceV1</a>(taskId) -> Chrt.TaskWaitTimeGeofenceRes</code></summary>
18871
+ <dl>
18872
+ <dd>
18873
+
18874
+ #### 📝 Description
18875
+
18876
+ <dl>
18877
+ <dd>
18878
+
18879
+ <dl>
18880
+ <dd>
18881
+
18882
+ Checks whether the assigned driver's available location is inside the task wait-time geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (TaskWaitTimeGeofenceRes)
18883
+
18884
+ </dd>
18885
+ </dl>
18886
+ </dd>
18887
+ </dl>
18888
+
18889
+ #### 🔌 Usage
18890
+
18891
+ <dl>
18892
+ <dd>
18893
+
18894
+ <dl>
18895
+ <dd>
18896
+
18897
+ ```typescript
18898
+ await client.shipping.tasks.waitTimeGeofenceV1("task_id");
18899
+ ```
18900
+
18901
+ </dd>
18902
+ </dl>
18903
+ </dd>
18904
+ </dl>
18905
+
18906
+ #### ⚙️ Parameters
18907
+
18908
+ <dl>
18909
+ <dd>
18910
+
18911
+ <dl>
18912
+ <dd>
18913
+
18914
+ **taskId:** `string`
18915
+
18916
+ </dd>
18917
+ </dl>
18918
+
18919
+ <dl>
18920
+ <dd>
18921
+
18922
+ **requestOptions:** `Tasks.RequestOptions`
18923
+
18924
+ </dd>
18925
+ </dl>
18926
+ </dd>
18927
+ </dl>
18928
+
18929
+ </dd>
18930
+ </dl>
18931
+ </details>
18932
+
18933
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeStartV1</a>(taskId) -> boolean</code></summary>
18934
+ <dl>
18935
+ <dd>
18936
+
18937
+ #### 📝 Description
18938
+
18939
+ <dl>
18940
+ <dd>
18941
+
18942
+ <dl>
18943
+ <dd>
18944
+
18945
+ Starts wait time for a task and records whether the assigned driver's available location is inside the geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)
18946
+
18947
+ </dd>
18948
+ </dl>
18949
+ </dd>
18950
+ </dl>
18951
+
18952
+ #### 🔌 Usage
18953
+
18954
+ <dl>
18955
+ <dd>
18956
+
18957
+ <dl>
18958
+ <dd>
18959
+
18960
+ ```typescript
18961
+ await client.shipping.tasks.waitTimeStartV1("task_id");
18962
+ ```
18963
+
18964
+ </dd>
18965
+ </dl>
18966
+ </dd>
18967
+ </dl>
18968
+
18969
+ #### ⚙️ Parameters
18970
+
18971
+ <dl>
18972
+ <dd>
18973
+
18974
+ <dl>
18975
+ <dd>
18976
+
18977
+ **taskId:** `string`
18978
+
18979
+ </dd>
18980
+ </dl>
18981
+
18982
+ <dl>
18983
+ <dd>
18984
+
18985
+ **requestOptions:** `Tasks.RequestOptions`
18986
+
18987
+ </dd>
18988
+ </dl>
18989
+ </dd>
18990
+ </dl>
18991
+
18992
+ </dd>
18993
+ </dl>
18994
+ </details>
18995
+
18996
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeEndV1</a>(taskId) -> boolean</code></summary>
18997
+ <dl>
18998
+ <dd>
18999
+
19000
+ #### 📝 Description
19001
+
19002
+ <dl>
19003
+ <dd>
19004
+
19005
+ <dl>
19006
+ <dd>
19007
+
19008
+ Ends an active wait-time session for a task. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)
19009
+
19010
+ </dd>
19011
+ </dl>
19012
+ </dd>
19013
+ </dl>
19014
+
19015
+ #### 🔌 Usage
19016
+
19017
+ <dl>
19018
+ <dd>
19019
+
19020
+ <dl>
19021
+ <dd>
19022
+
19023
+ ```typescript
19024
+ await client.shipping.tasks.waitTimeEndV1("task_id");
19025
+ ```
19026
+
19027
+ </dd>
19028
+ </dl>
19029
+ </dd>
19030
+ </dl>
19031
+
19032
+ #### ⚙️ Parameters
19033
+
19034
+ <dl>
19035
+ <dd>
19036
+
19037
+ <dl>
19038
+ <dd>
19039
+
19040
+ **taskId:** `string`
19041
+
19042
+ </dd>
19043
+ </dl>
19044
+
19045
+ <dl>
19046
+ <dd>
19047
+
19048
+ **requestOptions:** `Tasks.RequestOptions`
19049
+
19050
+ </dd>
19051
+ </dl>
19052
+ </dd>
19053
+ </dl>
19054
+
19055
+ </dd>
19056
+ </dl>
19057
+ </details>
19058
+
19059
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeValidateV1</a>(taskId) -> boolean</code></summary>
19060
+ <dl>
19061
+ <dd>
19062
+
19063
+ #### 📝 Description
19064
+
19065
+ <dl>
19066
+ <dd>
19067
+
19068
+ <dl>
19069
+ <dd>
19070
+
19071
+ Validates wait time for a task. | authz_personas=[executor_org_operators] | () -> (bool)
19072
+
19073
+ </dd>
19074
+ </dl>
19075
+ </dd>
19076
+ </dl>
19077
+
19078
+ #### 🔌 Usage
19079
+
19080
+ <dl>
19081
+ <dd>
19082
+
19083
+ <dl>
19084
+ <dd>
19085
+
19086
+ ```typescript
19087
+ await client.shipping.tasks.waitTimeValidateV1("task_id");
19088
+ ```
19089
+
19090
+ </dd>
19091
+ </dl>
19092
+ </dd>
19093
+ </dl>
19094
+
19095
+ #### ⚙️ Parameters
19096
+
19097
+ <dl>
19098
+ <dd>
19099
+
19100
+ <dl>
19101
+ <dd>
19102
+
19103
+ **taskId:** `string`
19104
+
19105
+ </dd>
19106
+ </dl>
19107
+
19108
+ <dl>
19109
+ <dd>
19110
+
19111
+ **requestOptions:** `Tasks.RequestOptions`
19112
+
19113
+ </dd>
19114
+ </dl>
19115
+ </dd>
19116
+ </dl>
19117
+
19118
+ </dd>
19119
+ </dl>
19120
+ </details>
19121
+
19122
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeOverrideV1</a>(taskId, { ...params }) -> boolean</code></summary>
19123
+ <dl>
19124
+ <dd>
19125
+
19126
+ #### 📝 Description
19127
+
19128
+ <dl>
19129
+ <dd>
19130
+
19131
+ <dl>
19132
+ <dd>
19133
+
19134
+ Overrides wait-time timestamps or geofence distance for a task. | authz_personas=[executor_org_operators] | (WaitTimeOverrideReq) -> (bool)
19135
+
19136
+ </dd>
19137
+ </dl>
19138
+ </dd>
19139
+ </dl>
19140
+
19141
+ #### 🔌 Usage
19142
+
19143
+ <dl>
19144
+ <dd>
19145
+
19146
+ <dl>
19147
+ <dd>
19148
+
19149
+ ```typescript
19150
+ await client.shipping.tasks.waitTimeOverrideV1("task_id");
19151
+ ```
19152
+
19153
+ </dd>
19154
+ </dl>
19155
+ </dd>
19156
+ </dl>
19157
+
19158
+ #### ⚙️ Parameters
19159
+
19160
+ <dl>
19161
+ <dd>
19162
+
19163
+ <dl>
19164
+ <dd>
19165
+
19166
+ **taskId:** `string`
19167
+
19168
+ </dd>
19169
+ </dl>
19170
+
19171
+ <dl>
19172
+ <dd>
19173
+
19174
+ **request:** `Chrt.shipping.WaitTimeOverrideReq`
19175
+
19176
+ </dd>
19177
+ </dl>
19178
+
19179
+ <dl>
19180
+ <dd>
19181
+
19182
+ **requestOptions:** `Tasks.RequestOptions`
19183
+
19184
+ </dd>
19185
+ </dl>
19186
+ </dd>
19187
+ </dl>
19188
+
19189
+ </dd>
19190
+ </dl>
19191
+ </details>
19192
+
18799
19193
  <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">addToTaskGroupV1</a>(taskGroupId, { ...params }) -> string</code></summary>
18800
19194
  <dl>
18801
19195
  <dd>
@@ -19406,6 +19800,77 @@ await client.shipping.drivers.complianceDocuments.createV1("driver_id", {
19406
19800
  </dl>
19407
19801
  </details>
19408
19802
 
19803
+ <details><summary><code>client.shipping.drivers.complianceDocuments.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/client/Client.ts">updateV1</a>(driverComplianceDocumentId, { ...params }) -> Chrt.DriverComplianceDocument1</code></summary>
19804
+ <dl>
19805
+ <dd>
19806
+
19807
+ #### 📝 Description
19808
+
19809
+ <dl>
19810
+ <dd>
19811
+
19812
+ <dl>
19813
+ <dd>
19814
+
19815
+ Updates a driver compliance document in the caller's provider organization. | authz: allowed_org_types=[provider], min_org_role=administrator | (DriverComplianceDocumentClientUpdate1) -> (DriverComplianceDocument1)
19816
+
19817
+ </dd>
19818
+ </dl>
19819
+ </dd>
19820
+ </dl>
19821
+
19822
+ #### 🔌 Usage
19823
+
19824
+ <dl>
19825
+ <dd>
19826
+
19827
+ <dl>
19828
+ <dd>
19829
+
19830
+ ```typescript
19831
+ await client.shipping.drivers.complianceDocuments.updateV1("driver_compliance_document_id");
19832
+ ```
19833
+
19834
+ </dd>
19835
+ </dl>
19836
+ </dd>
19837
+ </dl>
19838
+
19839
+ #### ⚙️ Parameters
19840
+
19841
+ <dl>
19842
+ <dd>
19843
+
19844
+ <dl>
19845
+ <dd>
19846
+
19847
+ **driverComplianceDocumentId:** `string`
19848
+
19849
+ </dd>
19850
+ </dl>
19851
+
19852
+ <dl>
19853
+ <dd>
19854
+
19855
+ **request:** `Chrt.shipping.drivers.DriverComplianceDocumentClientUpdate1`
19856
+
19857
+ </dd>
19858
+ </dl>
19859
+
19860
+ <dl>
19861
+ <dd>
19862
+
19863
+ **requestOptions:** `ComplianceDocuments.RequestOptions`
19864
+
19865
+ </dd>
19866
+ </dl>
19867
+ </dd>
19868
+ </dl>
19869
+
19870
+ </dd>
19871
+ </dl>
19872
+ </details>
19873
+
19409
19874
  ## Shipping Drivers ComplianceDocuments S3Object
19410
19875
 
19411
19876
  <details><summary><code>client.shipping.drivers.complianceDocuments.s3Object.<a href="/src/api/resources/shipping/resources/drivers/resources/complianceDocuments/resources/s3Object/client/Client.ts">getS3ObjectMetadataV1</a>(driverComplianceDocumentS3ObjectMetadataId) -> Chrt.DriverComplianceDocumentS3ObjectMetadata1</code></summary>