@devrev/typescript-sdk 1.1.28 → 1.1.29

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.OrgEnvironment = exports.OpportunityPriority = 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.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.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
- exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = 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.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = void 0;
38
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = void 0;
36
+ 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;
37
+ 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;
38
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = void 0;
39
39
  var AccessLevel;
40
40
  (function (AccessLevel) {
41
41
  AccessLevel["External"] = "external";
@@ -85,6 +85,12 @@ var ArticleStatus;
85
85
  ArticleStatus["Published"] = "published";
86
86
  ArticleStatus["ReviewNeeded"] = "review_needed";
87
87
  })(ArticleStatus = exports.ArticleStatus || (exports.ArticleStatus = {}));
88
+ /** Type of the article. */
89
+ var ArticleType;
90
+ (function (ArticleType) {
91
+ ArticleType["Article"] = "article";
92
+ ArticleType["ContentBlock"] = "content_block";
93
+ })(ArticleType = exports.ArticleType || (exports.ArticleType = {}));
88
94
  var AtomType;
89
95
  (function (AtomType) {
90
96
  AtomType["Account"] = "account";
@@ -168,11 +174,11 @@ var AuthTokenSubjectTokenType;
168
174
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtAuth0"] = "urn:devrev:params:oauth:token-type:jwt:auth0";
169
175
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtDev"] = "urn:devrev:params:oauth:token-type:jwt:dev";
170
176
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRat"] = "urn:devrev:params:oauth:token-type:rat";
177
+ AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRev"] = "urn:devrev:params:oauth:token-type:rev";
171
178
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRevinfo"] = "urn:devrev:params:oauth:token-type:revinfo";
172
179
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
173
180
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSysu"] = "urn:devrev:params:oauth:token-type:sysu";
174
181
  AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfo"] = "urn:devrev:params:oauth:token-type:userinfo";
175
- AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfoProfile"] = "urn:devrev:params:oauth:token-type:userinfo:profile";
176
182
  AuthTokenSubjectTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
177
183
  })(AuthTokenSubjectTokenType = exports.AuthTokenSubjectTokenType || (exports.AuthTokenSubjectTokenType = {}));
178
184
  /** The type of the issued token. Bearer is the only supported token type. */
@@ -300,6 +306,7 @@ var ErrorBadRequestType;
300
306
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
301
307
  ErrorBadRequestType["InvalidField"] = "invalid_field";
302
308
  ErrorBadRequestType["InvalidId"] = "invalid_id";
309
+ ErrorBadRequestType["MergeWorksError"] = "merge_works_error";
303
310
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
304
311
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
305
312
  ErrorBadRequestType["ParseError"] = "parse_error";
@@ -355,6 +362,15 @@ var EventSourceStatus;
355
362
  EventSourceStatus["Blocked"] = "blocked";
356
363
  EventSourceStatus["Paused"] = "paused";
