@chrt-inc/typescript-sdk 1.390.0 → 1.395.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 (118) hide show
  1. package/dist/cjs/Client.d.ts +3 -0
  2. package/dist/cjs/Client.js +15 -10
  3. package/dist/cjs/api/resources/analytics/client/Client.d.ts +23 -0
  4. package/dist/cjs/api/resources/analytics/client/Client.js +17 -0
  5. package/dist/cjs/api/resources/analytics/client/index.d.ts +1 -0
  6. package/dist/cjs/api/resources/analytics/client/index.js +2 -0
  7. package/dist/cjs/api/resources/analytics/index.d.ts +2 -0
  8. package/dist/cjs/api/resources/analytics/index.js +18 -0
  9. package/dist/cjs/api/resources/analytics/resources/index.d.ts +2 -0
  10. package/dist/cjs/api/resources/analytics/resources/index.js +41 -0
  11. package/dist/cjs/api/resources/analytics/resources/shipping/client/Client.d.ts +50 -0
  12. package/dist/cjs/api/resources/analytics/resources/shipping/client/Client.js +133 -0
  13. package/dist/cjs/api/resources/analytics/resources/shipping/client/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/analytics/resources/shipping/client/index.js +17 -0
  15. package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/AnalyticsTimePeriodRequest.d.ts +18 -0
  16. package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/AnalyticsTimePeriodRequest.js +5 -0
  17. package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/index.d.ts +1 -0
  18. package/dist/cjs/api/resources/analytics/resources/shipping/client/requests/index.js +2 -0
  19. package/dist/cjs/api/resources/analytics/resources/shipping/index.d.ts +1 -0
  20. package/dist/cjs/api/resources/analytics/resources/shipping/index.js +17 -0
  21. package/dist/cjs/api/resources/dev/client/Client.d.ts +7 -14
  22. package/dist/cjs/api/resources/dev/client/Client.js +25 -65
  23. package/dist/cjs/api/resources/dev/client/requests/AgentReq.d.ts +10 -0
  24. package/dist/cjs/api/resources/dev/client/requests/AgentReq.js +5 -0
  25. package/dist/cjs/api/resources/dev/client/requests/index.d.ts +1 -0
  26. package/dist/cjs/api/resources/index.d.ts +2 -0
  27. package/dist/cjs/api/resources/index.js +3 -1
  28. package/dist/cjs/api/resources/users/client/Client.d.ts +38 -0
  29. package/dist/cjs/api/resources/users/client/Client.js +178 -0
  30. package/dist/cjs/api/resources/users/client/index.d.ts +1 -0
  31. package/dist/cjs/api/resources/users/client/index.js +15 -0
  32. package/dist/cjs/api/resources/users/client/requests/UserPrivateDataClientCreate1.d.ts +14 -0
  33. package/dist/cjs/api/resources/users/client/requests/UserPrivateDataClientCreate1.js +5 -0
  34. package/dist/cjs/api/resources/users/client/requests/UserPrivateDataClientUpdate1.d.ts +11 -0
  35. package/dist/cjs/api/resources/users/client/requests/UserPrivateDataClientUpdate1.js +5 -0
  36. package/dist/cjs/api/resources/users/client/requests/index.d.ts +2 -0
  37. package/dist/cjs/api/resources/users/client/requests/index.js +2 -0
  38. package/dist/cjs/api/types/AgentRes.d.ts +8 -0
  39. package/dist/cjs/api/types/AgentRes.js +5 -0
  40. package/dist/cjs/api/types/AnalyticsTimeBucketResponse.d.ts +8 -0
  41. package/dist/cjs/api/types/AnalyticsTimeBucketResponse.js +5 -0
  42. package/dist/cjs/api/types/OrderAndTaskGroupExpandedReq.d.ts +1 -0
  43. package/dist/cjs/api/types/OrderDraftExpanded.d.ts +1 -0
  44. package/dist/cjs/api/types/OrderExpanded.d.ts +1 -0
  45. package/dist/cjs/api/types/StartOfWeek.d.ts +13 -0
  46. package/dist/cjs/api/types/StartOfWeek.js +15 -0
  47. package/dist/cjs/api/types/TimeBucket.d.ts +7 -0
  48. package/dist/cjs/api/types/TimeBucket.js +5 -0
  49. package/dist/cjs/api/types/TimeGranularity.d.ts +11 -0
  50. package/dist/cjs/api/types/TimeGranularity.js +13 -0
  51. package/dist/cjs/api/types/TimezoneEnum.d.ts +23 -0
  52. package/dist/cjs/api/types/TimezoneEnum.js +25 -0
  53. package/dist/cjs/api/types/UserPrivateData1.d.ts +12 -0
  54. package/dist/cjs/api/types/UserPrivateData1.js +5 -0
  55. package/dist/cjs/api/types/index.d.ts +7 -0
  56. package/dist/cjs/api/types/index.js +7 -0
  57. package/dist/cjs/version.d.ts +1 -1
  58. package/dist/cjs/version.js +1 -1
  59. package/dist/esm/Client.d.mts +3 -0
  60. package/dist/esm/Client.mjs +7 -2
  61. package/dist/esm/api/resources/analytics/client/Client.d.mts +23 -0
  62. package/dist/esm/api/resources/analytics/client/Client.mjs +13 -0
  63. package/dist/esm/api/resources/analytics/client/index.d.mts +1 -0
  64. package/dist/esm/api/resources/analytics/client/index.mjs +1 -0
  65. package/dist/esm/api/resources/analytics/index.d.mts +2 -0
  66. package/dist/esm/api/resources/analytics/index.mjs +2 -0
  67. package/dist/esm/api/resources/analytics/resources/index.d.mts +2 -0
  68. package/dist/esm/api/resources/analytics/resources/index.mjs +2 -0
  69. package/dist/esm/api/resources/analytics/resources/shipping/client/Client.d.mts +50 -0
  70. package/dist/esm/api/resources/analytics/resources/shipping/client/Client.mjs +96 -0
  71. package/dist/esm/api/resources/analytics/resources/shipping/client/index.d.mts +2 -0
  72. package/dist/esm/api/resources/analytics/resources/shipping/client/index.mjs +1 -0
  73. package/dist/esm/api/resources/analytics/resources/shipping/client/requests/AnalyticsTimePeriodRequest.d.mts +18 -0
  74. package/dist/esm/api/resources/analytics/resources/shipping/client/requests/AnalyticsTimePeriodRequest.mjs +4 -0
  75. package/dist/esm/api/resources/analytics/resources/shipping/client/requests/index.d.mts +1 -0
  76. package/dist/esm/api/resources/analytics/resources/shipping/client/requests/index.mjs +1 -0
  77. package/dist/esm/api/resources/analytics/resources/shipping/index.d.mts +1 -0
  78. package/dist/esm/api/resources/analytics/resources/shipping/index.mjs +1 -0
  79. package/dist/esm/api/resources/dev/client/Client.d.mts +7 -14
  80. package/dist/esm/api/resources/dev/client/Client.mjs +25 -65
  81. package/dist/esm/api/resources/dev/client/requests/AgentReq.d.mts +10 -0
  82. package/dist/esm/api/resources/dev/client/requests/AgentReq.mjs +4 -0
  83. package/dist/esm/api/resources/dev/client/requests/index.d.mts +1 -0
  84. package/dist/esm/api/resources/index.d.mts +2 -0
  85. package/dist/esm/api/resources/index.mjs +2 -0
  86. package/dist/esm/api/resources/users/client/Client.d.mts +38 -0
  87. package/dist/esm/api/resources/users/client/Client.mjs +178 -0
  88. package/dist/esm/api/resources/users/client/index.d.mts +1 -0
  89. package/dist/esm/api/resources/users/client/index.mjs +1 -1
  90. package/dist/esm/api/resources/users/client/requests/UserPrivateDataClientCreate1.d.mts +14 -0
  91. package/dist/esm/api/resources/users/client/requests/UserPrivateDataClientCreate1.mjs +4 -0
  92. package/dist/esm/api/resources/users/client/requests/UserPrivateDataClientUpdate1.d.mts +11 -0
  93. package/dist/esm/api/resources/users/client/requests/UserPrivateDataClientUpdate1.mjs +4 -0
  94. package/dist/esm/api/resources/users/client/requests/index.d.mts +2 -0
  95. package/dist/esm/api/resources/users/client/requests/index.mjs +1 -0
  96. package/dist/esm/api/types/AgentRes.d.mts +8 -0
  97. package/dist/esm/api/types/AgentRes.mjs +4 -0
  98. package/dist/esm/api/types/AnalyticsTimeBucketResponse.d.mts +8 -0
  99. package/dist/esm/api/types/AnalyticsTimeBucketResponse.mjs +4 -0
  100. package/dist/esm/api/types/OrderAndTaskGroupExpandedReq.d.mts +1 -0
  101. package/dist/esm/api/types/OrderDraftExpanded.d.mts +1 -0
  102. package/dist/esm/api/types/OrderExpanded.d.mts +1 -0
  103. package/dist/esm/api/types/StartOfWeek.d.mts +13 -0
  104. package/dist/esm/api/types/StartOfWeek.mjs +12 -0
  105. package/dist/esm/api/types/TimeBucket.d.mts +7 -0
  106. package/dist/esm/api/types/TimeBucket.mjs +4 -0
  107. package/dist/esm/api/types/TimeGranularity.d.mts +11 -0
  108. package/dist/esm/api/types/TimeGranularity.mjs +10 -0
  109. package/dist/esm/api/types/TimezoneEnum.d.mts +23 -0
  110. package/dist/esm/api/types/TimezoneEnum.mjs +22 -0
  111. package/dist/esm/api/types/UserPrivateData1.d.mts +12 -0
  112. package/dist/esm/api/types/UserPrivateData1.mjs +4 -0
  113. package/dist/esm/api/types/index.d.mts +7 -0
  114. package/dist/esm/api/types/index.mjs +7 -0
  115. package/dist/esm/version.d.mts +1 -1
  116. package/dist/esm/version.mjs +1 -1
  117. package/package.json +1 -1
  118. package/reference.md +262 -58
