@devrev/typescript-sdk 1.1.29 → 1.1.31

package/dist/auto-generated/beta/beta-devrev-sdk.js

@@ -33,9 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GenericNotificationEventType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
-exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = 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.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = void 0;
-exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = void 0;
+exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.GeneralPreferencesGroupPreferredLocale = exports.FieldValueType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
+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.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = 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.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = void 0;
+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 = void 0;
 var AccessLevel;
 (function (AccessLevel) {
     AccessLevel["External"] = "external";
@@ -114,7 +114,9 @@ var AtomType;
     AtomType["Task"] = "task";
     AtomType["TenantFragment"] = "tenant_fragment";
     AtomType["Ticket"] = "ticket";
+    AtomType["TimelineChangeEvent"] = "timeline_change_event";
     AtomType["TimelineComment"] = "timeline_comment";
+    AtomType["UserPreferences"] = "user_preferences";
     AtomType["Webhook"] = "webhook";
 })(AtomType = exports.AtomType || (exports.AtomType = {}));
 var AuthConnectionToggle;
@@ -196,6 +198,7 @@ var BooleanExpressionType;
 /** Source of the code change object. */
 var CodeChangeSource;
 (function (CodeChangeSource) {
+    CodeChangeSource["AzureDevops"] = "azure_devops";
     CodeChangeSource["Bitbucket"] = "bitbucket";
     CodeChangeSource["Github"] = "github";
 })(CodeChangeSource = exports.CodeChangeSource || (exports.CodeChangeSource = {}));
