@augno/sdk 0.12.4 → 0.12.5
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/CHANGELOG.md +2 -2
- package/package.json +1 -1
- package/resources/auth/api-keys/api-keys.d.mts +4 -0
- package/resources/auth/api-keys/api-keys.d.mts.map +1 -1
- package/resources/auth/api-keys/api-keys.d.ts +4 -0
- package/resources/auth/api-keys/api-keys.d.ts.map +1 -1
- package/resources/auth/api-keys/api-keys.js.map +1 -1
- package/resources/auth/api-keys/api-keys.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +3 -3
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +3 -3
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/core.d.mts +2 -2
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +2 -2
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/request-logs.d.mts +11 -1
- package/resources/core/request-logs.d.mts.map +1 -1
- package/resources/core/request-logs.d.ts +11 -1
- package/resources/core/request-logs.d.ts.map +1 -1
- package/resources/identity/accounts.d.mts +34 -0
- package/resources/identity/accounts.d.mts.map +1 -0
- package/resources/identity/accounts.d.ts +34 -0
- package/resources/identity/accounts.d.ts.map +1 -0
- package/resources/identity/accounts.js +35 -0
- package/resources/identity/accounts.js.map +1 -0
- package/resources/identity/accounts.mjs +31 -0
- package/resources/identity/accounts.mjs.map +1 -0
- package/resources/identity/identity.d.mts +4 -0
- package/resources/identity/identity.d.mts.map +1 -1
- package/resources/identity/identity.d.ts +4 -0
- package/resources/identity/identity.d.ts.map +1 -1
- package/resources/identity/identity.js +4 -0
- package/resources/identity/identity.js.map +1 -1
- package/resources/identity/identity.mjs +4 -0
- package/resources/identity/identity.mjs.map +1 -1
- package/resources/identity/index.d.mts +1 -0
- package/resources/identity/index.d.mts.map +1 -1
- package/resources/identity/index.d.ts +1 -0
- package/resources/identity/index.d.ts.map +1 -1
- package/resources/identity/index.js +3 -1
- package/resources/identity/index.js.map +1 -1
- package/resources/identity/index.mjs +1 -0
- package/resources/identity/index.mjs.map +1 -1
- package/resources/messaging/announcements/announcements.d.mts +1 -1
- package/resources/messaging/announcements/announcements.d.mts.map +1 -1
- package/resources/messaging/announcements/announcements.d.ts +1 -1
- package/resources/messaging/announcements/announcements.d.ts.map +1 -1
- package/resources/messaging/announcements/announcements.js.map +1 -1
- package/resources/messaging/announcements/announcements.mjs.map +1 -1
- package/resources/messaging/conversations/conversations.d.mts +32 -19
- package/resources/messaging/conversations/conversations.d.mts.map +1 -1
- package/resources/messaging/conversations/conversations.d.ts +32 -19
- package/resources/messaging/conversations/conversations.d.ts.map +1 -1
- package/resources/messaging/conversations/conversations.js +2 -2
- package/resources/messaging/conversations/conversations.js.map +1 -1
- package/resources/messaging/conversations/conversations.mjs +2 -2
- package/resources/messaging/conversations/conversations.mjs.map +1 -1
- package/resources/messaging/conversations/links.d.mts +2 -2
- package/resources/messaging/conversations/links.d.mts.map +1 -1
- package/resources/messaging/conversations/links.d.ts +2 -2
- package/resources/messaging/conversations/links.d.ts.map +1 -1
- package/resources/messaging/conversations/messages.d.mts +2 -2
- package/resources/messaging/conversations/messages.d.mts.map +1 -1
- package/resources/messaging/conversations/messages.d.ts +2 -2
- package/resources/messaging/conversations/messages.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.d.mts +6 -6
- package/resources/messaging/notifications/notifications.d.mts.map +1 -1
- package/resources/messaging/notifications/notifications.d.ts +6 -6
- package/resources/messaging/notifications/notifications.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.js.map +1 -1
- package/resources/messaging/notifications/notifications.mjs.map +1 -1
- package/resources/sales/index.d.mts +1 -1
- package/resources/sales/index.d.mts.map +1 -1
- package/resources/sales/index.d.ts +1 -1
- package/resources/sales/index.d.ts.map +1 -1
- package/resources/sales/index.js +2 -2
- package/resources/sales/index.js.map +1 -1
- package/resources/sales/index.mjs +1 -1
- package/resources/sales/index.mjs.map +1 -1
- package/resources/sales/sales-orders/actions.d.mts +255 -0
- package/resources/sales/sales-orders/actions.d.mts.map +1 -0
- package/resources/sales/sales-orders/actions.d.ts +255 -0
- package/resources/sales/sales-orders/actions.d.ts.map +1 -0
- package/resources/sales/sales-orders/actions.js +156 -0
- package/resources/sales/sales-orders/actions.js.map +1 -0
- package/resources/sales/sales-orders/actions.mjs +152 -0
- package/resources/sales/sales-orders/actions.mjs.map +1 -0
- package/resources/sales/sales-orders/index.d.mts +4 -0
- package/resources/sales/sales-orders/index.d.mts.map +1 -0
- package/resources/sales/sales-orders/index.d.ts +4 -0
- package/resources/sales/sales-orders/index.d.ts.map +1 -0
- package/resources/sales/sales-orders/index.js +11 -0
- package/resources/sales/sales-orders/index.js.map +1 -0
- package/resources/sales/sales-orders/index.mjs +5 -0
- package/resources/sales/sales-orders/index.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/actions.d.mts +56 -0
- package/resources/sales/sales-orders/lines/actions.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/actions.d.ts +56 -0
- package/resources/sales/sales-orders/lines/actions.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/actions.js +38 -0
- package/resources/sales/sales-orders/lines/actions.js.map +1 -0
- package/resources/sales/sales-orders/lines/actions.mjs +34 -0
- package/resources/sales/sales-orders/lines/actions.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/index.d.mts +3 -0
- package/resources/sales/sales-orders/lines/index.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/index.d.ts +3 -0
- package/resources/sales/sales-orders/lines/index.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/index.js +9 -0
- package/resources/sales/sales-orders/lines/index.js.map +1 -0
- package/resources/sales/sales-orders/lines/index.mjs +4 -0
- package/resources/sales/sales-orders/lines/index.mjs.map +1 -0
- package/resources/sales/sales-orders/lines/lines.d.mts +208 -0
- package/resources/sales/sales-orders/lines/lines.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines/lines.d.ts +208 -0
- package/resources/sales/sales-orders/lines/lines.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines/lines.js +100 -0
- package/resources/sales/sales-orders/lines/lines.js.map +1 -0
- package/resources/sales/sales-orders/lines/lines.mjs +95 -0
- package/resources/sales/sales-orders/lines/lines.mjs.map +1 -0
- package/resources/sales/sales-orders/lines.d.mts +2 -0
- package/resources/sales/sales-orders/lines.d.mts.map +1 -0
- package/resources/sales/sales-orders/lines.d.ts +2 -0
- package/resources/sales/sales-orders/lines.d.ts.map +1 -0
- package/resources/sales/sales-orders/lines.js +6 -0
- package/resources/sales/sales-orders/lines.js.map +1 -0
- package/resources/sales/sales-orders/lines.mjs +3 -0
- package/resources/sales/sales-orders/lines.mjs.map +1 -0
- package/resources/sales/sales-orders/sales-orders.d.mts +1466 -0
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -0
- package/resources/sales/sales-orders/sales-orders.d.ts +1466 -0
- package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -0
- package/resources/sales/sales-orders/sales-orders.js +199 -0
- package/resources/sales/sales-orders/sales-orders.js.map +1 -0
- package/resources/sales/sales-orders/sales-orders.mjs +194 -0
- package/resources/sales/sales-orders/sales-orders.mjs.map +1 -0
- package/resources/sales/sales-orders.d.mts +1 -980
- package/resources/sales/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders.d.ts +1 -980
- package/resources/sales/sales-orders.d.ts.map +1 -1
- package/resources/sales/sales-orders.js +2 -76
- package/resources/sales/sales-orders.js.map +1 -1
- package/resources/sales/sales-orders.mjs +1 -74
- package/resources/sales/sales-orders.mjs.map +1 -1
- package/resources/sales/sales.d.mts +3 -3
- package/resources/sales/sales.d.mts.map +1 -1
- package/resources/sales/sales.d.ts +3 -3
- package/resources/sales/sales.d.ts.map +1 -1
- package/resources/sales/sales.js +2 -2
- package/resources/sales/sales.js.map +1 -1
- package/resources/sales/sales.mjs +2 -2
- package/resources/sales/sales.mjs.map +1 -1
- package/src/resources/auth/api-keys/api-keys.ts +5 -0
- package/src/resources/core/audit-events.ts +40 -7
- package/src/resources/core/core.ts +27 -5
- package/src/resources/core/request-logs.ts +46 -0
- package/src/resources/identity/accounts.ts +40 -0
- package/src/resources/identity/identity.ts +6 -0
- package/src/resources/identity/index.ts +1 -0
- package/src/resources/messaging/announcements/announcements.ts +2 -1
- package/src/resources/messaging/conversations/conversations.ts +75 -27
- package/src/resources/messaging/conversations/links.ts +28 -6
- package/src/resources/messaging/conversations/messages.ts +28 -6
- package/src/resources/messaging/notifications/notifications.ts +36 -10
- package/src/resources/sales/index.ts +16 -1
- package/src/resources/sales/sales-orders/actions.ts +316 -0
- package/src/resources/sales/sales-orders/index.ts +60 -0
- package/src/resources/sales/sales-orders/lines/actions.ts +72 -0
- package/src/resources/sales/sales-orders/lines/index.ts +17 -0
- package/src/resources/sales/sales-orders/lines/lines.ts +284 -0
- package/src/resources/sales/sales-orders/lines.ts +3 -0
- package/src/resources/sales/sales-orders/sales-orders.ts +1934 -0
- package/src/resources/sales/sales-orders.ts +1 -1239
- package/src/resources/sales/sales.ts +54 -24
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -116,6 +116,7 @@ export interface Entity {
|
|
|
116
116
|
| 'record'
|
|
117
117
|
| 'freight'
|
|
118
118
|
| 'sales_order_totals'
|
|
119
|
+
| 'sales_order_stage_total'
|
|
119
120
|
| 'sales_order_related'
|
|
120
121
|
| 'order_contact'
|
|
121
122
|
| 'user'
|
|
@@ -151,6 +152,7 @@ export interface Entity {
|
|
|
151
152
|
| 'notification_unread_summary'
|
|
152
153
|
| 'announcement'
|
|
153
154
|
| 'conversation'
|
|
155
|
+
| 'support_case'
|
|
154
156
|
| 'conversation_participant'
|
|
155
157
|
| 'read_cursor'
|
|
156
158
|
| 'chat_message'
|
|
@@ -186,6 +188,7 @@ export interface Entity {
|
|
|
186
188
|
| 'account_branding'
|
|
187
189
|
| 'account_portal'
|
|
188
190
|
| 'account_logo_url'
|
|
191
|
+
| 'account_favicon_url'
|
|
189
192
|
| 'public_account'
|
|
190
193
|
| 'property'
|
|
191
194
|
| 'carrier'
|
|
@@ -271,6 +274,7 @@ export interface Entity {
|
|
|
271
274
|
| 'customer_freight_preferences'
|
|
272
275
|
| 'customer_defaults'
|
|
273
276
|
| 'customer_notification_preferences'
|
|
277
|
+
| 'order_notification_recipient'
|
|
274
278
|
| 'order_discount'
|
|
275
279
|
| 'sales_order_line'
|
|
276
280
|
| 'sales_order_type'
|
|
@@ -337,9 +341,11 @@ export interface Entity {
|
|
|
337
341
|
| 'tenancy_pending_registration'
|
|
338
342
|
| 'invoice_allocation_entry'
|
|
339
343
|
| 'allocation_customer'
|
|
340
|
-
| '
|
|
341
|
-
| 'create_production_run_response'
|
|
344
|
+
| 'checkout_sales_order'
|
|
342
345
|
| 'sales_order_price_quote'
|
|
346
|
+
| 'sales_order_freight_quote'
|
|
347
|
+
| 'sales_order_price_quote_line'
|
|
348
|
+
| 'sales_order_quote_rate'
|
|
343
349
|
| 'hubspot_sync_job'
|
|
344
350
|
| 'hubspot_sync_report'
|
|
345
351
|
| 'hubspot_company_review'
|
|
@@ -351,7 +357,12 @@ export interface Entity {
|
|
|
351
357
|
| 'messaging_group_member'
|
|
352
358
|
| 'portal_profile'
|
|
353
359
|
| 'portal_registration_session'
|
|
354
|
-
| 'portal_registration_session_data'
|
|
360
|
+
| 'portal_registration_session_data'
|
|
361
|
+
| 'pack_list'
|
|
362
|
+
| 'pack_list_party'
|
|
363
|
+
| 'pack_list_line_item'
|
|
364
|
+
| 'pack_list_back_order'
|
|
365
|
+
| 'pack_list_case';
|
|
355
366
|
}
|
|
356
367
|
|
|
357
368
|
/**
|
|
@@ -417,6 +428,7 @@ export interface CoreRetrieveSearchParams {
|
|
|
417
428
|
| 'record'
|
|
418
429
|
| 'freight'
|
|
419
430
|
| 'sales_order_totals'
|
|
431
|
+
| 'sales_order_stage_total'
|
|
420
432
|
| 'sales_order_related'
|
|
421
433
|
| 'order_contact'
|
|
422
434
|
| 'user'
|
|
@@ -452,6 +464,7 @@ export interface CoreRetrieveSearchParams {
|
|
|
452
464
|
| 'notification_unread_summary'
|
|
453
465
|
| 'announcement'
|
|
454
466
|
| 'conversation'
|
|
467
|
+
| 'support_case'
|
|
455
468
|
| 'conversation_participant'
|
|
456
469
|
| 'read_cursor'
|
|
457
470
|
| 'chat_message'
|
|
@@ -487,6 +500,7 @@ export interface CoreRetrieveSearchParams {
|
|
|
487
500
|
| 'account_branding'
|
|
488
501
|
| 'account_portal'
|
|
489
502
|
| 'account_logo_url'
|
|
503
|
+
| 'account_favicon_url'
|
|
490
504
|
| 'public_account'
|
|
491
505
|
| 'property'
|
|
492
506
|
| 'carrier'
|
|
@@ -572,6 +586,7 @@ export interface CoreRetrieveSearchParams {
|
|
|
572
586
|
| 'customer_freight_preferences'
|
|
573
587
|
| 'customer_defaults'
|
|
574
588
|
| 'customer_notification_preferences'
|
|
589
|
+
| 'order_notification_recipient'
|
|
575
590
|
| 'order_discount'
|
|
576
591
|
| 'sales_order_line'
|
|
577
592
|
| 'sales_order_type'
|
|
@@ -638,9 +653,11 @@ export interface CoreRetrieveSearchParams {
|
|
|
638
653
|
| 'tenancy_pending_registration'
|
|
639
654
|
| 'invoice_allocation_entry'
|
|
640
655
|
| 'allocation_customer'
|
|
641
|
-
| '
|
|
642
|
-
| 'create_production_run_response'
|
|
656
|
+
| 'checkout_sales_order'
|
|
643
657
|
| 'sales_order_price_quote'
|
|
658
|
+
| 'sales_order_freight_quote'
|
|
659
|
+
| 'sales_order_price_quote_line'
|
|
660
|
+
| 'sales_order_quote_rate'
|
|
644
661
|
| 'hubspot_sync_job'
|
|
645
662
|
| 'hubspot_sync_report'
|
|
646
663
|
| 'hubspot_company_review'
|
|
@@ -653,6 +670,11 @@ export interface CoreRetrieveSearchParams {
|
|
|
653
670
|
| 'portal_profile'
|
|
654
671
|
| 'portal_registration_session'
|
|
655
672
|
| 'portal_registration_session_data'
|
|
673
|
+
| 'pack_list'
|
|
674
|
+
| 'pack_list_party'
|
|
675
|
+
| 'pack_list_line_item'
|
|
676
|
+
| 'pack_list_back_order'
|
|
677
|
+
| 'pack_list_case'
|
|
656
678
|
>;
|
|
657
679
|
}
|
|
658
680
|
|
|
@@ -302,6 +302,52 @@ export interface RequestLogListParams {
|
|
|
302
302
|
| 'invalid_credentials'
|
|
303
303
|
| 'insufficient_permissions'
|
|
304
304
|
| 'payment_required'
|
|
305
|
+
| 'agent_spending_cap_reached'
|
|
306
|
+
| 'validation_failed'
|
|
307
|
+
| 'missing_field'
|
|
308
|
+
| 'invalid_format'
|
|
309
|
+
| 'method_not_allowed'
|
|
310
|
+
| 'resource_not_found'
|
|
311
|
+
| 'resource_exists'
|
|
312
|
+
| 'resource_conflict'
|
|
313
|
+
| 'resource_gone'
|
|
314
|
+
| 'idempotency_in_progress'
|
|
315
|
+
| 'limit_exceeded'
|
|
316
|
+
| 'registration_closed'
|
|
317
|
+
| 'rate_limit_exceeded'
|
|
318
|
+
| 'parameter_missing'
|
|
319
|
+
| 'parameter_invalid'
|
|
320
|
+
| 'parameter_unknown'
|
|
321
|
+
| 'parameters_exclusive'
|
|
322
|
+
| 'internal_error'
|
|
323
|
+
| 'service_unavailable'
|
|
324
|
+
| 'external_service_error'
|
|
325
|
+
| 'timeout'
|
|
326
|
+
| 'connection_error'
|
|
327
|
+
| 'request_timeout'
|
|
328
|
+
| 'client_closed_request'
|
|
329
|
+
| 'api_version_required'
|
|
330
|
+
| 'api_version_invalid'
|
|
331
|
+
| 'api_version_too_old'
|
|
332
|
+
>;
|
|
333
|
+
|
|
334
|
+
/**
|
|
335
|
+
* Exclude request logs whose API error code is in this set.
|
|
336
|
+
*
|
|
337
|
+
* Applied as a negative filter after all other filters. Successful requests (which
|
|
338
|
+
* have no error code) are always kept. The dashboard uses this to hide routine
|
|
339
|
+
* `expired_token` 401s — the noise from short-lived access tokens expiring and
|
|
340
|
+
* clients silently refreshing — while still surfacing genuine auth failures like
|
|
341
|
+
* `invalid_credentials`.
|
|
342
|
+
*/
|
|
343
|
+
exclude_error_codes?: Array<
|
|
344
|
+
| 'expired_token'
|
|
345
|
+
| 'api_key_expired'
|
|
346
|
+
| 'api_key_revoked'
|
|
347
|
+
| 'invalid_credentials'
|
|
348
|
+
| 'insufficient_permissions'
|
|
349
|
+
| 'payment_required'
|
|
350
|
+
| 'agent_spending_cap_reached'
|
|
305
351
|
| 'validation_failed'
|
|
306
352
|
| 'missing_field'
|
|
307
353
|
| 'invalid_format'
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../core/resource';
|
|
4
|
+
import { APIPromise } from '../../core/api-promise';
|
|
5
|
+
import { RequestOptions } from '../../internal/request-options';
|
|
6
|
+
import { path } from '../../internal/utils/path';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Manage account details, branding, portal, logo, and favicon.
|
|
10
|
+
*/
|
|
11
|
+
export class Accounts extends APIResource {
|
|
12
|
+
/**
|
|
13
|
+
* Uploads a customer-portal favicon.
|
|
14
|
+
*
|
|
15
|
+
* Send the image as the raw request body, not as multipart form data. Use a small
|
|
16
|
+
* square PNG (e.g. 32x32 or 64x64) for the best result in browser tabs. The
|
|
17
|
+
* uploaded image replaces any existing favicon and is shown on the account's
|
|
18
|
+
* customer portal. You can only upload a favicon for the account you are acting
|
|
19
|
+
* in.
|
|
20
|
+
*
|
|
21
|
+
* This endpoint requires the permission: `self:update`.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const response =
|
|
26
|
+
* await client.identity.accounts.updateFavicon(
|
|
27
|
+
* 'ac_01148680966698341a9c0976db',
|
|
28
|
+
* );
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
updateFavicon(id: string, options?: RequestOptions): APIPromise<AccountUpdateFaviconResponse> {
|
|
32
|
+
return this._client.put(path`/v1/identity/accounts/${id}/favicon`, options);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export interface AccountUpdateFaviconResponse {}
|
|
37
|
+
|
|
38
|
+
export declare namespace Accounts {
|
|
39
|
+
export { type AccountUpdateFaviconResponse as AccountUpdateFaviconResponse };
|
|
40
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as AccountsAPI from './accounts';
|
|
5
|
+
import { AccountUpdateFaviconResponse, Accounts } from './accounts';
|
|
4
6
|
import * as RolesAPI from './roles';
|
|
5
7
|
import {
|
|
6
8
|
CreateRoleRequest,
|
|
@@ -28,10 +30,12 @@ import {
|
|
|
28
30
|
|
|
29
31
|
export class Identity extends APIResource {
|
|
30
32
|
accountUsers: AccountUsersAPI.AccountUsers = new AccountUsersAPI.AccountUsers(this._client);
|
|
33
|
+
accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
|
|
31
34
|
roles: RolesAPI.Roles = new RolesAPI.Roles(this._client);
|
|
32
35
|
}
|
|
33
36
|
|
|
34
37
|
Identity.AccountUsers = AccountUsers;
|
|
38
|
+
Identity.Accounts = Accounts;
|
|
35
39
|
Identity.Roles = Roles;
|
|
36
40
|
|
|
37
41
|
export declare namespace Identity {
|
|
@@ -47,6 +51,8 @@ export declare namespace Identity {
|
|
|
47
51
|
type AccountUserUpdateParams as AccountUserUpdateParams,
|
|
48
52
|
};
|
|
49
53
|
|
|
54
|
+
export { Accounts as Accounts, type AccountUpdateFaviconResponse as AccountUpdateFaviconResponse };
|
|
55
|
+
|
|
50
56
|
export {
|
|
51
57
|
Roles as Roles,
|
|
52
58
|
type CreateRoleRequest as CreateRoleRequest,
|
|
@@ -80,11 +80,11 @@ export class Conversations extends APIResource {
|
|
|
80
80
|
* ```ts
|
|
81
81
|
* const conversation =
|
|
82
82
|
* await client.messaging.conversations.create({
|
|
83
|
-
* type: 'group',
|
|
84
|
-
* group_id: 'cvgp_018e88072d1320808dc97abc',
|
|
85
83
|
* participant_account_user_ids: [
|
|
86
84
|
* 'acus_01ea9983ddb41dacc44ecf997c',
|
|
87
85
|
* ],
|
|
86
|
+
* type: 'group',
|
|
87
|
+
* group_id: 'cvgp_018e88072d1320808dc97abc',
|
|
88
88
|
* title: 'Order #1042 — shipping question',
|
|
89
89
|
* topic_resource_id: 'or_01d5034136c3ccc048abecc312',
|
|
90
90
|
* topic_resource_type: 'sales_order',
|
|
@@ -961,6 +961,15 @@ export interface ConversationParticipant {
|
|
|
961
961
|
* Request to create a conversation.
|
|
962
962
|
*/
|
|
963
963
|
export interface CreateConversationRequest {
|
|
964
|
+
/**
|
|
965
|
+
* The other participant(s).
|
|
966
|
+
*
|
|
967
|
+
* For a direct message, exactly one account_user ID. For a group, the members to
|
|
968
|
+
* add — optional when `group_id` seeds the roster or the conversation is anchored
|
|
969
|
+
* to a `topic_resource` (a record discussion can start solo).
|
|
970
|
+
*/
|
|
971
|
+
participant_account_user_ids: Array<string>;
|
|
972
|
+
|
|
964
973
|
/**
|
|
965
974
|
* The kind of conversation to create.
|
|
966
975
|
*/
|
|
@@ -975,14 +984,6 @@ export interface CreateConversationRequest {
|
|
|
975
984
|
*/
|
|
976
985
|
group_id?: string;
|
|
977
986
|
|
|
978
|
-
/**
|
|
979
|
-
* The other participant(s).
|
|
980
|
-
*
|
|
981
|
-
* For a direct message, exactly one account_user ID. For a group, the members to
|
|
982
|
-
* add — optional when `group_id` seeds the roster.
|
|
983
|
-
*/
|
|
984
|
-
participant_account_user_ids?: Array<string>;
|
|
985
|
-
|
|
986
987
|
/**
|
|
987
988
|
* Title for a group conversation.
|
|
988
989
|
*
|
|
@@ -1005,6 +1006,7 @@ export interface CreateConversationRequest {
|
|
|
1005
1006
|
| 'record'
|
|
1006
1007
|
| 'freight'
|
|
1007
1008
|
| 'sales_order_totals'
|
|
1009
|
+
| 'sales_order_stage_total'
|
|
1008
1010
|
| 'sales_order_related'
|
|
1009
1011
|
| 'order_contact'
|
|
1010
1012
|
| 'user'
|
|
@@ -1040,6 +1042,7 @@ export interface CreateConversationRequest {
|
|
|
1040
1042
|
| 'notification_unread_summary'
|
|
1041
1043
|
| 'announcement'
|
|
1042
1044
|
| 'conversation'
|
|
1045
|
+
| 'support_case'
|
|
1043
1046
|
| 'conversation_participant'
|
|
1044
1047
|
| 'read_cursor'
|
|
1045
1048
|
| 'chat_message'
|
|
@@ -1075,6 +1078,7 @@ export interface CreateConversationRequest {
|
|
|
1075
1078
|
| 'account_branding'
|
|
1076
1079
|
| 'account_portal'
|
|
1077
1080
|
| 'account_logo_url'
|
|
1081
|
+
| 'account_favicon_url'
|
|
1078
1082
|
| 'public_account'
|
|
1079
1083
|
| 'property'
|
|
1080
1084
|
| 'carrier'
|
|
@@ -1160,6 +1164,7 @@ export interface CreateConversationRequest {
|
|
|
1160
1164
|
| 'customer_freight_preferences'
|
|
1161
1165
|
| 'customer_defaults'
|
|
1162
1166
|
| 'customer_notification_preferences'
|
|
1167
|
+
| 'order_notification_recipient'
|
|
1163
1168
|
| 'order_discount'
|
|
1164
1169
|
| 'sales_order_line'
|
|
1165
1170
|
| 'sales_order_type'
|
|
@@ -1226,9 +1231,11 @@ export interface CreateConversationRequest {
|
|
|
1226
1231
|
| 'tenancy_pending_registration'
|
|
1227
1232
|
| 'invoice_allocation_entry'
|
|
1228
1233
|
| 'allocation_customer'
|
|
1229
|
-
| '
|
|
1230
|
-
| 'create_production_run_response'
|
|
1234
|
+
| 'checkout_sales_order'
|
|
1231
1235
|
| 'sales_order_price_quote'
|
|
1236
|
+
| 'sales_order_freight_quote'
|
|
1237
|
+
| 'sales_order_price_quote_line'
|
|
1238
|
+
| 'sales_order_quote_rate'
|
|
1232
1239
|
| 'hubspot_sync_job'
|
|
1233
1240
|
| 'hubspot_sync_report'
|
|
1234
1241
|
| 'hubspot_company_review'
|
|
@@ -1240,7 +1247,12 @@ export interface CreateConversationRequest {
|
|
|
1240
1247
|
| 'messaging_group_member'
|
|
1241
1248
|
| 'portal_profile'
|
|
1242
1249
|
| 'portal_registration_session'
|
|
1243
|
-
| 'portal_registration_session_data'
|
|
1250
|
+
| 'portal_registration_session_data'
|
|
1251
|
+
| 'pack_list'
|
|
1252
|
+
| 'pack_list_party'
|
|
1253
|
+
| 'pack_list_line_item'
|
|
1254
|
+
| 'pack_list_back_order'
|
|
1255
|
+
| 'pack_list_case';
|
|
1244
1256
|
}
|
|
1245
1257
|
|
|
1246
1258
|
/**
|
|
@@ -1392,11 +1404,24 @@ export interface Message {
|
|
|
1392
1404
|
*/
|
|
1393
1405
|
id: string;
|
|
1394
1406
|
|
|
1407
|
+
/**
|
|
1408
|
+
* Machine-readable error code for a failed agent reply (e.g.
|
|
1409
|
+
* `agent_spending_cap_reached`).
|
|
1410
|
+
*
|
|
1411
|
+
* `null` when the reply did not fail or carried no specific code.
|
|
1412
|
+
*/
|
|
1413
|
+
agent_error_code: string | null;
|
|
1414
|
+
|
|
1395
1415
|
/**
|
|
1396
1416
|
* A single execution of an agent, from trigger through completion.
|
|
1397
1417
|
*/
|
|
1398
1418
|
agent_run: AgentRun | null;
|
|
1399
1419
|
|
|
1420
|
+
/**
|
|
1421
|
+
* Whether this message is an agent reply that resolved a failed run.
|
|
1422
|
+
*/
|
|
1423
|
+
agent_run_failed: boolean;
|
|
1424
|
+
|
|
1400
1425
|
/**
|
|
1401
1426
|
* List represents a paginated list of resources.
|
|
1402
1427
|
*/
|
|
@@ -1752,6 +1777,15 @@ export interface UpdateConversationRequest {
|
|
|
1752
1777
|
}
|
|
1753
1778
|
|
|
1754
1779
|
export interface ConversationCreateParams {
|
|
1780
|
+
/**
|
|
1781
|
+
* Body param: The other participant(s).
|
|
1782
|
+
*
|
|
1783
|
+
* For a direct message, exactly one account_user ID. For a group, the members to
|
|
1784
|
+
* add — optional when `group_id` seeds the roster or the conversation is anchored
|
|
1785
|
+
* to a `topic_resource` (a record discussion can start solo).
|
|
1786
|
+
*/
|
|
1787
|
+
participant_account_user_ids: Array<string>;
|
|
1788
|
+
|
|
1755
1789
|
/**
|
|
1756
1790
|
* Body param: The kind of conversation to create.
|
|
1757
1791
|
*/
|
|
@@ -1783,14 +1817,6 @@ export interface ConversationCreateParams {
|
|
|
1783
1817
|
*/
|
|
1784
1818
|
group_id?: string;
|
|
1785
1819
|
|
|
1786
|
-
/**
|
|
1787
|
-
* Body param: The other participant(s).
|
|
1788
|
-
*
|
|
1789
|
-
* For a direct message, exactly one account_user ID. For a group, the members to
|
|
1790
|
-
* add — optional when `group_id` seeds the roster.
|
|
1791
|
-
*/
|
|
1792
|
-
participant_account_user_ids?: Array<string>;
|
|
1793
|
-
|
|
1794
1820
|
/**
|
|
1795
1821
|
* Body param: Title for a group conversation.
|
|
1796
1822
|
*
|
|
@@ -1813,6 +1839,7 @@ export interface ConversationCreateParams {
|
|
|
1813
1839
|
| 'record'
|
|
1814
1840
|
| 'freight'
|
|
1815
1841
|
| 'sales_order_totals'
|
|
1842
|
+
| 'sales_order_stage_total'
|
|
1816
1843
|
| 'sales_order_related'
|
|
1817
1844
|
| 'order_contact'
|
|
1818
1845
|
| 'user'
|
|
@@ -1848,6 +1875,7 @@ export interface ConversationCreateParams {
|
|
|
1848
1875
|
| 'notification_unread_summary'
|
|
1849
1876
|
| 'announcement'
|
|
1850
1877
|
| 'conversation'
|
|
1878
|
+
| 'support_case'
|
|
1851
1879
|
| 'conversation_participant'
|
|
1852
1880
|
| 'read_cursor'
|
|
1853
1881
|
| 'chat_message'
|
|
@@ -1883,6 +1911,7 @@ export interface ConversationCreateParams {
|
|
|
1883
1911
|
| 'account_branding'
|
|
1884
1912
|
| 'account_portal'
|
|
1885
1913
|
| 'account_logo_url'
|
|
1914
|
+
| 'account_favicon_url'
|
|
1886
1915
|
| 'public_account'
|
|
1887
1916
|
| 'property'
|
|
1888
1917
|
| 'carrier'
|
|
@@ -1968,6 +1997,7 @@ export interface ConversationCreateParams {
|
|
|
1968
1997
|
| 'customer_freight_preferences'
|
|
1969
1998
|
| 'customer_defaults'
|
|
1970
1999
|
| 'customer_notification_preferences'
|
|
2000
|
+
| 'order_notification_recipient'
|
|
1971
2001
|
| 'order_discount'
|
|
1972
2002
|
| 'sales_order_line'
|
|
1973
2003
|
| 'sales_order_type'
|
|
@@ -2034,9 +2064,11 @@ export interface ConversationCreateParams {
|
|
|
2034
2064
|
| 'tenancy_pending_registration'
|
|
2035
2065
|
| 'invoice_allocation_entry'
|
|
2036
2066
|
| 'allocation_customer'
|
|
2037
|
-
| '
|
|
2038
|
-
| 'create_production_run_response'
|
|
2067
|
+
| 'checkout_sales_order'
|
|
2039
2068
|
| 'sales_order_price_quote'
|
|
2069
|
+
| 'sales_order_freight_quote'
|
|
2070
|
+
| 'sales_order_price_quote_line'
|
|
2071
|
+
| 'sales_order_quote_rate'
|
|
2040
2072
|
| 'hubspot_sync_job'
|
|
2041
2073
|
| 'hubspot_sync_report'
|
|
2042
2074
|
| 'hubspot_company_review'
|
|
@@ -2048,7 +2080,12 @@ export interface ConversationCreateParams {
|
|
|
2048
2080
|
| 'messaging_group_member'
|
|
2049
2081
|
| 'portal_profile'
|
|
2050
2082
|
| 'portal_registration_session'
|
|
2051
|
-
| 'portal_registration_session_data'
|
|
2083
|
+
| 'portal_registration_session_data'
|
|
2084
|
+
| 'pack_list'
|
|
2085
|
+
| 'pack_list_party'
|
|
2086
|
+
| 'pack_list_line_item'
|
|
2087
|
+
| 'pack_list_back_order'
|
|
2088
|
+
| 'pack_list_case';
|
|
2052
2089
|
}
|
|
2053
2090
|
|
|
2054
2091
|
export interface ConversationListParams {
|
|
@@ -2127,6 +2164,7 @@ export interface ConversationListParams {
|
|
|
2127
2164
|
| 'record'
|
|
2128
2165
|
| 'freight'
|
|
2129
2166
|
| 'sales_order_totals'
|
|
2167
|
+
| 'sales_order_stage_total'
|
|
2130
2168
|
| 'sales_order_related'
|
|
2131
2169
|
| 'order_contact'
|
|
2132
2170
|
| 'user'
|
|
@@ -2162,6 +2200,7 @@ export interface ConversationListParams {
|
|
|
2162
2200
|
| 'notification_unread_summary'
|
|
2163
2201
|
| 'announcement'
|
|
2164
2202
|
| 'conversation'
|
|
2203
|
+
| 'support_case'
|
|
2165
2204
|
| 'conversation_participant'
|
|
2166
2205
|
| 'read_cursor'
|
|
2167
2206
|
| 'chat_message'
|
|
@@ -2197,6 +2236,7 @@ export interface ConversationListParams {
|
|
|
2197
2236
|
| 'account_branding'
|
|
2198
2237
|
| 'account_portal'
|
|
2199
2238
|
| 'account_logo_url'
|
|
2239
|
+
| 'account_favicon_url'
|
|
2200
2240
|
| 'public_account'
|
|
2201
2241
|
| 'property'
|
|
2202
2242
|
| 'carrier'
|
|
@@ -2282,6 +2322,7 @@ export interface ConversationListParams {
|
|
|
2282
2322
|
| 'customer_freight_preferences'
|
|
2283
2323
|
| 'customer_defaults'
|
|
2284
2324
|
| 'customer_notification_preferences'
|
|
2325
|
+
| 'order_notification_recipient'
|
|
2285
2326
|
| 'order_discount'
|
|
2286
2327
|
| 'sales_order_line'
|
|
2287
2328
|
| 'sales_order_type'
|
|
@@ -2348,9 +2389,11 @@ export interface ConversationListParams {
|
|
|
2348
2389
|
| 'tenancy_pending_registration'
|
|
2349
2390
|
| 'invoice_allocation_entry'
|
|
2350
2391
|
| 'allocation_customer'
|
|
2351
|
-
| '
|
|
2352
|
-
| 'create_production_run_response'
|
|
2392
|
+
| 'checkout_sales_order'
|
|
2353
2393
|
| 'sales_order_price_quote'
|
|
2394
|
+
| 'sales_order_freight_quote'
|
|
2395
|
+
| 'sales_order_price_quote_line'
|
|
2396
|
+
| 'sales_order_quote_rate'
|
|
2354
2397
|
| 'hubspot_sync_job'
|
|
2355
2398
|
| 'hubspot_sync_report'
|
|
2356
2399
|
| 'hubspot_company_review'
|
|
@@ -2362,7 +2405,12 @@ export interface ConversationListParams {
|
|
|
2362
2405
|
| 'messaging_group_member'
|
|
2363
2406
|
| 'portal_profile'
|
|
2364
2407
|
| 'portal_registration_session'
|
|
2365
|
-
| 'portal_registration_session_data'
|
|
2408
|
+
| 'portal_registration_session_data'
|
|
2409
|
+
| 'pack_list'
|
|
2410
|
+
| 'pack_list_party'
|
|
2411
|
+
| 'pack_list_line_item'
|
|
2412
|
+
| 'pack_list_back_order'
|
|
2413
|
+
| 'pack_list_case';
|
|
2366
2414
|
|
|
2367
2415
|
/**
|
|
2368
2416
|
* Filter by conversation type.
|
|
@@ -98,6 +98,7 @@ export interface AddConversationLinkRequest {
|
|
|
98
98
|
| 'record'
|
|
99
99
|
| 'freight'
|
|
100
100
|
| 'sales_order_totals'
|
|
101
|
+
| 'sales_order_stage_total'
|
|
101
102
|
| 'sales_order_related'
|
|
102
103
|
| 'order_contact'
|
|
103
104
|
| 'user'
|
|
@@ -133,6 +134,7 @@ export interface AddConversationLinkRequest {
|
|
|
133
134
|
| 'notification_unread_summary'
|
|
134
135
|
| 'announcement'
|
|
135
136
|
| 'conversation'
|
|
137
|
+
| 'support_case'
|
|
136
138
|
| 'conversation_participant'
|
|
137
139
|
| 'read_cursor'
|
|
138
140
|
| 'chat_message'
|
|
@@ -168,6 +170,7 @@ export interface AddConversationLinkRequest {
|
|
|
168
170
|
| 'account_branding'
|
|
169
171
|
| 'account_portal'
|
|
170
172
|
| 'account_logo_url'
|
|
173
|
+
| 'account_favicon_url'
|
|
171
174
|
| 'public_account'
|
|
172
175
|
| 'property'
|
|
173
176
|
| 'carrier'
|
|
@@ -253,6 +256,7 @@ export interface AddConversationLinkRequest {
|
|
|
253
256
|
| 'customer_freight_preferences'
|
|
254
257
|
| 'customer_defaults'
|
|
255
258
|
| 'customer_notification_preferences'
|
|
259
|
+
| 'order_notification_recipient'
|
|
256
260
|
| 'order_discount'
|
|
257
261
|
| 'sales_order_line'
|
|
258
262
|
| 'sales_order_type'
|
|
@@ -319,9 +323,11 @@ export interface AddConversationLinkRequest {
|
|
|
319
323
|
| 'tenancy_pending_registration'
|
|
320
324
|
| 'invoice_allocation_entry'
|
|
321
325
|
| 'allocation_customer'
|
|
322
|
-
| '
|
|
323
|
-
| 'create_production_run_response'
|
|
326
|
+
| 'checkout_sales_order'
|
|
324
327
|
| 'sales_order_price_quote'
|
|
328
|
+
| 'sales_order_freight_quote'
|
|
329
|
+
| 'sales_order_price_quote_line'
|
|
330
|
+
| 'sales_order_quote_rate'
|
|
325
331
|
| 'hubspot_sync_job'
|
|
326
332
|
| 'hubspot_sync_report'
|
|
327
333
|
| 'hubspot_company_review'
|
|
@@ -333,7 +339,12 @@ export interface AddConversationLinkRequest {
|
|
|
333
339
|
| 'messaging_group_member'
|
|
334
340
|
| 'portal_profile'
|
|
335
341
|
| 'portal_registration_session'
|
|
336
|
-
| 'portal_registration_session_data'
|
|
342
|
+
| 'portal_registration_session_data'
|
|
343
|
+
| 'pack_list'
|
|
344
|
+
| 'pack_list_party'
|
|
345
|
+
| 'pack_list_line_item'
|
|
346
|
+
| 'pack_list_back_order'
|
|
347
|
+
| 'pack_list_case';
|
|
337
348
|
}
|
|
338
349
|
|
|
339
350
|
/**
|
|
@@ -406,6 +417,7 @@ export interface LinkCreateParams {
|
|
|
406
417
|
| 'record'
|
|
407
418
|
| 'freight'
|
|
408
419
|
| 'sales_order_totals'
|
|
420
|
+
| 'sales_order_stage_total'
|
|
409
421
|
| 'sales_order_related'
|
|
410
422
|
| 'order_contact'
|
|
411
423
|
| 'user'
|
|
@@ -441,6 +453,7 @@ export interface LinkCreateParams {
|
|
|
441
453
|
| 'notification_unread_summary'
|
|
442
454
|
| 'announcement'
|
|
443
455
|
| 'conversation'
|
|
456
|
+
| 'support_case'
|
|
444
457
|
| 'conversation_participant'
|
|
445
458
|
| 'read_cursor'
|
|
446
459
|
| 'chat_message'
|
|
@@ -476,6 +489,7 @@ export interface LinkCreateParams {
|
|
|
476
489
|
| 'account_branding'
|
|
477
490
|
| 'account_portal'
|
|
478
491
|
| 'account_logo_url'
|
|
492
|
+
| 'account_favicon_url'
|
|
479
493
|
| 'public_account'
|
|
480
494
|
| 'property'
|
|
481
495
|
| 'carrier'
|
|
@@ -561,6 +575,7 @@ export interface LinkCreateParams {
|
|
|
561
575
|
| 'customer_freight_preferences'
|
|
562
576
|
| 'customer_defaults'
|
|
563
577
|
| 'customer_notification_preferences'
|
|
578
|
+
| 'order_notification_recipient'
|
|
564
579
|
| 'order_discount'
|
|
565
580
|
| 'sales_order_line'
|
|
566
581
|
| 'sales_order_type'
|
|
@@ -627,9 +642,11 @@ export interface LinkCreateParams {
|
|
|
627
642
|
| 'tenancy_pending_registration'
|
|
628
643
|
| 'invoice_allocation_entry'
|
|
629
644
|
| 'allocation_customer'
|
|
630
|
-
| '
|
|
631
|
-
| 'create_production_run_response'
|
|
645
|
+
| 'checkout_sales_order'
|
|
632
646
|
| 'sales_order_price_quote'
|
|
647
|
+
| 'sales_order_freight_quote'
|
|
648
|
+
| 'sales_order_price_quote_line'
|
|
649
|
+
| 'sales_order_quote_rate'
|
|
633
650
|
| 'hubspot_sync_job'
|
|
634
651
|
| 'hubspot_sync_report'
|
|
635
652
|
| 'hubspot_company_review'
|
|
@@ -641,7 +658,12 @@ export interface LinkCreateParams {
|
|
|
641
658
|
| 'messaging_group_member'
|
|
642
659
|
| 'portal_profile'
|
|
643
660
|
| 'portal_registration_session'
|
|
644
|
-
| 'portal_registration_session_data'
|
|
661
|
+
| 'portal_registration_session_data'
|
|
662
|
+
| 'pack_list'
|
|
663
|
+
| 'pack_list_party'
|
|
664
|
+
| 'pack_list_line_item'
|
|
665
|
+
| 'pack_list_back_order'
|
|
666
|
+
| 'pack_list_case';
|
|
645
667
|
|
|
646
668
|
/**
|
|
647
669
|
* Query param: Sub-objects to expand in the response. When omitted, sub-objects
|