package/reference.md CHANGED
@@ -799,7 +799,7 @@ await client.orgProfiles.getAvatarV1("handle");
799
799
 
800
800
  ## Dev
801
801
 
802
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getAgentV1</a>() -> string</code></summary>
802
+ <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">postAgentV1</a>({ ...params }) -> Chrt.AgentRes</code></summary>
803
803
  <dl>
804
804
  <dd>
805
805
 
@@ -811,7 +811,7 @@ await client.orgProfiles.getAvatarV1("handle");
811
811
  <dl>
812
812
  <dd>
813
813
 
814
- Experimental endpoint for running AI agentic workflows. Returns the caller's ID for testing purposes. | () -> (str)
814
+ Runs a customer service agent that responds with logistics fun facts (real order data not yet available). | (AgentReq) -> (AgentRes)
815
815
 
816
816
  </dd>
817
817
  </dl>
@@ -827,7 +827,7 @@ Experimental endpoint for running AI agentic workflows. Returns the caller's ID
827
827
  <dd>
828
828
 
829
829
  ```typescript
830
- await client.dev.getAgentV1();
830
+ await client.dev.postAgentV1();
831
831
  ```
832
832
 
833
833
  </dd>
@@ -843,6 +843,14 @@ await client.dev.getAgentV1();
843
843
  <dl>
