@chrt-inc/typescript-sdk 1.689.0 → 1.691.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 (34) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.d.ts +66 -0
  3. package/dist/cjs/api/resources/shipping/resources/tasks/client/Client.js +299 -0
  4. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.d.ts +12 -0
  5. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.js +5 -0
  6. package/dist/cjs/api/resources/shipping/resources/tasks/client/requests/index.d.ts +1 -0
  7. package/dist/cjs/api/types/Driver1.d.ts +1 -0
  8. package/dist/cjs/api/types/Task1.d.ts +7 -0
  9. package/dist/cjs/api/types/TaskClientCreate1.d.ts +1 -0
  10. package/dist/cjs/api/types/TaskGroup1.d.ts +1 -0
  11. package/dist/cjs/api/types/TaskWaitTimeGeofenceRes.d.ts +9 -0
  12. package/dist/cjs/api/types/TaskWaitTimeGeofenceRes.js +5 -0
  13. package/dist/cjs/api/types/index.d.ts +1 -0
  14. package/dist/cjs/api/types/index.js +1 -0
  15. package/dist/cjs/version.d.ts +1 -1
  16. package/dist/cjs/version.js +1 -1
  17. package/dist/esm/Client.mjs +2 -2
  18. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.d.mts +66 -0
  19. package/dist/esm/api/resources/shipping/resources/tasks/client/Client.mjs +299 -0
  20. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.d.mts +12 -0
  21. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/WaitTimeOverrideReq.mjs +4 -0
  22. package/dist/esm/api/resources/shipping/resources/tasks/client/requests/index.d.mts +1 -0
  23. package/dist/esm/api/types/Driver1.d.mts +1 -0
  24. package/dist/esm/api/types/Task1.d.mts +7 -0
  25. package/dist/esm/api/types/TaskClientCreate1.d.mts +1 -0
  26. package/dist/esm/api/types/TaskGroup1.d.mts +1 -0
  27. package/dist/esm/api/types/TaskWaitTimeGeofenceRes.d.mts +9 -0
  28. package/dist/esm/api/types/TaskWaitTimeGeofenceRes.mjs +4 -0
  29. package/dist/esm/api/types/index.d.mts +1 -0
  30. package/dist/esm/api/types/index.mjs +1 -0
  31. package/dist/esm/version.d.mts +1 -1
  32. package/dist/esm/version.mjs +1 -1
  33. package/package.json +1 -1
  34. package/reference.md +323 -0