357
364
  })(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
365
+ /** Event type of the notification. */
366
+ var GenericNotificationEventType;
367
+ (function (GenericNotificationEventType) {
368
+ GenericNotificationEventType["Alert"] = "alert";
369
+ GenericNotificationEventType["Assignment"] = "assignment";
370
+ GenericNotificationEventType["Mention"] = "mention";
371
+ GenericNotificationEventType["Reminder"] = "reminder";
372
+ GenericNotificationEventType["Update"] = "update";
373
+ })(GenericNotificationEventType = exports.GenericNotificationEventType || (exports.GenericNotificationEventType = {}));
358
374
  /** Type of the members in the group. */
359
375
  var GroupMemberType;
360
376
  (function (GroupMemberType) {
@@ -397,10 +413,13 @@ var LinkEndpointType;
397
413
  /** Type of link used to define the relationship. */
398
414
  var LinkType;
399
415
  (function (LinkType) {
416
+ LinkType["CustomLink"] = "custom_link";
400
417
  LinkType["DevelopedWith"] = "developed_with";
401
418
  LinkType["Imports"] = "imports";
419
+ LinkType["IsAnalyzedBy"] = "is_analyzed_by";
402
420
  LinkType["IsDependentOn"] = "is_dependent_on";
403
421
  LinkType["IsDuplicateOf"] = "is_duplicate_of";
422
+ LinkType["IsMergedInto"] = "is_merged_into";
404
423
  LinkType["IsParentOf"] = "is_parent_of";
405
424
  LinkType["IsPartOf"] = "is_part_of";
406
425
  LinkType["IsRelatedTo"] = "is_related_to";
@@ -540,6 +559,7 @@ var SchemaFieldDescriptorArrayTypeBaseType;
540
559
  SchemaFieldDescriptorArrayTypeBaseType["Id"] = "id";
541
560
  SchemaFieldDescriptorArrayTypeBaseType["Int"] = "int";
542
561
  SchemaFieldDescriptorArrayTypeBaseType["RichText"] = "rich_text";
562
+ SchemaFieldDescriptorArrayTypeBaseType["Struct"] = "struct";
543
563
  SchemaFieldDescriptorArrayTypeBaseType["Text"] = "text";
544
564
  SchemaFieldDescriptorArrayTypeBaseType["Timestamp"] = "timestamp";
545
565
  SchemaFieldDescriptorArrayTypeBaseType["Tokens"] = "tokens";
@@ -556,6 +576,7 @@ var SchemaFieldDescriptorFieldType;
556
576
  SchemaFieldDescriptorFieldType["Id"] = "id";
557
577
  SchemaFieldDescriptorFieldType["Int"] = "int";
558
578
  SchemaFieldDescriptorFieldType["RichText"] = "rich_text";
579
+ SchemaFieldDescriptorFieldType["Struct"] = "struct";
559
580
  SchemaFieldDescriptorFieldType["Text"] = "text";
560
581
  SchemaFieldDescriptorFieldType["Timestamp"] = "timestamp";
561
582
  SchemaFieldDescriptorFieldType["Tokens"] = "tokens";
@@ -567,10 +588,13 @@ var SearchHybridNamespace;
567
588
  (function (SearchHybridNamespace) {
568
589
  SearchHybridNamespace["Article"] = "article";
569
590
  SearchHybridNamespace["Conversation"] = "conversation";
591
+ SearchHybridNamespace["Dataset"] = "dataset";
592
+ SearchHybridNamespace["Incident"] = "incident";
570
593
  SearchHybridNamespace["Issue"] = "issue";
571
594
  SearchHybridNamespace["Part"] = "part";
572
595
  SearchHybridNamespace["QuestionAnswer"] = "question_answer";
573
596
  SearchHybridNamespace["Ticket"] = "ticket";
597
+ SearchHybridNamespace["Widget"] = "widget";
574
598
  SearchHybridNamespace["Work"] = "work";
575
599
  })(SearchHybridNamespace = exports.SearchHybridNamespace || (exports.SearchHybridNamespace = {}));
576
600
  /** The namespaces to search in. */
@@ -639,6 +663,10 @@ var SearchSortOrderParam;
639
663
  SearchSortOrderParam["Asc"] = "asc";
640
664
  SearchSortOrderParam["Desc"] = "desc";
641
665
  })(SearchSortOrderParam = exports.SearchSortOrderParam || (exports.SearchSortOrderParam = {}));
666
+ var SendNotificationType;
667
+ (function (SendNotificationType) {
668
+ SendNotificationType["GenericNotification"] = "generic_notification";
669
+ })(SendNotificationType = exports.SendNotificationType || (exports.SendNotificationType = {}));
642
670
  /**
643
671
  * The object types on which the SLA applies. An external SLA can apply to
644
672
  * multiple object types, but an internal SLA can apply to only one object
@@ -839,6 +867,13 @@ var TimelineEntryObjectType;
839
867
  TimelineEntryObjectType["Ticket"] = "ticket";
840
868
  TimelineEntryObjectType["TimelineComment"] = "timeline_comment";
841
869
  })(TimelineEntryObjectType = exports.TimelineEntryObjectType || (exports.TimelineEntryObjectType = {}));
870
+ /** Display panels for the Timeline entry. */
871
+ var TimelineEntryPanel;
872
+ (function (TimelineEntryPanel) {
873
+ TimelineEntryPanel["CustomerChat"] = "customer_chat";
874
+ TimelineEntryPanel["Discussions"] = "discussions";
875
+ TimelineEntryPanel["Events"] = "events";
876
+ })(TimelineEntryPanel = exports.TimelineEntryPanel || (exports.TimelineEntryPanel = {}));
842
877
  var TimelineEntryType;
843
878
  (function (TimelineEntryType) {
844
879
  TimelineEntryType["TimelineComment"] = "timeline_comment";
@@ -924,6 +959,9 @@ var WebhookEventType;
924
959
  WebhookEventType["DevUserCreated"] = "dev_user_created";
925
960
  WebhookEventType["DevUserDeleted"] = "dev_user_deleted";
926
961
  WebhookEventType["DevUserUpdated"] = "dev_user_updated";
962
+ WebhookEventType["GroupCreated"] = "group_created";
963
+ WebhookEventType["GroupDeleted"] = "group_deleted";
964
+ WebhookEventType["GroupUpdated"] = "group_updated";
927
965
  WebhookEventType["PartCreated"] = "part_created";
928
966
  WebhookEventType["PartDeleted"] = "part_deleted";
929
967
  WebhookEventType["PartUpdated"] = "part_updated";
@@ -1870,6 +1908,77 @@ class Api extends HttpClient {
1870
1908
  * @secure
1871
1909
  */
1872
1910
  this.groupsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/groups.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1911
+ /**
1912
+ * @description Gets an incident.
1913
+ *
1914
+ * @tags operate
1915
+ * @name IncidentsGet
1916
+ * @request GET:/incidents.get
1917
+ * @secure
1918
+ */
1919
+ this.incidentsGet = (query, params = {}) => this.request(Object.assign({ path: `/incidents.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
1920
+ /**
1921
+ * @description Gets an incident.
1922
+ *
1923
+ * @tags operate
1924
+ * @name IncidentsGetPost
1925
+ * @request POST:/incidents.get
1926
+ * @secure
1927
+ */
1928
+ this.incidentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/incidents.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1929
+ /**
1930
+ * @description Lists collections of incidents by groups.
1931
+ *
1932
+ * @tags operate
1933
+ * @name IncidentsGroup
1934
+ * @request GET:/incidents.group
1935
+ * @secure
1936
+ */
1937
+ this.incidentsGroup = (query, params = {}) => this.request(Object.assign({ path: `/incidents.group`, method: 'GET', query: query, secure: true, format: 'json' }, params));
1938
+ /**
1939
+ * @description Lists collections of incidents by groups.
1940
+ *
1941
+ * @tags operate
1942
+ * @name IncidentsGroupPost
1943
+ * @request POST:/incidents.group
1944
+ * @secure
1945
+ */
1946
+ this.incidentsGroupPost = (data, params = {}) => this.request(Object.assign({ path: `/incidents.group`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1947
+ /**
1948
+ * @description Lists incidents.
1949
+ *
1950
+ * @tags operate
1951
+ * @name IncidentsList
1952
+ * @request GET:/incidents.list
1953
+ * @secure
1954
+ */
1955
+ this.incidentsList = (query, params = {}) => this.request(Object.assign({ path: `/incidents.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
1956
+ /**
1957
+ * @description Lists incidents.
1958
+ *
1959
+ * @tags operate
1960
+ * @name IncidentsListPost
1961
+ * @request POST:/incidents.list
1962
+ * @secure
1963
+ */
1964
+ this.incidentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/incidents.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1965
+ /**
1966
+ * @description OAuth2 authorization callback.
1967
+ *
1968
+ * @tags keyring
1969
+ * @name KeyringsCreateCallback
1970
+ * @request GET:/keyrings.authorize
1971
+ */
1972
+ this.keyringsCreateCallback = (query, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'GET', query: query }, params));
1973
+ /**
1974
+ * @description OAuth2 authorization callback.
1975
+ *
1976
+ * @tags keyring
1977
+ * @name KeyringsCreateCallbackPost
1978
+ * @request POST:/keyrings.authorize
1979
+ * @secure
1980
+ */
1981
+ this.keyringsCreateCallbackPost = (data, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
1873
1982
  /**
1874
1983
  * @description Creates a link between two objects to indicate a relationship.
1875
1984
  *
@@ -1951,6 +2060,15 @@ class Api extends HttpClient {
1951
2060
  * @secure
1952
2061
  */
1953
2062
  this.metricsDevrevIngest = (data, params = {}) => this.request(Object.assign({ path: `/metrics.devrev.ingest`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2063
+ /**
2064
+ * @description Generate a notification.
2065
+ *
2066
+ * @tags notifications
2067
+ * @name NotificationsSend
2068
+ * @request POST:/notifications.send
2069
+ * @secure
2070
+ */
2071
+ this.notificationsSend = (data, params = {}) => this.request(Object.assign({ path: `/notifications.send`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1954
2072
  /**
1955
2073
  * @description Creates an organization schedule fragment.
1956
2074
  *