844
844
  <dd>
845
845
 
846
+ **request:** `Chrt.AgentReq`
847
+
848
+ </dd>
849
+ </dl>
850
+
851
+ <dl>
852
+ <dd>
853
+
846
854
  **requestOptions:** `Dev.RequestOptions`
847
855
 
848
856
  </dd>
@@ -1074,61 +1082,6 @@ await client.dev.getEmailV1();
1074
1082
  </dl>
1075
1083
  </details>
1076
1084
 
1077
- <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getDurableV1</a>() -> Record&lt;string, unknown&gt;</code></summary>
1078
- <dl>
1079
- <dd>
1080
-
1081
- #### 📝 Description
1082
-
1083
- <dl>
1084
- <dd>
1085
-
1086
- <dl>
1087
- <dd>
1088
-
1089
- Experimental endpoint for running durable execution workflows. Returns the caller's ID for testing purposes. | () -> (dict[str, Any])
1090
-
1091
- </dd>
1092
- </dl>
1093
- </dd>
1094
- </dl>
1095
-
1096
- #### 🔌 Usage
1097
-
1098
- <dl>
1099
- <dd>
1100
-
1101
- <dl>
1102
- <dd>
1103
-
1104
- ```typescript
1105
- await client.dev.getDurableV1();
1106
- ```
1107
-
1108
- </dd>
1109
- </dl>
1110
- </dd>
1111
- </dl>
1112
-
1113
- #### ⚙️ Parameters
1114
-
1115
- <dl>
1116
- <dd>
1117
-
1118
- <dl>
1119
- <dd>
1120
-
1121
- **requestOptions:** `Dev.RequestOptions`
1122
-
1123
- </dd>
1124
- </dl>
1125
- </dd>
1126
- </dl>
1127
-
1128
- </dd>
1129
- </dl>
1130
- </details>
1131
-
1132
1085
  <details><summary><code>client.dev.<a href="/src/api/resources/dev/client/Client.ts">getTemplateV1</a>() -> string</code></summary>
