@devrev/typescript-sdk 1.1.55 → 1.1.57

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

@@ -117,6 +117,8 @@ export interface AccountsExportRequest {
     sort_by?: string[];
     /** Filters for accounts on specified stages. */
     stage?: string[];
+    /** Tier of the accounts to be filtered. */
+    tier?: string[];
     /** Array of websites of accounts to be filtered. */
     websites?: string[];
 }
@@ -140,6 +142,8 @@ export interface AccountsFilters {
     modified_date?: DateTimeFilter;
     /** Filters for accounts on specified stages. */
     stage?: string[];
+    /** Tier of the accounts to be filtered. */
+    tier?: string[];
     /** Array of websites of accounts to be filtered. */
     websites?: string[];
 }
@@ -199,6 +203,8 @@ export interface AccountsListRequest {
     sort_by?: string[];
     /** Filters for accounts on specified stages. */
     stage?: string[];
+    /** Tier of the accounts to be filtered. */
+    tier?: string[];
     /** Array of websites of accounts to be filtered. */
     websites?: string[];
 }
@@ -513,6 +519,33 @@ export type Article = AtomBase & {
      */
     title?: string;
 };
+/** Content format of the article. */
+export declare enum ArticleContentFormat {
+    Drdfv2 = "drdfv2",
+    Rt = "rt"
+}
+/** article-data-source-create */
+export interface ArticleDataSourceCreate {
+    /** Indicates if the leaf type is custom. */
+    is_custom_leaf_type: boolean;
+    /** Indicates if the data source is default. */
+    is_default: boolean;
+    /**
+     * The object's type.
+     * @format text
+     */
+    leaf_type: string;
+    /**
+     * The ID of the object powering article.
+     * @format id
+     */
+    object: string;
+    /**
+     * The reference ID of the data source.
+     * @format text
+     */
+    reference_id: string;
+}
 /** Status of the article. */
 export declare enum ArticleStatus {
     Archived = "archived",
@@ -538,10 +571,9 @@ export interface ArticlesCreateRequest {
     aliases?: string[];
     /**
      * The parts that the article applies to.
-     * @minItems 1
      * @example ["PROD-12345"]
      */
-    applies_to_parts: string[];
+    applies_to_parts?: string[];
     /** Type of the article. */
     article_type?: ArticleType;
     /**
@@ -549,6 +581,8 @@ export interface ArticlesCreateRequest {
      * @example ["DEVU-12345"]
      */
     authored_by?: string[];
+    /** Content format of the article. */
+    content_format?: ArticleContentFormat;
     /** Application-defined custom fields. */
     custom_fields?: object;
     /**
@@ -560,6 +594,8 @@ export interface ArticlesCreateRequest {
      * validate_required_fields: true.
      */
     custom_schema_spec?: CustomSchemaSpec;
+    /** Data sources provide the backing data for the article. */
+    data_sources?: ArticleDataSourceCreate[];
     /**
      * Description for the article.
      * @format text
@@ -779,6 +815,8 @@ export interface ArticlesUpdateRequest {
     artifacts?: ArticlesUpdateRequestArtifacts;
     authored_by?: ArticlesUpdateRequestAuthoredBy;
     content_blocks?: ArticlesUpdateRequestContentBlocks;
+    /** Content format of the article. */
+    content_format?: ArticleContentFormat;
     /** Application-defined custom fields. */
     custom_fields?: object;
     /**
@@ -790,6 +828,7 @@ export interface ArticlesUpdateRequest {
      * validate_required_fields: true.
      */
     custom_schema_spec?: CustomSchemaSpec;
+    data_sources?: ArticlesUpdateRequestArticleDataSourceUpdate;
     /**
      * Updated description of the article object, or unchanged if not
      * provided.
@@ -858,6 +897,11 @@ export interface ArticlesUpdateRequestAppliesToParts {
      */
     set?: string[];
 }
+/** articles-update-request-article-data-source-update */
+export interface ArticlesUpdateRequestArticleDataSourceUpdate {
+    /** Updates data sources provide the backing data for the article. */
+    set?: ArticleDataSourceCreate[];
+}
 /** articles-update-request-artifacts */
 export interface ArticlesUpdateRequestArtifacts {
     /**
@@ -1024,6 +1068,25 @@ export interface ArtifactsGetResponse {
     /** The version of the artifact. */
     version: ArtifactVersion;
 }
+/**
+ * artifacts-hard-delete-version-request
+ * The request to permnanently delete an artifact's version.
+ */
+export interface ArtifactsHardDeleteVersionRequest {
+    /**
+     * The ID of the artifact to delete the version for.
+     * @format id
+     * @example "ARTIFACT-12345"
+     */
+    id: string;
+    /**
+     * The version of the artifact that needs to be deleted.
+     * @format text
+     */
+    version?: string;
+}
+/** artifacts-hard-delete-version-response */
+export type ArtifactsHardDeleteVersionResponse = object;
 /**
  * artifacts-list-request
  * The request to list artifacts attached to an object.
@@ -1125,6 +1188,44 @@ export interface ArtifactsPrepareResponseFormData {
      */
     value: string;
 }
