@devrev/typescript-sdk 1.1.53 → 1.1.54

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.
@@ -33,9 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatCompletionsRequestMessageRole = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.AssociatedToType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
- exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.RoleTarget = exports.RolePrivileges = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingChannel = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = void 0;
38
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncUnitSyncType = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = void 0;
36
+ exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatCompletionsRequestMessageRole = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.AssociatedToType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
+ exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SnapKitActionRequestElementTypeValue = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.RoleTarget = exports.RolePrivileges = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingChannel = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = void 0;
38
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncUnitSyncType = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = void 0;
39
39
  var AccessLevel;
40
40
  (function (AccessLevel) {
41
41
  AccessLevel["External"] = "external";
@@ -241,6 +241,7 @@ var CommandSurfaceObjectTypes;
241
241
  CommandSurfaceObjectTypes["Account"] = "account";
242
242
  CommandSurfaceObjectTypes["Article"] = "article";
243
243
  CommandSurfaceObjectTypes["Conversation"] = "conversation";
244
+ CommandSurfaceObjectTypes["CustomObject"] = "custom_object";
244
245
  CommandSurfaceObjectTypes["Engagement"] = "engagement";
245
246
  CommandSurfaceObjectTypes["Flow"] = "flow";
246
247
  CommandSurfaceObjectTypes["Incident"] = "incident";
@@ -442,6 +443,11 @@ var EventSourceStatus;
442
443
  EventSourceStatus["Blocked"] = "blocked";
443
444
  EventSourceStatus["Paused"] = "paused";
444
445
  })(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
446
+ var EventTimelineEntryUpdatedReactionAction;
447
+ (function (EventTimelineEntryUpdatedReactionAction) {
448
+ EventTimelineEntryUpdatedReactionAction["Added"] = "added";
449
+ EventTimelineEntryUpdatedReactionAction["Removed"] = "removed";
450
+ })(EventTimelineEntryUpdatedReactionAction = exports.EventTimelineEntryUpdatedReactionAction || (exports.EventTimelineEntryUpdatedReactionAction = {}));
445
451
  var ExternalSystemType;
446
452
  (function (ExternalSystemType) {
447
453
  ExternalSystemType["Adaas"] = "adaas";
@@ -986,6 +992,11 @@ var SlasFilterAppliesToOperatorType;
986
992
  SlasFilterAppliesToOperatorType["All"] = "all";
987
993
  SlasFilterAppliesToOperatorType["Any"] = "any";
988
994
  })(SlasFilterAppliesToOperatorType = exports.SlasFilterAppliesToOperatorType || (exports.SlasFilterAppliesToOperatorType = {}));
995
+ var SnapKitActionRequestElementTypeValue;
996
+ (function (SnapKitActionRequestElementTypeValue) {
997
+ SnapKitActionRequestElementTypeValue["Button"] = "button";
998
+ SnapKitActionRequestElementTypeValue["Form"] = "form";
999
+ })(SnapKitActionRequestElementTypeValue = exports.SnapKitActionRequestElementTypeValue || (exports.SnapKitActionRequestElementTypeValue = {}));
989
1000
  var SnapWidgetClickInteractionClickAction;
990
1001
  (function (SnapWidgetClickInteractionClickAction) {
991
1002
  SnapWidgetClickInteractionClickAction["OpenPlugWidget"] = "open_plug_widget";
@@ -1016,10 +1027,12 @@ var SnapWidgetStatus;
1016
1027
  var SnapWidgetType;
1017
1028
  (function (SnapWidgetType) {
1018
1029
  SnapWidgetType["EmailPreview"] = "email_preview";
1030
+ SnapWidgetType["StarterMessageNudge"] = "starter_message_nudge";
1019
1031
  })(SnapWidgetType = exports.SnapWidgetType || (exports.SnapWidgetType = {}));
1020
1032
  var SnapWidgetsCreateRequestType;
1021
1033
  (function (SnapWidgetsCreateRequestType) {
1022
1034
  SnapWidgetsCreateRequestType["EmailPreview"] = "email_preview";
1035
+ SnapWidgetsCreateRequestType["StarterMessageNudge"] = "starter_message_nudge";
1023
1036
  })(SnapWidgetsCreateRequestType = exports.SnapWidgetsCreateRequestType || (exports.SnapWidgetsCreateRequestType = {}));
1024
1037
  /** Type of stage validation options when creating an object. */
1025
1038
  var StageValidationOptionForCreate;
@@ -1545,6 +1558,16 @@ class Api extends HttpClient {
1545
1558
  * @secure
1546
1559
  */
1547
1560
  this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1561
+ /**
1562
+ * @description Execute an AI agent input event asynchronously.
1563
+ *
1564
+ * @tags ai-agents
1565
+ * @name AiAgentEventsExecuteAsync
1566
+ * @summary Execute-Async Ai Agents Events
1567
+ * @request POST:/ai-agents.events.execute-async
1568
+ * @secure
1569
+ */
1570
+ this.aiAgentEventsExecuteAsync = (data, params = {}) => this.request(Object.assign({ path: `/ai-agents.events.execute-async`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1548
1571
  /**
1549
1572
  * @description Gets a single sync unit's information.
1550
1573
  *
@@ -3644,6 +3667,16 @@ class Api extends HttpClient {
3644
3667
  * @secure
3645
3668
  */
3646
3669
  this.revOrgsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3670
+ /**
3671
+ * @description Adds an association to a Rev user. This API is only available when the multi-association contact feature is enabled.
3672
+ *
3673
+ * @tags rev-users
3674
+ * @name RevUsersAssociationsAdd
3675
+ * @summary Add Rev Users Associations
3676
+ * @request POST:/rev-users.associations.add
3677
+ * @secure
3678
+ */
3679
+ this.revUsersAssociationsAdd = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.associations.add`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3647
3680
  /**
3648
3681
  * @description Returns a list of associations on a Rev user.
3649
3682
  *
@@ -3664,6 +3697,16 @@ class Api extends HttpClient {
3664
3697
  * @secure
3665
3698
  */
3666
3699
  this.revUsersAssociationsListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.associations.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3700
+ /**
3701
+ * @description Removes an association from a Rev user. This API is only available when the multi-association contact feature is enabled.
3702
+ *
3703
+ * @tags rev-users
3704
+ * @name RevUsersAssociationsRemove
3705
+ * @summary Remove Rev Users Associations
3706
+ * @request POST:/rev-users.associations.remove
3707
+ * @secure
3708
+ */
3709
+ this.revUsersAssociationsRemove = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.associations.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3667
3710
  /**
3668
3711
  * @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
3669
3712
  *
@@ -4174,6 +4217,16 @@ class Api extends HttpClient {
4174
4217
  * @secure
4175
4218
  */
4176
4219
  this.snapInsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/snap-ins.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4220
+ /**
4221
+ * @description Executes deferred snap-kit actions.
4222
+ *
4223
+ * @tags snap-kit-execution
4224
+ * @name SnapKitActionExecuteDeferred
4225
+ * @summary Deferred Snap Kit Action Execute
4226
+ * @request POST:/snap-kit-action.execute.deferred
4227
+ * @secure
4228
+ */
4229
+ this.snapKitActionExecuteDeferred = (data, params = {}) => this.request(Object.assign({ path: `/snap-kit-action.execute.deferred`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4177
4230
  /**
4178
4231
  * @description Create a snap widget object.
4179
4232
  *
@@ -4424,6 +4477,16 @@ class Api extends HttpClient {
4424
4477
  * @secure
4425
4478
  */
4426
4479
  this.surveysResponsesListPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4480
+ /**
4481
+ * @description Updates a user's survey response for the provided dispatch ID.
4482
+ *
4483
+ * @tags surveys
4484
+ * @name SurveysResponsesUpdate
4485
+ * @summary Update Surveys Response
4486
+ * @request POST:/surveys.responses.update
4487
+ * @secure
4488
+ */
4489
+ this.surveysResponsesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4427
4490
  /**
4428
4491
  * @description Sends a survey on the specified channels.
4429
4492
  *
@@ -638,6 +638,11 @@ export interface ArticlesListRequest {
638
638
  scope?: number[];
639
639
  /** Filter for articles based on intended audience. */
640
640
  shared_with?: SharedWithMembershipFilter[];
641
+ /**
642
+ * Filters for article with any of the provided tags.
643
+ * @example ["TAG-12345"]
644
+ */
645
+ tags?: string[];
641
646
  }
642
647
  /**
643
648
  * articles-list-response
@@ -1475,6 +1480,8 @@ export type Capability = PartBase;
1475
1480
  export type CapabilitySummary = PartBaseSummary;
1476
1481
  /** conversation */
1477
1482
  export type Conversation = AtomBase & {
1483
+ /** Channel IDs of the conversation. */
1484
+ channels?: ExternalCommunicationChannelSummary[];
1478
1485
  /** Description of the conversation object. */
1479
1486
  description?: string;
1480
1487
  group?: GroupSummary;
@@ -2737,6 +2744,8 @@ export interface EventAccountUpdated {
2737
2744
  }
2738
2745
  /** event-ai-agent-response */
2739
2746
  export interface EventAiAgentResponse {
2747
+ /** The ID of the AI agent that consumed the event. */
2748
+ agent: string;
2740
2749
  agent_response?: 'error' | 'message' | 'progress';
2741
2750
  /** The metadata given by client to be passed to the event source. */
2742
2751
  client_metadata?: object;
@@ -2749,6 +2758,13 @@ export interface EventAiAgentResponse {
2749
2758
  message?: string;
2750
2759
  /** A progress object providing the status of the AI agent event execution. */
2751
2760
  progress?: AiAgentEventExecuteProgress;
2761
+ /**
2762
+ * The agent session ID to track the asynchronous execution of this
2763
+ * session.
2764
+ */
2765
+ session: string;
2766
+ /** An identifier of the session with the AI agent. */
2767
+ session_object: string;
2752
2768
  }
2753
2769
  /** event-conversation-created */
2754
2770
  export interface EventConversationCreated {
@@ -2998,6 +3014,22 @@ export interface EventTimelineEntryDeleted {
2998
3014
  export interface EventTimelineEntryUpdated {
2999
3015
  entry: TimelineEntry;
3000
3016
  old_entry?: TimelineEntry;
3017
+ /**
3018
+ * The reactions that were performed.
3019
+ * @maxItems 16
3020
+ */
3021
+ reactions?: EventTimelineEntryUpdatedReaction[];
3022
+ }
3023
+ /** event-timeline-entry-updated-reaction */
3024
+ export interface EventTimelineEntryUpdatedReaction {
3025
+ action: EventTimelineEntryUpdatedReactionAction;
3026
+ /** The emoji for the reaction. */
3027
+ emoji: string;
3028
+ reactor?: UserSummary;
3029
+ }
3030
+ export declare enum EventTimelineEntryUpdatedReactionAction {
3031
+ Added = "added",
3032
+ Removed = "removed"
3001
3033
  }
3002
3034
  /** event-webhook-created */
3003
3035
  export interface EventWebhookCreated {
@@ -3046,6 +3078,8 @@ export interface EventWorkUpdated {
3046
3078
  old_work?: Work;
3047
3079
  work: Work;
3048
3080
  }
3081
+ /** external-communication-channel-summary */
3082
+ export type ExternalCommunicationChannelSummary = AtomBaseSummary;
3049
3083
  /**
3050
3084
  * external-identity
3051
3085
  * External identity of a user.
@@ -3822,6 +3856,8 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
3822
3856
  * @example ["DEVU-12345"]
3823
3857
  */
3824
3858
  owned_by: string[];
3859
+ /** Tags associated with the part. */
3860
+ tags?: SetTagWithValue[];
3825
3861
  };
3826
3862
  /** parts-create-request-capability */
3827
3863
  export interface PartsCreateRequestCapability {
@@ -3927,6 +3963,11 @@ export interface PartsListRequest {
3927
3963
  owned_by?: string[];
3928
3964
  /** The filter for specifying parent part. */
3929
3965
  parent_part?: ParentPartFilter;
3966
+ /**
3967
+ * Filters for part with any of the provided tags.
3968
+ * @example ["TAG-12345"]
3969
+ */
3970
+ tags?: string[];
3930
3971
  }
3931
3972
  /** parts-list-response */
3932
3973
  export interface PartsListResponse {
@@ -3957,6 +3998,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
3957
3998
  /** The updated name of the part. */
3958
3999
  name?: string;
3959
4000
  owned_by?: PartsUpdateRequestOwnedBy;
4001
+ tags?: PartsUpdateRequestTags;
3960
4002
  };
3961
4003
  /** parts-update-request-artifacts */
3962
4004
  export interface PartsUpdateRequestArtifacts {
@@ -3997,6 +4039,11 @@ export interface PartsUpdateRequestOwnedBy {
3997
4039
  }
3998
4040
  /** parts-update-request-product */
3999
4041
  export type PartsUpdateRequestProduct = object;
4042
+ /** parts-update-request-tags */
4043
+ export interface PartsUpdateRequestTags {
4044
+ /** Sets the tags to the provided tags. */
4045
+ set?: SetTagWithValue[];
4046
+ }
4000
4047
  /** parts-update-response */
4001
4048
  export interface PartsUpdateResponse {
4002
4049
  part: Part;
@@ -5486,6 +5533,54 @@ export interface SlasUpdateRequest {
5486
5533
  export interface SlasUpdateResponse {
5487
5534
  sla: Sla;
5488
5535
  }
5536
+ /** snap-kit-action-execute-deferred-request */
5537
+ export interface SnapKitActionExecuteDeferredRequest {
5538
+ /**
5539
+ * List of actions triggered in the request.
5540
+ * @maxItems 5
5541
+ */
5542
+ actions: SnapKitActionRequest[];
5543
+ /** ID of the deferred snap-kit action to be executed. */
5544
+ id: string;
5545
+ }
5546
+ /** snap-kit-action-execute-deferred-response */
5547
+ export type SnapKitActionExecuteDeferredResponse = object;
5548
+ /** snap-kit-action-request */
5549
+ export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
5550
+ type: SnapKitActionRequestElementTypeValue;
5551
+ /**
5552
+ * Id of the interactive element specified by developer in a snap-kit
5553
+ * object.
5554
+ */
5555
+ action_id: string;
5556
+ /** Action interaction type. */
5557
+ action_type?: string;
5558
+ /**
5559
+ * Id of the block within the surface which is the container for the
5560
+ * interactive element.
5561
+ */
5562
+ block_id?: string;
5563
+ /**
5564
+ * Timestamp when the action was originated.
5565
+ * @format date-time
5566
+ * @example "2023-01-01T12:00:00.000Z"
5567
+ */
5568
+ timestamp: string;
5569
+ };
5570
+ /** snap-kit-action-request-button */
5571
+ export interface SnapKitActionRequestButton {
5572
+ /** Value for the button interactive element. */
5573
+ value: string;
5574
+ }
5575
+ export declare enum SnapKitActionRequestElementTypeValue {
5576
+ Button = "button",
5577
+ Form = "form"
5578
+ }
5579
+ /** snap-kit-action-request-form */
5580
+ export interface SnapKitActionRequestForm {
5581
+ /** Value for the form interactive element. */
5582
+ value: object;
5583
+ }
5489
5584
  /** snap-widget */
5490
5585
  export interface SnapWidget {
5491
5586
  type: SnapWidgetType;
@@ -5590,6 +5685,100 @@ export type SurveyResponse = AtomBase & {
5590
5685
  /** The ID of the survey for which response is taken. */
5591
5686
  survey?: string;
5592
5687
  };
5688
+ /** surveys-responses-list-request */
5689
+ export interface SurveysResponsesListRequest {
5690
+ /**
5691
+ * Filters for survey responses created by any of these users.
5692
+ * @example ["DEVU-12345"]
5693
+ */
5694
+ created_by?: string[];
5695
+ /** Provides ways to specify date ranges on objects. */
5696
+ created_date?: DateFilter;
5697
+ /**
5698
+ * The cursor to resume iteration from. If not provided, then
5699
+ * iteration starts from the beginning.
5700
+ */
5701
+ cursor?: string;
5702
+ /** Filters for survey responses associated with these unique IDs. */
5703
+ dispatch_ids?: string[];
5704
+ /**
5705
+ * The maximum number of survey responses to return. If not set, then
5706
+ * the default is '50'.
5707
+ * @format int32
5708
+ */
5709
+ limit?: number;
5710
+ /**
5711
+ * The iteration mode to use. If "after", then entries after the provided
5712
+ * cursor will be returned, or if no cursor is provided, then from the
5713
+ * beginning. If "before", then entries before the provided cursor will be
5714
+ * returned, or if no cursor is provided, then from the end. Entries will
5715
+ * always be returned in the specified sort-by order.
5716
+ */
5717
+ mode?: ListMode;
5718
+ /** Provides ways to specify date ranges on objects. */
5719
+ modified_date?: DateFilter;
5720
+ /**
5721
+ * Filters for survey responses created for the objects.
5722
+ * @example ["ACC-12345"]
5723
+ */
5724
+ objects?: string[];
5725
+ /**
5726
+ * Filters for survey responses dispatched to any of these users.
5727
+ * @example ["DEVU-12345"]
5728
+ */
5729
+ recipient?: string[];
5730
+ /**
5731
+ * Fields to sort the survey responses by and the direction to sort
5732
+ * them.
5733
+ */
5734
+ sort_by?: string[];
5735
+ /** Filters for survey response stages. */
5736
+ stages?: number[];
5737
+ /** Filters for survey responses for the provided survey IDs. */
5738
+ surveys?: string[];
5739
+ }
5740
+ /** surveys-responses-list-response */
5741
+ export interface SurveysResponsesListResponse {
5742
+ /**
5743
+ * The cursor used to iterate subsequent results in accordance to the
5744
+ * sort order. If not set, then no later elements exist.
5745
+ */
5746
+ next_cursor?: string;
5747
+ /**
5748
+ * The cursor used to iterate preceding results in accordance to the
5749
+ * sort order. If not set, then no prior elements exist.
5750
+ */
5751
+ prev_cursor?: string;
5752
+ /** The list of the survey responses. */
5753
+ survey_responses: SurveyResponse[];
5754
+ }
5755
+ /** surveys-responses-update-request */
5756
+ export interface SurveysResponsesUpdateRequest {
5757
+ /** The unique ID associated with the dispatched survey. */
5758
+ dispatch_id: string;
5759
+ /** Survey response submitted for the object. */
5760
+ response?: object;
5761
+ /**
5762
+ * The source channel ordinal which recorded the survey response.
5763
+ * @format int64
5764
+ */
5765
+ response_channel?: number;
5766
+ /**
5767
+ * The response score for the survey. Only applicable for CSAT and
5768
+ * NPS.
5769
+ * @format int32
5770
+ * @min 1
5771
+ * @max 10
5772
+ */
5773
+ response_score?: number;
5774
+ /**
5775
+ * The stage ordinal of the survey response object.
5776
+ * @format int64
5777
+ */
5778
+ stage?: number;
5779
+ }
5780
+ /** surveys-responses-update-response */
5781
+ export type SurveysResponsesUpdateResponse = object;
5593
5782
  /** sync-history */
5594
5783
  export type SyncHistory = AtomBase & {
5595
5784
  /** Object for holding run-specific data. */
@@ -5952,8 +6141,11 @@ export interface TagsUpdateResponse {
5952
6141
  }
5953
6142
  /** ticket */
5954
6143
  export type Ticket = WorkBase & {
6144
+ account?: AccountSummary;
5955
6145
  /** Channels of the ticket. */
5956
6146
  channels?: TicketChannels[];
6147
+ /** Channel IDs of the ticket. */
6148
+ channels_v2?: ExternalCommunicationChannelSummary[];
5957
6149
  group?: GroupSummary;
5958
6150
  /** Whether the ticket needs a response. */
5959
6151
  needs_response?: boolean;
@@ -5975,6 +6167,7 @@ export type Ticket = WorkBase & {
5975
6167
  sla_tracker?: SlaTrackerSummary;
5976
6168
  /** Source channel of the ticket. */
5977
6169
  source_channel?: string;
6170
+ source_channel_v2?: ExternalCommunicationChannelSummary;
5978
6171
  /** The properties of an enum value. */
5979
6172
  visibility?: EnumValue;
5980
6173
  };
@@ -5995,6 +6188,7 @@ export declare enum TicketSeverity {
5995
6188
  }
5996
6189
  /** ticket-summary */
5997
6190
  export type TicketSummary = WorkBaseSummary & {
6191
+ account?: AccountSummary;
5998
6192
  rev_org?: OrgSummary;
5999
6193
  /** Severity of the ticket. */
6000
6194
  severity?: TicketSeverity;
@@ -6815,6 +7009,11 @@ export interface WorksCreateRequestIssue {
6815
7009
  }
6816
7010
  /** works-create-request-ticket */
6817
7011
  export interface WorksCreateRequestTicket {
7012
+ /**
7013
+ * The account that the ticket is associated with.
7014
+ * @example "ACC-12345"
7015
+ */
7016
+ account?: string;
6818
7017
  /** Channels of the ticket. */
6819
7018
  channels?: TicketChannels[];
6820
7019
  /** The group that the ticket is associated with. */
@@ -6907,7 +7106,7 @@ export interface WorksExportResponse {
6907
7106
  /** works-filter-issue */
6908
7107
  export interface WorksFilterIssue {
6909
7108
  /**
6910
- * Filters for issues with any of the provided Accounts.
7109
+ * Filters for issues with any of the provided accounts.
6911
7110
  * @example ["ACC-12345"]
6912
7111
  */
6913
7112
  accounts?: string[];
@@ -7071,8 +7270,8 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
7071
7270
  /** Updates an object's stage. */
7072
7271
  stage?: StageUpdate;
7073
7272
  /**
7074
- * The type of stage validations options when updating the stage of an
7075
- * object.
7273
+ * The type of stage validations options when updating the stage or
7274
+ * the stage diagram of an object.
7076
7275
  */
7077
7276
  stage_validation_options?: StageValidationOptionForUpdate[];
7078
7277
  staged_info?: WorksUpdateRequestStagedInfoUpdate;
@@ -7181,6 +7380,11 @@ export interface WorksUpdateRequestTags {
7181
7380
  }
7182
7381
  /** works-update-request-ticket */
7183
7382
  export interface WorksUpdateRequestTicket {
7383
+ /**
7384
+ * Updates the account that the ticket is associated with.
7385
+ * @example "ACC-12345"
7386
+ */
7387
+ account?: string | null;
7184
7388
  channels?: WorksUpdateRequestTicketChannels;
7185
7389
  /** Updates the group that the ticket is associated with. */
7186
7390
  group?: string | null;
@@ -7575,6 +7779,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7575
7779
  'shared_with.member'?: string;
7576
7780
  /** Role ID of the group/member with whom the item is shared. */
7577
7781
  'shared_with.role'?: string;
7782
+ /**
7783
+ * Filters for article with any of the provided tags.
7784
+ * @example ["TAG-12345"]
7785
+ */
7786
+ tags?: string[];
7578
7787
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
7579
7788
  /**
7580
7789
  * @description Lists a collection of articles.
@@ -8585,6 +8794,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8585
8794
  * @example ["PROD-12345"]
8586
8795
  */
8587
8796
  'parent_part.parts'?: string[];
8797
+ /**
8798
+ * Filters for part with any of the provided tags.
8799
+ * @example ["TAG-12345"]
8800
+ */
8801
+ tags?: string[];
8588
8802
  /** Filters for parts of the provided type(s). */
8589
8803
  type?: PartType[];
8590
8804
  }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
@@ -9106,6 +9320,89 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9106
9320
  * @secure
9107
9321
  */
9108
9322
  slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
9323
+ /**
9324
+ * @description Executes deferred snap-kit actions.
9325
+ *
9326
+ * @tags snap-kit-execution
9327
+ * @name SnapKitActionExecuteDeferred
9328
+ * @summary Deferred Snap Kit Action Execute
9329
+ * @request POST:/snap-kit-action.execute.deferred
9330
+ * @secure
9331
+ */
9332
+ snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
9333
+ /**
9334
+ * @description List survey responses requested by the user.
9335
+ *
9336
+ * @tags surveys
9337
+ * @name SurveysResponsesList
9338
+ * @summary List Surveys Responses
9339
+ * @request GET:/surveys.responses.list
9340
+ * @secure
9341
+ */
9342
+ surveysResponsesList: (query?: {
9343
+ /**
9344
+ * Filters for survey responses created by any of these users.
9345
+ * @example ["DEVU-12345"]
9346
+ */
9347
+ created_by?: string[];
9348
+ /**
9349
+ * The cursor to resume iteration from. If not provided, then iteration
9350
+ * starts from the beginning.
9351
+ */
9352
+ cursor?: string;
9353
+ /** Filters for survey responses associated with these unique IDs. */
9354
+ dispatch_ids?: string[];
9355
+ /**
9356
+ * The maximum number of survey responses to return. If not set, then
9357
+ * the default is '50'.
9358
+ * @format int32
9359
+ */
9360
+ limit?: number;
9361
+ /**
9362
+ * The iteration mode to use, otherwise if not set, then "after" is
9363
+ * used.
9364
+ */
9365
+ mode?: ListMode;
9366
+ /**
9367
+ * Filters for survey responses created for the objects.
9368
+ * @example ["ACC-12345"]
9369
+ */
9370
+ objects?: string[];
9371
+ /**
9372
+ * Filters for survey responses dispatched to any of these users.
9373
+ * @example ["DEVU-12345"]
9374
+ */
9375
+ recipient?: string[];
9376
+ /**
9377
+ * Fields to sort the survey responses by and the direction to sort
9378
+ * them.
9379
+ */
9380
+ sort_by?: string[];
9381
+ /** Filters for survey response stages. */
9382
+ stages?: number[];
9383
+ /** Filters for survey responses for the provided survey IDs. */
9384
+ surveys?: string[];
9385
+ }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
9386
+ /**
9387
+ * @description List survey responses requested by the user.
9388
+ *
9389
+ * @tags surveys
9390
+ * @name SurveysResponsesListPost
9391
+ * @summary List Surveys Responses (POST)
9392
+ * @request POST:/surveys.responses.list
9393
+ * @secure
9394
+ */
9395
+ surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
9396
+ /**
9397
+ * @description Updates a user's survey response for the provided dispatch ID.
9398
+ *
9399
+ * @tags surveys
9400
+ * @name SurveysResponsesUpdate
9401
+ * @summary Update Surveys Response
9402
+ * @request POST:/surveys.responses.update
9403
+ * @secure
9404
+ */
9405
+ surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
9109
9406
  /**
9110
9407
  * @description Lists system users within your organization.
9111
9408
  *
@@ -9488,7 +9785,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9488
9785
  */
9489
9786
  first?: number;
9490
9787
  /**
9491
- * Filters for issues with any of the provided Accounts.
9788
+ * Filters for issues with any of the provided accounts.
9492
9789
  * @example ["ACC-12345"]
9493
9790
  */
9494
9791
  'issue.accounts'?: string[];
@@ -9625,7 +9922,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9625
9922
  */
9626
9923
  cursor?: string;
9627
9924
  /**
9628
- * Filters for issues with any of the provided Accounts.
9925
+ * Filters for issues with any of the provided accounts.
9629
9926
  * @example ["ACC-12345"]
9630
9927
  */
9631
9928
  'issue.accounts'?: string[];