package/reference.md CHANGED
@@ -18796,6 +18796,329 @@ await client.shipping.taskGroups.quoteForProviderPayDriverV1("task_group_id", {
18796
18796
 
18797
18797
  ## Shipping Tasks
18798
18798
 
18799
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeGeofenceV1</a>(taskId) -> Chrt.TaskWaitTimeGeofenceRes</code></summary>
18800
+ <dl>
18801
+ <dd>
18802
+
18803
+ #### 📝 Description
18804
+
18805
+ <dl>
18806
+ <dd>
18807
+
18808
+ <dl>
18809
+ <dd>
18810
+
18811
+ Checks whether the assigned driver's available location is inside the task wait-time geofence. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (TaskWaitTimeGeofenceRes)
18812
+
18813
+ </dd>
18814
+ </dl>
18815
+ </dd>
18816
+ </dl>
18817
+
18818
+ #### 🔌 Usage
18819
+
18820
+ <dl>
18821
+ <dd>
18822
+
18823
+ <dl>
18824
+ <dd>
18825
+
18826
+ ```typescript
18827
+ await client.shipping.tasks.waitTimeGeofenceV1("task_id");
18828
+ ```
18829
+
18830
+ </dd>
18831
+ </dl>
18832
+ </dd>
18833
+ </dl>
18834
+
18835
+ #### ⚙️ Parameters
18836
+
18837
+ <dl>
18838
+ <dd>
18839
+
18840
+ <dl>
18841
+ <dd>
18842
+
18843
+ **taskId:** `string`
18844
+
18845
+ </dd>
18846
+ </dl>
18847
+
18848
+ <dl>
18849
+ <dd>
18850
+
18851
+ **requestOptions:** `Tasks.RequestOptions`
18852
+
18853
+ </dd>
18854
+ </dl>
18855
+ </dd>
18856
+ </dl>
18857
+
18858
+ </dd>
18859
+ </dl>
18860
+ </details>
18861
+
18862
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeStartV1</a>(taskId) -> boolean</code></summary>
18863
+ <dl>
18864
+ <dd>
18865
+
18866
+ #### 📝 Description
18867
+
18868
+ <dl>
18869
+ <dd>
18870
+
18871
+ <dl>
18872
+ <dd>
18873
+
18874
+ 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)
18875
+
18876
+ </dd>
18877
+ </dl>
18878
+ </dd>
18879
+ </dl>
18880
+
18881
+ #### 🔌 Usage
18882
+
18883
+ <dl>
18884
+ <dd>
18885
+
18886
+ <dl>
18887
+ <dd>
18888
+
18889
+ ```typescript
18890
+ await client.shipping.tasks.waitTimeStartV1("task_id");
18891
+ ```
18892
+
18893
+ </dd>
18894
+ </dl>
18895
+ </dd>
18896
+ </dl>
18897
+
18898
+ #### ⚙️ Parameters
18899
+
18900
+ <dl>
18901
+ <dd>
18902
+
18903
+ <dl>
18904
+ <dd>
18905
+
18906
+ **taskId:** `string`
18907
+
18908
+ </dd>
18909
+ </dl>
18910
+
18911
+ <dl>
18912
+ <dd>
18913
+
18914
+ **requestOptions:** `Tasks.RequestOptions`
18915
+
18916
+ </dd>
18917
+ </dl>
18918
+ </dd>
18919
+ </dl>
18920
+
18921
+ </dd>
18922
+ </dl>
18923
+ </details>
18924
+
18925
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeEndV1</a>(taskId) -> boolean</code></summary>
18926
+ <dl>
18927
+ <dd>
18928
+
18929
+ #### 📝 Description
18930
+
18931
+ <dl>
18932
+ <dd>
18933
+
18934
+ <dl>
18935
+ <dd>
18936
+
18937
+ Ends an active wait-time session for a task. | authz_personas=[driver_for_executor, executor_org_operators] | () -> (bool)
18938
+
18939
+ </dd>
18940
+ </dl>
18941
+ </dd>
18942
+ </dl>
18943
+
18944
+ #### 🔌 Usage
18945
+
18946
+ <dl>
18947
+ <dd>
18948
+
18949
+ <dl>
18950
+ <dd>
18951
+
18952
+ ```typescript
18953
+ await client.shipping.tasks.waitTimeEndV1("task_id");
18954
+ ```
18955
+
18956
+ </dd>
18957
+ </dl>
18958
+ </dd>
18959
+ </dl>
18960
+
18961
+ #### ⚙️ Parameters
18962
+
18963
+ <dl>
18964
+ <dd>
18965
+
18966
+ <dl>
18967
+ <dd>
18968
+
18969
+ **taskId:** `string`
18970
+
18971
+ </dd>
18972
+ </dl>
18973
+
18974
+ <dl>
18975
+ <dd>
18976
+
18977
+ **requestOptions:** `Tasks.RequestOptions`
18978
+
18979
+ </dd>
18980
+ </dl>
18981
+ </dd>
18982
+ </dl>
18983
+
18984
+ </dd>
18985
+ </dl>
18986
+ </details>
18987
+
18988
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeValidateV1</a>(taskId) -> boolean</code></summary>
18989
+ <dl>
18990
+ <dd>
18991
+
18992
+ #### 📝 Description
18993
+
18994
+ <dl>
18995
+ <dd>
18996
+
18997
+ <dl>
18998
+ <dd>
18999
+
19000
+ Validates wait time for a task. | authz_personas=[executor_org_operators] | () -> (bool)
19001
+
19002
+ </dd>
19003
+ </dl>
19004
+ </dd>
19005
+ </dl>
19006
+
19007
+ #### 🔌 Usage
19008
+
19009
+ <dl>
19010
+ <dd>
19011
+
19012
+ <dl>
19013
+ <dd>
19014
+
19015
+ ```typescript
19016
+ await client.shipping.tasks.waitTimeValidateV1("task_id");
19017
+ ```
19018
+
19019
+ </dd>
19020
+ </dl>
19021
+ </dd>
19022
+ </dl>
19023
+
19024
+ #### ⚙️ Parameters
19025
+
19026
+ <dl>
19027
+ <dd>
19028
+
19029
+ <dl>
19030
+ <dd>
19031
+
19032
+ **taskId:** `string`
19033
+
19034
+ </dd>
19035
+ </dl>
19036
+
19037
+ <dl>
19038
+ <dd>
19039
+
19040
+ **requestOptions:** `Tasks.RequestOptions`
19041
+
19042
+ </dd>
19043
+ </dl>
19044
+ </dd>
19045
+ </dl>
19046
+
19047
+ </dd>
19048
+ </dl>
19049
+ </details>
19050
+
19051
+ <details><summary><code>client.shipping.tasks.<a href="/src/api/resources/shipping/resources/tasks/client/Client.ts">waitTimeOverrideV1</a>(taskId, { ...params }) -> boolean</code></summary>
19052
+ <dl>
19053
+ <dd>
19054
+
19055
+ #### 📝 Description
19056
+
19057
+ <dl>
19058
+ <dd>
19059
+
19060
+ <dl>
19061
+ <dd>
19062
+
19063
+ Overrides wait-time timestamps or geofence distance for a task. | authz_personas=[executor_org_operators] | (WaitTimeOverrideReq) -> (bool)
19064
+
19065
+ </dd>
19066
+ </dl>
19067
+ </dd>
19068
+ </dl>
19069
+
19070
+ #### 🔌 Usage
19071
+
19072
+ <dl>
19073
+ <dd>
19074
+
19075
+ <dl>
19076
+ <dd>
19077
+
19078
+ ```typescript
19079
+ await client.shipping.tasks.waitTimeOverrideV1("task_id");
19080
+ ```
19081
+
19082
+ </dd>
19083
+ </dl>
19084
+ </dd>
19085
+ </dl>
19086
+
19087
+ #### ⚙️ Parameters
19088
+
19089
+ <dl>
19090
+ <dd>
19091
+
19092
+ <dl>
19093
+ <dd>
19094
+
19095
+ **taskId:** `string`
19096
+
19097
+ </dd>
19098
+ </dl>
19099
+
19100
+ <dl>
19101
+ <dd>
19102
+
19103
+ **request:** `Chrt.shipping.WaitTimeOverrideReq`
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
+
18799
19122
  <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
19123
  <dl>
18801
19124
  <dd>