@devrev/typescript-sdk 1.1.14 → 1.1.16

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

@@ -609,6 +609,34 @@ export interface ArtifactsPrepareResponseFormData {
     /** Value corresponding to the key. */
     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.
+     * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
+     */
+    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. */
+    url: string;
+}
+/** artifacts-versions-prepare-response-form-data */
+export interface ArtifactsVersionsPrepareResponseFormData {
+    /** Key of the form field. */
+    key: string;
+    /** Value corresponding to the key. */
+    value: string;
+}
 /** atom-base */
 export interface AtomBase {
     created_by?: UserSummary;
@@ -2055,6 +2083,42 @@ export declare enum ListMode {
     After = "after",
     Before = "before"
 }
+/** metric-data-point */
+export interface MetricDataPoint {
+    /**
+     * Key-value pairs for specifying additional attributes.
+     * @maxItems 10
+     */
+    dimensions?: MetricDataPointDimension[];
+    /**
+     * Timestamp when metric value is captured.
+     * @format date-time
+     */
+    timestamp: string;
+    /**
+     * The value corresponding to the metric. For simply recording
+     * occurrence of an event, this value should be 1.0.
+     * @format double
+     */
+    value: number;
+}
+/** metric-data-point-dimension */
+export interface MetricDataPointDimension {
+    /**
+     * The key for the dimension. The keys must be unique and it is not
+     * allowed to have more than one value with the same key. Key must be
+     * at least one character long and cannot be longer than 64
+     * characters.Key can only contain alphanumeric characters (A-Z, a-z,
+     * and 0-9) and underscores (_). Key cannot start with a number and is
+     * case-insensitive.
+     */
+    key: string;
+    /**
+     * The value for the dimension. Value could be any string and cannot
+     * be longer than 256 characters.
+     */
+    value: string;
+}
 /** metric-definition */
 export type MetricDefinition = AtomBase;
 /** The list of item types on which the metric might be applied. */
@@ -2114,6 +2178,41 @@ export interface MetricDefinitionsListResponse {
      */
     prev_cursor?: string;
 }
+/** metrics-data */
+export interface MetricsData {
+    /**
+     * One or more data points collected for a given metric such as object
+     * usage, object state etc.
+     * @minItems 1
+     */
+    data_points: MetricDataPoint[];
+    /**
+     * Name of the metric which is being measured. For example,
+     * num_api_calls, num_active_users, etc.
+     */
+    name: string;
+    /**
+     * Rev Org ID or external_ref for which metric is being published.Rev
+     * Org ID is DevRev DON ID. For example,
+     * don:identity:dvrv-us-1:devo/0:revo/156. External_ref is the
+     * identification of DevRev customer's customers and maintained by
+     * DevRev's customers. Devrev will internally resolve external_ref to
+     * Rev Org ID and use it for further processing. For example,
+     * external_ref=org_customer_1 may resolve to
+     * don:identity:dvrv-us-1:devo/0:revo/155.
+     */
+    org_ref?: string;
+    /** Rev User ID or user ref for which metric is being published. */
+    user_ref?: string;
+}
+/** metrics-data-ingest-request */
+export interface MetricsDataIngestRequest {
+    /**
+     * Metrics data received from Dev orgs.
+     * @minItems 1
+     */
+    metrics: MetricsData[];
+}
 /** opportunity */
 export type Opportunity = WorkBase;
 /** Forecast category of the opportunity. */
@@ -2508,6 +2607,198 @@ export declare enum PartType {
     Feature = "feature",
     Product = "product"
 }
+/** parts-create-request */
+export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
+    /**
+     * The IDs of the artifacts.
+     * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
+     */
+    artifacts?: string[];
+    /** Custom fields. */
+    custom_fields?: object;
+    /**
+     * The custom schema fragments to use.
+     * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
+     */
+    custom_schema_fragments?: string[];
+    /** Description of the part. */
+    description?: string;
+    /** Name of the part. */
+    name: string;
+    /**
+     * The users that own the part.
+     * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+     */
+    owned_by: string[];
+    type: PartType;
+};
+/** parts-create-request-capability */
+export interface PartsCreateRequestCapability {
+    /**
+     * ID of the parent product for the capability.
+     * @maxItems 1
+     * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
+     */
+    parent_part: string[];
+}
+/** parts-create-request-enhancement */
+export interface PartsCreateRequestEnhancement {
+    /**
+     * ID of the parent part on which the enhancement is to be created.
+     * @maxItems 1
+     * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
+     */
+    parent_part: string[];
+    /**
+     * Target close date by which enhancement is expected to be closed.
+     * @format date-time
+     */
+    target_close_date?: string;
+}
+/** parts-create-request-feature */
+export interface PartsCreateRequestFeature {
+    /**
+     * ID of the parent capability/feature for the feature.
+     * @maxItems 1
+     * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
+     */
+    parent_part: string[];
+}
+/** parts-create-request-product */
+export type PartsCreateRequestProduct = object;
+/** parts-create-response */
+export interface PartsCreateResponse {
+    part: Part;
+}
+/** parts-delete-request */
+export interface PartsDeleteRequest {
+    /**
+     * The ID of the part to delete.
+     * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
+     */
+    id: string;
+}
+/** parts-delete-response */
+export type PartsDeleteResponse = object;
+/** parts-get-request */
+export interface PartsGetRequest {
+    /**
+     * The ID of the part to retrieve.
+     * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
+     */
+    id: string;
+}
+/** parts-get-response */
+export interface PartsGetResponse {
+    part: Part;
+}
+/** parts-list-request */
+export interface PartsListRequest {
+    /**
+     * Filters for parts created by any of these users.
+     * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+     */
+    created_by?: string[];
+    /**
+     * The cursor to resume iteration from. If not provided, then
+     * iteration starts from the beginning.
+     */
+    cursor?: string;
+    /**
+     * The maximum number of parts to return. 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;
+    /** Filters for parts of the provided name(s). */
+    name?: string[];
+    /**
+     * Filters for parts owned by any of these users.
+     * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+     */
+    owned_by?: string[];
+    /** Filters for parts of the provided type(s). */
+    type?: PartType[];
+}
+/** parts-list-response */
+export interface PartsListResponse {
+    /**
+     * 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 list of parts. */
+    parts: Part[];
+    /**
+     * The cursor used to iterate preceding results in accordance to the
+     * sort order. If not set, then no prior elements exist.
+     */
+    prev_cursor?: string;
+}
+/** parts-update-request */
+export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
+    artifacts?: PartsUpdateRequestArtifacts;
+    /** Custom fields. */
+    custom_fields?: object;
+    /**
+     * The custom schema fragments to use.
+     * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
+     */
+    custom_schema_fragments?: string[];
+    /** The updated description of the part. */
+    description?: string;
+    /**
+     * The ID of the part to update.
+     * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
+     */
+    id: string;
+    /** The updated name of the part. */
+    name?: string;
+    owned_by?: PartsUpdateRequestOwnedBy;
+    type?: PartType;
+};
+/** parts-update-request-artifacts */
+export interface PartsUpdateRequestArtifacts {
+    /**
+     * Sets the artifacts to the provided IDs.
+     * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
+     */
+    set?: string[];
+}
+/** parts-update-request-capability */
+export type PartsUpdateRequestCapability = object;
+/** parts-update-request-enhancement */
+export interface PartsUpdateRequestEnhancement {
+    /**
+     * Updates the target close date of the enhancement.
+     * @format date-time
+     */
+    target_close_date?: string;
+}
+/** parts-update-request-feature */
+export type PartsUpdateRequestFeature = object;
+/** parts-update-request-owned-by */
+export interface PartsUpdateRequestOwnedBy {
+    /**
+     * Sets the owner IDs to the provided user IDs. This must not be
+     * empty.
+     * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+     */
+    set?: string[];
+}
+/** parts-update-request-product */
+export type PartsUpdateRequestProduct = object;
+/** parts-update-response */
+export interface PartsUpdateResponse {
+    part: Part;
+}
 /** product */
 export type Product = PartBase;
 /** product-summary */