1133
1086
  <dl>
1134
1087
  <dd>
@@ -5146,6 +5099,189 @@ await client.users.getUserPublicDataV1();
5146
5099
  </dl>
5147
5100
  </details>
5148
5101
 
5102
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getUserPrivateDataV1</a>() -> Chrt.UserPrivateData1</code></summary>
5103
+ <dl>
5104
+ <dd>
5105
+
5106
+ #### 📝 Description
5107
+
5108
+ <dl>
5109
+ <dd>
5110
+
5111
+ <dl>
5112
+ <dd>
5113
+
5114
+ Retrieves private user data for the caller. | () -> (UserPrivateData1)
5115
+
5116
+ </dd>
5117
+ </dl>
5118
+ </dd>
5119
+ </dl>
5120
+
5121
+ #### 🔌 Usage
5122
+
5123
+ <dl>
5124
+ <dd>
5125
+
5126
+ <dl>
5127
+ <dd>
5128
+
5129
+ ```typescript
5130
+ await client.users.getUserPrivateDataV1();
5131
+ ```
5132
+
5133
+ </dd>
5134
+ </dl>
5135
+ </dd>
5136
+ </dl>
5137
+
5138
+ #### ⚙️ Parameters
5139
+
5140
+ <dl>
5141
+ <dd>
5142
+
5143
+ <dl>
5144
+ <dd>
5145
+
5146
+ **requestOptions:** `Users.RequestOptions`
5147
+
5148
+ </dd>
5149
+ </dl>
5150
+ </dd>
5151
+ </dl>
5152
+
5153
+ </dd>
5154
+ </dl>
5155
+ </details>
5156
+
5157
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createUserPrivateDataV1</a>({ ...params }) -> Chrt.UserPrivateData1</code></summary>
5158
+ <dl>
5159
+ <dd>
5160
+
5161
+ #### 📝 Description
5162
+
5163
+ <dl>
5164
+ <dd>
5165
+
5166
+ <dl>
5167
+ <dd>
5168
+
5169
+ Creates private user data for the caller. | (UserPrivateDataClientCreate1) -> (UserPrivateData1)
5170
+
5171
+ </dd>
5172
+ </dl>
5173
+ </dd>
5174
+ </dl>
5175
+
5176
+ #### 🔌 Usage
5177
+
5178
+ <dl>
5179
+ <dd>
5180
+
5181
+ <dl>
5182
+ <dd>
5183
+
5184
+ ```typescript
5185
+ await client.users.createUserPrivateDataV1({
5186
+ schema_version: 1,
5187
+ });
5188
+ ```
5189
+
5190
+ </dd>
5191
+ </dl>
5192
+ </dd>
5193
+ </dl>
5194
+
5195
+ #### ⚙️ Parameters
5196
+
5197
+ <dl>
5198
+ <dd>
5199
+
5200
+ <dl>
5201
+ <dd>
5202
+
5203
+ **request:** `Chrt.UserPrivateDataClientCreate1`
5204
+
5205
+ </dd>
5206
+ </dl>
5207
+
5208
+ <dl>
5209
+ <dd>
5210
+
5211
+ **requestOptions:** `Users.RequestOptions`
5212
+
5213
+ </dd>
5214
+ </dl>
5215
+ </dd>
5216
+ </dl>
5217
+
5218
+ </dd>
5219
+ </dl>
5220
+ </details>
5221
+
5222
+ <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">updateUserPrivateDataV1</a>({ ...params }) -> Chrt.UserPrivateData1</code></summary>
5223
+ <dl>
5224
+ <dd>
5225
+
5226
+ #### 📝 Description
5227
+
5228
+ <dl>
5229
+ <dd>
5230
+
5231
+ <dl>
5232
+ <dd>
5233
+
5234
+ Updates private user data for the caller. | (UserPrivateDataClientUpdate1) -> (UserPrivateData1)
5235
+
5236
+ </dd>
5237
+ </dl>
5238
+ </dd>
5239
+ </dl>
5240
+
5241
+ #### 🔌 Usage
5242
+
5243
+ <dl>
5244
+ <dd>
5245
+
5246
+ <dl>
5247
+ <dd>
5248
+
5249
+ ```typescript
5250
+ await client.users.updateUserPrivateDataV1();
5251
+ ```
5252
+
5253
+ </dd>
5254
+ </dl>
5255
+ </dd>
5256
+ </dl>
5257
+
5258
+ #### ⚙️ Parameters
5259
+
5260
+ <dl>
5261
+ <dd>
5262
+
5263
+ <dl>
5264
+ <dd>
5265
+
5266
+ **request:** `Chrt.UserPrivateDataClientUpdate1`
5267
+
5268
+ </dd>
5269
+ </dl>
5270
+
5271
+ <dl>
5272
+ <dd>
5273
+
5274
+ **requestOptions:** `Users.RequestOptions`
5275
+
5276
+ </dd>
5277
+ </dl>
5278
+ </dd>
5279
+ </dl>
5280
+
5281
+ </dd>
5282
+ </dl>
5283
+ </details>
5284
+
5149
5285
  ## Utils