+/**
+ * artifacts-versions-prepare-request
+ * The request to prepare a new version of an artifact.
+ */
+export interface ArtifactsVersionsPrepareRequest {
+    /**
+     * The ID of the artifact to prepare a new version for.
+     * @format id
+     * @example "ARTIFACT-12345"
+     */
+    id: string;
+}
+/**
+ * artifacts-versions-prepare-response
+ * The response to preparing a new artifact version.
+ */
+export interface ArtifactsVersionsPrepareResponse {
+    /** The POST policy form data. */
+    form_data: ArtifactsVersionsPrepareResponseFormData[];
+    /**
+     * The URL that the file's data should be uploaded to.
+     * @format text
+     */
+    url: string;
+}
+/** artifacts-versions-prepare-response-form-data */
+export interface ArtifactsVersionsPrepareResponseFormData {
+    /**
+     * Key of the form field.
+     * @format text
+     */
+    key: string;
+    /**
+     * Value corresponding to the key.
+     * @format text
+     */
+    value: string;
+}
 /** atom */
 export type Atom = (AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
     type: AtomType;
@@ -1964,6 +2065,8 @@ export interface ConversationsGetResponse {
  * The request to get information about a list of conversations.
  */
 export interface ConversationsListRequest {
+    /** Provides ways to specify date ranges on objects. */
+    actual_close_date?: DateFilter;
     /**
      * Filters for conversations belonging to any of the provided parts.
      * @example ["PROD-12345"]
@@ -2036,6 +2139,8 @@ export interface ConversationsListRequest {
     source_channels?: string[];
     /** The filter for stages. */
     stage?: StageFilter;
+    /** Filters for conversations with any of the provided states. */
+    state?: string[];
     /**
      * Filters for conversations with any of the provided tags.
      * @deprecated
@@ -2149,9 +2254,7 @@ export interface ConversationsUpdateRequestMetadata {
 /** conversations-update-request-owned-by */
 export interface ConversationsUpdateRequestOwnedBy {
     /**
-     * Sets the owner IDs to the provided user IDs. This must not be
-     * empty.
-     * @minItems 1
+     * Sets the owner IDs to the provided user IDs.
      * @example ["DEVU-12345"]
      */
     set?: string[];
@@ -3768,6 +3871,19 @@ export interface EventSlaTrackerDeleted {
     id: string;
     old_sla_tracker?: SlaTracker;
 }
+/** event-sla-tracker-fetched */
+export type EventSlaTrackerFetched = (Empty | EventSlaTrackerFetchedOk) & {
+    /**
+     * The ID of the SLA tracker that was fetched.
+     * @format id
+     */
+    id: string;
+    result: EventFetchedResult;
+};
+/** event-sla-tracker-fetched-ok */
+export interface EventSlaTrackerFetchedOk {
+    sla_tracker?: SlaTracker;
+}
 /** event-sla-tracker-updated */
 export interface EventSlaTrackerUpdated {
     old_sla_tracker?: SlaTracker;
@@ -4167,6 +4283,8 @@ export interface GroupsGetResponse {
  * A request to get information about a list of groups.
  */
 export interface GroupsListRequest {
+    /** Filters the groups on the basis of creator. */
+    created_by?: string[];
     /**
      * The cursor to resume iteration from. If not provided, then
      * iteration starts from the beginning.
@@ -4194,8 +4312,11 @@ export interface GroupsListRequest {
      * always be returned in the specified sort-by order.
      */
     mode?: ListMode;
+    /** Filters the groups on the basis of group name. */
+    name?: string[];
     /** Comma-separated fields to sort the groups by. */
     sort_by?: string[];
+    sync_metadata?: SyncMetadataFilter;
 }
 /**
  * groups-list-response
@@ -4611,6 +4732,36 @@ export interface LinksListResponse {
      */
     prev_cursor?: string;
 }
+/**
+ * links-replace-request
+ * The request to replace a link.
+ */
+export interface LinksReplaceRequest {
+    /**
+     * The ID of the link to be replaced.
+     * @format id
+     */
+    id: string;
+    /** Type of link used to define the relationship. */
+    link_type: LinkType;
+    /**
+     * The ID of the source object.
+     * @format id
+     */
+    source: string;
+    /**
+     * The ID of the target object.
+     * @format id
+     */
+    target: string;
+}
+/**
+ * links-replace-response
+ * The response to replacing a link.
+ */
+export interface LinksReplaceResponse {
+    link: Link;
+}
 /**
  * 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
@@ -4725,6 +4876,29 @@ export interface MetricDefinitionsListResponse {
      */
     prev_cursor?: string;
 }
+/** metric-tracker */
+export interface MetricTracker {
+    type: MetricTrackerType;
+}
+export type MetricTrackerType = string;
+/** metric-trackers-get-request */
+export interface MetricTrackersGetRequest {
+    /**
+     * The ID of the metric that is being tracked.
+     * @format id
+     */
+    metric: string;
+    /**
+     * The ID of the underlying object on which the metric is being
+     * tracked.
+     * @format id
+     */
+    object: string;
+}
+/** metric-trackers-get-response */
+export interface MetricTrackersGetResponse {
+    metric_tracker: MetricTracker;
+}
 /** org-base */
 export type OrgBase = AtomBase & {
     /**
@@ -5190,6 +5364,12 @@ export type RevOrgSummary = OrgBaseSummary;
  * organization.
  */
 export interface RevOrgsCreateRequest {
+    /**
+     * Account Id to associate with this Rev organization.
+     * @format id
+     * @example "ACC-12345"
+     */
+    account: string;
     /**
      * Description of the Rev organization.
      * @format text
@@ -6229,6 +6409,31 @@ export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
 export type ServiceAccount = UserBase;
 /** service-account-summary */
 export type ServiceAccountSummary = UserBaseSummary;
+/**
+ * service-accounts-create-request
+ * The request object to create a new service account.
+ */
+export interface ServiceAccountsCreateRequest {
+    /**
+     * The service account's display name. A unique, human readable name
+     * to identify a service account.
+     * @format text
+     */
+    display_name: string;
+    /**
+     * Indicates whether to generate a keyring along with the new service
+     * account. The default is false.
+     */
+    gen_keyring?: boolean;
+}
+/**
+ * service-accounts-create-response
+ * The response object to the corresponding create service account
+ * request.
+ */
+export interface ServiceAccountsCreateResponse {
+    service_account: ServiceAccount;
+}
 /**
  * service-accounts-get-request
  * The request object to get a service account's information.
@@ -7205,6 +7410,8 @@ export interface SyncMetadataFilterSyncInFilter {
     status?: SyncMetadataFilterSyncInFilterStatus[];
     /** Provides ways to specify date ranges on objects. */
     sync_date?: DateFilter;
+    /** Filters for works modified with selected sync history. */
+    sync_history?: string[];
     /** Filters for works modified with selected sync units. */
     sync_unit?: string[];
 }
@@ -7220,6 +7427,8 @@ export interface SyncMetadataFilterSyncOutFilter {
     status?: SyncMetadataFilterSyncOutFilterStatus[];
     /** Provides ways to specify date ranges on objects. */
     sync_date?: DateFilter;
+    /** Filters for works modified with selected sync history. */
+    sync_history?: string[];
     /** Filters for works modified with selected sync units. */
     sync_unit?: string[];
 }
@@ -8149,6 +8358,7 @@ export interface WebhookEventRequest {
     rev_user_updated?: EventRevUserUpdated;
     sla_tracker_created?: EventSlaTrackerCreated;
     sla_tracker_deleted?: EventSlaTrackerDeleted;
+    sla_tracker_fetched?: EventSlaTrackerFetched;
     sla_tracker_updated?: EventSlaTrackerUpdated;
     survey_created?: EventSurveyCreated;
     survey_deleted?: EventSurveyDeleted;
@@ -8244,6 +8454,7 @@ export declare enum WebhookEventType {
     RevUserUpdated = "rev_user_updated",
     SlaTrackerCreated = "sla_tracker_created",
     SlaTrackerDeleted = "sla_tracker_deleted",
+    SlaTrackerFetched = "sla_tracker_fetched",
     SlaTrackerUpdated = "sla_tracker_updated",
     SurveyCreated = "survey_created",
     SurveyDeleted = "survey_deleted",
@@ -9236,6 +9447,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         sort_by?: string[];
         /** Filters for accounts on specified stages. */
         stage?: string[];
+        /** Tier of the accounts to be filtered. */
+        tier?: string[];
         /** Array of websites of accounts to be filtered. */
         websites?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
@@ -9339,6 +9552,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         sort_by?: string[];
         /** Filters for accounts on specified stages. */
         stage?: string[];
+        /** Tier of the accounts to be filtered. */
+        tier?: string[];
         /** Array of websites of accounts to be filtered. */
         websites?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
@@ -9603,6 +9818,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
+    /**
+     * @description Permanently deletes a version of an artifact.
+     *
+     * @tags artifacts
+     * @name ArtifactsHardDeleteVersion
+     * @summary Delete Artifacts Version
+     * @request POST:/artifacts.versions.delete
+     * @secure
+     */
+    artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
+    /**
+     * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
+     *
+     * @tags artifacts
+     * @name ArtifactsVersionsPrepare
+     * @summary Prepare Artifacts Versions
+     * @request POST:/artifacts.versions.prepare
+     * @secure
+     */
+    artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
     /**
      * @description Gets the specified object.
      *
@@ -9871,6 +10106,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         source_channels?: string[];
         /** Filters for records in the provided stage(s) by name. */
         'stage.name'?: string[];
+        /** Filters for conversations with any of the provided states. */
+        state?: string[];
         /**
          * Filters for conversations with any of the provided tags.
          * @deprecated
@@ -10161,6 +10398,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     groupsList: (query?: {
+        /** Filters the groups on the basis of creator. */
+        created_by?: string[];
         /**
          * The cursor to resume iteration from. If not provided, then iteration
          * starts from the beginning.
@@ -10185,8 +10424,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /** Filters the groups on the basis of group name. */
+        name?: string[];
         /** Comma-separated fields to sort the groups by. */
         sort_by?: string[];
+        /** Filters for issues with this specific external reference. */
+        'sync_metadata.external_reference'?: string[];
+        /** Filters for works with selected sync statuses. */
+        'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_in.sync_history'?: string[];
+        /** Filters for works modified with selected sync units. */
+        'sync_metadata.last_sync_in.sync_unit'?: string[];
+        /** Filters for works with selected sync statuses. */
+        'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_out.sync_history'?: string[];
+        /** Filters for works modified with selected sync units. */
+        'sync_metadata.last_sync_out.sync_unit'?: string[];
+        /** Filters for issues synced from this specific origin system. */
+        'sync_metadata.origin_system'?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
     /**
      * @description Lists the available groups.
@@ -10411,6 +10668,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
+    /**
+     * @description Replaces a link.
+     *
+     * @tags links
+     * @name LinksReplace
+     * @summary Replace Links
+     * @request POST:/links.replace
+     * @secure
+     */
+    linksReplace: (data: LinksReplaceRequest, params?: RequestParams) => Promise<AxiosResponse<LinksReplaceResponse, any>>;
     /**
      * @description Lists metric definitions matching a filter.
      *
@@ -10461,6 +10728,37 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
+    /**
+     * @description Gets a metric tracker.
+     *
+     * @tags slas
+     * @name MetricTrackersGet
+     * @summary Get Metric Tracker
+     * @request GET:/metric-trackers.get
+     * @secure
+     */
+    metricTrackersGet: (query: {
+        /**
+         * The ID of the metric that is being tracked.
+         * @format id
+         */
+        metric: string;
+        /**
+         * The ID of the underlying object on which the metric is being tracked.
+         * @format id
+         */
+        object: string;
+    }, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
+    /**
+     * @description Gets a metric tracker.
+     *
+     * @tags slas
+     * @name MetricTrackersGetPost
+     * @summary Get Metric Tracker (POST)
+     * @request POST:/metric-trackers.get
+     * @secure
+     */
+    metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
     /**
      * @description Creates new [part](https://devrev.ai/docs/product/parts).
      *
@@ -10866,6 +11164,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
+    /**
+     * @description Creates a service account.
+     *
+     * @tags service-accounts
+     * @name ServiceAccountsCreate
+     * @summary Create Service Account
+     * @request POST:/service-accounts.create
+     * @secure
+     */
+    serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any>>;
     /**
      * @description Gets a service account.
      *
@@ -11613,10 +11921,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         'sync_metadata.external_reference'?: string[];
         /** Filters for works with selected sync statuses. */
         'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_in.sync_history'?: string[];
         /** Filters for works modified with selected sync units. */
         'sync_metadata.last_sync_in.sync_unit'?: string[];
         /** Filters for works with selected sync statuses. */
         'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_out.sync_history'?: string[];
         /** Filters for works modified with selected sync units. */
         'sync_metadata.last_sync_out.sync_unit'?: string[];
         /** Filters for issues synced from this specific origin system. */
@@ -11764,10 +12076,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         'sync_metadata.external_reference'?: string[];
         /** Filters for works with selected sync statuses. */
         'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_in.sync_history'?: string[];
         /** Filters for works modified with selected sync units. */
         'sync_metadata.last_sync_in.sync_unit'?: string[];
         /** Filters for works with selected sync statuses. */
         'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
+        /** Filters for works modified with selected sync history. */
+        'sync_metadata.last_sync_out.sync_history'?: string[];
         /** Filters for works modified with selected sync units. */
         'sync_metadata.last_sync_out.sync_unit'?: string[];
         /** Filters for issues synced from this specific origin system. */