@devrev/typescript-sdk 1.1.52 → 1.1.54

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

@@ -638,6 +638,11 @@ export interface ArticlesListRequest {
     scope?: number[];
     /** Filter for articles based on intended audience. */
     shared_with?: SharedWithMembershipFilter[];
+    /**
+     * Filters for article with any of the provided tags.
+     * @example ["TAG-12345"]
+     */
+    tags?: string[];
 }
 /**
  * articles-list-response
@@ -1475,6 +1480,8 @@ export type Capability = PartBase;
 export type CapabilitySummary = PartBaseSummary;
 /** conversation */
 export type Conversation = AtomBase & {
+    /** Channel IDs of the conversation. */
+    channels?: ExternalCommunicationChannelSummary[];
     /** Description of the conversation object. */
     description?: string;
     group?: GroupSummary;
@@ -1626,6 +1633,8 @@ export interface ConversationsListRequest {
     group?: string[];
     /** Filters for conversations that are created by verified users. */
     is_creator_verified?: boolean;
+    /** Filters for conversations that are frozen. */
+    is_frozen?: boolean;
     /** Filters for conversations that are spam. */
     is_spam?: boolean;
     /**
@@ -1725,6 +1734,8 @@ export interface ConversationsUpdateRequest {
     group?: string;
     /** The ID of the conversation to update. */
     id: string;
+    /** Whether the conversation is frozen. */
+    is_frozen?: boolean;
     /** Whether the conversation is spam. */
     is_spam?: boolean;
     members?: ConversationsUpdateRequestMembers;
@@ -2733,6 +2744,8 @@ export interface EventAccountUpdated {
 }
 /** event-ai-agent-response */
 export interface EventAiAgentResponse {
+    /** The ID of the AI agent that consumed the event. */
+    agent: string;
     agent_response?: 'error' | 'message' | 'progress';
     /** The metadata given by client to be passed to the event source. */
     client_metadata?: object;
@@ -2745,6 +2758,13 @@ export interface EventAiAgentResponse {
     message?: string;
     /** A progress object providing the status of the AI agent event execution. */
     progress?: AiAgentEventExecuteProgress;
+    /**
+     * The agent session ID to track the asynchronous execution of this
+     * session.
+     */
+    session: string;
+    /** An identifier of the session with the AI agent. */
+    session_object: string;
 }
 /** event-conversation-created */
 export interface EventConversationCreated {
@@ -2994,6 +3014,22 @@ export interface EventTimelineEntryDeleted {
 export interface EventTimelineEntryUpdated {
     entry: TimelineEntry;
     old_entry?: TimelineEntry;
+    /**
+     * The reactions that were performed.
+     * @maxItems 16
+     */
+    reactions?: EventTimelineEntryUpdatedReaction[];
+}
+/** event-timeline-entry-updated-reaction */
+export interface EventTimelineEntryUpdatedReaction {
+    action: EventTimelineEntryUpdatedReactionAction;
+    /** The emoji for the reaction. */
+    emoji: string;
+    reactor?: UserSummary;
+}
+export declare enum EventTimelineEntryUpdatedReactionAction {
+    Added = "added",
+    Removed = "removed"
 }
 /** event-webhook-created */
 export interface EventWebhookCreated {
@@ -3042,6 +3078,8 @@ export interface EventWorkUpdated {
     old_work?: Work;
     work: Work;
 }
+/** external-communication-channel-summary */
+export type ExternalCommunicationChannelSummary = AtomBaseSummary;
 /**
  * external-identity
  * External identity of a user.
@@ -3312,8 +3350,6 @@ export type Incident = AtomBase & {
     identified_date?: string;
     /** Details of the impact due to the incident. */
     impact?: ImpactedCustomerDetails;
-    /** List of customers impacted due to the incident. */
-    impacted_customers?: AccountSummary[];
     /**
      * Timestamp when the incident was mitigated.
      * @format date-time
@@ -3330,11 +3366,6 @@ export type Incident = AtomBase & {
     source?: EnumValue;
     /** Describes the current stage of a object. */
     stage?: Stage;
-    /**
-     * Users, along with the incident commander, involved in resolving
-     * incidents and handling communication.
-     */
-    stakeholders?: UserSummary[];
     /** Tags associated with the object. */
     tags?: TagWithValue[];
     /**
@@ -3825,6 +3856,8 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
      * @example ["DEVU-12345"]
      */
     owned_by: string[];
+    /** Tags associated with the part. */
+    tags?: SetTagWithValue[];
 };
 /** parts-create-request-capability */
 export interface PartsCreateRequestCapability {
@@ -3930,6 +3963,11 @@ export interface PartsListRequest {
     owned_by?: string[];
     /** The filter for specifying parent part. */
     parent_part?: ParentPartFilter;
+    /**
+     * Filters for part with any of the provided tags.
+     * @example ["TAG-12345"]
+     */
+    tags?: string[];
 }
 /** parts-list-response */
 export interface PartsListResponse {
@@ -3960,6 +3998,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
     /** The updated name of the part. */
     name?: string;
     owned_by?: PartsUpdateRequestOwnedBy;
+    tags?: PartsUpdateRequestTags;
 };
 /** parts-update-request-artifacts */
 export interface PartsUpdateRequestArtifacts {
@@ -4000,6 +4039,11 @@ export interface PartsUpdateRequestOwnedBy {
 }
 /** parts-update-request-product */
 export type PartsUpdateRequestProduct = object;
+/** parts-update-request-tags */
+export interface PartsUpdateRequestTags {
+    /** Sets the tags to the provided tags. */
+    set?: SetTagWithValue[];
+}
 /** parts-update-response */
 export interface PartsUpdateResponse {
     part: Part;
@@ -4012,8 +4056,12 @@ export type ProductSummary = PartBaseSummary;
 export type QuestionAnswer = AtomBase & {
     /** The Answer. */
     answer?: string;
+    /** Details of the parts relevant to the question_answer. */
+    applies_to_parts?: PartSummary[];
     /** The Question. */
     question?: string;
+    /** Status of the question answer. */
+    status?: QuestionAnswerStatus;
     /** An alternative answer suggested by the Q/A generation algorithm. */
     suggested_answer?: string;
     /**
@@ -4026,6 +4074,14 @@ export type QuestionAnswer = AtomBase & {
     /** Whether the Q/A was verified. */
     verified?: boolean;
 };
+/** Status of the question answer. */
+export declare enum QuestionAnswerStatus {
+    Archived = "archived",
+    Discarded = "discarded",
+    Draft = "draft",
+    Published = "published",
+    ReviewNeeded = "review_needed"
+}
 /** remove-tag-with-value */
 export interface RemoveTagWithValue {
     /**
@@ -4533,11 +4589,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
  * schema-field-descriptor
  * Set of field attributes.
  */
-export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
+export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaJsonValueFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
     field_type: SchemaFieldDescriptorFieldType;
 };
 /** schema-field-descriptor-array-type */
-export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
+export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaJsonValueListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
     base_type: SchemaFieldDescriptorArrayTypeBaseType;
     /**
      * The exact array length.
@@ -4563,6 +4619,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
     Enum = "enum",
     Id = "id",
     Int = "int",
+    JsonValue = "json_value",
     RichText = "rich_text",
     Struct = "struct",
     Text = "text",
@@ -4605,6 +4662,7 @@ export declare enum SchemaFieldDescriptorFieldType {
     Enum = "enum",
     Id = "id",
     Int = "int",
+    JsonValue = "json_value",
     RichText = "rich_text",
     Struct = "struct",
     Text = "text",
@@ -4700,6 +4758,16 @@ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
      */
     lte?: number;
 };
+/** schema-json-value-field-descriptor */
+export type SchemaJsonValueFieldDescriptor = SchemaFieldDescriptorBase & {
+    /** Default value. */
+    default_value?: any;
+};
+/** schema-json-value-list-field-descriptor */
+export type SchemaJsonValueListFieldDescriptor = SchemaFieldDescriptorBase & {
+    /** Default value. */
+    default_value?: any[];
+};
 /** schema-rich-text-field-descriptor */
 export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
     /** The contained substring. */
@@ -5465,6 +5533,54 @@ export interface SlasUpdateRequest {
 export interface SlasUpdateResponse {
     sla: Sla;
 }
+/** snap-kit-action-execute-deferred-request */
+export interface SnapKitActionExecuteDeferredRequest {
+    /**
+     * List of actions triggered in the request.
+     * @maxItems 5
+     */
+    actions: SnapKitActionRequest[];
+    /** ID of the deferred snap-kit action to be executed. */
+    id: string;
+}
+/** snap-kit-action-execute-deferred-response */
+export type SnapKitActionExecuteDeferredResponse = object;
+/** snap-kit-action-request */
+export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
+    type: SnapKitActionRequestElementTypeValue;
+    /**
+     * Id of the interactive element specified by developer in a snap-kit
+     * object.
+     */
+    action_id: string;
+    /** Action interaction type. */
+    action_type?: string;
+    /**
+     * Id of the block within the surface which is the container for the
+     * interactive element.
+     */
+    block_id?: string;
+    /**
+     * Timestamp when the action was originated.
+     * @format date-time
+     * @example "2023-01-01T12:00:00.000Z"
+     */
+    timestamp: string;
+};
+/** snap-kit-action-request-button */
+export interface SnapKitActionRequestButton {
+    /** Value for the button interactive element. */
+    value: string;
+}
+export declare enum SnapKitActionRequestElementTypeValue {
+    Button = "button",
+    Form = "form"
+}
+/** snap-kit-action-request-form */
+export interface SnapKitActionRequestForm {
+    /** Value for the form interactive element. */
+    value: object;
+}
 /** snap-widget */
 export interface SnapWidget {
     type: SnapWidgetType;
@@ -5569,6 +5685,100 @@ export type SurveyResponse = AtomBase & {
     /** The ID of the survey for which response is taken. */
     survey?: string;
 };
+/** surveys-responses-list-request */
+export interface SurveysResponsesListRequest {
+    /**
+     * Filters for survey responses created by any of these users.
+     * @example ["DEVU-12345"]
+     */
+    created_by?: string[];
+    /** Provides ways to specify date ranges on objects. */
+    created_date?: DateFilter;
+    /**
+     * The cursor to resume iteration from. If not provided, then
+     * iteration starts from the beginning.
+     */
+    cursor?: string;
+    /** Filters for survey responses associated with these unique IDs. */
+    dispatch_ids?: string[];
+    /**
+     * The maximum number of survey responses to return. If not set, then
+     * the default is '50'.
+     * @format int32
+     */
+    limit?: number;
+    /**
+     * The iteration mode to use. If "after", then entries after the provided
+     * cursor will be returned, or if no cursor is provided, then from the
+     * beginning. If "before", then entries before the provided cursor will be
+     * returned, or if no cursor is provided, then from the end. Entries will
+     * always be returned in the specified sort-by order.
+     */
+    mode?: ListMode;
+    /** Provides ways to specify date ranges on objects. */
+    modified_date?: DateFilter;
+    /**
+     * Filters for survey responses created for the objects.
+     * @example ["ACC-12345"]
+     */
+    objects?: string[];
+    /**
+     * Filters for survey responses dispatched to any of these users.
+     * @example ["DEVU-12345"]
+     */
+    recipient?: string[];
+    /**
+     * Fields to sort the survey responses by and the direction to sort
+     * them.
+     */
+    sort_by?: string[];
+    /** Filters for survey response stages. */
+    stages?: number[];
+    /** Filters for survey responses for the provided survey IDs. */
+    surveys?: string[];
+}
+/** surveys-responses-list-response */
+export interface SurveysResponsesListResponse {
+    /**
+     * The cursor used to iterate subsequent results in accordance to the
+     * sort order. If not set, then no later elements exist.
+     */
+    next_cursor?: string;
+    /**
+     * The cursor used to iterate preceding results in accordance to the
+     * sort order. If not set, then no prior elements exist.
+     */
+    prev_cursor?: string;
+    /** The list of the survey responses. */
+    survey_responses: SurveyResponse[];
+}
+/** surveys-responses-update-request */
+export interface SurveysResponsesUpdateRequest {
+    /** The unique ID associated with the dispatched survey. */
+    dispatch_id: string;
+    /** Survey response submitted for the object. */
+    response?: object;
+    /**
+     * The source channel ordinal which recorded the survey response.
+     * @format int64
+     */
+    response_channel?: number;
+    /**
+     * The response score for the survey. Only applicable for CSAT and
+     * NPS.
+     * @format int32
+     * @min 1
+     * @max 10
+     */
+    response_score?: number;
+    /**
+     * The stage ordinal of the survey response object.
+     * @format int64
+     */
+    stage?: number;
+}
+/** surveys-responses-update-response */
+export type SurveysResponsesUpdateResponse = object;
 /** sync-history */
 export type SyncHistory = AtomBase & {
     /** Object for holding run-specific data. */
@@ -5931,8 +6141,11 @@ export interface TagsUpdateResponse {
 }
 /** ticket */
 export type Ticket = WorkBase & {
+    account?: AccountSummary;
     /** Channels of the ticket. */
     channels?: TicketChannels[];
+    /** Channel IDs of the ticket. */
+    channels_v2?: ExternalCommunicationChannelSummary[];
     group?: GroupSummary;
     /** Whether the ticket needs a response. */
     needs_response?: boolean;
@@ -5954,6 +6167,9 @@ export type Ticket = WorkBase & {
     sla_tracker?: SlaTrackerSummary;
     /** Source channel of the ticket. */
     source_channel?: string;
+    source_channel_v2?: ExternalCommunicationChannelSummary;
+    /** The properties of an enum value. */
+    visibility?: EnumValue;
 };
 /** Channels of the ticket. */
 export declare enum TicketChannels {
@@ -5972,6 +6188,7 @@ export declare enum TicketSeverity {
 }
 /** ticket-summary */
 export type TicketSummary = WorkBaseSummary & {
+    account?: AccountSummary;
     rev_org?: OrgSummary;
     /** Severity of the ticket. */
     severity?: TicketSeverity;
@@ -6792,6 +7009,11 @@ export interface WorksCreateRequestIssue {
 }
 /** works-create-request-ticket */
 export interface WorksCreateRequestTicket {
+    /**
+     * The account that the ticket is associated with.
+     * @example "ACC-12345"
+     */
+    account?: string;
     /** Channels of the ticket. */
     channels?: TicketChannels[];
     /** The group that the ticket is associated with. */
@@ -6884,7 +7106,7 @@ export interface WorksExportResponse {
 /** works-filter-issue */
 export interface WorksFilterIssue {
     /**
-     * Filters for issues with any of the provided Accounts.
+     * Filters for issues with any of the provided accounts.
      * @example ["ACC-12345"]
      */
     accounts?: string[];
@@ -7048,8 +7270,8 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
     /** Updates an object's stage. */
     stage?: StageUpdate;
     /**
-     * The type of stage validations options when updating the stage of an
-     * object.
+     * The type of stage validations options when updating the stage or
+     * the stage diagram of an object.
      */
     stage_validation_options?: StageValidationOptionForUpdate[];
     staged_info?: WorksUpdateRequestStagedInfoUpdate;
@@ -7158,6 +7380,11 @@ export interface WorksUpdateRequestTags {
 }
 /** works-update-request-ticket */
 export interface WorksUpdateRequestTicket {
+    /**
+     * Updates the account that the ticket is associated with.
+     * @example "ACC-12345"
+     */
+    account?: string | null;
     channels?: WorksUpdateRequestTicketChannels;
     /** Updates the group that the ticket is associated with. */
     group?: string | null;
@@ -7552,6 +7779,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         'shared_with.member'?: string;
         /** Role ID of the group/member with whom the item is shared. */
         'shared_with.role'?: string;
+        /**
+         * Filters for article with any of the provided tags.
+         * @example ["TAG-12345"]
+         */
+        tags?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
     /**
      * @description Lists a collection of articles.
@@ -7852,6 +8084,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         group?: string[];
         /** Filters for conversations that are created by verified users. */
         is_creator_verified?: boolean;
+        /** Filters for conversations that are frozen. */
+        is_frozen?: boolean;
         /** Filters for conversations that are spam. */
         is_spam?: boolean;
         /**
@@ -8560,6 +8794,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["PROD-12345"]
          */
         'parent_part.parts'?: string[];
+        /**
+         * Filters for part with any of the provided tags.
+         * @example ["TAG-12345"]
+         */
+        tags?: string[];
         /** Filters for parts of the provided type(s). */
         type?: PartType[];
     }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
@@ -9081,6 +9320,89 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
+    /**
+     * @description Executes deferred snap-kit actions.
+     *
+     * @tags snap-kit-execution
+     * @name SnapKitActionExecuteDeferred
+     * @summary Deferred Snap Kit Action Execute
+     * @request POST:/snap-kit-action.execute.deferred
+     * @secure
+     */
+    snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
+    /**
+     * @description List survey responses requested by the user.
+     *
+     * @tags surveys
+     * @name SurveysResponsesList
+     * @summary List Surveys Responses
+     * @request GET:/surveys.responses.list
+     * @secure
+     */
+    surveysResponsesList: (query?: {
+        /**
+         * Filters for survey responses created by any of these users.
+         * @example ["DEVU-12345"]
+         */
+        created_by?: string[];
+        /**
+         * The cursor to resume iteration from. If not provided, then iteration
+         * starts from the beginning.
+         */
+        cursor?: string;
+        /** Filters for survey responses associated with these unique IDs. */
+        dispatch_ids?: string[];
+        /**
+         * The maximum number of survey responses to return. If not set, then
+         * the default is '50'.
+         * @format int32
+         */
+        limit?: number;
+        /**
+         * The iteration mode to use, otherwise if not set, then "after" is
+         * used.
+         */
+        mode?: ListMode;
+        /**
+         * Filters for survey responses created for the objects.
+         * @example ["ACC-12345"]
+         */
+        objects?: string[];
+        /**
+         * Filters for survey responses dispatched to any of these users.
+         * @example ["DEVU-12345"]
+         */
+        recipient?: string[];
+        /**
+         * Fields to sort the survey responses by and the direction to sort
+         * 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>>;
+    /**
+     * @description List survey responses requested by the user.
+     *
+     * @tags surveys
+     * @name SurveysResponsesListPost
+     * @summary List Surveys Responses (POST)
+     * @request POST:/surveys.responses.list
+     * @secure
+     */
+    surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
+    /**
+     * @description Updates a user's survey response for the provided dispatch ID.
+     *
+     * @tags surveys
+     * @name SurveysResponsesUpdate
+     * @summary Update Surveys Response
+     * @request POST:/surveys.responses.update
+     * @secure
+     */
+    surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
     /**
      * @description Lists system users within your organization.
      *
@@ -9463,7 +9785,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         first?: number;
         /**
-         * Filters for issues with any of the provided Accounts.
+         * Filters for issues with any of the provided accounts.
          * @example ["ACC-12345"]
          */
         'issue.accounts'?: string[];
@@ -9600,7 +9922,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         cursor?: string;
         /**
-         * Filters for issues with any of the provided Accounts.
+         * Filters for issues with any of the provided accounts.
          * @example ["ACC-12345"]
          */
         'issue.accounts'?: string[];