@devrev/typescript-sdk 1.1.25 → 1.1.27

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

@@ -33,8 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = 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;
-exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = 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.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = void 0;
+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;
+exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = 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;
+exports.Api = exports.HttpClient = exports.ContentType = void 0;
 var AccessLevel;
 (function (AccessLevel) {
     AccessLevel["External"] = "external";
@@ -292,6 +293,7 @@ var EngagementsCreateRequestEngagementType;
 })(EngagementsCreateRequestEngagementType = exports.EngagementsCreateRequestEngagementType || (exports.EngagementsCreateRequestEngagementType = {}));
 var ErrorBadRequestType;
 (function (ErrorBadRequestType) {
+    ErrorBadRequestType["ArtifactAlreadyAttachedToAParent"] = "artifact_already_attached_to_a_parent";
     ErrorBadRequestType["BadRequest"] = "bad_request";
     ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
     ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
@@ -433,6 +435,7 @@ var MemberType;
 var MetricDefinitionAppliesTo;
 (function (MetricDefinitionAppliesTo) {
     MetricDefinitionAppliesTo["Conversation"] = "conversation";
+    MetricDefinitionAppliesTo["Issue"] = "issue";
     MetricDefinitionAppliesTo["Ticket"] = "ticket";
 })(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
 /**
@@ -446,6 +449,16 @@ var MetricDefinitionMetricType;
     MetricDefinitionMetricType["Time"] = "time";
     MetricDefinitionMetricType["Value"] = "value";
 })(MetricDefinitionMetricType = exports.MetricDefinitionMetricType || (exports.MetricDefinitionMetricType = {}));
+/**
+ * The status of the metric. 'active' metrics can be used to create new
+ * SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
+ * be updated between 'active' and 'inactive' states.
+ */
+var MetricDefinitionStatus;
+(function (MetricDefinitionStatus) {
+    MetricDefinitionStatus["Active"] = "active";
+    MetricDefinitionStatus["Inactive"] = "inactive";
+})(MetricDefinitionStatus = exports.MetricDefinitionStatus || (exports.MetricDefinitionStatus = {}));
 /** Forecast category of the opportunity. */
 var OpportunityForecastCategory;
 (function (OpportunityForecastCategory) {
@@ -509,6 +522,7 @@ var PartType;
 var QuestionAnswerStatus;
 (function (QuestionAnswerStatus) {
     QuestionAnswerStatus["Archived"] = "archived";
+    QuestionAnswerStatus["Discarded"] = "discarded";
     QuestionAnswerStatus["Draft"] = "draft";
     QuestionAnswerStatus["Published"] = "published";
     QuestionAnswerStatus["ReviewNeeded"] = "review_needed";
@@ -620,6 +634,17 @@ var SearchSortOrderParam;
     SearchSortOrderParam["Asc"] = "asc";
     SearchSortOrderParam["Desc"] = "desc";
 })(SearchSortOrderParam = exports.SearchSortOrderParam || (exports.SearchSortOrderParam = {}));
+/**
+ * The object types on which the SLA applies. An external SLA can apply to
+ * multiple object types, but an internal SLA can apply to only one object
+ * type.
+ */
+var SlaAppliesTo;
+(function (SlaAppliesTo) {
+    SlaAppliesTo["Conversation"] = "conversation";
+    SlaAppliesTo["Issue"] = "issue";
+    SlaAppliesTo["Ticket"] = "ticket";
+})(SlaAppliesTo = exports.SlaAppliesTo || (exports.SlaAppliesTo = {}));
 /**
  * Specifies the frequency of when the contractually-meaningful evaluation
  * of the SLA happens. The organization for their own information might
@@ -639,9 +664,10 @@ var SlaEvaluationPeriod;
 var SlaSelectorAppliesTo;
 (function (SlaSelectorAppliesTo) {
     SlaSelectorAppliesTo["Conversation"] = "conversation";
+    SlaSelectorAppliesTo["Issue"] = "issue";
     SlaSelectorAppliesTo["Ticket"] = "ticket";
 })(SlaSelectorAppliesTo = exports.SlaSelectorAppliesTo || (exports.SlaSelectorAppliesTo = {}));
-/** Th SLA policy applies to conversations with these priorities. */
+/** The SLA policy applies to conversations with these priorities. */
 var SlaSelectorPriority;
 (function (SlaSelectorPriority) {
     SlaSelectorPriority["P0"] = "p0";
@@ -679,6 +705,17 @@ var SlaSummaryStage;
     SlaSummaryStage["Running"] = "running";
     SlaSummaryStage["Warning"] = "warning";
 })(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
+/** Type of the SLA. */
+var SlaType;
+(function (SlaType) {
+    SlaType["External"] = "external";
+    SlaType["Internal"] = "internal";
+})(SlaType = exports.SlaType || (exports.SlaType = {}));
+var SlasFilterAppliesToOperatorType;
+(function (SlasFilterAppliesToOperatorType) {
+    SlasFilterAppliesToOperatorType["All"] = "all";
+    SlasFilterAppliesToOperatorType["Any"] = "any";
+})(SlasFilterAppliesToOperatorType = exports.SlasFilterAppliesToOperatorType || (exports.SlasFilterAppliesToOperatorType = {}));
 /** Logical grouping of snap widgets. Useful for filtering. */
 var SnapWidgetNamespace;
 (function (SnapWidgetNamespace) {
@@ -747,6 +784,7 @@ var TicketChannels;
     TicketChannels["Email"] = "email";
     TicketChannels["Plug"] = "plug";
     TicketChannels["Slack"] = "slack";
+    TicketChannels["Twilio"] = "twilio";
 })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
 /** Severity of the ticket. */
 var TicketSeverity;
@@ -1535,6 +1573,24 @@ class Api extends HttpClient {
          * @secure
          */
         this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Links an external/secondary identity to the Dev user.
+         *
+         * @tags dev-users
+         * @name DevUsersIdentitiesLink
+         * @request POST:/dev-users.identities.link
+         * @secure
+         */
+        this.devUsersIdentitiesLink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.link`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Unlinks an external/secondary identity from the Dev user.
+         *
+         * @tags dev-users
+         * @name DevUsersIdentitiesUnlink
+         * @request POST:/dev-users.identities.unlink
+         * @secure
+         */
+        this.devUsersIdentitiesUnlink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.unlink`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Lists users within your organization.
          *

package/dist/auto-generated/public-devrev-sdk.d.ts

@@ -1006,8 +1006,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
 }
 /** dev-user */
 export type DevUser = UserBase & {
+    /**
+     * Start date of the user's employment.
+     * @format date-time
+     * @example "2023-01-01T12:00:00.000Z"
+     */
+    experience_start_date?: string;
     /** IDs of the Dev User outside the DevRev SOR. */
     external_identities?: ExternalIdentity[];
+    /** Job history of the user. */
+    job_history?: JobHistoryItem[];
+    /** Array of skills of the user. */
+    skills?: UserSkill[];
 };
 /** dev-user-external-identity-filter */
 export interface DevUserExternalIdentityFilter {
@@ -1101,10 +1111,35 @@ export type Empty = object;
 export type Enhancement = PartBase;
 /** enhancement-summary */
 export type EnhancementSummary = PartBaseSummary;
+/**
+ * enum-value
+ * Enum Value defines the structure for an enum.
+ */
+export interface EnumValue {
+    /**
+     * Unique ID of the enum value. This is immutable.
+     * @format int64
+     */
+    id: number;
+    /** Display label of the enum value. This is mutable. */
+    label: string;
+    /**
+     * Order number of the enum value. This is mutable.
+     * @format int64
+     */
+    ordinal: number;
+}
 /** error-bad-request */
-export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
+export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
     type: ErrorBadRequestType;
 };
+/** error-bad-request-artifact-already-attached-to-a-parent */
+export interface ErrorBadRequestArtifactAlreadyAttachedToAParent {
+    /** The existing parent attached to the artifact. */
+    existing_parent: string;
+    /** Whether the existing parent is the same as the new parent. */
+    is_same: boolean;
+}
 /** error-bad-request-bad-request */
 export type ErrorBadRequestBadRequest = object;
 /** error-bad-request-invalid-api-version */
@@ -1163,6 +1198,7 @@ export type ErrorBadRequestParseError = object;
  */
 export type ErrorBadRequestStaleSchemaFragments = object;
 export declare enum ErrorBadRequestType {
+    ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
     BadRequest = "bad_request",
     InvalidApiVersion = "invalid_api_version",
     InvalidEnumValue = "invalid_enum_value",
@@ -1472,6 +1508,8 @@ export type Issue = WorkBase & {
     developed_with?: PartSummary[];
     /** Priority of the work based upon impact and criticality. */
     priority?: IssuePriority;
+    /** Vista group item. */
+    sprint?: VistaGroupItemSummary;
     /**
      * Target start date for the object.
      * @format date-time
@@ -1486,6 +1524,32 @@ export declare enum IssuePriority {
     P2 = "p2",
     P3 = "p3"
 }
+/**
+ * job-history-item
+ * Defines a job history line item.
+ */
+export interface JobHistoryItem {
+    /** Enum Value defines the structure for an enum. */
+    employment_status?: EnumValue;
+    /**
+     * The end date of the job, or not specified if current.
+     * @format date-time
+     * @example "2023-01-01T12:00:00.000Z"
+     */
+    end_date?: string;
+    /** Is this the current active job for the user. */
+    is_current?: boolean;
+    /** The job location for the user. */
+    location?: string;
+    /**
+     * The start date of the job.
+     * @format date-time
+     * @example "2023-01-01T12:00:00.000Z"
+     */
+    start_date?: string;
+    /** The job title for the user. */
+    title?: string;
+}
 /**
  * legacy-stage
  * Describes the current stage of a work item.
@@ -2161,6 +2225,7 @@ export type SurveyResponse = AtomBase & {
     dispatch_id?: string;
     /** The ID of the object for which survey is taken. */
     object?: string;
+    recipient?: UserSummary;
     /** Response for the survey. */
     response?: object;
     /** The ID of the survey for which response is taken. */
@@ -2391,7 +2456,8 @@ export type Ticket = WorkBase & {
 export declare enum TicketChannels {
     Email = "email",
     Plug = "plug",
-    Slack = "slack"
+    Slack = "slack",
+    Twilio = "twilio"
 }
 /** Severity of the ticket. */
 export declare enum TicketSeverity {
@@ -2719,6 +2785,14 @@ export type UserBaseSummary = AtomBaseSummary & {
     /** State of the user. */
     state?: UserState;
 };
+/**
+ * user-skill
+ * Skill associated with the user.
+ */
+export interface UserSkill {
+    /** Name of the skill. */
+    name?: string;
+}
 /** State of the user. */
 export declare enum UserState {
     Active = "active",
@@ -2737,6 +2811,11 @@ export declare enum UserType {
     RevUser = "rev_user",
     SysUser = "sys_user"
 }
+/**
+ * vista-group-item-summary
+ * Vista group item.
+ */
+export type VistaGroupItemSummary = object;
 /** webhook */
 export type Webhook = AtomBase & {
     /** The event types that the webhook will receive. */
@@ -3208,6 +3287,8 @@ export interface WorksFilterIssue {
      * @example ["REV-AbCdEfGh"]
      */
     rev_orgs?: string[];
+    /** Filters for issues with any of the sprint. */
+    sprint?: string[];
     /** Provides ways to specify date ranges on objects. */
     target_start_date?: DateFilter;
 }
@@ -4601,6 +4682,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["REV-AbCdEfGh"]
          */
         'issue.rev_orgs'?: string[];
+        /** Filters for issues with any of the sprint. */
+        'issue.sprint'?: string[];
         /**
          * Filters for work owned by any of these users.
          * @example ["DEVU-12345"]
@@ -4724,6 +4807,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["REV-AbCdEfGh"]
          */
         'issue.rev_orgs'?: string[];
+        /** Filters for issues with any of the sprint. */
+        'issue.sprint'?: string[];
         /**
          * The maximum number of works to return. The default is '50'.
          * @format int32

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

@@ -141,6 +141,7 @@ var DevOrgAuthConnectionsUpdateRequestType;
 })(DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsUpdateRequestType || (exports.DevOrgAuthConnectionsUpdateRequestType = {}));
 var ErrorBadRequestType;
 (function (ErrorBadRequestType) {
+    ErrorBadRequestType["ArtifactAlreadyAttachedToAParent"] = "artifact_already_attached_to_a_parent";
     ErrorBadRequestType["BadRequest"] = "bad_request";
     ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
     ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
@@ -289,6 +290,7 @@ var TicketChannels;
     TicketChannels["Email"] = "email";
     TicketChannels["Plug"] = "plug";
     TicketChannels["Slack"] = "slack";
+    TicketChannels["Twilio"] = "twilio";
 })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
 /** Severity of the ticket. */
 var TicketSeverity;

package/dist/snap-ins/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interfaces';
+export * from './schema.pb';
+export * from './stock_objects';
+export * from './types';

package/dist/snap-ins/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./interfaces"), exports);
+__exportStar(require("./schema.pb"), exports);
+__exportStar(require("./stock_objects"), exports);
+__exportStar(require("./types"), exports);

package/dist/snap-ins/interfaces.d.ts

@@ -0,0 +1,15 @@
+import { OperationOutput } from './schema.pb';
+import { OperationContext } from './types';
+/**
+ * Interface for the operation base class. Contains the GetContext method.
+ */
+export interface OperationBaseIfc {
+    GetContext: (...args: any[]) => OperationContext;
+}
+/**
+ * Interface for the operation class. All operations should implement this interface.
+ * Extends the OperationBaseIfc interface.
+ */
+export interface OperationIfc extends OperationBaseIfc {
+    run(metadata: OperationContext, input: Record<string, any>, resources: Record<string, any>): Promise<OperationOutput>;
+}

package/dist/snap-ins/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });