@devrev/typescript-sdk 1.1.25 → 1.1.27

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

@@ -491,6 +491,11 @@ export interface ArticlesCountRequest {
      * @example ["DEVU-12345"]
      */
     created_by?: string[];
+    /**
+     * Filters for articles modified by any of the provided users.
+     * @example ["DEVU-12345"]
+     */
+    modified_by?: string[];
     /**
      * Filters for articles owned by any of the provided users.
      * @example ["DEVU-12345"]
@@ -644,6 +649,11 @@ export interface ArticlesListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /**
+     * Filters for articles modified by any of the provided users.
+     * @example ["DEVU-12345"]
+     */
+    modified_by?: string[];
     /**
      * Filters for articles owned by any of the provided users.
      * @example ["DEVU-12345"]
@@ -2608,8 +2618,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 {
@@ -2650,6 +2670,41 @@ export interface DevUsersGetRequest {
 export interface DevUsersGetResponse {
     dev_user: DevUser;
 }
+/**
+ * dev-users-identities-link-request
+ * Request to link external identity to a Dev user.
+ */
+export interface DevUsersIdentitiesLinkRequest {
+    /** Display name of the Dev user in the external source. */
+    display_name?: string;
+    /** Unique ID of the Dev user in the external source. */
+    id: string;
+    /** Issuer of the external identity of the Dev user. */
+    issuer: string;
+}
+/**
+ * dev-users-identities-link-response
+ * Response for the request to link an external identity to a Dev user.
+ */
+export interface DevUsersIdentitiesLinkResponse {
+    dev_user: DevUser;
+}
+/**
+ * dev-users-identities-unlink-request
+ * Request to unlink an external identity from a Dev user.
+ */
+export interface DevUsersIdentitiesUnlinkRequest {
+    /** Issuer that needs to be unlinked from a Dev user. */
+    issuer: string;
+}
+/**
+ * dev-users-identities-unlink-response
+ * Response for the request to unlink an external identity from a Dev
+ * user.
+ */
+export interface DevUsersIdentitiesUnlinkResponse {
+    dev_user: DevUser;
+}
 /**
  * dev-users-list-request
  * A request to get the list of Dev user's information.
@@ -3024,6 +3079,24 @@ export interface EngagementsUpdateResponse {
 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 */
 export interface Error {
     /** Information about the error. */
@@ -3037,9 +3110,16 @@ export interface Error {
     type?: string;
 }
 /** 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 */
@@ -3098,6 +3178,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",
@@ -3604,6 +3685,8 @@ export type GroupSearchSummary = SearchSummaryBase & {
 };
 /** group-summary */
 export type GroupSummary = AtomBaseSummary & {
+    /** Type of the members in the group. */
+    member_type?: GroupMemberType;
     /** Name of the group. */
     name?: string;
 };
@@ -3747,6 +3830,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
@@ -3766,6 +3851,32 @@ export type IssueSummary = WorkBaseSummary & {
     /** Priority of the work based upon impact and criticality. */
     priority?: IssuePriority;
 };
+/**
+ * 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.
@@ -4077,6 +4188,7 @@ export type MetricDefinition = AtomBase & {
 /** The list of item types on which the metric might be applied. */
 export declare enum MetricDefinitionAppliesTo {
     Conversation = "conversation",
+    Issue = "issue",
     Ticket = "ticket"
 }
 /**
@@ -4089,6 +4201,15 @@ export declare enum MetricDefinitionMetricType {
     Time = "time",
     Value = "value"
 }
+/**
+ * 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.
+ */
+export declare enum MetricDefinitionStatus {
+    Active = "active",
+    Inactive = "inactive"
+}
 /** metric-definition-summary */
 export type MetricDefinitionSummary = AtomBaseSummary & {
     /** Human readable name of the metric. */
@@ -4121,6 +4242,8 @@ export interface MetricDefinitionsListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /** The status of the metric definition. */
+    status?: MetricDefinitionStatus[];
     /** The type of metric definitions sought. */
     type?: MetricDefinitionMetricType[];
 }
@@ -4872,6 +4995,7 @@ export type QuestionAnswerSearchSummary = SearchSummaryBase & {
 /** Status of the question answer. */
 export declare enum QuestionAnswerStatus {
     Archived = "archived",
+    Discarded = "discarded",
     Draft = "draft",
     Published = "published",
     ReviewNeeded = "review_needed"
@@ -6315,6 +6439,36 @@ export interface ServiceAccountsGetRequest {
 export interface ServiceAccountsGetResponse {
     service_account: ServiceAccount;
 }
+/** set-issue-selector */
+export interface SetIssueSelector {
+    /**
+     * Custom fields on the issue with their fully qualified names and the
+     * associated with their exact allowed values. The SLA policy applies
+     * to issues where all named custom fields have exactly the specified
+     * values.
+     */
+    custom_fields?: object;
+    /**
+     * The SLA policy applies to the issues of these parts.
+     * @example ["PROD-12345"]
+     */
+    parts?: string[];
+    /**
+     * The SLA policy applies to the issues of these revorgs.
+     * @example ["REV-AbCdEfGh"]
+     */
+    rev_orgs?: string[];
+    /** The SLA policy applies to issues with these stages. */
+    stage_name?: string[];
+    /** The issue subtype for which the SLA policy applies. */
+    subtype?: string[];
+    /**
+     * The SLA policy applies to issues with these tags. If empty, the tag
+     * filter isn't applied.
+     * @example ["TAG-12345"]
+     */
+    tags?: string[];
+}
 /** set-org-schedule-fragment-summary */
 export interface SetOrgScheduleFragmentSummary {
     /** Organization schedule fragment ID. */
@@ -6344,6 +6498,7 @@ export interface SetSlaSelector {
      * value is null, the field must have null value or not be present.
      */
     custom_fields?: object;
+    issue_selector?: SetIssueSelector;
     /**
      * The SLA policy applies to the tickets of these parts.
      * @example ["PROD-12345"]
@@ -6448,6 +6603,8 @@ export type Sla = AtomBase & {
      * priority.
      */
     policies?: SlaPolicy[];
+    /** Type of the SLA. */
+    sla_type?: SlaType;
     /**
      * Status determines how an item can be used. In 'draft' status an item
      * can be edited but can't be used. When 'published' the item can longer
@@ -6455,6 +6612,16 @@ export type Sla = AtomBase & {
      */
     status: SlaStatus;
 };
+/**
+ * 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.
+ */
+export declare enum SlaAppliesTo {
+    Conversation = "conversation",
+    Issue = "issue",
+    Ticket = "ticket"
+}
 /** sla-assign-result */
 export interface SlaAssignResult {
     error?: Error;
@@ -6490,9 +6657,10 @@ export type SlaPolicy = object;
 /** The item type for which the SLA policy applies. */
 export declare enum SlaSelectorAppliesTo {
     Conversation = "conversation",
+    Issue = "issue",
     Ticket = "ticket"
 }
-/** Th SLA policy applies to conversations with these priorities. */
+/** The SLA policy applies to conversations with these priorities. */
 export declare enum SlaSelectorPriority {
     P0 = "p0",
     P1 = "p1",
@@ -6579,6 +6747,11 @@ export interface SlaTrackersGetRequest {
 export interface SlaTrackersGetResponse {
     sla_tracker: SlaTracker;
 }
+/** Type of the SLA. */
+export declare enum SlaType {
+    External = "external",
+    Internal = "internal"
+}
 /** slas-assign-request */
 export interface SlasAssignRequest {
     /**
@@ -6601,6 +6774,8 @@ export interface SlasAssignResponse {
 /** slas-create-request */
 export interface SlasCreateRequest {
     account_selector?: AccountsFilters;
+    /** The object types this SLA can apply to. */
+    applies_to?: SlaAppliesTo[];
     /** Description of the purpose and capabilities of the SLA. */
     description?: string;
     /**
@@ -6619,11 +6794,17 @@ export interface SlasCreateRequest {
      * priority.
      */
     policies?: SetSlaPolicy[];
+    /** Type of the SLA. */
+    sla_type?: SlaType;
 }
 /** slas-create-response */
 export interface SlasCreateResponse {
     sla: Sla;
 }
+export declare enum SlasFilterAppliesToOperatorType {
+    All = "all",
+    Any = "any"
+}
 /** slas-get-request */
 export interface SlasGetRequest {
     /** The ID of the SLA to get. */
@@ -6635,6 +6816,9 @@ export interface SlasGetResponse {
 }
 /** slas-list-request */
 export interface SlasListRequest {
+    /** The object types the SLA applies to. */
+    applies_to?: SlaAppliesTo[];
+    applies_to_op?: SlasFilterAppliesToOperatorType;
     /**
      * The cursor to resume iteration from. If not provided, then
      * iteration starts from the beginning.
@@ -6653,6 +6837,8 @@ export interface SlasListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /** The SLA types the filter matches. */
+    sla_type?: SlaType[];
     /** The SLA statuses the filter matches. */
     status?: SlaStatus[];
 }
@@ -6957,6 +7143,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. */
@@ -7072,6 +7259,8 @@ export interface SurveysResponsesListRequest {
      * them.
      */
     sort_by?: string[];
+    /** Filters for survey response stages. */
+    stages?: number[];
     /** Filters for survey responses for the provided survey IDs. */
     surveys?: string[];
 }
@@ -7111,14 +7300,21 @@ export type SurveysSendResponse = object;
 export interface SurveysSubmitRequest {
     /** The unique ID associated with the dispatched survey. */
     dispatch_id?: string;
+    /** The ordinals of the source channels on which the survey is sent. */
+    dispatched_channels?: number[];
     /**
      * The ID of the object this survey is on (e.g. ticket, conversation,
      * etc).
      * @example "ACC-12345"
      */
     object: string;
+    /**
+     * The unique ID associated with the recipient of the survey.
+     * @example "DEVU-12345"
+     */
+    recipient?: string;
     /** Survey response submitted for the object. */
-    response: object;
+    response?: object;
     /**
      * The response score for the survey. Only applicable for CSAT and
      * NPS.
@@ -7127,6 +7323,11 @@ export interface SurveysSubmitRequest {
     response_score?: number;
     /** The source channel from which survey response is submitted. */
     source_channel?: string;
+    /**
+     * The stage ordinal of the survey response object.
+     * @format int64
+     */
+    stage?: number;
     /** The ID of the survey to submit the response to. */
     survey: string;
 }
@@ -7460,7 +7661,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 {
@@ -8275,6 +8477,14 @@ export type UserBaseSummary = AtomBaseSummary & {
 export type UserSearchSummary = SearchSummaryBase & {
     user: UserSummary;
 };
+/**
+ * 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",
@@ -8299,6 +8509,11 @@ export type VistaBaseSummary = AtomBaseSummary & {
     /** Name of the vista. */
     name: string;
 };
+/**
+ * vista-group-item-summary
+ * Vista group item.
+ */
+export type VistaGroupItemSummary = object;
 /** vista-search-summary */
 export type VistaSearchSummary = SearchSummaryBase & {
     /** Represents a collection of DevRev objects. */
@@ -8891,6 +9106,8 @@ export interface WorksFilterIssue {
      * @example ["REV-AbCdEfGh"]
      */
     rev_orgs?: string[];
+    /** Filters for issues with any of the sprint. */
+    sprint?: string[];
     /** Filters for issues with any of the provided subtypes. */
     subtype?: string[];
     /** Provides ways to specify date ranges on objects. */
@@ -9501,6 +9718,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["DEVU-12345"]
          */
         created_by?: string[];
+        /**
+         * Filters for articles modified by any of the provided users.
+         * @example ["DEVU-12345"]
+         */
+        modified_by?: string[];
         /**
          * Filters for articles owned by any of the provided users.
          * @example ["DEVU-12345"]
@@ -9597,6 +9819,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /**
+         * Filters for articles modified by any of the provided users.
+         * @example ["DEVU-12345"]
+         */
+        modified_by?: string[];
         /**
          * Filters for articles owned by any of the provided users.
          * @example ["DEVU-12345"]
@@ -10188,6 +10415,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
+    /**
+     * @description Links an external/secondary identity to the Dev user.
+     *
+     * @tags dev-users
+     * @name DevUsersIdentitiesLink
+     * @request POST:/dev-users.identities.link
+     * @secure
+     */
+    devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any>>;
+    /**
+     * @description Unlinks an external/secondary identity from the Dev user.
+     *
+     * @tags dev-users
+     * @name DevUsersIdentitiesUnlink
+     * @request POST:/dev-users.identities.unlink
+     * @secure
+     */
+    devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any>>;
     /**
      * @description Lists users within your organization.
      *
@@ -10695,6 +10940,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /** The status of the metric definition. */
+        status?: MetricDefinitionStatus[];
         /** The type of metric definitions sought. */
         type?: MetricDefinitionMetricType[];
     }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
@@ -11737,6 +11984,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     slasList: (query?: {
+        /** The object types the SLA applies to. */
+        applies_to?: SlaAppliesTo[];
+        /**
+         * The Filter operator to be applied on the applies to object types
+         * filter.
+         */
+        applies_to_op?: SlasFilterAppliesToOperatorType;
         /**
          * The cursor to resume iteration from. If not provided, then iteration
          * starts from the beginning.
@@ -11752,6 +12006,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /** The SLA types the filter matches. */
+        sla_type?: SlaType[];
         /** The SLA statuses the filter matches. */
         status?: SlaStatus[];
     }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
@@ -12066,6 +12322,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * them.
          */
         sort_by?: string[];
+        /** Filters for survey response stages. */
+        stages?: number[];
         /** Filters for survey responses for the provided survey IDs. */
         surveys?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
@@ -12631,6 +12889,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 issues with any of the provided subtypes. */
         'issue.subtype'?: string[];
         /**
@@ -12771,6 +13031,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 issues with any of the provided subtypes. */
         'issue.subtype'?: string[];
         /**