5150
5286
 
5151
5287
  <details><summary><code>client.utils.<a href="/src/api/resources/utils/client/Client.ts">getTimezoneV1</a>({ ...params }) -> Chrt.TimezoneResponse</code></summary>
@@ -5214,6 +5350,74 @@ await client.utils.getTimezoneV1({
5214
5350
  </dl>
5215
5351
  </details>
5216
5352
 
5353
+ ## Analytics Shipping
5354
+
5355
+ <details><summary><code>client.analytics.shipping.<a href="/src/api/resources/analytics/resources/shipping/client/Client.ts">retrieveOrdersCountV1</a>({ ...params }) -> Chrt.AnalyticsTimeBucketResponse</code></summary>
5356
+ <dl>
5357
+ <dd>
5358
+
5359
+ #### 📝 Description
5360
+
5361
+ <dl>
5362
+ <dd>
5363
+
5364
+ <dl>
5365
+ <dd>
5366
+
5367
+ Retrieves order counts bucketed by time period. | (AnalyticsTimePeriodRequest) -> (AnalyticsTimeBucketResponse)
5368
+
5369
+ </dd>
5370
+ </dl>
5371
+ </dd>
5372
+ </dl>
5373
+
5374
+ #### 🔌 Usage
5375
+
5376
+ <dl>
5377
+ <dd>
5378
+
5379
+ <dl>
5380
+ <dd>
5381
+
5382
+ ```typescript
5383
+ await client.analytics.shipping.retrieveOrdersCountV1({
5384
+ start: "2024-01-15T09:30:00Z",
5385
+ end: "2024-01-15T09:30:00Z",
5386
+ });
5387
+ ```
5388
+
5389
+ </dd>
5390
+ </dl>
5391
+ </dd>
5392
+ </dl>
5393
+
5394
+ #### ⚙️ Parameters
5395
+
5396
+ <dl>
5397
+ <dd>
5398
+
5399
+ <dl>
5400
+ <dd>
5401
+
5402
+ **request:** `Chrt.analytics.AnalyticsTimePeriodRequest`
5403
+
5404
+ </dd>
5405
+ </dl>
5406
+
5407
+ <dl>
5408
+ <dd>
5409
+
5410
+ **requestOptions:** `Shipping.RequestOptions`
5411
+
5412
+ </dd>
5413
+ </dl>
5414
+ </dd>
5415
+ </dl>
5416
+
5417
+ </dd>
5418
+ </dl>
5419
+ </details>
5420
+
5217
5421
  ## Billing LineItemGroups
5218
5422
 
5219
5423
  <details><summary><code>client.billing.lineItemGroups.<a href="/src/api/resources/billing/resources/lineItemGroups/client/Client.ts">getV1</a>(lineItemGroupId) -> Chrt.LineItemGroup1</code></summary>