@@ -282,6 +285,8 @@ var DevUserJobTitle;
 var EngagementType;
 (function (EngagementType) {
     EngagementType["Call"] = "call";
+    EngagementType["Conversation"] = "conversation";
+    EngagementType["Custom"] = "custom";
     EngagementType["Default"] = "default";
     EngagementType["Email"] = "email";
     EngagementType["LinkedIn"] = "linked_in";
@@ -362,6 +367,34 @@ var EventSourceStatus;
     EventSourceStatus["Blocked"] = "blocked";
     EventSourceStatus["Paused"] = "paused";
 })(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
+var FieldValueType;
+(function (FieldValueType) {
+    FieldValueType["Bool"] = "bool";
+    FieldValueType["BoolList"] = "bool_list";
+    FieldValueType["Composite"] = "composite";
+    FieldValueType["CompositeList"] = "composite_list";
+    FieldValueType["Date"] = "date";
+    FieldValueType["DateList"] = "date_list";
+    FieldValueType["DateTime"] = "date_time";
+    FieldValueType["DateTimeList"] = "date_time_list";
+    FieldValueType["Double"] = "double";
+    FieldValueType["DoubleList"] = "double_list";
+    FieldValueType["Id"] = "id";
+    FieldValueType["IdList"] = "id_list";
+    FieldValueType["Int"] = "int";
+    FieldValueType["IntList"] = "int_list";
+    FieldValueType["Stage"] = "stage";
+    FieldValueType["String"] = "string";
+    FieldValueType["StringList"] = "string_list";
+    FieldValueType["TagSummary"] = "tag_summary";
+    FieldValueType["TagSummaryList"] = "tag_summary_list";
+})(FieldValueType = exports.FieldValueType || (exports.FieldValueType = {}));
+/** Preferred locale of the user. */
+var GeneralPreferencesGroupPreferredLocale;
+(function (GeneralPreferencesGroupPreferredLocale) {
+    GeneralPreferencesGroupPreferredLocale["EnUs"] = "en_us";
+    GeneralPreferencesGroupPreferredLocale["JaJp"] = "ja_jp";
+})(GeneralPreferencesGroupPreferredLocale = exports.GeneralPreferencesGroupPreferredLocale || (exports.GeneralPreferencesGroupPreferredLocale = {}));
 /** Event type of the notification. */
 var GenericNotificationEventType;
 (function (GenericNotificationEventType) {
@@ -371,6 +404,12 @@ var GenericNotificationEventType;
     GenericNotificationEventType["Reminder"] = "reminder";
     GenericNotificationEventType["Update"] = "update";
 })(GenericNotificationEventType = exports.GenericNotificationEventType || (exports.GenericNotificationEventType = {}));
+/** Creation source of the group. */
+var GroupIngestionSource;
+(function (GroupIngestionSource) {
+    GroupIngestionSource["Airdrop"] = "airdrop";
+    GroupIngestionSource["Scim"] = "scim";
+})(GroupIngestionSource = exports.GroupIngestionSource || (exports.GroupIngestionSource = {}));
 /** Type of the members in the group. */
 var GroupMemberType;
 (function (GroupMemberType) {
@@ -417,6 +456,7 @@ var LinkType;
     LinkType["DevelopedWith"] = "developed_with";
     LinkType["Imports"] = "imports";
     LinkType["IsAnalyzedBy"] = "is_analyzed_by";
+    LinkType["IsConvertedTo"] = "is_converted_to";
     LinkType["IsDependentOn"] = "is_dependent_on";
     LinkType["IsDuplicateOf"] = "is_duplicate_of";
     LinkType["IsMergedInto"] = "is_merged_into";
@@ -540,6 +580,10 @@ var PartType;
     PartType["Feature"] = "feature";
     PartType["Product"] = "product";
 })(PartType = exports.PartType || (exports.PartType = {}));
+var PreferencesType;
+(function (PreferencesType) {
+    PreferencesType["UserPreferences"] = "user_preferences";
+})(PreferencesType = exports.PreferencesType || (exports.PreferencesType = {}));
 /** Status of the question answer. */
 var QuestionAnswerStatus;
 (function (QuestionAnswerStatus) {
@@ -752,6 +796,7 @@ var SlasFilterAppliesToOperatorType;
 /** Logical grouping of snap widgets. Useful for filtering. */
 var SnapWidgetNamespace;
 (function (SnapWidgetNamespace) {
+    SnapWidgetNamespace["AiAssistantMessage"] = "ai_assistant_message";
     SnapWidgetNamespace["CommentSuggestionReplies"] = "comment_suggestion_replies";
     SnapWidgetNamespace["EmailPreview"] = "email_preview";
     SnapWidgetNamespace["LinkPreview"] = "link_preview";
@@ -818,6 +863,7 @@ var TicketChannels;
     TicketChannels["Plug"] = "plug";
     TicketChannels["Slack"] = "slack";
     TicketChannels["Twilio"] = "twilio";
+    TicketChannels["TwilioSms"] = "twilio_sms";
 })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
 /** Severity of the ticket. */
 var TicketSeverity;
@@ -827,6 +873,15 @@ var TicketSeverity;
     TicketSeverity["Low"] = "low";
     TicketSeverity["Medium"] = "medium";
 })(TicketSeverity = exports.TicketSeverity || (exports.TicketSeverity = {}));
+/** The type of the event. */
+var TimelineChangeEventEventType;
+(function (TimelineChangeEventEventType) {
+    TimelineChangeEventEventType["Annotated"] = "annotated";
+    TimelineChangeEventEventType["Created"] = "created";
+    TimelineChangeEventEventType["Deleted"] = "deleted";
+    TimelineChangeEventEventType["Linked"] = "linked";
+    TimelineChangeEventEventType["Updated"] = "updated";
+})(TimelineChangeEventEventType = exports.TimelineChangeEventEventType || (exports.TimelineChangeEventEventType = {}));
 /** The type of the body to use for the comment. */
 var TimelineCommentBodyType;
 (function (TimelineCommentBodyType) {
@@ -865,6 +920,7 @@ var TimelineEntryObjectType;
     TimelineEntryObjectType["RevUser"] = "rev_user";
     TimelineEntryObjectType["Task"] = "task";
     TimelineEntryObjectType["Ticket"] = "ticket";
+    TimelineEntryObjectType["TimelineChangeEvent"] = "timeline_change_event";
     TimelineEntryObjectType["TimelineComment"] = "timeline_comment";
 })(TimelineEntryObjectType = exports.TimelineEntryObjectType || (exports.TimelineEntryObjectType = {}));
 /** Display panels for the Timeline entry. */
@@ -876,6 +932,7 @@ var TimelineEntryPanel;
 })(TimelineEntryPanel = exports.TimelineEntryPanel || (exports.TimelineEntryPanel = {}));
 var TimelineEntryType;
 (function (TimelineEntryType) {
+    TimelineEntryType["TimelineChangeEvent"] = "timeline_change_event";
     TimelineEntryType["TimelineComment"] = "timeline_comment";
 })(TimelineEntryType = exports.TimelineEntryType || (exports.TimelineEntryType = {}));
 /**
@@ -961,7 +1018,12 @@ var WebhookEventType;
     WebhookEventType["DevUserUpdated"] = "dev_user_updated";
     WebhookEventType["GroupCreated"] = "group_created";
     WebhookEventType["GroupDeleted"] = "group_deleted";
+    WebhookEventType["GroupMemberAdded"] = "group_member_added";
+    WebhookEventType["GroupMemberRemoved"] = "group_member_removed";
     WebhookEventType["GroupUpdated"] = "group_updated";
+    WebhookEventType["LinkCreated"] = "link_created";
+    WebhookEventType["LinkDeleted"] = "link_deleted";
+    WebhookEventType["LinkUpdated"] = "link_updated";
     WebhookEventType["PartCreated"] = "part_created";
     WebhookEventType["PartDeleted"] = "part_deleted";
     WebhookEventType["PartUpdated"] = "part_updated";
@@ -974,6 +1036,12 @@ var WebhookEventType;
     WebhookEventType["SlaTrackerCreated"] = "sla_tracker_created";
     WebhookEventType["SlaTrackerDeleted"] = "sla_tracker_deleted";
     WebhookEventType["SlaTrackerUpdated"] = "sla_tracker_updated";
+    WebhookEventType["SurveyCreated"] = "survey_created";
+    WebhookEventType["SurveyDeleted"] = "survey_deleted";
+    WebhookEventType["SurveyResponseCreated"] = "survey_response_created";
+    WebhookEventType["SurveyResponseDeleted"] = "survey_response_deleted";
+    WebhookEventType["SurveyResponseUpdated"] = "survey_response_updated";
+    WebhookEventType["SurveyUpdated"] = "survey_updated";
     WebhookEventType["TagCreated"] = "tag_created";
     WebhookEventType["TagDeleted"] = "tag_deleted";
     WebhookEventType["TagUpdated"] = "tag_updated";
@@ -1458,6 +1526,51 @@ class Api extends HttpClient {
          * @secure
          */
         this.codeChangesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Create the content template.
