@devrev/typescript-sdk 1.1.13 → 1.1.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -609,6 +609,34 @@ export interface ArtifactsPrepareResponseFormData {
|
|
|
609
609
|
/** Value corresponding to the key. */
|
|
610
610
|
value: string;
|
|
611
611
|
}
|
|
612
|
+
/**
|
|
613
|
+
* artifacts-versions-prepare-request
|
|
614
|
+
* The request to prepare a new version of an artifact.
|
|
615
|
+
*/
|
|
616
|
+
export interface ArtifactsVersionsPrepareRequest {
|
|
617
|
+
/**
|
|
618
|
+
* The ID of the artifact to prepare a new version for.
|
|
619
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
|
|
620
|
+
*/
|
|
621
|
+
id: string;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* artifacts-versions-prepare-response
|
|
625
|
+
* The response to preparing a new artifact version.
|
|
626
|
+
*/
|
|
627
|
+
export interface ArtifactsVersionsPrepareResponse {
|
|
628
|
+
/** The POST policy form data. */
|
|
629
|
+
form_data: ArtifactsVersionsPrepareResponseFormData[];
|
|
630
|
+
/** The URL that the file's data should be uploaded to. */
|
|
631
|
+
url: string;
|
|
632
|
+
}
|
|
633
|
+
/** artifacts-versions-prepare-response-form-data */
|
|
634
|
+
export interface ArtifactsVersionsPrepareResponseFormData {
|
|
635
|
+
/** Key of the form field. */
|
|
636
|
+
key: string;
|
|
637
|
+
/** Value corresponding to the key. */
|
|
638
|
+
value: string;
|
|
639
|
+
}
|
|
612
640
|
/** atom-base */
|
|
613
641
|
export interface AtomBase {
|
|
614
642
|
created_by?: UserSummary;
|
|
@@ -1076,7 +1104,7 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1076
1104
|
/** The ID of the associated custom stage diagram. */
|
|
1077
1105
|
stage_diagram?: string;
|
|
1078
1106
|
/** List of stock field enum overrides. */
|
|
1079
|
-
|
|
1107
|
+
stock_field_uenum_overrides?: StockFieldUenumOverride[];
|
|
1080
1108
|
/** The string used to populate the subtype in the leaf type. */
|
|
1081
1109
|
subtype: string;
|
|
1082
1110
|
/** The display name of the subtype. */
|
|
@@ -2055,6 +2083,42 @@ export declare enum ListMode {
|
|
|
2055
2083
|
After = "after",
|
|
2056
2084
|
Before = "before"
|
|
2057
2085
|
}
|
|
2086
|
+
/** metric-data-point */
|
|
2087
|
+
export interface MetricDataPoint {
|
|
2088
|
+
/**
|
|
2089
|
+
* Key-value pairs for specifying additional attributes.
|
|
2090
|
+
* @maxItems 10
|
|
2091
|
+
*/
|
|
2092
|
+
dimensions?: MetricDataPointDimension[];
|
|
2093
|
+
/**
|
|
2094
|
+
* Timestamp when metric value is captured.
|
|
2095
|
+
* @format date-time
|
|
2096
|
+
*/
|
|
2097
|
+
timestamp: string;
|
|
2098
|
+
/**
|
|
2099
|
+
* The value corresponding to the metric. For simply recording
|
|
2100
|
+
* occurrence of an event, this value should be 1.0.
|
|
2101
|
+
* @format double
|
|
2102
|
+
*/
|
|
2103
|
+
value: number;
|
|
2104
|
+
}
|
|
2105
|
+
/** metric-data-point-dimension */
|
|
2106
|
+
export interface MetricDataPointDimension {
|
|
2107
|
+
/**
|
|
2108
|
+
* The key for the dimension. The keys must be unique and it is not
|
|
2109
|
+
* allowed to have more than one value with the same key. Key must be
|
|
2110
|
+
* at least one character long and cannot be longer than 64
|
|
2111
|
+
* characters.Key can only contain alphanumeric characters (A-Z, a-z,
|
|
2112
|
+
* and 0-9) and underscores (_). Key cannot start with a number and is
|
|
2113
|
+
* case-insensitive.
|
|
2114
|
+
*/
|
|
2115
|
+
key: string;
|
|
2116
|
+
/**
|
|
2117
|
+
* The value for the dimension. Value could be any string and cannot
|
|
2118
|
+
* be longer than 256 characters.
|
|
2119
|
+
*/
|
|
2120
|
+
value: string;
|
|
2121
|
+
}
|
|
2058
2122
|
/** metric-definition */
|
|
2059
2123
|
export type MetricDefinition = AtomBase;
|
|
2060
2124
|
/** The list of item types on which the metric might be applied. */
|
|
@@ -2114,6 +2178,41 @@ export interface MetricDefinitionsListResponse {
|
|
|
2114
2178
|
*/
|
|
2115
2179
|
prev_cursor?: string;
|
|
2116
2180
|
}
|
|
2181
|
+
/** metrics-data */
|
|
2182
|
+
export interface MetricsData {
|
|
2183
|
+
/**
|
|
2184
|
+
* One or more data points collected for a given metric such as object
|
|
2185
|
+
* usage, object state etc.
|
|
2186
|
+
* @minItems 1
|
|
2187
|
+
*/
|
|
2188
|
+
data_points: MetricDataPoint[];
|
|
2189
|
+
/**
|
|
2190
|
+
* Name of the metric which is being measured. For example,
|
|
2191
|
+
* num_api_calls, num_active_users, etc.
|
|
2192
|
+
*/
|
|
2193
|
+
name: string;
|
|
2194
|
+
/**
|
|
2195
|
+
* Rev Org ID or external_ref for which metric is being published.Rev
|
|
2196
|
+
* Org ID is DevRev DON ID. For example,
|
|
2197
|
+
* don:identity:dvrv-us-1:devo/0:revo/156. External_ref is the
|
|
2198
|
+
* identification of DevRev customer's customers and maintained by
|
|
2199
|
+
* DevRev's customers. Devrev will internally resolve external_ref to
|
|
2200
|
+
* Rev Org ID and use it for further processing. For example,
|
|
2201
|
+
* external_ref=org_customer_1 may resolve to
|
|
2202
|
+
* don:identity:dvrv-us-1:devo/0:revo/155.
|
|
2203
|
+
*/
|
|
2204
|
+
org_ref?: string;
|
|
2205
|
+
/** Rev User ID or user ref for which metric is being published. */
|
|
2206
|
+
user_ref?: string;
|
|
2207
|
+
}
|
|
2208
|
+
/** metrics-data-ingest-request */
|
|
2209
|
+
export interface MetricsDataIngestRequest {
|
|
2210
|
+
/**
|
|
2211
|
+
* Metrics data received from Dev orgs.
|
|
2212
|
+
* @minItems 1
|
|
2213
|
+
*/
|
|
2214
|
+
metrics: MetricsData[];
|
|
2215
|
+
}
|
|
2117
2216
|
/** opportunity */
|
|
2118
2217
|
export type Opportunity = WorkBase;
|
|
2119
2218
|
/** Forecast category of the opportunity. */
|
|
@@ -3727,10 +3826,10 @@ export interface StageUpdate {
|
|
|
3727
3826
|
name?: string;
|
|
3728
3827
|
}
|
|
3729
3828
|
/**
|
|
3730
|
-
* stock-field-
|
|
3829
|
+
* stock-field-uenum-override
|
|
3731
3830
|
* Override for the allowed values of a stock field enum.
|
|
3732
3831
|
*/
|
|
3733
|
-
export type
|
|
3832
|
+
export type StockFieldUenumOverride = object;
|
|
3734
3833
|
/** subtype */
|
|
3735
3834
|
export interface Subtype {
|
|
3736
3835
|
/** Display name of the subtype. */
|
|
@@ -4648,6 +4747,11 @@ export interface WorksExportRequest {
|
|
|
4648
4747
|
sort_by?: string[];
|
|
4649
4748
|
/** The filter for stages. */
|
|
4650
4749
|
stage?: StageFilter;
|
|
4750
|
+
/**
|
|
4751
|
+
* Filters for work with any of the provided tags.
|
|
4752
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
4753
|
+
*/
|
|
4754
|
+
tags?: string[];
|
|
4651
4755
|
/** Provides ways to specify date ranges on objects. */
|
|
4652
4756
|
target_close_date?: DateFilter;
|
|
4653
4757
|
ticket?: WorksFilterTicket;
|
|
@@ -4764,6 +4868,11 @@ export interface WorksListRequest {
|
|
|
4764
4868
|
sort_by?: string[];
|
|
4765
4869
|
/** The filter for stages. */
|
|
4766
4870
|
stage?: StageFilter;
|
|
4871
|
+
/**
|
|
4872
|
+
* Filters for work with any of the provided tags.
|
|
4873
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
4874
|
+
*/
|
|
4875
|
+
tags?: string[];
|
|
4767
4876
|
/** Provides ways to specify date ranges on objects. */
|
|
4768
4877
|
target_close_date?: DateFilter;
|
|
4769
4878
|
ticket?: WorksFilterTicket;
|
|
@@ -5304,6 +5413,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5304
5413
|
* @secure
|
|
5305
5414
|
*/
|
|
5306
5415
|
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
|
|
5416
|
+
/**
|
|
5417
|
+
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
5418
|
+
*
|
|
5419
|
+
* @tags artifacts
|
|
5420
|
+
* @name ArtifactsVersionsPrepare
|
|
5421
|
+
* @request POST:/artifacts.versions.prepare
|
|
5422
|
+
* @secure
|
|
5423
|
+
*/
|
|
5424
|
+
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
|
|
5307
5425
|
/**
|
|
5308
5426
|
* @description Creates a conversation.
|
|
5309
5427
|
*
|
|
@@ -5882,6 +6000,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5882
6000
|
* @secure
|
|
5883
6001
|
*/
|
|
5884
6002
|
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
6003
|
+
/**
|
|
6004
|
+
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
6005
|
+
*
|
|
6006
|
+
* @tags telemetry
|
|
6007
|
+
* @name MetricsDevrevIngest
|
|
6008
|
+
* @request POST:/metrics.devrev.ingest
|
|
6009
|
+
* @secure
|
|
6010
|
+
*/
|
|
6011
|
+
metricsDevrevIngest: (data: MetricsDataIngestRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
5885
6012
|
/**
|
|
5886
6013
|
* @description Creates an organization schedule fragment.
|
|
5887
6014
|
*
|
|
@@ -6701,6 +6828,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6701
6828
|
sort_by?: string[];
|
|
6702
6829
|
/** Filters for records in the provided stage(s) by name. */
|
|
6703
6830
|
'stage.name'?: string[];
|
|
6831
|
+
/**
|
|
6832
|
+
* Filters for work with any of the provided tags.
|
|
6833
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
6834
|
+
*/
|
|
6835
|
+
tags?: string[];
|
|
6704
6836
|
/** Filters for tickets belonging to specific groups. */
|
|
6705
6837
|
'ticket.group'?: string[];
|
|
6706
6838
|
/** Filters for tickets that are spam. */
|
|
@@ -6812,6 +6944,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6812
6944
|
sort_by?: string[];
|
|
6813
6945
|
/** Filters for records in the provided stage(s) by name. */
|
|
6814
6946
|
'stage.name'?: string[];
|
|
6947
|
+
/**
|
|
6948
|
+
* Filters for work with any of the provided tags.
|
|
6949
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
6950
|
+
*/
|
|
6951
|
+
tags?: string[];
|
|
6815
6952
|
/** Filters for tickets belonging to specific groups. */
|
|
6816
6953
|
'ticket.group'?: string[];
|
|
6817
6954
|
/** Filters for tickets that are spam. */
|
|
@@ -738,6 +738,15 @@ class Api extends HttpClient {
|
|
|
738
738
|
* @secure
|
|
739
739
|
*/
|
|
740
740
|
this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
741
|
+
/**
|
|
742
|
+
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
743
|
+
*
|
|
744
|
+
* @tags artifacts
|
|
745
|
+
* @name ArtifactsVersionsPrepare
|
|
746
|
+
* @request POST:/artifacts.versions.prepare
|
|
747
|
+
* @secure
|
|
748
|
+
*/
|
|
749
|
+
this.artifactsVersionsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
741
750
|
/**
|
|
742
751
|
* @description Creates a conversation.
|
|
743
752
|
*
|
|
@@ -1062,6 +1071,15 @@ class Api extends HttpClient {
|
|
|
1062
1071
|
* @secure
|
|
1063
1072
|
*/
|
|
1064
1073
|
this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1074
|
+
/**
|
|
1075
|
+
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
1076
|
+
*
|
|
1077
|
+
* @tags telemetry
|
|
1078
|
+
* @name MetricsDevrevIngest
|
|
1079
|
+
* @request POST:/metrics.devrev.ingest
|
|
1080
|
+
* @secure
|
|
1081
|
+
*/
|
|
1082
|
+
this.metricsDevrevIngest = (data, params = {}) => this.request(Object.assign({ path: `/metrics.devrev.ingest`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
1065
1083
|
/**
|
|
1066
1084
|
* @description Creates an organization schedule fragment.
|
|
1067
1085
|
*
|
|
@@ -2152,6 +2152,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2152
2152
|
* @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
|
|
2153
2153
|
*/
|
|
2154
2154
|
id: string;
|
|
2155
|
+
/**
|
|
2156
|
+
* The version of the artifact that needs to be fetched.
|
|
2157
|
+
* @format date-time
|
|
2158
|
+
*/
|
|
2159
|
+
timestamp?: string;
|
|
2155
2160
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2156
2161
|
/**
|
|
2157
2162
|
* @description Creates an artifact and generates an upload URL for its data.
|
|
@@ -2784,6 +2789,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2784
2789
|
owned_by?: string[];
|
|
2785
2790
|
/** Filters for records in the provided stage(s) by name. */
|
|
2786
2791
|
'stage.name'?: string[];
|
|
2792
|
+
/**
|
|
2793
|
+
* Filters for work with any of the provided tags.
|
|
2794
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
2795
|
+
*/
|
|
2796
|
+
tags?: string[];
|
|
2787
2797
|
/** Filters for tickets belonging to specific groups. */
|
|
2788
2798
|
'ticket.group'?: string[];
|
|
2789
2799
|
/** Filters for tickets that are spam. */
|
|
@@ -2866,6 +2876,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2866
2876
|
owned_by?: string[];
|
|
2867
2877
|
/** Filters for records in the provided stage(s) by name. */
|
|
2868
2878
|
'stage.name'?: string[];
|
|
2879
|
+
/**
|
|
2880
|
+
* Filters for work with any of the provided tags.
|
|
2881
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
2882
|
+
*/
|
|
2883
|
+
tags?: string[];
|
|
2869
2884
|
/** Filters for tickets belonging to specific groups. */
|
|
2870
2885
|
'ticket.group'?: string[];
|
|
2871
2886
|
/** Filters for tickets that are spam. */
|