@@ -4826,7 +5117,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
      * Updates the timestamp for when the work is expected to be complete.
      * @format date-time
      */
-    target_close_date?: string;
+    target_close_date?: string | null;
     /** Updated title of the work object, or unchanged if not provided. */
     title?: string;
     type?: WorkType;
@@ -5314,6 +5605,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
+    /**
+     * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
+     *
+     * @tags artifacts
+     * @name ArtifactsVersionsPrepare
+     * @request POST:/artifacts.versions.prepare
+     * @secure
+     */
+    artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
     /**
      * @description Creates a conversation.
      *
@@ -5892,6 +6192,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
+    /**
+     * @description Ingest endpoint for DevRev metrics data from clients.
+     *
+     * @tags telemetry
+     * @name MetricsDevrevIngest
+     * @request POST:/metrics.devrev.ingest
+     * @secure
+     */
+    metricsDevrevIngest: (data: MetricsDataIngestRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
     /**
      * @description Creates an organization schedule fragment.
      *
@@ -6027,6 +6336,105 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
      * @secure
      */
     orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
+    /**
+     * @description Creates new [part](https://devrev.ai/docs/product/parts).
+     *
+     * @tags parts
+     * @name PartsCreate
+     * @request POST:/parts.create
+     * @secure
+     */
+    partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any>>;
+    /**
+     * @description Deletes a [part](https://devrev.ai/docs/product/parts).
+     *
+     * @tags parts
+     * @name PartsDelete
+     * @request POST:/parts.delete
+     * @secure
+     */
+    partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
+    /**
+     * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
+     *
+     * @tags parts
+     * @name PartsGet
+     * @request GET:/parts.get
+     * @secure
+     */
+    partsGet: (query: {
+        /**
+         * The ID of the part to retrieve.
+         * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
+         */
+        id: string;
+    }, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
+    /**
+     * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
+     *
+     * @tags parts
+     * @name PartsGetPost
+     * @request POST:/parts.get
+     * @secure
+     */
+    partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
+    /**
+     * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
+     *
+     * @tags parts
+     * @name PartsList
+     * @request GET:/parts.list
+     * @secure
+     */
+    partsList: (query?: {
+        /**
+         * Filters for parts created by any of these users.
+         * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+         */
+        created_by?: string[];
+        /**
+         * The cursor to resume iteration from. If not provided, then iteration
+         * starts from the beginning.
+         */
+        cursor?: string;
+        /**
+         * The maximum number of parts to return. 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 parts of the provided name(s). */
+        name?: string[];
+        /**
+         * Filters for parts owned by any of these users.
+         * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
+         */
+        owned_by?: string[];
+        /** Filters for parts of the provided type(s). */
+        type?: PartType[];
+    }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
+    /**
+     * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
+     *
+     * @tags parts
+     * @name PartsListPost
+     * @request POST:/parts.list
+     * @secure
+     */
+    partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
+    /**
+     * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
+     *
+     * @tags parts
+     * @name PartsUpdate
+     * @request POST:/parts.update
+     * @secure
+     */
+    partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
     /**
      * @description Creates a Rev organization in the authenticated user's Dev organization.
      *

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

@@ -738,6 +738,15 @@ class Api extends HttpClient {
          * @secure
          */
         this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
+         *
+         * @tags artifacts
+         * @name ArtifactsVersionsPrepare
+         * @request POST:/artifacts.versions.prepare
+         * @secure
+         */
+        this.artifactsVersionsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Creates a conversation.
          *
@@ -1062,6 +1071,15 @@ class Api extends HttpClient {
          * @secure
          */
         this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Ingest endpoint for DevRev metrics data from clients.
+         *
+         * @tags telemetry
+         * @name MetricsDevrevIngest
+         * @request POST:/metrics.devrev.ingest
+         * @secure
+         */
+        this.metricsDevrevIngest = (data, params = {}) => this.request(Object.assign({ path: `/metrics.devrev.ingest`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
         /**
          * @description Creates an organization schedule fragment.
          *
@@ -1170,6 +1188,69 @@ class Api extends HttpClient {
          * @secure
          */
         this.orgSchedulesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Creates new [part](https://devrev.ai/docs/product/parts).
+         *
+         * @tags parts
+         * @name PartsCreate
+         * @request POST:/parts.create
+         * @secure
+         */
+        this.partsCreate = (data, params = {}) => this.request(Object.assign({ path: `/parts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Deletes a [part](https://devrev.ai/docs/product/parts).
+         *
+         * @tags parts
+         * @name PartsDelete
+         * @request POST:/parts.delete
+         * @secure
+         */
+        this.partsDelete = (data, params = {}) => this.request(Object.assign({ path: `/parts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
+         *
+         * @tags parts
+         * @name PartsGet
+         * @request GET:/parts.get
+         * @secure
+         */
+        this.partsGet = (query, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
+         *
+         * @tags parts
+         * @name PartsGetPost
+         * @request POST:/parts.get
+         * @secure
+         */
+        this.partsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
+         *
+         * @tags parts
+         * @name PartsList
+         * @request GET:/parts.list
+         * @secure
+         */
+        this.partsList = (query, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
+         *
+         * @tags parts
+         * @name PartsListPost
+         * @request POST:/parts.list
+         * @secure
+         */
+        this.partsListPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
+         *
+         * @tags parts
+         * @name PartsUpdate
+         * @request POST:/parts.update
+         * @secure
+         */
+        this.partsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/parts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Creates a Rev organization in the authenticated user's Dev organization.
          *

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

@@ -2029,7 +2029,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
      * Updates the timestamp for when the work is expected to be complete.
      * @format date-time
      */
-    target_close_date?: string;
+    target_close_date?: string | null;
     /** Updated title of the work object, or unchanged if not provided. */
     title?: string;
     type?: WorkType;
@@ -2152,6 +2152,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
          */
         id: string;
+        /**
+         * The version of the artifact that needs to be fetched.
+         * @format date-time
+         */
+        timestamp?: string;
     }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
     /**
      * @description Creates an artifact and generates an upload URL for its data.
@@ -2587,6 +2592,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * used.
          */
         mode?: ListMode;
+        /** Filters for tags with the provided names. */
+        name?: string[];
+        /** Fields to sort tags by and the direction to sort them. */
+        sort_by?: string[];
     }, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
     /**
      * @description Updates a tag's information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/typescript-sdk",
-  "version": "1.1.14",
+  "version": "1.1.16",
   "description": "## SDK Generation",
   "main": "./dist/index.js",
   "scripts": {