+         *
+         * @tags notifications
+         * @name ContentTemplateCreate
+         * @request POST:/content-template.create
+         * @secure
+         */
+        this.contentTemplateCreate = (data, params = {}) => this.request(Object.assign({ path: `/content-template.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get the content template.
+         *
+         * @tags notifications
+         * @name ContentTemplateGet
+         * @request GET:/content-template.get
+         * @secure
+         */
+        this.contentTemplateGet = (query, params = {}) => this.request(Object.assign({ path: `/content-template.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get the content template.
+         *
+         * @tags notifications
+         * @name ContentTemplateGetPost
+         * @request POST:/content-template.get
+         * @secure
+         */
+        this.contentTemplateGetPost = (data, params = {}) => this.request(Object.assign({ path: `/content-template.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Lists the content templates.
+         *
+         * @tags notifications
+         * @name ContentTemplateList
+         * @request GET:/content-template.list
+         * @secure
+         */
+        this.contentTemplateList = (query, params = {}) => this.request(Object.assign({ path: `/content-template.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Lists the content templates.
+         *
+         * @tags notifications
+         * @name ContentTemplateListPost
+         * @request POST:/content-template.list
+         * @secure
+         */
+        this.contentTemplateListPost = (data, params = {}) => this.request(Object.assign({ path: `/content-template.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Creates a conversation.
          *
@@ -1908,6 +2021,24 @@ class Api extends HttpClient {
          * @secure
          */
         this.groupsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/groups.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Creates an incident.
+         *
+         * @tags operate
+         * @name IncidentsCreate
+         * @request POST:/incidents.create
+         * @secure
+         */
+        this.incidentsCreate = (data, params = {}) => this.request(Object.assign({ path: `/incidents.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Deletes an incident.
+         *
+         * @tags operate
+         * @name IncidentsDelete
+         * @request POST:/incidents.delete
+         * @secure
+         */
+        this.incidentsDelete = (data, params = {}) => this.request(Object.assign({ path: `/incidents.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Gets an incident.
          *
@@ -1962,6 +2093,15 @@ class Api extends HttpClient {
          * @secure
          */
         this.incidentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/incidents.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Updates an incident.
+         *
+         * @tags operate
+         * @name IncidentsUpdate
+         * @request POST:/incidents.update
+         * @secure
+         */
+        this.incidentsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/incidents.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description OAuth2 authorization callback.
          *
@@ -2240,6 +2380,24 @@ class Api extends HttpClient {
          * @secure
          */
         this.partsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/parts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get the preferences object.
+         *
+         * @tags preferences
+         * @name PreferencesGet
+         * @request GET:/preferences.get
+         * @secure
+         */
+        this.preferencesGet = (query, params = {}) => this.request(Object.assign({ path: `/preferences.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get the preferences object.
+         *
+         * @tags preferences
+         * @name PreferencesGetPost
+         * @request POST:/preferences.get
+         * @secure
+         */
+        this.preferencesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/preferences.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Creates a question-answer.
          *
@@ -2429,6 +2587,24 @@ class Api extends HttpClient {
          * @secure
          */
         this.revUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Scans through all Rev users.
+         *
+         * @tags rev-users
+         * @name RevUsersScan
+         * @request GET:/rev-users.scan
+         * @secure
+         */
+        this.revUsersScan = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Scans through all Rev users.
+         *
+         * @tags rev-users
+         * @name RevUsersScanPost
+         * @request POST:/rev-users.scan
+         * @secure
+         */
+        this.revUsersScanPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Unlinks a rev user from a rev org.
          *
@@ -2726,6 +2902,15 @@ class Api extends HttpClient {
          * @secure
          */
         this.snapInsResourcesPost = (data, params = {}) => this.request(Object.assign({ path: `/snap-ins.resources`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Updates a snap-in.
+         *
+         * @tags snap-ins
+         * @name SnapInsUpdate
+         * @request POST:/snap-ins.update
+         * @secure
+         */
+        this.snapInsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/snap-ins.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Create a snap widget object.
          *