@devrev/typescript-sdk 1.1.9 → 1.1.10
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.
|
@@ -577,6 +577,38 @@ export interface ArticlesUpdateResponse {
|
|
|
577
577
|
}
|
|
578
578
|
/** artifact-summary */
|
|
579
579
|
export type ArtifactSummary = AtomBaseSummary;
|
|
580
|
+
/**
|
|
581
|
+
* artifacts-prepare-request
|
|
582
|
+
* The request to prepare a URL to upload a file.
|
|
583
|
+
*/
|
|
584
|
+
export interface ArtifactsPrepareRequest {
|
|
585
|
+
/** The name of the file that's being uploaded. */
|
|
586
|
+
file_name: string;
|
|
587
|
+
/** The type of file that's being uploaded. */
|
|
588
|
+
file_type?: string;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* artifacts-prepare-response
|
|
592
|
+
* The response to preparing a URL to upload a file.
|
|
593
|
+
*/
|
|
594
|
+
export interface ArtifactsPrepareResponse {
|
|
595
|
+
/** The POST policy form data. */
|
|
596
|
+
form_data: ArtifactsPrepareResponseFormData[];
|
|
597
|
+
/**
|
|
598
|
+
* The generated artifact's ID.
|
|
599
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
|
|
600
|
+
*/
|
|
601
|
+
id: string;
|
|
602
|
+
/** The URL that the file's data should be uploaded to. */
|
|
603
|
+
url: string;
|
|
604
|
+
}
|
|
605
|
+
/** artifacts-prepare-response-form-data */
|
|
606
|
+
export interface ArtifactsPrepareResponseFormData {
|
|
607
|
+
/** Key of the form field. */
|
|
608
|
+
key: string;
|
|
609
|
+
/** Value corresponding to the key. */
|
|
610
|
+
value: string;
|
|
611
|
+
}
|
|
580
612
|
/** atom-base */
|
|
581
613
|
export interface AtomBase {
|
|
582
614
|
created_by?: UserSummary;
|
|
@@ -750,9 +782,12 @@ export interface ConversationsExportRequest {
|
|
|
750
782
|
stage?: StageFilter;
|
|
751
783
|
/**
|
|
752
784
|
* Filters for conversations with any of the provided tags.
|
|
785
|
+
* @deprecated
|
|
753
786
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
754
787
|
*/
|
|
755
788
|
tags?: string[];
|
|
789
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
790
|
+
tags_v2?: TagWithValueFilter[];
|
|
756
791
|
}
|
|
757
792
|
/** conversations-export-response */
|
|
758
793
|
export interface ConversationsExportResponse {
|
|
@@ -832,9 +867,12 @@ export interface ConversationsListRequest {
|
|
|
832
867
|
stage?: StageFilter;
|
|
833
868
|
/**
|
|
834
869
|
* Filters for conversations with any of the provided tags.
|
|
870
|
+
* @deprecated
|
|
835
871
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
836
872
|
*/
|
|
837
873
|
tags?: string[];
|
|
874
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
875
|
+
tags_v2?: TagWithValueFilter[];
|
|
838
876
|
}
|
|
839
877
|
/**
|
|
840
878
|
* conversations-list-response
|
|
@@ -1549,25 +1587,6 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
1549
1587
|
* Set of field attributes.
|
|
1550
1588
|
*/
|
|
1551
1589
|
export type FieldDescriptor = object;
|
|
1552
|
-
/**
|
|
1553
|
-
* get-accounts-default-rev-org-request
|
|
1554
|
-
* Request object to get an account's default Rev organization.
|
|
1555
|
-
*/
|
|
1556
|
-
export interface GetAccountsDefaultRevOrgRequest {
|
|
1557
|
-
/**
|
|
1558
|
-
* The ID of Account for which default Rev organization is to be
|
|
1559
|
-
* fetched.
|
|
1560
|
-
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
1561
|
-
*/
|
|
1562
|
-
id: string;
|
|
1563
|
-
}
|
|
1564
|
-
/**
|
|
1565
|
-
* get-accounts-default-rev-org-response
|
|
1566
|
-
* Response object for getting account's default Rev organization.
|
|
1567
|
-
*/
|
|
1568
|
-
export interface GetAccountsDefaultRevOrgResponse {
|
|
1569
|
-
rev_org: RevOrg;
|
|
1570
|
-
}
|
|
1571
1590
|
/** group */
|
|
1572
1591
|
export type Group = AtomBase & {
|
|
1573
1592
|
/** Description of the group. */
|
|
@@ -3507,8 +3526,6 @@ export interface Stage {
|
|
|
3507
3526
|
export interface StageFilter {
|
|
3508
3527
|
/** Filters for records in the provided stage(s) by name. */
|
|
3509
3528
|
name?: string[];
|
|
3510
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
3511
|
-
ordinal?: number[];
|
|
3512
3529
|
}
|
|
3513
3530
|
/**
|
|
3514
3531
|
* stage-init
|
|
@@ -3650,6 +3667,19 @@ export interface TagWithValue {
|
|
|
3650
3667
|
/** The value for the object's association with the tag. */
|
|
3651
3668
|
value?: string;
|
|
3652
3669
|
}
|
|
3670
|
+
/** tag-with-value-filter */
|
|
3671
|
+
export interface TagWithValueFilter {
|
|
3672
|
+
/**
|
|
3673
|
+
* The ID of the tag.
|
|
3674
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
3675
|
+
*/
|
|
3676
|
+
id?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* The value for the object's association with the tag. If specified,
|
|
3679
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
3680
|
+
*/
|
|
3681
|
+
value?: string;
|
|
3682
|
+
}
|
|
3653
3683
|
/** task */
|
|
3654
3684
|
export type Task = WorkBase;
|
|
3655
3685
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -4636,31 +4666,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4636
4666
|
* @secure
|
|
4637
4667
|
*/
|
|
4638
4668
|
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
|
|
4639
|
-
/**
|
|
4640
|
-
* @description Fetches account's default Rev organization.
|
|
4641
|
-
*
|
|
4642
|
-
* @tags accounts
|
|
4643
|
-
* @name GetAccountsDefaultRevOrg
|
|
4644
|
-
* @request GET:/accounts.default-rev-org.get
|
|
4645
|
-
* @secure
|
|
4646
|
-
*/
|
|
4647
|
-
getAccountsDefaultRevOrg: (query: {
|
|
4648
|
-
/**
|
|
4649
|
-
* The ID of Account for which default Rev organization is to be
|
|
4650
|
-
* fetched.
|
|
4651
|
-
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
4652
|
-
*/
|
|
4653
|
-
id: string;
|
|
4654
|
-
}, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4655
|
-
/**
|
|
4656
|
-
* @description Fetches account's default Rev organization.
|
|
4657
|
-
*
|
|
4658
|
-
* @tags accounts
|
|
4659
|
-
* @name GetAccountsDefaultRevOrgPost
|
|
4660
|
-
* @request POST:/accounts.default-rev-org.get
|
|
4661
|
-
* @secure
|
|
4662
|
-
*/
|
|
4663
|
-
getAccountsDefaultRevOrgPost: (data: GetAccountsDefaultRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4664
4669
|
/**
|
|
4665
4670
|
* @description Deletes an account.
|
|
4666
4671
|
*
|
|
@@ -4980,6 +4985,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4980
4985
|
* @secure
|
|
4981
4986
|
*/
|
|
4982
4987
|
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
4988
|
+
/**
|
|
4989
|
+
* @description Creates an artifact and generates an upload URL for its data.
|
|
4990
|
+
*
|
|
4991
|
+
* @tags artifacts
|
|
4992
|
+
* @name ArtifactsPrepare
|
|
4993
|
+
* @request POST:/artifacts.prepare
|
|
4994
|
+
* @secure
|
|
4995
|
+
*/
|
|
4996
|
+
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
|
|
4983
4997
|
/**
|
|
4984
4998
|
* @description Creates a conversation.
|
|
4985
4999
|
*
|
|
@@ -5044,13 +5058,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5044
5058
|
source_channels?: string[];
|
|
5045
5059
|
/** Filters for records in the provided stage(s) by name. */
|
|
5046
5060
|
'stage.name'?: string[];
|
|
5047
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
5048
|
-
'stage.ordinal'?: number[];
|
|
5049
5061
|
/**
|
|
5050
5062
|
* Filters for conversations with any of the provided tags.
|
|
5063
|
+
* @deprecated
|
|
5051
5064
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
5052
5065
|
*/
|
|
5053
5066
|
tags?: string[];
|
|
5067
|
+
/**
|
|
5068
|
+
* The ID of the tag.
|
|
5069
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
5070
|
+
*/
|
|
5071
|
+
'tags_v2.id'?: string;
|
|
5072
|
+
/**
|
|
5073
|
+
* The value for the object's association with the tag. If specified,
|
|
5074
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5075
|
+
*/
|
|
5076
|
+
'tags_v2.value'?: string;
|
|
5054
5077
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
5055
5078
|
/**
|
|
5056
5079
|
* @description Exports a collection of conversation items.
|
|
@@ -5137,13 +5160,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5137
5160
|
source_channels?: string[];
|
|
5138
5161
|
/** Filters for records in the provided stage(s) by name. */
|
|
5139
5162
|
'stage.name'?: string[];
|
|
5140
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
5141
|
-
'stage.ordinal'?: number[];
|
|
5142
5163
|
/**
|
|
5143
5164
|
* Filters for conversations with any of the provided tags.
|
|
5165
|
+
* @deprecated
|
|
5144
5166
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
5145
5167
|
*/
|
|
5146
5168
|
tags?: string[];
|
|
5169
|
+
/**
|
|
5170
|
+
* The ID of the tag.
|
|
5171
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
5172
|
+
*/
|
|
5173
|
+
'tags_v2.id'?: string;
|
|
5174
|
+
/**
|
|
5175
|
+
* The value for the object's association with the tag. If specified,
|
|
5176
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5177
|
+
*/
|
|
5178
|
+
'tags_v2.value'?: string;
|
|
5147
5179
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
5148
5180
|
/**
|
|
5149
5181
|
* @description Lists the available conversations.
|
|
@@ -6351,8 +6383,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6351
6383
|
sort_by?: string[];
|
|
6352
6384
|
/** Filters for records in the provided stage(s) by name. */
|
|
6353
6385
|
'stage.name'?: string[];
|
|
6354
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
6355
|
-
'stage.ordinal'?: number[];
|
|
6356
6386
|
/** Filters for tickets belonging to specific groups. */
|
|
6357
6387
|
'ticket.group'?: string[];
|
|
6358
6388
|
/** Filters for tickets that are spam. */
|
|
@@ -6464,8 +6494,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6464
6494
|
sort_by?: string[];
|
|
6465
6495
|
/** Filters for records in the provided stage(s) by name. */
|
|
6466
6496
|
'stage.name'?: string[];
|
|
6467
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
6468
|
-
'stage.ordinal'?: number[];
|
|
6469
6497
|
/** Filters for tickets belonging to specific groups. */
|
|
6470
6498
|
'ticket.group'?: string[];
|
|
6471
6499
|
/** Filters for tickets that are spam. */
|
|
@@ -543,24 +543,6 @@ class Api extends HttpClient {
|
|
|
543
543
|
* @secure
|
|
544
544
|
*/
|
|
545
545
|
this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
546
|
-
/**
|
|
547
|
-
* @description Fetches account's default Rev organization.
|
|
548
|
-
*
|
|
549
|
-
* @tags accounts
|
|
550
|
-
* @name GetAccountsDefaultRevOrg
|
|
551
|
-
* @request GET:/accounts.default-rev-org.get
|
|
552
|
-
* @secure
|
|
553
|
-
*/
|
|
554
|
-
this.getAccountsDefaultRevOrg = (query, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
555
|
-
/**
|
|
556
|
-
* @description Fetches account's default Rev organization.
|
|
557
|
-
*
|
|
558
|
-
* @tags accounts
|
|
559
|
-
* @name GetAccountsDefaultRevOrgPost
|
|
560
|
-
* @request POST:/accounts.default-rev-org.get
|
|
561
|
-
* @secure
|
|
562
|
-
*/
|
|
563
|
-
this.getAccountsDefaultRevOrgPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
564
546
|
/**
|
|
565
547
|
* @description Deletes an account.
|
|
566
548
|
*
|
|
@@ -714,6 +696,15 @@ class Api extends HttpClient {
|
|
|
714
696
|
* @secure
|
|
715
697
|
*/
|
|
716
698
|
this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
699
|
+
/**
|
|
700
|
+
* @description Creates an artifact and generates an upload URL for its data.
|
|
701
|
+
*
|
|
702
|
+
* @tags artifacts
|
|
703
|
+
* @name ArtifactsPrepare
|
|
704
|
+
* @request POST:/artifacts.prepare
|
|
705
|
+
* @secure
|
|
706
|
+
*/
|
|
707
|
+
this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
717
708
|
/**
|
|
718
709
|
* @description Creates a conversation.
|
|
719
710
|
*
|
|
@@ -2776,8 +2776,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2776
2776
|
owned_by?: string[];
|
|
2777
2777
|
/** Filters for records in the provided stage(s) by name. */
|
|
2778
2778
|
'stage.name'?: string[];
|
|
2779
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
2780
|
-
'stage.ordinal'?: number[];
|
|
2781
2779
|
/** Filters for tickets belonging to specific groups. */
|
|
2782
2780
|
'ticket.group'?: string[];
|
|
2783
2781
|
/** Filters for tickets that are spam. */
|
|
@@ -2860,8 +2858,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2860
2858
|
owned_by?: string[];
|
|
2861
2859
|
/** Filters for records in the provided stage(s) by name. */
|
|
2862
2860
|
'stage.name'?: string[];
|
|
2863
|
-
/** Filters for records in the provided stage(s) by ordinal. */
|
|
2864
|
-
'stage.ordinal'?: number[];
|
|
2865
2861
|
/** Filters for tickets belonging to specific groups. */
|
|
2866
2862
|
'ticket.group'?: string[];
|
|
2867
2863
|
/** Filters for tickets that are spam. */
|