@devrev/typescript-sdk 1.1.57 → 1.1.60

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

@@ -603,6 +603,11 @@ export interface AiAgentEventExecuteProgress {
 export interface AiAgentEventExecuteProgressSkillExecuted {
     /** The arguments for the skill call. */
     args?: object;
+    /**
+     * The metadata of the skill call. The fields depend on the skill that
+     * was executed.
+     */
+    metadata?: object;
     /** The output of the skill call. */
     output: object;
     /**
@@ -1018,6 +1023,8 @@ export declare enum ArticleStatus {
 }
 /** article-summary */
 export type ArticleSummary = AtomBaseSummary & {
+    /** Type of the article. */
+    article_type?: ArticleType;
     /** Resource details. */
     resource?: ResourceSummary;
     /** Sync information for records synced into/from DevRev. */
@@ -1031,7 +1038,8 @@ export type ArticleSummary = AtomBaseSummary & {
 /** Type of the article. */
 export declare enum ArticleType {
     Article = "article",
-    ContentBlock = "content_block"
+    ContentBlock = "content_block",
+    Page = "page"
 }
 /** articles-count-request */
 export interface ArticlesCountRequest {
@@ -1055,6 +1063,8 @@ export interface ArticlesCountRequest {
      * @example ["DEVU-12345"]
      */
     authored_by?: string[];
+    /** Filters for articles belonging to any of the provided brands. */
+    brands?: string[];
     /**
      * Filters for articles created by any of the provided users.
      * @example ["DEVU-12345"]
@@ -1111,6 +1121,11 @@ export interface ArticlesCreateRequest {
      * @example ["DEVU-12345"]
      */
     authored_by?: string[];
+    /**
+     * The brand associated with the article.
+     * @format id
+     */
+    brand?: string;
     /** Content format of the article. */
     content_format?: ArticleContentFormat;
     /** Application-defined custom fields. */
@@ -1265,6 +1280,8 @@ export interface ArticlesListRequest {
      * @example ["DEVU-12345"]
      */
     authored_by?: string[];
+    /** Filters for articles belonging to any of the provided brands. */
+    brands?: string[];
     /**
      * Filters for articles created by any of the provided users.
      * @example ["DEVU-12345"]
@@ -1344,6 +1361,11 @@ export interface ArticlesUpdateRequest {
     applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
     artifacts?: ArticlesUpdateRequestArtifacts;
     authored_by?: ArticlesUpdateRequestAuthoredBy;
+    /**
+     * The updated brand of the article.
+     * @format id
+     */
+    brand?: string | null;
     content_blocks?: ArticlesUpdateRequestContentBlocks;
     /** Content format of the article. */
     content_format?: ArticleContentFormat;
@@ -1507,6 +1529,23 @@ export type Artifact = AtomBase & {
     /** Defines a file object. */
     file?: ArtifactFile;
 };
+/** Represents a set of configuration to be used with the artifacts object. */
+export declare enum ArtifactConfigurationSet {
+    ArticleMedia = "article_media",
+    Default = "default",
+    EmailMedia = "email_media",
+    JobData = "job_data",
+    MarketplaceListingIcon = "marketplace_listing_icon",
+    MarketplaceMedia = "marketplace_media",
+    OrgLogo = "org_logo",
+    PlugSetting = "plug_setting",
+    PlugSettingBannerCard = "plug_setting_banner_card",
+    PortalCss = "portal_css",
+    SnapInFunctionsCode = "snap_in_functions_code",
+    SnapWidget = "snap_widget",
+    UserProfilePicture = "user_profile_picture",
+    Work = "work"
+}
 /**
  * artifact-file
  * Defines a file object.
@@ -1679,6 +1718,8 @@ export interface ArtifactsLocateResponse {
  * The request to prepare a URL to upload a file.
  */
 export interface ArtifactsPrepareRequest {
+    /** Represents a set of configuration to be used with the artifacts object. */
+    configuration_set?: ArtifactConfigurationSet;
     /**
      * The name of the file that's being uploaded.
      * @format text
@@ -2929,6 +2970,60 @@ export interface ChatsGetRequestDm {
 export interface ChatsGetResponse {
     chat: Chat;
 }
+/** chats-update-request */
+export type ChatsUpdateRequest = (ChatsUpdateRequestDm | Empty) & {
+    type?: ChatType;
+    /** Application-defined custom fields. */
+    custom_fields?: object;
+    /**
+     * Custom schemas described using identifiers. Each custom field in the
+     * request must have the corresponding schema specified; omission results
+     * in a Bad Request error. If a custom schema is not included in the
+     * specifier, it remains unchanged. For surfaces with human interactors,
+     * it is recommended to provide tenant_fragment: true and
+     * validate_required_fields: true.
+     */
+    custom_schema_spec?: CustomSchemaSpec;
+    /**
+     * The chat's ID.
+     * @format id
+     * @example "CHAN-AbCdEfGh"
+     */
+    id: string;
+    /**
+     * The updated title for the chat, or unchanged if not provided.
+     * @format text
+     */
+    title?: string;
+};
+/** chats-update-request-dm */
+export interface ChatsUpdateRequestDm {
+    records?: ChatsUpdateRequestDmRecords;
+    users?: ChatsUpdateRequestDmUsers;
+}
+/** chats-update-request-dm-records */
+export interface ChatsUpdateRequestDmRecords {
+    /**
+     * The associated records to set for this DM.
+     * @maxItems 16
+     */
+    set?: string[];
+}
+/** chats-update-request-dm-users */
+export interface ChatsUpdateRequestDmUsers {
+    /**
+     * The updated list of users to send direct messages to. The
+     * authenticated user must be included in this list.
+     * @maxItems 16
+     * @minItems 1
+     * @example ["DEVU-12345"]
+     */
+    set: string[];
+}
+/** chats-update-response */
+export interface ChatsUpdateResponse {
+    chat: Chat;
+}
 /**
  * client-context
  * Properties of client to be used in track API.
@@ -3862,6 +3957,11 @@ export type ConversationSummary = AtomBaseSummary & {
  */
 export interface ConversationsCreateRequest {
     type: ConversationsCreateRequestTypeValue;
+    /**
+     * The brand associated with the conversation.
+     * @format id
+     */
+    brand?: string;
     /** Channel IDs of the conversation. */
     channels?: string[];
     /** Application-defined custom fields. */
@@ -3967,6 +4067,8 @@ export interface ConversationsExportRequest {
      * @example ["PROD-12345"]
      */
     applies_to_parts?: string[];
+    /** Filters for tickets that are associated with any of the brands. */
+    brand?: string[];
     /**
      * Filters for conversations that are associated with any of the
      * channels.
@@ -4071,6 +4173,8 @@ export interface ConversationsListRequest {
      * @example ["PROD-12345"]
      */
     applies_to_parts?: string[];
+    /** Filters for tickets that are associated with any of the brands. */
+    brand?: string[];
     /**
      * Filters for conversations that are associated with any of the
      * channels.
@@ -4179,6 +4283,11 @@ export interface ConversationsListResponse {
  */
 export interface ConversationsUpdateRequest {
     applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
+    /**
+     * The brand associated with the conversation.
+     * @format id
+     */
+    brand?: string;
     channels?: ConversationsUpdateRequestChannels;
     /** Application-defined custom fields. */
     custom_fields?: object;
@@ -10197,6 +10306,11 @@ export type LinkableSummary = PartBaseSummary;
  * The request to create a new link.
  */
 export interface LinksCreateRequest {
+    /**
+     * The ID of the custom link type.
+     * @format id
+     */
+    custom_link_type?: string;
     /** Type of link used to define the relationship. */
     link_type: LinkType;
     /**
@@ -12135,6 +12249,11 @@ export interface PartsListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /**
+     * Filters for parts modified by any of these users.
+     * @example ["DEVU-12345"]
+     */
+    modified_by?: string[];
     /** Filters for parts of the provided name(s). */
     name?: string[];
     /**
@@ -12795,6 +12914,84 @@ export declare enum ReactionsUpdateRequestAction {
 }
 /** reactions-update-response */
 export type ReactionsUpdateResponse = object;
+/** record-template */
+export type RecordTemplate = AtomBase & {
+    /**
+     * Custom Fields of the object that the record template is associated
+     * with.
+     */
+    custom_fields?: RecordTemplateFieldValues[];
+    /**
+     * Description of the record template.
+     * @format text
+     */
+    description?: string;
+    /**
+     * Type of object that the record template is associated with.
+     * @format text
+     */
+    leaf_type?: string;
+    /**
+     * Name of the record template.
+     * @format text
+     */
+    name?: string;
+    /** Shared with membership. */
+    shared_with?: SharedWithMembership[];
+    /** State of the record template. */
+    state?: RecordTemplateState;
+    /**
+     * Stock Fields of the object that the record template is associated
+     * with.
+     */
+    stock_fields?: RecordTemplateFieldValues[];
+    /**
+     * Subtype of the object that the record template is associated with.
+     * @format text
+     */
+    subtype?: string;
+};
+/**
+ * record-template-field-values
+ * Information about the field values.
+ */
+export interface RecordTemplateFieldValues {
+    /**
+     * The field's name.
+     * @format text
+     */
+    field_name?: string;
+    /** Value of the given field. */
+    field_value?: any;
+}
+/** record-template-get-request */
+export interface RecordTemplateGetRequest {
+    /**
+     * The ID of the record template.
+     * @format id
+     */
+    id: string;
+}
+/** record-template-get-response */
+export interface RecordTemplateGetResponse {
+    record_template_info: RecordTemplateInfo;
+}
+/** record-template-info */
+export interface RecordTemplateInfo {
+    record_template: RecordTemplate;
+    /**
+     * List of fields that do not conform to the expected schema of the
+     * underlying leaf type of the template object.
+     */
+    stale_fields?: RecordTemplateFieldValues[];
+}
+/** State of the record template. */
+export declare enum RecordTemplateState {
+    Active = "active",
+    Draft = "draft",
+    Inactive = "inactive",
+    NeedsAttention = "needs_attention"
+}
 /** remove-tag-with-value */
 export interface RemoveTagWithValue {
     /**
@@ -14954,6 +15151,31 @@ export interface ServiceAccountsGetRequest {
 export interface ServiceAccountsGetResponse {
     service_account: ServiceAccount;
 }
+/**
+ * service-accounts-update-request
+ * The request object to update a service account.
+ */
+export interface ServiceAccountsUpdateRequest {
+    /**
+     * The service account's display name to be updated. A unique, human
+     * readable name to identify a service account.
+     * @format text
+     */
+    display_name?: string;
+    /**
+     * The ID of the requested service account.
+     * @format id
+     */
+    id: string;
+}
+/**
+ * service-accounts-update-response
+ * The response object that carries the updated service account's
+ * information.
+ */
+export interface ServiceAccountsUpdateResponse {
+    service_account: ServiceAccount;
+}
 /** set-issue-selector */
 export interface SetIssueSelector {
     /**
@@ -16230,6 +16452,63 @@ export interface SubWidget {
      */
     visualization: WidgetVisualization;
 }
+/** subscribers-list-request */
+export interface SubscribersListRequest {
+    /**
+     * The cursor to resume iteration from, otherwise if not provided,
+     * then iteration starts from the beginning.
+     * @format text
+     */
+    cursor?: string;
+    /**
+     * The object's ID.
+     * @format id
+     * @example "ISS-12345"
+     */
+    id: string;
+    /**
+     * The maximum number of subscribers to return. If not set or `<= 0`,
+     * then this defaults to `50`.
+     * @format int32
+     */
+    limit?: number;
+}
+/** subscribers-list-response */
+export interface SubscribersListResponse {
+    /**
+     * The cursor that should be used to iterate the next sequence of
+     * results, otherwise if not set, then no elements exist after.
+     * @format text
+     */
+    next_cursor?: string;
+    /** The list of subscribers on the object. */
+    users: UserSummary[];
+}
+/** subscribers-update-request */
+export interface SubscribersUpdateRequest {
+    /**
+     * The object's ID.
+     * @format id
+     * @example "ISS-12345"
+     */
+    id: string;
+    subscribers?: SubscribersUpdateRequestSubscribers;
+}
+/** subscribers-update-request-subscribers */
+export interface SubscribersUpdateRequestSubscribers {
+    /**
+     * The list of users to add as subscribers on the object.
+     * @example ["DEVU-12345"]
+     */
+    add?: string[];
+    /**
+     * The list of users to remove as subscribers on the object.
+     * @example ["DEVU-12345"]
+     */
+    remove?: string[];
+}
+/** subscribers-update-response */
+export type SubscribersUpdateResponse = object;
 /** subtype */
 export interface Subtype {
     /**
@@ -16440,6 +16719,18 @@ export interface SurveysDeleteRequest {
 }
 /** surveys-delete-response */
 export type SurveysDeleteResponse = object;
+/** surveys-get-request */
+export interface SurveysGetRequest {
+    /**
+     * The ID of the survey to get.
+     * @format id
+     */
+    id: string;
+}
+/** surveys-get-response */
+export interface SurveysGetResponse {
+    survey: Survey;
+}
 /** surveys-list-request */
 export interface SurveysListRequest {
     /**
@@ -20496,6 +20787,11 @@ export interface WorksExportRequest {
      */
     first?: number;
     issue?: WorksFilterIssue;
+    /**
+     * Filters for work modified by any of these users.
+     * @example ["DEVU-12345"]
+     */
+    modified_by?: string[];
     /** Provides ways to specify date ranges on objects. */
     modified_date?: DateFilter;
     opportunity?: WorksFilterOpportunity;
@@ -20578,6 +20874,8 @@ export interface WorksFilterOpportunity {
 }
 /** works-filter-ticket */
 export interface WorksFilterTicket {
+    /** Filters for tickets that are associated with any of the brands. */
+    brand?: string[];
     /** Filters for tickets with any of the provided channels. */
     channels?: TicketChannels[];
     /** Filters for tickets that are associated with any of the channels. */
@@ -20660,6 +20958,11 @@ export interface WorksListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /**
+     * Filters for work modified by any of these users.
+     * @example ["DEVU-12345"]
+     */
+    modified_by?: string[];
     /** Provides ways to specify date ranges on objects. */
     modified_date?: DateFilter;
     opportunity?: WorksFilterOpportunity;
@@ -21483,6 +21786,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["DEVU-12345"]
          */
         authored_by?: string[];
+        /** Filters for articles belonging to any of the provided brands. */
+        brands?: string[];
         /**
          * Filters for articles created by any of the provided users.
          * @example ["DEVU-12345"]
@@ -21598,6 +21903,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["DEVU-12345"]
          */
         authored_by?: string[];
+        /** Filters for articles belonging to any of the provided brands. */
+        brands?: string[];
         /**
          * Filters for articles created by any of the provided users.
          * @example ["DEVU-12345"]
@@ -22068,6 +22375,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     chatsGetPost: (data: ChatsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any>>;
+    /**
+     * @description Updates a chat's information.
+     *
+     * @tags chats
+     * @name ChatsUpdate
+     * @summary Update Chat
+     * @request POST:/chats.update
+     * @secure
+     */
+    chatsUpdate: (data: ChatsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsUpdateResponse, any>>;
     /**
      * @description Creates a code change object.
      *
@@ -22382,6 +22699,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["PROD-12345"]
          */
         applies_to_parts?: string[];
+        /** Filters for tickets that are associated with any of the brands. */
+        brand?: string[];
         /**
          * Filters for conversations that are associated with any of the
          * channels.
@@ -22524,6 +22843,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["PROD-12345"]
          */
         applies_to_parts?: string[];
+        /** Filters for tickets that are associated with any of the brands. */
+        brand?: string[];
         /**
          * Filters for conversations that are associated with any of the
          * channels.
@@ -24799,6 +25120,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /**
+         * Filters for parts modified by any of these users.
+         * @example ["DEVU-12345"]
+         */
+        modified_by?: string[];
         /** Filters for parts of the provided name(s). */
         name?: string[];
         /**
@@ -25081,6 +25407,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     getReply: (data: GetReplyRequest, params?: RequestParams) => Promise<AxiosResponse<GetReplyResponse, any>>;
+    /**
+     * @description Gets a record template object.
+     *
+     * @tags record-templates
+     * @name RecordTemplateGet
+     * @summary Get Record Template
+     * @request GET:/record-templates.get
+     * @secure
+     */
+    recordTemplateGet: (query: {
+        /**
+         * The ID of the record template.
+         * @format id
+         */
+        id: string;
+    }, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any>>;
+    /**
+     * @description Gets a record template object.
+     *
+     * @tags record-templates
+     * @name RecordTemplateGetPost
+     * @summary Get Record Template (POST)
+     * @request POST:/record-templates.get
+     * @secure
+     */
+    recordTemplateGetPost: (data: RecordTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any>>;
     /**
      * @description Creates a Rev organization in the authenticated user's Dev organization.
      *
@@ -25976,6 +26328,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
+    /**
+     * @description Updates a service account.
+     *
+     * @tags service-accounts
+     * @name ServiceAccountsUpdate
+     * @summary Update Service Account
+     * @request POST:/service-accounts.update
+     * @secure
+     */
+    serviceAccountsUpdate: (data: ServiceAccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsUpdateResponse, any>>;
     /**
      * @description Gets an SLA tracker.
      *
@@ -26525,6 +26887,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
+    /**
+     * @description Lists subscribers of an object.
+     *
+     * @tags subscribers
+     * @name SubscribersList
+     * @summary List Subscribers
+     * @request GET:/subscribers.list
+     * @secure
+     */
+    subscribersList: (query: {
+        /**
+         * The object's ID.
+         * @format id
+         * @example "ISS-12345"
+         */
+        id: string;
+        /**
+         * The cursor to resume iteration from, otherwise if not provided, then
+         * iteration starts from the beginning.
+         * @format text
+         */
+        cursor?: string;
+        /**
+         * The maximum number of subscribers to return. If not set or `<= 0`,
+         * then this defaults to `50`.
+         * @format int32
+         */
+        limit?: number;
+    }, params?: RequestParams) => Promise<AxiosResponse<SubscribersListResponse, any>>;
+    /**
+     * @description Lists subscribers of an object.
+     *
+     * @tags subscribers
+     * @name SubscribersListPost
+     * @summary List Subscribers (POST)
+     * @request POST:/subscribers.list
+     * @secure
+     */
+    subscribersListPost: (data: SubscribersListRequest, params?: RequestParams) => Promise<AxiosResponse<SubscribersListResponse, any>>;
+    /**
+     * @description Updates subscribers on the object.
+     *
+     * @tags subscribers
+     * @name SubscribersUpdate
+     * @summary Update Subscriber
+     * @request POST:/subscribers.update
+     * @secure
+     */
+    subscribersUpdate: (data: SubscribersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
     /**
      * @description Creates a schema for survey, which includes name and description of schema.
      *
@@ -26545,6 +26956,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
+    /**
+     * @description Gets a survey given the ID.
+     *
+     * @tags surveys
+     * @name SurveysGet
+     * @summary Get Survey
+     * @request GET:/surveys.get
+     * @secure
+     */
+    surveysGet: (query: {
+        /**
+         * The ID of the survey to get.
+         * @format id
+         */
+        id: string;
+    }, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any>>;
+    /**
+     * @description Gets a survey given the ID.
+     *
+     * @tags surveys
+     * @name SurveysGetPost
+     * @summary Get Survey (POST)
+     * @request POST:/surveys.get
+     * @secure
+     */
+    surveysGetPost: (data: SurveysGetRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any>>;
     /**
      * @description List surveys requested by the user.
      *
@@ -27423,6 +27860,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         'issue.sprint'?: string[];
         /** Filters for issues with any of the provided subtypes. */
         'issue.subtype'?: string[];
+        /**
+         * Filters for work modified by any of these users.
+         * @example ["DEVU-12345"]
+         */
+        modified_by?: string[];
         /**
          * Filters for opportunities belonging to any of the provided accounts.
          * @example ["ACC-12345"]
@@ -27476,6 +27918,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["TAG-12345"]
          */
         tags?: string[];
+        /** Filters for tickets that are associated with any of the brands. */
+        'ticket.brand'?: string[];
         /** Filters for tickets with any of the provided channels. */
         'ticket.channels'?: TicketChannels[];
         /** Filters for tickets that are associated with any of the channels. */
@@ -27600,6 +28044,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /**
+         * Filters for work modified by any of these users.
+         * @example ["DEVU-12345"]
+         */
+        modified_by?: string[];
         /**
          * Filters for opportunities belonging to any of the provided accounts.
          * @example ["ACC-12345"]
@@ -27653,6 +28102,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example ["TAG-12345"]
          */
         tags?: string[];
+        /** Filters for tickets that are associated with any of the brands. */
+        'ticket.brand'?: string[];
         /** Filters for tickets with any of the provided channels. */
         'ticket.channels'?: TicketChannels[];
         /** Filters for tickets that are associated with any of the channels. */