@devrev/typescript-sdk 1.1.20 → 1.1.22
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.
|
@@ -77,10 +77,11 @@ export interface AccountsCreateRequest {
|
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
79
|
* accounts-create-response
|
|
80
|
-
*
|
|
80
|
+
* The response to creating a new account.
|
|
81
81
|
*/
|
|
82
82
|
export interface AccountsCreateResponse {
|
|
83
83
|
account: Account;
|
|
84
|
+
default_rev_org: RevOrg;
|
|
84
85
|
}
|
|
85
86
|
/**
|
|
86
87
|
* accounts-delete-request
|
|
@@ -137,6 +138,25 @@ export interface AccountsExportResponse {
|
|
|
137
138
|
/** The exported accounts. */
|
|
138
139
|
accounts: Account[];
|
|
139
140
|
}
|
|
141
|
+
/** accounts-filters */
|
|
142
|
+
export interface AccountsFilters {
|
|
143
|
+
/** Filters for accounts created by the specified user(s). */
|
|
144
|
+
created_by?: string[];
|
|
145
|
+
created_date?: DateTimeFilter;
|
|
146
|
+
/** Filters for custom fields. */
|
|
147
|
+
custom_fields?: object;
|
|
148
|
+
/** Domains for accounts to be filtered. */
|
|
149
|
+
domains?: string[];
|
|
150
|
+
/** Array of references of accounts to be filtered. */
|
|
151
|
+
external_refs?: string[];
|
|
152
|
+
modified_date?: DateTimeFilter;
|
|
153
|
+
/** Filters for accounts owned by the specified user(s). */
|
|
154
|
+
owned_by?: string[];
|
|
155
|
+
/** Filters for accounts on specified stages. */
|
|
156
|
+
stage?: string[];
|
|
157
|
+
/** List of tags to be filtered. */
|
|
158
|
+
tags?: string[];
|
|
159
|
+
}
|
|
140
160
|
/**
|
|
141
161
|
* accounts-get-request
|
|
142
162
|
* Request object to get an account's information.
|
|
@@ -353,7 +373,10 @@ export declare enum AggregationDetailAggregationType {
|
|
|
353
373
|
UniqueCount = "unique_count"
|
|
354
374
|
}
|
|
355
375
|
/** app-fragment */
|
|
356
|
-
export type AppFragment = CustomSchemaFragmentBase
|
|
376
|
+
export type AppFragment = CustomSchemaFragmentBase & {
|
|
377
|
+
/** App this fragment applies to. */
|
|
378
|
+
app?: string;
|
|
379
|
+
};
|
|
357
380
|
/** article */
|
|
358
381
|
export type Article = AtomBase & {
|
|
359
382
|
/** Details of the parts relevant to the article. */
|
|
@@ -362,6 +385,9 @@ export type Article = AtomBase & {
|
|
|
362
385
|
description?: string;
|
|
363
386
|
/** Artifacts containing the extracted content. */
|
|
364
387
|
extracted_content?: ArtifactSummary[];
|
|
388
|
+
parent?: DirectorySummary;
|
|
389
|
+
/** Rank of the article. */
|
|
390
|
+
rank?: string;
|
|
365
391
|
/** Resource details. */
|
|
366
392
|
resource?: Resource;
|
|
367
393
|
/** Title of the article. */
|
|
@@ -436,6 +462,8 @@ export interface ArticlesCreateRequest {
|
|
|
436
462
|
* @example ["DEVU-12345"]
|
|
437
463
|
*/
|
|
438
464
|
owned_by: string[];
|
|
465
|
+
/** The parent directory of the article. */
|
|
466
|
+
parent?: string;
|
|
439
467
|
/**
|
|
440
468
|
* The published date of the article.
|
|
441
469
|
* @format date-time
|
|
@@ -443,6 +471,8 @@ export interface ArticlesCreateRequest {
|
|
|
443
471
|
*/
|
|
444
472
|
published_at?: string;
|
|
445
473
|
resource: ArticlesCreateRequestResource;
|
|
474
|
+
/** Information about the role the member receives due to the share. */
|
|
475
|
+
shared_with?: SharedWithMembership[];
|
|
446
476
|
/** Status of the article. */
|
|
447
477
|
status?: ArticleStatus;
|
|
448
478
|
/** Tags associated with the article. */
|
|
@@ -590,8 +620,12 @@ export interface ArticlesUpdateRequest {
|
|
|
590
620
|
/** Updates the language of the article. */
|
|
591
621
|
language?: string;
|
|
592
622
|
owned_by?: ArticlesUpdateRequestOwnedBy;
|
|
623
|
+
/** The updated parent directory for the article. */
|
|
624
|
+
parent?: string | null;
|
|
593
625
|
/** Updates the the latest published version. */
|
|
594
626
|
published_version?: string;
|
|
627
|
+
reorder?: ArticlesUpdateRequestReorder;
|
|
628
|
+
shared_with?: ArticlesUpdateRequestSharedWith;
|
|
595
629
|
/** Status of the article. */
|
|
596
630
|
status?: ArticleStatus;
|
|
597
631
|
tags?: ArticlesUpdateRequestTags;
|
|
@@ -641,6 +675,24 @@ export interface ArticlesUpdateRequestOwnedBy {
|
|
|
641
675
|
*/
|
|
642
676
|
set?: string[];
|
|
643
677
|
}
|
|
678
|
+
/** articles-update-request-reorder */
|
|
679
|
+
export interface ArticlesUpdateRequestReorder {
|
|
680
|
+
/**
|
|
681
|
+
* The article after which the reordered article is placed.
|
|
682
|
+
* @example "ARTICLE-12345"
|
|
683
|
+
*/
|
|
684
|
+
after?: string;
|
|
685
|
+
/**
|
|
686
|
+
* The article before which the reordered article is placed.
|
|
687
|
+
* @example "ARTICLE-12345"
|
|
688
|
+
*/
|
|
689
|
+
before?: string;
|
|
690
|
+
}
|
|
691
|
+
/** articles-update-request-shared-with */
|
|
692
|
+
export interface ArticlesUpdateRequestSharedWith {
|
|
693
|
+
/** Sets the field to the provided membership list. */
|
|
694
|
+
set?: SharedWithMembership[];
|
|
695
|
+
}
|
|
644
696
|
/** articles-update-request-tags */
|
|
645
697
|
export interface ArticlesUpdateRequestTags {
|
|
646
698
|
/** Sets the provided tags on the article. */
|
|
@@ -652,6 +704,33 @@ export interface ArticlesUpdateResponse {
|
|
|
652
704
|
}
|
|
653
705
|
/** artifact-summary */
|
|
654
706
|
export type ArtifactSummary = AtomBaseSummary;
|
|
707
|
+
/**
|
|
708
|
+
* artifacts-locate-request
|
|
709
|
+
* The request to get an artifact's download URL.
|
|
710
|
+
*/
|
|
711
|
+
export interface ArtifactsLocateRequest {
|
|
712
|
+
/**
|
|
713
|
+
* The ID of the artifact to get the URL for.
|
|
714
|
+
* @example "ARTIFACT-12345"
|
|
715
|
+
*/
|
|
716
|
+
id: string;
|
|
717
|
+
/** The version of the artifact that needs to be fetched. */
|
|
718
|
+
version?: string;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* artifacts-locate-response
|
|
722
|
+
* The response to getting an artifact's download URL.
|
|
723
|
+
*/
|
|
724
|
+
export interface ArtifactsLocateResponse {
|
|
725
|
+
/**
|
|
726
|
+
* The expiration timestamp of the URL.
|
|
727
|
+
* @format date-time
|
|
728
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
729
|
+
*/
|
|
730
|
+
expires_at?: string;
|
|
731
|
+
/** The artifact's download URL. */
|
|
732
|
+
url: string;
|
|
733
|
+
}
|
|
655
734
|
/**
|
|
656
735
|
* artifacts-prepare-request
|
|
657
736
|
* The request to prepare a URL to upload a file.
|
|
@@ -740,6 +819,392 @@ export interface AtomBaseSummary {
|
|
|
740
819
|
/** Globally unique object ID. */
|
|
741
820
|
id: string;
|
|
742
821
|
}
|
|
822
|
+
/**
|
|
823
|
+
* auth-connection
|
|
824
|
+
* Connection object that specifies the configuration for an
|
|
825
|
+
* authentication connection that is set up for a Dev organization.
|
|
826
|
+
*/
|
|
827
|
+
export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
|
|
828
|
+
/**
|
|
829
|
+
* Display name of the authentication connection. This name will be
|
|
830
|
+
* visible to all the users when they sign in to this Dev
|
|
831
|
+
* organization. For example, if the display_name is 'abclogin', then
|
|
832
|
+
* it would appear on the login button as 'Log in to abclogin'.
|
|
833
|
+
*/
|
|
834
|
+
display_name?: string;
|
|
835
|
+
/**
|
|
836
|
+
* Whether the authentication connection is enabled or disabled. If
|
|
837
|
+
* set to false, the authentication connection will not show up on the
|
|
838
|
+
* login screen as a login option.
|
|
839
|
+
*/
|
|
840
|
+
enabled?: boolean;
|
|
841
|
+
/** ID of the authentication connection. */
|
|
842
|
+
id: string;
|
|
843
|
+
/**
|
|
844
|
+
* Defines the type for the authentication connection. The configuration
|
|
845
|
+
* for each authentication connection will depend on the type value.
|
|
846
|
+
*/
|
|
847
|
+
type: AuthConnectionType;
|
|
848
|
+
};
|
|
849
|
+
/**
|
|
850
|
+
* auth-connection-options-azure-ad
|
|
851
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
852
|
+
* authentication connection.
|
|
853
|
+
*/
|
|
854
|
+
export interface AuthConnectionOptionsAzureAd {
|
|
855
|
+
/** Client ID for the Azure authentication connection. */
|
|
856
|
+
client_id?: string;
|
|
857
|
+
/** Client secret for the Azure authentication connection. */
|
|
858
|
+
client_secret?: string;
|
|
859
|
+
/** Domain URL of the Azure authentication connection. */
|
|
860
|
+
domain?: string;
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* auth-connection-options-google-apps
|
|
864
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
865
|
+
* authentication connection.
|
|
866
|
+
*/
|
|
867
|
+
export interface AuthConnectionOptionsGoogleApps {
|
|
868
|
+
/** Client ID for the Google Apps authentication connection. */
|
|
869
|
+
client_id?: string;
|
|
870
|
+
/** Client secret for the Google Apps authentication connection. */
|
|
871
|
+
client_secret?: string;
|
|
872
|
+
/** Tenant domain URL of the Google Apps authentication connection. */
|
|
873
|
+
tenant_domain?: string;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* auth-connection-options-oidc
|
|
877
|
+
* Object encapsulating the configuration parameters for an OIDC
|
|
878
|
+
* authentication connection.
|
|
879
|
+
*/
|
|
880
|
+
export interface AuthConnectionOptionsOidc {
|
|
881
|
+
/** Client ID for the OIDC authentication connection. */
|
|
882
|
+
client_id?: string;
|
|
883
|
+
/** Client secret for the OIDC authentication connection. */
|
|
884
|
+
client_secret?: string;
|
|
885
|
+
/** Issuer URL of the OIDC authentication connection. */
|
|
886
|
+
issuer?: string;
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* auth-connection-options-saml
|
|
890
|
+
* Object encapsulating the configuration parameters for a SAML
|
|
891
|
+
* authentication connection.
|
|
892
|
+
*/
|
|
893
|
+
export interface AuthConnectionOptionsSaml {
|
|
894
|
+
/** Sign In endpoint for the SAML authentication connection. */
|
|
895
|
+
sign_in_endpoint?: string;
|
|
896
|
+
/** Signing certificate for the SAML authentication connection. */
|
|
897
|
+
signing_cert?: string;
|
|
898
|
+
}
|
|
899
|
+
/** auth-connection-options-social */
|
|
900
|
+
export type AuthConnectionOptionsSocial = object;
|
|
901
|
+
export declare enum AuthConnectionToggle {
|
|
902
|
+
Disable = "disable",
|
|
903
|
+
Enable = "enable"
|
|
904
|
+
}
|
|
905
|
+
/**
|
|
906
|
+
* Defines the type for the authentication connection. The configuration
|
|
907
|
+
* for each authentication connection will depend on the type value.
|
|
908
|
+
*/
|
|
909
|
+
export declare enum AuthConnectionType {
|
|
910
|
+
GoogleApps = "google_apps",
|
|
911
|
+
Oidc = "oidc",
|
|
912
|
+
Samlp = "samlp",
|
|
913
|
+
Social = "social",
|
|
914
|
+
Waad = "waad"
|
|
915
|
+
}
|
|
916
|
+
/** auth-token */
|
|
917
|
+
export type AuthToken = AtomBase & {
|
|
918
|
+
/**
|
|
919
|
+
* An identifier that represents the application that requested the
|
|
920
|
+
* token. Only applicable for application access tokens.
|
|
921
|
+
*/
|
|
922
|
+
client_id?: string;
|
|
923
|
+
/**
|
|
924
|
+
* The time at which the token expires.
|
|
925
|
+
* @format date-time
|
|
926
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
927
|
+
*/
|
|
928
|
+
expires_at?: string;
|
|
929
|
+
/**
|
|
930
|
+
* The time at which the token was issued.
|
|
931
|
+
* @format date-time
|
|
932
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
933
|
+
*/
|
|
934
|
+
issued_at?: string;
|
|
935
|
+
/** The type of the requested token. */
|
|
936
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
937
|
+
/** The scopes associated with the issued token. */
|
|
938
|
+
scopes?: string[];
|
|
939
|
+
/** The status of the token. */
|
|
940
|
+
status?: AuthTokenStatus;
|
|
941
|
+
/** The subject of the token. */
|
|
942
|
+
subject?: string;
|
|
943
|
+
/** A hint that identifies the token. */
|
|
944
|
+
token_hint?: string;
|
|
945
|
+
};
|
|
946
|
+
/** Specifies the process of obtaining a token. */
|
|
947
|
+
export declare enum AuthTokenGrantType {
|
|
948
|
+
UrnDevrevParamsOauthGrantTypeTokenIssue = "urn:devrev:params:oauth:grant-type:token-issue",
|
|
949
|
+
UrnIetfParamsOauthGrantTypeTokenExchange = "urn:ietf:params:oauth:grant-type:token-exchange"
|
|
950
|
+
}
|
|
951
|
+
/** The type of the requested token. */
|
|
952
|
+
export declare enum AuthTokenRequestedTokenType {
|
|
953
|
+
UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
|
|
954
|
+
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
955
|
+
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
956
|
+
UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
|
|
957
|
+
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
958
|
+
UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
|
|
959
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
960
|
+
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
961
|
+
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
962
|
+
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
963
|
+
UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
|
|
964
|
+
UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
|
|
965
|
+
UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
|
|
966
|
+
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
967
|
+
}
|
|
968
|
+
/** The status of the token. */
|
|
969
|
+
export declare enum AuthTokenStatus {
|
|
970
|
+
Active = "active",
|
|
971
|
+
Expired = "expired",
|
|
972
|
+
Revoked = "revoked"
|
|
973
|
+
}
|
|
974
|
+
/** The type of the subject token. */
|
|
975
|
+
export declare enum AuthTokenSubjectTokenType {
|
|
976
|
+
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
977
|
+
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
978
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
979
|
+
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
980
|
+
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
981
|
+
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
982
|
+
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
983
|
+
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
984
|
+
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
985
|
+
}
|
|
986
|
+
/** The type of the issued token. Bearer is the only supported token type. */
|
|
987
|
+
export declare enum AuthTokenTokenType {
|
|
988
|
+
Bearer = "bearer"
|
|
989
|
+
}
|
|
990
|
+
/**
|
|
991
|
+
* auth-tokens-create-request
|
|
992
|
+
* A request to create a new token corresponding to the requested token
|
|
993
|
+
* type.
|
|
994
|
+
*/
|
|
995
|
+
export interface AuthTokensCreateRequest {
|
|
996
|
+
/** The unique ID of the Dev user to impersonate. */
|
|
997
|
+
act_as?: string;
|
|
998
|
+
/** The expected audience values with respect to the token. */
|
|
999
|
+
aud?: string[];
|
|
1000
|
+
/**
|
|
1001
|
+
* An identifier that represents the application which is requesting
|
|
1002
|
+
* the token. If no client_id is present in the request to generate an
|
|
1003
|
+
* application access token (AAT), DevRev will generate a client_id.
|
|
1004
|
+
* This client_id is only associated with an AAT.
|
|
1005
|
+
*/
|
|
1006
|
+
client_id?: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* The expected validity lifetime of the token in number of days. In
|
|
1009
|
+
* practice, the value should be based on the usage of the token.
|
|
1010
|
+
* @min 0
|
|
1011
|
+
* @max 4294967295
|
|
1012
|
+
*/
|
|
1013
|
+
expires_in?: number;
|
|
1014
|
+
/** Specifies the process of obtaining a token. */
|
|
1015
|
+
grant_type?: AuthTokenGrantType;
|
|
1016
|
+
/** The type of the requested token. */
|
|
1017
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1018
|
+
/**
|
|
1019
|
+
* Carries info corresponding to the Rev user to be provisioned and/or
|
|
1020
|
+
* issue a Rev session token.
|
|
1021
|
+
*/
|
|
1022
|
+
rev_info?: AuthTokensRevInfo;
|
|
1023
|
+
/**
|
|
1024
|
+
* The requested set of scopes associated with the issued token. A
|
|
1025
|
+
* space-delimited list of values in which the order of values does
|
|
1026
|
+
* not matter.
|
|
1027
|
+
*/
|
|
1028
|
+
scope?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Represents the entity that requests the token. Not required when
|
|
1031
|
+
* requesting an application access token (AAT).
|
|
1032
|
+
*/
|
|
1033
|
+
subject_token?: string;
|
|
1034
|
+
/** The type of the subject token. */
|
|
1035
|
+
subject_token_type?: AuthTokenSubjectTokenType;
|
|
1036
|
+
/** A hint that identifies the token. */
|
|
1037
|
+
token_hint?: string;
|
|
1038
|
+
}
|
|
1039
|
+
/**
|
|
1040
|
+
* auth-tokens-create-response
|
|
1041
|
+
* Response for the request to create a new token corresponding to the
|
|
1042
|
+
* requested token type.
|
|
1043
|
+
*/
|
|
1044
|
+
export interface AuthTokensCreateResponse {
|
|
1045
|
+
/**
|
|
1046
|
+
* The issued JSON Web Token (JWT) corresponding to the requested
|
|
1047
|
+
* token type.
|
|
1048
|
+
*/
|
|
1049
|
+
access_token: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* An identifier that represents the application which is requesting
|
|
1052
|
+
* the token. Only present in a response corresponding to an
|
|
1053
|
+
* application access token (AAT).
|
|
1054
|
+
*/
|
|
1055
|
+
client_id?: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* The validity lifetime of the token specified in seconds since Unix
|
|
1058
|
+
* epoch.
|
|
1059
|
+
* @format int64
|
|
1060
|
+
*/
|
|
1061
|
+
expires_in: number;
|
|
1062
|
+
/** A token to refresh the issued token. */
|
|
1063
|
+
refresh_token?: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* The scopes associated with the issued token. A space-delimited list
|
|
1066
|
+
* of values in which the order of values does not matter.
|
|
1067
|
+
*/
|
|
1068
|
+
scope?: string;
|
|
1069
|
+
/** The type of the issued token. Bearer is the only supported token type. */
|
|
1070
|
+
token_type: AuthTokenTokenType;
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* auth-tokens-delete-request
|
|
1074
|
+
* The request to revoke the token.
|
|
1075
|
+
*/
|
|
1076
|
+
export interface AuthTokensDeleteRequest {
|
|
1077
|
+
/**
|
|
1078
|
+
* The unique identifier for the token under a given Dev organization.
|
|
1079
|
+
* If no token ID is provided, then the token ID will be set from the
|
|
1080
|
+
* JTI claim of the token in the authorization header.
|
|
1081
|
+
*/
|
|
1082
|
+
token_id?: string;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* auth-tokens-get-request
|
|
1086
|
+
* The request to get the token metadata.
|
|
1087
|
+
*/
|
|
1088
|
+
export interface AuthTokensGetRequest {
|
|
1089
|
+
/** The unique identifier of the token under a given Dev organization. */
|
|
1090
|
+
token_id: string;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* auth-tokens-get-response
|
|
1094
|
+
* The response to get the token metadata.
|
|
1095
|
+
*/
|
|
1096
|
+
export interface AuthTokensGetResponse {
|
|
1097
|
+
token: AuthToken;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* auth-tokens-list-request
|
|
1101
|
+
* A request to list the token metadata.
|
|
1102
|
+
*/
|
|
1103
|
+
export interface AuthTokensListRequest {
|
|
1104
|
+
/**
|
|
1105
|
+
* An identifier that represents the application, which requested the
|
|
1106
|
+
* token. Only relevant for application access tokens.
|
|
1107
|
+
*/
|
|
1108
|
+
client_id?: string;
|
|
1109
|
+
/** The type of the requested token. */
|
|
1110
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1111
|
+
/**
|
|
1112
|
+
* The subject associated with the token. In the absence of this
|
|
1113
|
+
* parameter, the ID of the authenticated entity is treated as the
|
|
1114
|
+
* subject.
|
|
1115
|
+
*/
|
|
1116
|
+
subject?: string;
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* auth-tokens-list-response
|
|
1120
|
+
* The response to list the token metadata.
|
|
1121
|
+
*/
|
|
1122
|
+
export interface AuthTokensListResponse {
|
|
1123
|
+
/** The list of token metadata. */
|
|
1124
|
+
tokens: AuthToken[];
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* auth-tokens-org-traits
|
|
1128
|
+
* Carries Rev org info.
|
|
1129
|
+
*/
|
|
1130
|
+
export interface AuthTokensOrgTraits {
|
|
1131
|
+
/** Application-defined custom fields of the Rev org. */
|
|
1132
|
+
custom_fields?: object;
|
|
1133
|
+
/** The description of the Rev org. */
|
|
1134
|
+
description?: string;
|
|
1135
|
+
/** The display name of the Rev org. */
|
|
1136
|
+
display_name?: string;
|
|
1137
|
+
/** The domain of the Rev org. */
|
|
1138
|
+
domain?: string;
|
|
1139
|
+
/** Phone numbers of the Rev org. */
|
|
1140
|
+
phone_numbers?: string[];
|
|
1141
|
+
/** The tier of the Rev org. */
|
|
1142
|
+
tier?: string;
|
|
1143
|
+
}
|
|
1144
|
+
/**
|
|
1145
|
+
* auth-tokens-rev-info
|
|
1146
|
+
* Carries info corresponding to the Rev user to be provisioned and/or
|
|
1147
|
+
* issue a Rev session token.
|
|
1148
|
+
*/
|
|
1149
|
+
export interface AuthTokensRevInfo {
|
|
1150
|
+
/** An identifier which uniquely identifies a Rev org. */
|
|
1151
|
+
org_ref?: string;
|
|
1152
|
+
/** Carries Rev org info. */
|
|
1153
|
+
org_traits?: AuthTokensOrgTraits;
|
|
1154
|
+
/** The unique ID of the Rev user. */
|
|
1155
|
+
user_id?: string;
|
|
1156
|
+
/** An identifier which uniquely identifies a Rev user. */
|
|
1157
|
+
user_ref?: string;
|
|
1158
|
+
/** Carries Rev user info. */
|
|
1159
|
+
user_traits?: AuthTokensUserTraits;
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* auth-tokens-self-delete-request
|
|
1163
|
+
* The request to delete all the tokens created by the authenticated user,
|
|
1164
|
+
* that match with the provided token type.
|
|
1165
|
+
*/
|
|
1166
|
+
export interface AuthTokensSelfDeleteRequest {
|
|
1167
|
+
/** The type of the requested token. */
|
|
1168
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* auth-tokens-update-request
|
|
1172
|
+
* A request to update the token metadata.
|
|
1173
|
+
*/
|
|
1174
|
+
export interface AuthTokensUpdateRequest {
|
|
1175
|
+
/** A hint that identifies the token. */
|
|
1176
|
+
token_hint: string;
|
|
1177
|
+
/** The unique identifier of the token under a given Dev organization. */
|
|
1178
|
+
token_id: string;
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* auth-tokens-update-response
|
|
1182
|
+
* Response for the request to update the token metadata.
|
|
1183
|
+
*/
|
|
1184
|
+
export interface AuthTokensUpdateResponse {
|
|
1185
|
+
token: AuthToken;
|
|
1186
|
+
}
|
|
1187
|
+
/**
|
|
1188
|
+
* auth-tokens-user-traits
|
|
1189
|
+
* Carries Rev user info.
|
|
1190
|
+
*/
|
|
1191
|
+
export interface AuthTokensUserTraits {
|
|
1192
|
+
/** Application-defined custom fields of the Rev user. */
|
|
1193
|
+
custom_fields?: object;
|
|
1194
|
+
/** The description of the Rev user. */
|
|
1195
|
+
description?: string;
|
|
1196
|
+
/** The display name of the Rev user. */
|
|
1197
|
+
display_name?: string;
|
|
1198
|
+
/** The email address of the Rev user. */
|
|
1199
|
+
email?: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* The full name of the Rev user.
|
|
1202
|
+
* @deprecated
|
|
1203
|
+
*/
|
|
1204
|
+
full_name?: string;
|
|
1205
|
+
/** Phone numbers of the Rev user. */
|
|
1206
|
+
phone_numbers?: string[];
|
|
1207
|
+
}
|
|
743
1208
|
/** capability */
|
|
744
1209
|
export type Capability = PartBase;
|
|
745
1210
|
/** capability-summary */
|
|
@@ -752,12 +1217,16 @@ export type CodeChange = AtomBase & {
|
|
|
752
1217
|
description?: string;
|
|
753
1218
|
/** Unique external identifier for this change.e.g Pull Request URL. */
|
|
754
1219
|
external_identifier?: string;
|
|
1220
|
+
/** Details of lines of code in this code change. */
|
|
1221
|
+
filtered_loc?: LinesOfCode;
|
|
755
1222
|
/** URL pointing to the repo this change was on. */
|
|
756
1223
|
repo_url?: string;
|
|
757
1224
|
/** Source of the code change object. */
|
|
758
1225
|
source?: CodeChangeSource;
|
|
759
1226
|
/** Title describing in brief the contents of this change. */
|
|
760
1227
|
title?: string;
|
|
1228
|
+
/** Details of lines of code in this code change. */
|
|
1229
|
+
total_loc?: LinesOfCode;
|
|
761
1230
|
};
|
|
762
1231
|
/** Source of the code change object. */
|
|
763
1232
|
export declare enum CodeChangeSource {
|
|
@@ -1192,12 +1661,35 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
|
|
|
1192
1661
|
type: CustomSchemaFragmentType;
|
|
1193
1662
|
};
|
|
1194
1663
|
/** custom-schema-fragment-base */
|
|
1195
|
-
export type CustomSchemaFragmentBase = AtomBase
|
|
1664
|
+
export type CustomSchemaFragmentBase = AtomBase & {
|
|
1665
|
+
/** The conditions associated with the fields. */
|
|
1666
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
1667
|
+
/**
|
|
1668
|
+
* Indicates if the fragment has been deprecated. Modifications to
|
|
1669
|
+
* this field are done in-place and don't result in creation of a new
|
|
1670
|
+
* fragment in chain.
|
|
1671
|
+
*/
|
|
1672
|
+
deprecated?: boolean;
|
|
1673
|
+
/** Description of the custom schema fragment. */
|
|
1674
|
+
description?: string;
|
|
1675
|
+
/** List of all fields in this custom schema fragment. */
|
|
1676
|
+
fields?: SchemaFieldDescriptor[];
|
|
1677
|
+
/** Type of the custom schema fragment. */
|
|
1678
|
+
fragment_type?: CustomSchemaFragmentFragmentType;
|
|
1679
|
+
/** Leaf type this fragment applies to. */
|
|
1680
|
+
leaf_type?: string;
|
|
1681
|
+
};
|
|
1196
1682
|
/**
|
|
1197
1683
|
* custom-schema-fragment-condition
|
|
1198
1684
|
* The condition associated with a field.
|
|
1199
1685
|
*/
|
|
1200
1686
|
export type CustomSchemaFragmentCondition = object;
|
|
1687
|
+
/** Type of the custom schema fragment. */
|
|
1688
|
+
export declare enum CustomSchemaFragmentFragmentType {
|
|
1689
|
+
App = "app",
|
|
1690
|
+
CustomType = "custom_type",
|
|
1691
|
+
Tenant = "tenant"
|
|
1692
|
+
}
|
|
1201
1693
|
export declare enum CustomSchemaFragmentType {
|
|
1202
1694
|
AppFragment = "app_fragment",
|
|
1203
1695
|
CustomTypeFragment = "custom_type_fragment",
|
|
@@ -1277,15 +1769,16 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
|
1277
1769
|
path?: CustomTypePathComponent[];
|
|
1278
1770
|
/** The ID of the associated custom stage diagram. */
|
|
1279
1771
|
stage_diagram?: string;
|
|
1280
|
-
/** List of stock field enum overrides. */
|
|
1281
|
-
stock_field_uenum_overrides?: StockFieldUenumOverride[];
|
|
1282
1772
|
/** The string used to populate the subtype in the leaf type. */
|
|
1283
1773
|
subtype: string;
|
|
1284
1774
|
/** The display name of the subtype. */
|
|
1285
1775
|
subtype_display_name?: string;
|
|
1286
1776
|
}
|
|
1287
1777
|
/** custom-schema-fragments-set-request-tenant-fragment */
|
|
1288
|
-
export
|
|
1778
|
+
export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
1779
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
1780
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
1781
|
+
}
|
|
1289
1782
|
export declare enum CustomSchemaFragmentsSetRequestType {
|
|
1290
1783
|
AppFragment = "app_fragment",
|
|
1291
1784
|
CustomTypeFragment = "custom_type_fragment",
|
|
@@ -1297,7 +1790,16 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
1297
1790
|
id: string;
|
|
1298
1791
|
}
|
|
1299
1792
|
/** custom-type-fragment */
|
|
1300
|
-
export type CustomTypeFragment = CustomSchemaFragmentBase
|
|
1793
|
+
export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
1794
|
+
stage_diagram?: StageDiagramSummary;
|
|
1795
|
+
/** The string used to populate the subtype in the leaf type. */
|
|
1796
|
+
subtype?: string;
|
|
1797
|
+
/**
|
|
1798
|
+
* Display name of the subtype. Modifications to this field are done
|
|
1799
|
+
* in-place and don't result in creation of a new fragment in chain.
|
|
1800
|
+
*/
|
|
1801
|
+
subtype_display_name?: string;
|
|
1802
|
+
};
|
|
1301
1803
|
/**
|
|
1302
1804
|
* custom-type-path-component
|
|
1303
1805
|
* Path component for rendering custom type lists in tree form.
|
|
@@ -1366,8 +1868,243 @@ export declare enum DateTimePresetType {
|
|
|
1366
1868
|
LastNDays = "last_n_days",
|
|
1367
1869
|
NextNDays = "next_n_days"
|
|
1368
1870
|
}
|
|
1871
|
+
/**
|
|
1872
|
+
* dev-org-auth-connections-create-request
|
|
1873
|
+
* Request to create a new enterprise authentication connection.
|
|
1874
|
+
*/
|
|
1875
|
+
export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
|
|
1876
|
+
/**
|
|
1877
|
+
* Display name of the authentication connection. This name will be
|
|
1878
|
+
* visible to all the users when they sign in to this Dev
|
|
1879
|
+
* organization. For example, if the display_name is 'abclogin', then
|
|
1880
|
+
* it would appear on the login button as 'Log in to abclogin'.
|
|
1881
|
+
*/
|
|
1882
|
+
display_name?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* Defines the type for the authentication connection. Different types of
|
|
1885
|
+
* authentication connections have different configuration parameters.
|
|
1886
|
+
*/
|
|
1887
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
1888
|
+
};
|
|
1889
|
+
/**
|
|
1890
|
+
* Defines the type for the authentication connection. Different types of
|
|
1891
|
+
* authentication connections have different configuration parameters.
|
|
1892
|
+
*/
|
|
1893
|
+
export declare enum DevOrgAuthConnectionsCreateRequestType {
|
|
1894
|
+
GoogleApps = "google_apps",
|
|
1895
|
+
Oidc = "oidc",
|
|
1896
|
+
Samlp = "samlp",
|
|
1897
|
+
Waad = "waad"
|
|
1898
|
+
}
|
|
1899
|
+
/**
|
|
1900
|
+
* dev-org-auth-connections-create-response
|
|
1901
|
+
* Response for the request to create a new enterprise authentication
|
|
1902
|
+
* connection.
|
|
1903
|
+
*/
|
|
1904
|
+
export interface DevOrgAuthConnectionsCreateResponse {
|
|
1905
|
+
/**
|
|
1906
|
+
* Connection object that specifies the configuration for an
|
|
1907
|
+
* authentication connection that is set up for a Dev organization.
|
|
1908
|
+
*/
|
|
1909
|
+
auth_connection: AuthConnection;
|
|
1910
|
+
}
|
|
1911
|
+
/**
|
|
1912
|
+
* dev-org-auth-connections-delete-request
|
|
1913
|
+
* Request to delete an enterprise authentication connection for a Dev
|
|
1914
|
+
* organization. A default connection and a connection which is currently
|
|
1915
|
+
* enabled cannot be deleted.
|
|
1916
|
+
*/
|
|
1917
|
+
export interface DevOrgAuthConnectionsDeleteRequest {
|
|
1918
|
+
/** ID of the authentication connection to be deleted. */
|
|
1919
|
+
id: string;
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
* dev-org-auth-connections-get-request
|
|
1923
|
+
* Request to get configuration details of organization's authentication
|
|
1924
|
+
* Connection.
|
|
1925
|
+
*/
|
|
1926
|
+
export interface DevOrgAuthConnectionsGetRequest {
|
|
1927
|
+
/** ID of the authentication connection. */
|
|
1928
|
+
id: string;
|
|
1929
|
+
}
|
|
1930
|
+
/**
|
|
1931
|
+
* dev-org-auth-connections-get-response
|
|
1932
|
+
* Response object encapsulating the configuration details of an
|
|
1933
|
+
* authentication connection.
|
|
1934
|
+
*/
|
|
1935
|
+
export interface DevOrgAuthConnectionsGetResponse {
|
|
1936
|
+
/**
|
|
1937
|
+
* Connection object that specifies the configuration for an
|
|
1938
|
+
* authentication connection that is set up for a Dev organization.
|
|
1939
|
+
*/
|
|
1940
|
+
auth_connection: AuthConnection;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* dev-org-auth-connections-list-response
|
|
1944
|
+
* Response object for the request to list all the social and enterprise
|
|
1945
|
+
* authentication connections configured for a Dev organization.
|
|
1946
|
+
*/
|
|
1947
|
+
export interface DevOrgAuthConnectionsListResponse {
|
|
1948
|
+
/**
|
|
1949
|
+
* List of all the authentication connections currently configured for
|
|
1950
|
+
* a Dev organization.
|
|
1951
|
+
*/
|
|
1952
|
+
auth_connections: AuthConnection[];
|
|
1953
|
+
}
|
|
1954
|
+
/**
|
|
1955
|
+
* dev-org-auth-connections-toggle-request
|
|
1956
|
+
* Request to enable or disable an authentication connection for a Dev
|
|
1957
|
+
* organization.
|
|
1958
|
+
*/
|
|
1959
|
+
export interface DevOrgAuthConnectionsToggleRequest {
|
|
1960
|
+
/** ID of the authentication connection to be toggled. */
|
|
1961
|
+
id: string;
|
|
1962
|
+
toggle?: AuthConnectionToggle;
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* dev-org-auth-connections-update-request
|
|
1966
|
+
* Request to update an enterprise authentication connection for a Dev
|
|
1967
|
+
* organization.
|
|
1968
|
+
*/
|
|
1969
|
+
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
|
|
1970
|
+
/**
|
|
1971
|
+
* New display name of the authentication connection. This name will
|
|
1972
|
+
* be visible to all the users when they sign in to this Dev
|
|
1973
|
+
* organization. For example, if the display_name is 'abclogin', then
|
|
1974
|
+
* it would appear on the login button as 'Log in to abclogin'.
|
|
1975
|
+
*/
|
|
1976
|
+
display_name?: string;
|
|
1977
|
+
/** ID of the authentication connection which is to be updated. */
|
|
1978
|
+
id: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* Specifies the type for the authentication connection. Different types
|
|
1981
|
+
* of authentication connections have different configuration parameters
|
|
1982
|
+
* that can be updated.
|
|
1983
|
+
*/
|
|
1984
|
+
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
1985
|
+
};
|
|
1986
|
+
/**
|
|
1987
|
+
* Specifies the type for the authentication connection. Different types
|
|
1988
|
+
* of authentication connections have different configuration parameters
|
|
1989
|
+
* that can be updated.
|
|
1990
|
+
*/
|
|
1991
|
+
export declare enum DevOrgAuthConnectionsUpdateRequestType {
|
|
1992
|
+
GoogleApps = "google_apps",
|
|
1993
|
+
None = "none",
|
|
1994
|
+
Oidc = "oidc",
|
|
1995
|
+
Samlp = "samlp",
|
|
1996
|
+
Waad = "waad"
|
|
1997
|
+
}
|
|
1998
|
+
/**
|
|
1999
|
+
* dev-org-auth-connections-update-response
|
|
2000
|
+
* Response for the request to update an enterprise authentication
|
|
2001
|
+
* connection.
|
|
2002
|
+
*/
|
|
2003
|
+
export interface DevOrgAuthConnectionsUpdateResponse {
|
|
2004
|
+
/**
|
|
2005
|
+
* Connection object that specifies the configuration for an
|
|
2006
|
+
* authentication connection that is set up for a Dev organization.
|
|
2007
|
+
*/
|
|
2008
|
+
auth_connection: AuthConnection;
|
|
2009
|
+
}
|
|
2010
|
+
/** dev-user */
|
|
2011
|
+
export type DevUser = UserBase & {
|
|
2012
|
+
/** IDs of the Dev User outside the DevRev SOR. */
|
|
2013
|
+
external_identities?: ExternalIdentity[];
|
|
2014
|
+
};
|
|
2015
|
+
/** dev-user-external-identity-filter */
|
|
2016
|
+
export interface DevUserExternalIdentityFilter {
|
|
2017
|
+
/** Unique ID of the user in the external source. */
|
|
2018
|
+
id?: string;
|
|
2019
|
+
/** Issuer of the external identity of the user. */
|
|
2020
|
+
issuer?: string;
|
|
2021
|
+
}
|
|
1369
2022
|
/** dev-user-summary */
|
|
1370
2023
|
export type DevUserSummary = UserBaseSummary;
|
|
2024
|
+
/**
|
|
2025
|
+
* dev-users-get-request
|
|
2026
|
+
* A request to get a Dev user's information.
|
|
2027
|
+
*/
|
|
2028
|
+
export interface DevUsersGetRequest {
|
|
2029
|
+
/** User ID of the requested Dev user. */
|
|
2030
|
+
id: string;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* dev-users-get-response
|
|
2034
|
+
* The response to getting the information for the Dev user.
|
|
2035
|
+
*/
|
|
2036
|
+
export interface DevUsersGetResponse {
|
|
2037
|
+
dev_user: DevUser;
|
|
2038
|
+
}
|
|
2039
|
+
/**
|
|
2040
|
+
* dev-users-list-request
|
|
2041
|
+
* A request to get the list of Dev user's information.
|
|
2042
|
+
*/
|
|
2043
|
+
export interface DevUsersListRequest {
|
|
2044
|
+
/**
|
|
2045
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2046
|
+
* iteration starts from the beginning.
|
|
2047
|
+
*/
|
|
2048
|
+
cursor?: string;
|
|
2049
|
+
/** Filters Dev users based on email addresses. */
|
|
2050
|
+
email?: string[];
|
|
2051
|
+
/** Filters Dev users based on external identity. */
|
|
2052
|
+
external_identity?: DevUserExternalIdentityFilter[];
|
|
2053
|
+
/**
|
|
2054
|
+
* The maximum number of Dev users to return. The default is '50'.
|
|
2055
|
+
* @format int32
|
|
2056
|
+
*/
|
|
2057
|
+
limit?: number;
|
|
2058
|
+
/**
|
|
2059
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2060
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2061
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2062
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2063
|
+
* always be returned in the specified sort-by order.
|
|
2064
|
+
*/
|
|
2065
|
+
mode?: ListMode;
|
|
2066
|
+
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
2067
|
+
sort_by?: string[];
|
|
2068
|
+
/** Filters Dev users based on state. */
|
|
2069
|
+
state?: UserState[];
|
|
2070
|
+
}
|
|
2071
|
+
/**
|
|
2072
|
+
* dev-users-list-response
|
|
2073
|
+
* The response to listing the Dev users.
|
|
2074
|
+
*/
|
|
2075
|
+
export interface DevUsersListResponse {
|
|
2076
|
+
/** The list of Dev users. */
|
|
2077
|
+
dev_users: DevUser[];
|
|
2078
|
+
/**
|
|
2079
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2080
|
+
* sort order. If not set, then no later elements exist.
|
|
2081
|
+
*/
|
|
2082
|
+
next_cursor?: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2085
|
+
* sort order. If not set, then no prior elements exist.
|
|
2086
|
+
*/
|
|
2087
|
+
prev_cursor?: string;
|
|
2088
|
+
}
|
|
2089
|
+
/**
|
|
2090
|
+
* dev-users-self-request
|
|
2091
|
+
* A request to get the authenticated user's information.
|
|
2092
|
+
*/
|
|
2093
|
+
export type DevUsersSelfRequest = object;
|
|
2094
|
+
/**
|
|
2095
|
+
* dev-users-self-response
|
|
2096
|
+
* The response to getting the information for the authenticated user.
|
|
2097
|
+
*/
|
|
2098
|
+
export interface DevUsersSelfResponse {
|
|
2099
|
+
dev_user: DevUser;
|
|
2100
|
+
}
|
|
2101
|
+
/** directory-summary */
|
|
2102
|
+
export type DirectorySummary = AtomBaseSummary;
|
|
2103
|
+
/**
|
|
2104
|
+
* dynamic-group-info
|
|
2105
|
+
* Information to define dynamic groups.
|
|
2106
|
+
*/
|
|
2107
|
+
export type DynamicGroupInfo = object;
|
|
1371
2108
|
/** empty */
|
|
1372
2109
|
export type Empty = object;
|
|
1373
2110
|
/** engagement */
|
|
@@ -1718,6 +2455,22 @@ export declare enum ErrorUnauthorizedType {
|
|
|
1718
2455
|
}
|
|
1719
2456
|
/** error-unauthorized-unauthenticated */
|
|
1720
2457
|
export type ErrorUnauthorizedUnauthenticated = object;
|
|
2458
|
+
/** event-account-created */
|
|
2459
|
+
export interface EventAccountCreated {
|
|
2460
|
+
account: Account;
|
|
2461
|
+
}
|
|
2462
|
+
/** event-account-deleted */
|
|
2463
|
+
export interface EventAccountDeleted {
|
|
2464
|
+
/**
|
|
2465
|
+
* The ID of the account that was deleted.
|
|
2466
|
+
* @example "ACC-12345"
|
|
2467
|
+
*/
|
|
2468
|
+
id: string;
|
|
2469
|
+
}
|
|
2470
|
+
/** event-account-updated */
|
|
2471
|
+
export interface EventAccountUpdated {
|
|
2472
|
+
account: Account;
|
|
2473
|
+
}
|
|
1721
2474
|
/** event-conversation-created */
|
|
1722
2475
|
export interface EventConversationCreated {
|
|
1723
2476
|
conversation: Conversation;
|
|
@@ -1731,6 +2484,19 @@ export interface EventConversationDeleted {
|
|
|
1731
2484
|
export interface EventConversationUpdated {
|
|
1732
2485
|
conversation: Conversation;
|
|
1733
2486
|
}
|
|
2487
|
+
/** event-dev-user-created */
|
|
2488
|
+
export interface EventDevUserCreated {
|
|
2489
|
+
dev_user: DevUser;
|
|
2490
|
+
}
|
|
2491
|
+
/** event-dev-user-deleted */
|
|
2492
|
+
export interface EventDevUserDeleted {
|
|
2493
|
+
/** The ID of the Dev user that was deleted. */
|
|
2494
|
+
id: string;
|
|
2495
|
+
}
|
|
2496
|
+
/** event-dev-user-updated */
|
|
2497
|
+
export interface EventDevUserUpdated {
|
|
2498
|
+
dev_user: DevUser;
|
|
2499
|
+
}
|
|
1734
2500
|
/** event-part-created */
|
|
1735
2501
|
export interface EventPartCreated {
|
|
1736
2502
|
part: Part;
|
|
@@ -1948,6 +2714,11 @@ export interface EventWorkDeleted {
|
|
|
1948
2714
|
export interface EventWorkUpdated {
|
|
1949
2715
|
work: Work;
|
|
1950
2716
|
}
|
|
2717
|
+
/**
|
|
2718
|
+
* external-identity
|
|
2719
|
+
* External identity of a user.
|
|
2720
|
+
*/
|
|
2721
|
+
export type ExternalIdentity = object;
|
|
1951
2722
|
/** feature */
|
|
1952
2723
|
export type Feature = PartBase;
|
|
1953
2724
|
/** feature-summary */
|
|
@@ -1974,11 +2745,98 @@ export declare enum GroupMemberType {
|
|
|
1974
2745
|
DevUser = "dev_user",
|
|
1975
2746
|
RevUser = "rev_user"
|
|
1976
2747
|
}
|
|
2748
|
+
/**
|
|
2749
|
+
* group-members-add-request
|
|
2750
|
+
* A request to add a new member to a group.
|
|
2751
|
+
*/
|
|
2752
|
+
export interface GroupMembersAddRequest {
|
|
2753
|
+
/** ID of the group where the member is being added. */
|
|
2754
|
+
group: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* ID of the member to be added.
|
|
2757
|
+
* @example "DEVU-12345"
|
|
2758
|
+
*/
|
|
2759
|
+
member: string;
|
|
2760
|
+
}
|
|
2761
|
+
/** group-members-add-response */
|
|
2762
|
+
export type GroupMembersAddResponse = object;
|
|
2763
|
+
/**
|
|
2764
|
+
* group-members-list-request
|
|
2765
|
+
* A request to list group members.
|
|
2766
|
+
*/
|
|
2767
|
+
export interface GroupMembersListRequest {
|
|
2768
|
+
/**
|
|
2769
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2770
|
+
* iteration starts from the beginning.
|
|
2771
|
+
*/
|
|
2772
|
+
cursor?: string;
|
|
2773
|
+
/** ID of the group for which to list members. */
|
|
2774
|
+
group: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* The maximum number of members to return. If not set, then the
|
|
2777
|
+
* default is '50'.
|
|
2778
|
+
* @format int32
|
|
2779
|
+
*/
|
|
2780
|
+
limit?: number;
|
|
2781
|
+
/**
|
|
2782
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2783
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2784
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2785
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2786
|
+
* always be returned in the specified sort-by order.
|
|
2787
|
+
*/
|
|
2788
|
+
mode?: ListMode;
|
|
2789
|
+
}
|
|
2790
|
+
/**
|
|
2791
|
+
* group-members-list-response
|
|
2792
|
+
* List of group members.
|
|
2793
|
+
*/
|
|
2794
|
+
export interface GroupMembersListResponse {
|
|
2795
|
+
/** List of members. */
|
|
2796
|
+
members: GroupMembersListResponseMember[];
|
|
2797
|
+
/**
|
|
2798
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2799
|
+
* sort order. If not set, then no later elements exist.
|
|
2800
|
+
*/
|
|
2801
|
+
next_cursor?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2804
|
+
* sort order. If not set, then no prior elements exist.
|
|
2805
|
+
*/
|
|
2806
|
+
prev_cursor?: string;
|
|
2807
|
+
}
|
|
2808
|
+
/**
|
|
2809
|
+
* group-members-list-response-member
|
|
2810
|
+
* A group member.
|
|
2811
|
+
*/
|
|
2812
|
+
export interface GroupMembersListResponseMember {
|
|
2813
|
+
member: MemberSummary;
|
|
2814
|
+
}
|
|
2815
|
+
/**
|
|
2816
|
+
* group-members-remove-request
|
|
2817
|
+
* A request to remove a group member.
|
|
2818
|
+
*/
|
|
2819
|
+
export interface GroupMembersRemoveRequest {
|
|
2820
|
+
/** ID of the group where the member is being removed. */
|
|
2821
|
+
group: string;
|
|
2822
|
+
/**
|
|
2823
|
+
* ID of the member to be removed.
|
|
2824
|
+
* @example "DEVU-12345"
|
|
2825
|
+
*/
|
|
2826
|
+
member: string;
|
|
2827
|
+
}
|
|
2828
|
+
/** group-members-remove-response */
|
|
2829
|
+
export type GroupMembersRemoveResponse = object;
|
|
1977
2830
|
/** group-summary */
|
|
1978
2831
|
export type GroupSummary = AtomBaseSummary & {
|
|
1979
2832
|
/** Name of the group. */
|
|
1980
2833
|
name?: string;
|
|
1981
2834
|
};
|
|
2835
|
+
/** Type of the group. */
|
|
2836
|
+
export declare enum GroupType {
|
|
2837
|
+
Dynamic = "dynamic",
|
|
2838
|
+
Static = "static"
|
|
2839
|
+
}
|
|
1982
2840
|
/**
|
|
1983
2841
|
* groups-create-request
|
|
1984
2842
|
* A request to create a new group.
|
|
@@ -1986,12 +2844,16 @@ export type GroupSummary = AtomBaseSummary & {
|
|
|
1986
2844
|
export interface GroupsCreateRequest {
|
|
1987
2845
|
/** Description of the group. */
|
|
1988
2846
|
description: string;
|
|
2847
|
+
/** Information to define dynamic groups. */
|
|
2848
|
+
dynamic_group_info?: DynamicGroupInfo;
|
|
1989
2849
|
/** Type of the members in the group. */
|
|
1990
2850
|
member_type?: GroupMemberType;
|
|
1991
2851
|
/** Unique name of the group. */
|
|
1992
2852
|
name: string;
|
|
1993
2853
|
/** Owner of the group. */
|
|
1994
2854
|
owner?: string;
|
|
2855
|
+
/** Type of the group. */
|
|
2856
|
+
type?: GroupType;
|
|
1995
2857
|
}
|
|
1996
2858
|
/**
|
|
1997
2859
|
* groups-create-response
|
|
@@ -2109,6 +2971,32 @@ export interface LegacyStage {
|
|
|
2109
2971
|
/** Current stage name of the work item. */
|
|
2110
2972
|
name: string;
|
|
2111
2973
|
}
|
|
2974
|
+
/**
|
|
2975
|
+
* lines-of-code
|
|
2976
|
+
* Details of lines of code in this code change.
|
|
2977
|
+
*/
|
|
2978
|
+
export interface LinesOfCode {
|
|
2979
|
+
/**
|
|
2980
|
+
* Count of files involved in this code change.
|
|
2981
|
+
* @format int64
|
|
2982
|
+
*/
|
|
2983
|
+
file_count?: number;
|
|
2984
|
+
/**
|
|
2985
|
+
* Number of new lines added in this code change.
|
|
2986
|
+
* @format int64
|
|
2987
|
+
*/
|
|
2988
|
+
lines_added?: number;
|
|
2989
|
+
/**
|
|
2990
|
+
* Number of lines deleted in this code change.
|
|
2991
|
+
* @format int64
|
|
2992
|
+
*/
|
|
2993
|
+
lines_deleted?: number;
|
|
2994
|
+
/**
|
|
2995
|
+
* Number of lines modified in this code change.
|
|
2996
|
+
* @format int64
|
|
2997
|
+
*/
|
|
2998
|
+
lines_modified?: number;
|
|
2999
|
+
}
|
|
2112
3000
|
/** link */
|
|
2113
3001
|
export type Link = AtomBase & {
|
|
2114
3002
|
/** Type of link used to define the relationship. */
|
|
@@ -2291,11 +3179,20 @@ export declare enum ListMode {
|
|
|
2291
3179
|
After = "after",
|
|
2292
3180
|
Before = "before"
|
|
2293
3181
|
}
|
|
3182
|
+
/** member-summary */
|
|
3183
|
+
export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
3184
|
+
type: MemberType;
|
|
3185
|
+
};
|
|
3186
|
+
export declare enum MemberType {
|
|
3187
|
+
DevUser = "dev_user",
|
|
3188
|
+
RevUser = "rev_user",
|
|
3189
|
+
SysUser = "sys_user"
|
|
3190
|
+
}
|
|
2294
3191
|
/** metric-data-point */
|
|
2295
3192
|
export interface MetricDataPoint {
|
|
2296
3193
|
/**
|
|
2297
3194
|
* Key-value pairs for specifying additional attributes.
|
|
2298
|
-
* @maxItems
|
|
3195
|
+
* @maxItems 12
|
|
2299
3196
|
*/
|
|
2300
3197
|
dimensions?: MetricDataPointDimension[];
|
|
2301
3198
|
/**
|
|
@@ -3152,6 +4049,22 @@ export interface RevOrgsCreateRequest {
|
|
|
3152
4049
|
export interface RevOrgsCreateResponse {
|
|
3153
4050
|
rev_org: RevOrg;
|
|
3154
4051
|
}
|
|
4052
|
+
/**
|
|
4053
|
+
* rev-orgs-delete-request
|
|
4054
|
+
* Request object to delete a Rev organization.
|
|
4055
|
+
*/
|
|
4056
|
+
export interface RevOrgsDeleteRequest {
|
|
4057
|
+
/**
|
|
4058
|
+
* The ID of Rev organization to delete.
|
|
4059
|
+
* @example "REV-AbCdEfGh"
|
|
4060
|
+
*/
|
|
4061
|
+
id: string;
|
|
4062
|
+
}
|
|
4063
|
+
/**
|
|
4064
|
+
* rev-orgs-delete-response
|
|
4065
|
+
* The response to deleting a Rev organization.
|
|
4066
|
+
*/
|
|
4067
|
+
export type RevOrgsDeleteResponse = object;
|
|
3155
4068
|
/**
|
|
3156
4069
|
* rev-orgs-get-request
|
|
3157
4070
|
* Request object to get Rev organization's information.
|
|
@@ -3374,7 +4287,7 @@ export interface RevUsersCreateRequest {
|
|
|
3374
4287
|
* system-generated identifier will be assigned to the user.
|
|
3375
4288
|
*/
|
|
3376
4289
|
external_ref?: string;
|
|
3377
|
-
/** Phone numbers of the Rev user. */
|
|
4290
|
+
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
3378
4291
|
phone_numbers?: string[];
|
|
3379
4292
|
/**
|
|
3380
4293
|
* The ID of Rev organization for which a Rev user is to be created.
|
|
@@ -3455,7 +4368,7 @@ export interface RevUsersListRequest {
|
|
|
3455
4368
|
*/
|
|
3456
4369
|
mode?: ListMode;
|
|
3457
4370
|
modified_date?: DateTimeFilter;
|
|
3458
|
-
/** List of phone numbers to filter Rev users on. */
|
|
4371
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
3459
4372
|
phone_numbers?: string[];
|
|
3460
4373
|
/**
|
|
3461
4374
|
* List of IDs of Rev organizations to be filtered.
|
|
@@ -3504,6 +4417,8 @@ export interface RevUsersUpdateRequest {
|
|
|
3504
4417
|
external_ref?: string;
|
|
3505
4418
|
/** The ID of Rev user to update. */
|
|
3506
4419
|
id: string;
|
|
4420
|
+
/** The phone numbers, in E.164 format, of the Rev user. */
|
|
4421
|
+
phone_numbers?: string[];
|
|
3507
4422
|
/** Tags associated with the Rev user. */
|
|
3508
4423
|
tags?: SetTagWithValue[];
|
|
3509
4424
|
}
|
|
@@ -3665,14 +4580,16 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
3665
4580
|
* The schema of MFZ specific fields.
|
|
3666
4581
|
*/
|
|
3667
4582
|
export type SchemaFieldMfzMetadata = object;
|
|
4583
|
+
/**
|
|
4584
|
+
* schema-field-uenum-value
|
|
4585
|
+
* A unified enum value.
|
|
4586
|
+
*/
|
|
4587
|
+
export type SchemaFieldUenumValue = object;
|
|
3668
4588
|
/**
|
|
3669
4589
|
* schema-field-ui-metadata
|
|
3670
4590
|
* The schema of ui specific fields.
|
|
3671
4591
|
*/
|
|
3672
|
-
export
|
|
3673
|
-
/** Display name of the field. */
|
|
3674
|
-
display_name?: string;
|
|
3675
|
-
}
|
|
4592
|
+
export type SchemaFieldUiMetadata = object;
|
|
3676
4593
|
/** schema-id-field-descriptor */
|
|
3677
4594
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3678
4595
|
/** Default value. */
|
|
@@ -3921,7 +4838,7 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3921
4838
|
/** schema-uenum-field-descriptor */
|
|
3922
4839
|
export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3923
4840
|
/** Allowed values for the field. */
|
|
3924
|
-
allowed_values:
|
|
4841
|
+
allowed_values: SchemaFieldUenumValue[];
|
|
3925
4842
|
/**
|
|
3926
4843
|
* Default value.
|
|
3927
4844
|
* @format int64
|
|
@@ -3931,7 +4848,7 @@ export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3931
4848
|
/** schema-uenum-list-field-descriptor */
|
|
3932
4849
|
export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3933
4850
|
/** Allowed values for the field. */
|
|
3934
|
-
allowed_values:
|
|
4851
|
+
allowed_values: SchemaFieldUenumValue[];
|
|
3935
4852
|
/** Default value. */
|
|
3936
4853
|
default_value?: number[];
|
|
3937
4854
|
};
|
|
@@ -3992,6 +4909,8 @@ export interface SetSlaSelector {
|
|
|
3992
4909
|
severity?: SlaSelectorSeverity[];
|
|
3993
4910
|
/** The SLA policy applies to conversations with these sources. */
|
|
3994
4911
|
source_channel?: string[];
|
|
4912
|
+
/** The SLA policy applies to tickets with these subtypes. */
|
|
4913
|
+
subtype?: string[];
|
|
3995
4914
|
/**
|
|
3996
4915
|
* The SLA policy applies to items with these tags.
|
|
3997
4916
|
* @example ["TAG-12345"]
|
|
@@ -4051,6 +4970,11 @@ export interface SetWeeklyOrgSchedule {
|
|
|
4051
4970
|
*/
|
|
4052
4971
|
period_name: string;
|
|
4053
4972
|
}
|
|
4973
|
+
/**
|
|
4974
|
+
* shared-with-membership
|
|
4975
|
+
* Information about the role the member receives due to the share.
|
|
4976
|
+
*/
|
|
4977
|
+
export type SharedWithMembership = object;
|
|
4054
4978
|
/** sla */
|
|
4055
4979
|
export type Sla = AtomBase & {
|
|
4056
4980
|
/**
|
|
@@ -4187,6 +5111,7 @@ export interface SlasAssignResponse {
|
|
|
4187
5111
|
}
|
|
4188
5112
|
/** slas-create-request */
|
|
4189
5113
|
export interface SlasCreateRequest {
|
|
5114
|
+
account_selector?: AccountsFilters;
|
|
4190
5115
|
/** Description of the purpose and capabilities of the SLA. */
|
|
4191
5116
|
description?: string;
|
|
4192
5117
|
/**
|
|
@@ -4274,6 +5199,7 @@ export interface SlasTransitionResponse {
|
|
|
4274
5199
|
}
|
|
4275
5200
|
/** slas-update-request */
|
|
4276
5201
|
export interface SlasUpdateRequest {
|
|
5202
|
+
account_selector?: AccountsFilters;
|
|
4277
5203
|
/** Description of the purpose and capabilities of the SLA. */
|
|
4278
5204
|
description?: string;
|
|
4279
5205
|
/**
|
|
@@ -4296,10 +5222,51 @@ export interface SlasUpdateRequest {
|
|
|
4296
5222
|
*/
|
|
4297
5223
|
policies?: SetSlaPolicy[];
|
|
4298
5224
|
}
|
|
4299
|
-
/** slas-update-response */
|
|
4300
|
-
export interface SlasUpdateResponse {
|
|
4301
|
-
sla: Sla;
|
|
5225
|
+
/** slas-update-response */
|
|
5226
|
+
export interface SlasUpdateResponse {
|
|
5227
|
+
sla: Sla;
|
|
5228
|
+
}
|
|
5229
|
+
/** snap-in-version-summary */
|
|
5230
|
+
export type SnapInVersionSummary = AtomBaseSummary;
|
|
5231
|
+
/** snap-ins-resources-request */
|
|
5232
|
+
export interface SnapInsResourcesRequest {
|
|
5233
|
+
/** The ID of the snap-in to get resources for. */
|
|
5234
|
+
id: string;
|
|
5235
|
+
/** The ID of the user to get resources for. */
|
|
5236
|
+
user: string;
|
|
5237
|
+
}
|
|
5238
|
+
/** snap-ins-resources-response */
|
|
5239
|
+
export interface SnapInsResourcesResponse {
|
|
5240
|
+
event_sources?: SnapInsResourcesResponseEventSourcesEntry;
|
|
5241
|
+
/** The inputs for the snap-in. */
|
|
5242
|
+
inputs?: object;
|
|
5243
|
+
keyrings?: SnapInsResourcesResponseKeyringsEntry;
|
|
5244
|
+
snap_in_version: SnapInVersionSummary;
|
|
5245
|
+
}
|
|
5246
|
+
/** snap-ins-resources-response-event-sources-entry */
|
|
5247
|
+
export interface SnapInsResourcesResponseEventSourcesEntry {
|
|
5248
|
+
key: string;
|
|
5249
|
+
value: string;
|
|
5250
|
+
}
|
|
5251
|
+
/** snap-ins-resources-response-keyring-data */
|
|
5252
|
+
export interface SnapInsResourcesResponseKeyringData {
|
|
5253
|
+
/** The ID of the keyring. */
|
|
5254
|
+
id: string;
|
|
5255
|
+
/** The secret value of the keyring. This must be handled with caution. */
|
|
5256
|
+
secret: string;
|
|
5257
|
+
}
|
|
5258
|
+
/** snap-ins-resources-response-keyrings-entry */
|
|
5259
|
+
export interface SnapInsResourcesResponseKeyringsEntry {
|
|
5260
|
+
key: string;
|
|
5261
|
+
value: SnapInsResourcesResponseKeyringData;
|
|
5262
|
+
}
|
|
5263
|
+
/** snap-widget */
|
|
5264
|
+
export interface SnapWidget {
|
|
5265
|
+
type: SnapWidgetType;
|
|
4302
5266
|
}
|
|
5267
|
+
export type SnapWidgetType = string;
|
|
5268
|
+
/** stage-diagram-summary */
|
|
5269
|
+
export type StageDiagramSummary = AtomBaseSummary;
|
|
4303
5270
|
/**
|
|
4304
5271
|
* stage-filter
|
|
4305
5272
|
* The filter for stages.
|
|
@@ -4325,10 +5292,10 @@ export interface StageUpdate {
|
|
|
4325
5292
|
name?: string;
|
|
4326
5293
|
}
|
|
4327
5294
|
/**
|
|
4328
|
-
* stock-field-
|
|
4329
|
-
*
|
|
5295
|
+
* stock-field-override
|
|
5296
|
+
* A stock field override.
|
|
4330
5297
|
*/
|
|
4331
|
-
export type
|
|
5298
|
+
export type StockFieldOverride = object;
|
|
4332
5299
|
/** subtype */
|
|
4333
5300
|
export interface Subtype {
|
|
4334
5301
|
/** Display name of the subtype. */
|
|
@@ -4481,6 +5448,143 @@ export interface TagWithValueFilter {
|
|
|
4481
5448
|
*/
|
|
4482
5449
|
value?: string;
|
|
4483
5450
|
}
|
|
5451
|
+
/**
|
|
5452
|
+
* tags-create-request
|
|
5453
|
+
* The request to create a new tag.
|
|
5454
|
+
*/
|
|
5455
|
+
export interface TagsCreateRequest {
|
|
5456
|
+
/**
|
|
5457
|
+
* The allowed values for the tag, or empty if no values are
|
|
5458
|
+
* permitted.
|
|
5459
|
+
*/
|
|
5460
|
+
allowed_values?: string[];
|
|
5461
|
+
/** The description for the tag. */
|
|
5462
|
+
description?: string;
|
|
5463
|
+
/** The name for the tag, which must be unique across all tags. */
|
|
5464
|
+
name: string;
|
|
5465
|
+
}
|
|
5466
|
+
/**
|
|
5467
|
+
* tags-create-response
|
|
5468
|
+
* The response to creating a new tag.
|
|
5469
|
+
*/
|
|
5470
|
+
export interface TagsCreateResponse {
|
|
5471
|
+
tag: Tag;
|
|
5472
|
+
}
|
|
5473
|
+
/**
|
|
5474
|
+
* tags-delete-request
|
|
5475
|
+
* The request to delete a tag.
|
|
5476
|
+
*/
|
|
5477
|
+
export interface TagsDeleteRequest {
|
|
5478
|
+
/**
|
|
5479
|
+
* The ID of the tag to delete.
|
|
5480
|
+
* @example "TAG-12345"
|
|
5481
|
+
*/
|
|
5482
|
+
id: string;
|
|
5483
|
+
}
|
|
5484
|
+
/**
|
|
5485
|
+
* tags-delete-response
|
|
5486
|
+
* The response for deleting a tag.
|
|
5487
|
+
*/
|
|
5488
|
+
export type TagsDeleteResponse = object;
|
|
5489
|
+
/**
|
|
5490
|
+
* tags-get-request
|
|
5491
|
+
* The request to get a tag's information.
|
|
5492
|
+
*/
|
|
5493
|
+
export interface TagsGetRequest {
|
|
5494
|
+
/**
|
|
5495
|
+
* The requested tag's ID.
|
|
5496
|
+
* @example "TAG-12345"
|
|
5497
|
+
*/
|
|
5498
|
+
id: string;
|
|
5499
|
+
}
|
|
5500
|
+
/**
|
|
5501
|
+
* tags-get-response
|
|
5502
|
+
* The response to getting a tag's information.
|
|
5503
|
+
*/
|
|
5504
|
+
export interface TagsGetResponse {
|
|
5505
|
+
tag: Tag;
|
|
5506
|
+
}
|
|
5507
|
+
/**
|
|
5508
|
+
* tags-list-request
|
|
5509
|
+
* The request to get information about a list of tags.
|
|
5510
|
+
*/
|
|
5511
|
+
export interface TagsListRequest {
|
|
5512
|
+
/**
|
|
5513
|
+
* The cursor to resume iteration from. If not provided, then
|
|
5514
|
+
* iteration starts from the beginning.
|
|
5515
|
+
*/
|
|
5516
|
+
cursor?: string;
|
|
5517
|
+
/**
|
|
5518
|
+
* The maximum number of tags to return. The default is '50'.
|
|
5519
|
+
* @format int32
|
|
5520
|
+
*/
|
|
5521
|
+
limit?: number;
|
|
5522
|
+
/**
|
|
5523
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
5524
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
5525
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
5526
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
5527
|
+
* always be returned in the specified sort-by order.
|
|
5528
|
+
*/
|
|
5529
|
+
mode?: ListMode;
|
|
5530
|
+
/** Filters for tags with the provided names. */
|
|
5531
|
+
name?: string[];
|
|
5532
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
5533
|
+
sort_by?: string[];
|
|
5534
|
+
}
|
|
5535
|
+
/**
|
|
5536
|
+
* tags-list-response
|
|
5537
|
+
* The response to listing the tags.
|
|
5538
|
+
*/
|
|
5539
|
+
export interface TagsListResponse {
|
|
5540
|
+
/**
|
|
5541
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
5542
|
+
* sort order. If not set, then no later elements exist.
|
|
5543
|
+
*/
|
|
5544
|
+
next_cursor?: string;
|
|
5545
|
+
/**
|
|
5546
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
5547
|
+
* sort order. If not set, then no prior elements exist.
|
|
5548
|
+
*/
|
|
5549
|
+
prev_cursor?: string;
|
|
5550
|
+
/** The list of tags. */
|
|
5551
|
+
tags: Tag[];
|
|
5552
|
+
}
|
|
5553
|
+
/**
|
|
5554
|
+
* tags-update-allowed-values
|
|
5555
|
+
* Specifies an update to a tag's allowed values.
|
|
5556
|
+
*/
|
|
5557
|
+
export interface TagsUpdateAllowedValues {
|
|
5558
|
+
/** Sets the allowed values for the tag. */
|
|
5559
|
+
set?: string[];
|
|
5560
|
+
}
|
|
5561
|
+
/**
|
|
5562
|
+
* tags-update-request
|
|
5563
|
+
* The request to update a tag.
|
|
5564
|
+
*/
|
|
5565
|
+
export interface TagsUpdateRequest {
|
|
5566
|
+
/** Specifies an update to a tag's allowed values. */
|
|
5567
|
+
allowed_values?: TagsUpdateAllowedValues;
|
|
5568
|
+
/** The updated description of the tag. */
|
|
5569
|
+
description?: string;
|
|
5570
|
+
/**
|
|
5571
|
+
* The ID of the tag to update.
|
|
5572
|
+
* @example "TAG-12345"
|
|
5573
|
+
*/
|
|
5574
|
+
id: string;
|
|
5575
|
+
/**
|
|
5576
|
+
* The updated name of the tag. The name must be unique across all
|
|
5577
|
+
* tags.
|
|
5578
|
+
*/
|
|
5579
|
+
name?: string;
|
|
5580
|
+
}
|
|
5581
|
+
/**
|
|
5582
|
+
* tags-update-response
|
|
5583
|
+
* The response for updating a tag.
|
|
5584
|
+
*/
|
|
5585
|
+
export interface TagsUpdateResponse {
|
|
5586
|
+
tag: Tag;
|
|
5587
|
+
}
|
|
4484
5588
|
/** task */
|
|
4485
5589
|
export type Task = WorkBase;
|
|
4486
5590
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -4500,6 +5604,8 @@ export type Ticket = WorkBase & {
|
|
|
4500
5604
|
rev_org?: OrgSummary;
|
|
4501
5605
|
/** Severity of the ticket. */
|
|
4502
5606
|
severity?: TicketSeverity;
|
|
5607
|
+
/** Source channel of the ticket. */
|
|
5608
|
+
source_channel?: string;
|
|
4503
5609
|
};
|
|
4504
5610
|
/** Severity of the ticket. */
|
|
4505
5611
|
export declare enum TicketSeverity {
|
|
@@ -4527,10 +5633,13 @@ export type TimelineComment = TimelineEntryBase & {
|
|
|
4527
5633
|
body_type?: TimelineCommentBodyType;
|
|
4528
5634
|
/** Snap Kit Body of the comment. */
|
|
4529
5635
|
snap_kit_body?: TimelineSnapKitBody;
|
|
5636
|
+
/** The snap widget body of the comment. */
|
|
5637
|
+
snap_widget_body?: SnapWidget[];
|
|
4530
5638
|
};
|
|
4531
5639
|
/** The type of the body to use for the comment. */
|
|
4532
5640
|
export declare enum TimelineCommentBodyType {
|
|
4533
5641
|
SnapKit = "snap_kit",
|
|
5642
|
+
SnapWidget = "snap_widget",
|
|
4534
5643
|
Text = "text"
|
|
4535
5644
|
}
|
|
4536
5645
|
/** Describes collections of timeline entries. */
|
|
@@ -4615,6 +5724,40 @@ export declare enum TimelineEntriesCreateRequestType {
|
|
|
4615
5724
|
export interface TimelineEntriesCreateResponse {
|
|
4616
5725
|
timeline_entry: TimelineEntry;
|
|
4617
5726
|
}
|
|
5727
|
+
/**
|
|
5728
|
+
* timeline-entries-delete-request
|
|
5729
|
+
* The request to delete a timeline entry from an object.
|
|
5730
|
+
*/
|
|
5731
|
+
export interface TimelineEntriesDeleteRequest {
|
|
5732
|
+
/**
|
|
5733
|
+
* The ID of the timeline entry to delete.
|
|
5734
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
5735
|
+
*/
|
|
5736
|
+
id: string;
|
|
5737
|
+
}
|
|
5738
|
+
/**
|
|
5739
|
+
* timeline-entries-delete-response
|
|
5740
|
+
* The response to deleting a timeline entry from an object.
|
|
5741
|
+
*/
|
|
5742
|
+
export type TimelineEntriesDeleteResponse = object;
|
|
5743
|
+
/**
|
|
5744
|
+
* timeline-entries-get-request
|
|
5745
|
+
* The request to get a timeline entry.
|
|
5746
|
+
*/
|
|
5747
|
+
export interface TimelineEntriesGetRequest {
|
|
5748
|
+
/**
|
|
5749
|
+
* The ID of the timeline entry to get.
|
|
5750
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
5751
|
+
*/
|
|
5752
|
+
id: string;
|
|
5753
|
+
}
|
|
5754
|
+
/**
|
|
5755
|
+
* timeline-entries-get-response
|
|
5756
|
+
* The request to getting a timeline entry.
|
|
5757
|
+
*/
|
|
5758
|
+
export interface TimelineEntriesGetResponse {
|
|
5759
|
+
timeline_entry: TimelineEntry;
|
|
5760
|
+
}
|
|
4618
5761
|
/**
|
|
4619
5762
|
* timeline-entries-list-request
|
|
4620
5763
|
* The request to list timeline entries for an object.
|
|
@@ -4771,6 +5914,8 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
4771
5914
|
labels?: string[];
|
|
4772
5915
|
/** The object that the Timeline entry belongs to. */
|
|
4773
5916
|
object: string;
|
|
5917
|
+
/** The display ID of the object that the Timeline entry belongs to. */
|
|
5918
|
+
object_display_id: string;
|
|
4774
5919
|
/** The type of object that the Timeline entry belongs to. */
|
|
4775
5920
|
object_type?: TimelineEntryObjectType;
|
|
4776
5921
|
/** The reactions to the entry. */
|
|
@@ -4863,25 +6008,6 @@ export interface TimelineThread {
|
|
|
4863
6008
|
*/
|
|
4864
6009
|
total_replies?: number;
|
|
4865
6010
|
}
|
|
4866
|
-
/** uenum-value */
|
|
4867
|
-
export interface UenumValue {
|
|
4868
|
-
/**
|
|
4869
|
-
* The ID of the enum value.
|
|
4870
|
-
* @format int64
|
|
4871
|
-
*/
|
|
4872
|
-
id: number;
|
|
4873
|
-
/** Whether the enum value is deprecated. */
|
|
4874
|
-
is_deprecated?: boolean;
|
|
4875
|
-
/** The label of the enum value. */
|
|
4876
|
-
label: string;
|
|
4877
|
-
/**
|
|
4878
|
-
* The ordinal of the enum value.
|
|
4879
|
-
* @format int64
|
|
4880
|
-
*/
|
|
4881
|
-
ordinal: number;
|
|
4882
|
-
/** The tooltip of the enum value. */
|
|
4883
|
-
tooltip?: string;
|
|
4884
|
-
}
|
|
4885
6011
|
/**
|
|
4886
6012
|
* unit
|
|
4887
6013
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -5136,6 +6262,7 @@ export interface UomsUpdateRequest {
|
|
|
5136
6262
|
aggregation_type?: AggregationDetailAggregationType;
|
|
5137
6263
|
/** Description of the Unit of Measurement (UOM). */
|
|
5138
6264
|
description?: string;
|
|
6265
|
+
dimensions?: UomsUpdateRequestDimensions;
|
|
5139
6266
|
/** The Unit of Measurement (UOM)'s DON. */
|
|
5140
6267
|
id: string;
|
|
5141
6268
|
/**
|
|
@@ -5160,6 +6287,13 @@ export interface UomsUpdateRequest {
|
|
|
5160
6287
|
/** Unit name of the Unit of Measurement (UOM). */
|
|
5161
6288
|
unit?: string;
|
|
5162
6289
|
}
|
|
6290
|
+
/** uoms-update-request-dimensions */
|
|
6291
|
+
export interface UomsUpdateRequestDimensions {
|
|
6292
|
+
/** Adds the provided dimensions to the UOM. */
|
|
6293
|
+
add?: string[];
|
|
6294
|
+
/** Removes the provided dimensions from the UOM. */
|
|
6295
|
+
remove?: string[];
|
|
6296
|
+
}
|
|
5163
6297
|
/** uoms-update-response */
|
|
5164
6298
|
export interface UomsUpdateResponse {
|
|
5165
6299
|
uom: Uom;
|
|
@@ -5225,9 +6359,15 @@ export type Webhook = AtomBase & {
|
|
|
5225
6359
|
};
|
|
5226
6360
|
/** webhook-event-request */
|
|
5227
6361
|
export interface WebhookEventRequest {
|
|
6362
|
+
account_created?: EventAccountCreated;
|
|
6363
|
+
account_deleted?: EventAccountDeleted;
|
|
6364
|
+
account_updated?: EventAccountUpdated;
|
|
5228
6365
|
conversation_created?: EventConversationCreated;
|
|
5229
6366
|
conversation_deleted?: EventConversationDeleted;
|
|
5230
6367
|
conversation_updated?: EventConversationUpdated;
|
|
6368
|
+
dev_user_created?: EventDevUserCreated;
|
|
6369
|
+
dev_user_deleted?: EventDevUserDeleted;
|
|
6370
|
+
dev_user_updated?: EventDevUserUpdated;
|
|
5231
6371
|
/** The event's ID. */
|
|
5232
6372
|
id: string;
|
|
5233
6373
|
part_created?: EventPartCreated;
|
|
@@ -5283,6 +6423,15 @@ export interface WebhookEventResponse {
|
|
|
5283
6423
|
}
|
|
5284
6424
|
/** The event types that the webhook will receive. */
|
|
5285
6425
|
export declare enum WebhookEventType {
|
|
6426
|
+
AccountCreated = "account_created",
|
|
6427
|
+
AccountDeleted = "account_deleted",
|
|
6428
|
+
AccountUpdated = "account_updated",
|
|
6429
|
+
ConversationCreated = "conversation_created",
|
|
6430
|
+
ConversationDeleted = "conversation_deleted",
|
|
6431
|
+
ConversationUpdated = "conversation_updated",
|
|
6432
|
+
DevUserCreated = "dev_user_created",
|
|
6433
|
+
DevUserDeleted = "dev_user_deleted",
|
|
6434
|
+
DevUserUpdated = "dev_user_updated",
|
|
5286
6435
|
PartCreated = "part_created",
|
|
5287
6436
|
PartDeleted = "part_deleted",
|
|
5288
6437
|
PartUpdated = "part_updated",
|
|
@@ -5320,6 +6469,140 @@ export declare enum WebhookStatus {
|
|
|
5320
6469
|
Inactive = "inactive",
|
|
5321
6470
|
Unverified = "unverified"
|
|
5322
6471
|
}
|
|
6472
|
+
/**
|
|
6473
|
+
* webhooks-create-request
|
|
6474
|
+
* The request to create a new webhook.
|
|
6475
|
+
*/
|
|
6476
|
+
export interface WebhooksCreateRequest {
|
|
6477
|
+
/** The event types that the webhook endpoint will receive. */
|
|
6478
|
+
event_types?: WebhookEventType[];
|
|
6479
|
+
/**
|
|
6480
|
+
* The secret to use when verifying webhook events. If provided, the
|
|
6481
|
+
* secret must be between 8 and 32 bytes (inclusive). If not set, a
|
|
6482
|
+
* secret will be automatically generated and provided in the
|
|
6483
|
+
* response.
|
|
6484
|
+
* @format byte
|
|
6485
|
+
*/
|
|
6486
|
+
secret?: string;
|
|
6487
|
+
/** The URL of the webhook endpoint. */
|
|
6488
|
+
url: string;
|
|
6489
|
+
}
|
|
6490
|
+
/**
|
|
6491
|
+
* webhooks-create-response
|
|
6492
|
+
* The response to creating a new webhook.
|
|
6493
|
+
*/
|
|
6494
|
+
export interface WebhooksCreateResponse {
|
|
6495
|
+
webhook: Webhook;
|
|
6496
|
+
}
|
|
6497
|
+
/**
|
|
6498
|
+
* webhooks-delete-request
|
|
6499
|
+
* The request to delete a webhook.
|
|
6500
|
+
*/
|
|
6501
|
+
export interface WebhooksDeleteRequest {
|
|
6502
|
+
/**
|
|
6503
|
+
* ID for the webhook.
|
|
6504
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
6505
|
+
*/
|
|
6506
|
+
id: string;
|
|
6507
|
+
}
|
|
6508
|
+
/**
|
|
6509
|
+
* webhooks-delete-response
|
|
6510
|
+
* The response to deleting the webhook.
|
|
6511
|
+
*/
|
|
6512
|
+
export type WebhooksDeleteResponse = object;
|
|
6513
|
+
/**
|
|
6514
|
+
* webhooks-get-request
|
|
6515
|
+
* The request to get a webhook's information.
|
|
6516
|
+
*/
|
|
6517
|
+
export interface WebhooksGetRequest {
|
|
6518
|
+
/**
|
|
6519
|
+
* ID for the webhook.
|
|
6520
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
6521
|
+
*/
|
|
6522
|
+
id: string;
|
|
6523
|
+
}
|
|
6524
|
+
/**
|
|
6525
|
+
* webhooks-get-response
|
|
6526
|
+
* The response to getting the information for the webhook.
|
|
6527
|
+
*/
|
|
6528
|
+
export interface WebhooksGetResponse {
|
|
6529
|
+
webhook: Webhook;
|
|
6530
|
+
}
|
|
6531
|
+
/**
|
|
6532
|
+
* webhooks-list-request
|
|
6533
|
+
* The request to list the webhooks.
|
|
6534
|
+
*/
|
|
6535
|
+
export type WebhooksListRequest = object;
|
|
6536
|
+
/**
|
|
6537
|
+
* webhooks-list-response
|
|
6538
|
+
* The response to listing the webhooks.
|
|
6539
|
+
*/
|
|
6540
|
+
export interface WebhooksListResponse {
|
|
6541
|
+
/** The list of webhooks. */
|
|
6542
|
+
webhooks: Webhook[];
|
|
6543
|
+
}
|
|
6544
|
+
/** The action to update the webhook's status. */
|
|
6545
|
+
export declare enum WebhooksUpdateAction {
|
|
6546
|
+
Activate = "activate",
|
|
6547
|
+
Deactivate = "deactivate"
|
|
6548
|
+
}
|
|
6549
|
+
/**
|
|
6550
|
+
* webhooks-update-request
|
|
6551
|
+
* The request to update a webhook.
|
|
6552
|
+
*/
|
|
6553
|
+
export interface WebhooksUpdateRequest {
|
|
6554
|
+
/** The action to update the webhook's status. */
|
|
6555
|
+
action?: WebhooksUpdateAction;
|
|
6556
|
+
event_types?: WebhooksUpdateRequestEventTypes;
|
|
6557
|
+
/**
|
|
6558
|
+
* ID for the webhook.
|
|
6559
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
6560
|
+
*/
|
|
6561
|
+
id: string;
|
|
6562
|
+
/**
|
|
6563
|
+
* If provided, updates the secret that's used when verifying webhook
|
|
6564
|
+
* events, which must be between 8 and 32 bytes (inclusive). Otherwise
|
|
6565
|
+
* if empty, then a new secret is generated. If the webhook is active,
|
|
6566
|
+
* then its status will transition to the 'unverified' state and it
|
|
6567
|
+
* won't receive any object events until successfully verified.
|
|
6568
|
+
* @format byte
|
|
6569
|
+
*/
|
|
6570
|
+
secret?: string;
|
|
6571
|
+
/**
|
|
6572
|
+
* The webhook's updated URL. If the webhook is active, then the
|
|
6573
|
+
* webhook's status will transition to the 'unverified' state and it
|
|
6574
|
+
* won't receive any object events until successfully verified.
|
|
6575
|
+
*/
|
|
6576
|
+
url?: string;
|
|
6577
|
+
}
|
|
6578
|
+
/** webhooks-update-request-event-types */
|
|
6579
|
+
export interface WebhooksUpdateRequestEventTypes {
|
|
6580
|
+
/**
|
|
6581
|
+
* The event types to add. If a provided event type is already set for
|
|
6582
|
+
* the webhook, then nothing is done. Note this is mutually exclusive
|
|
6583
|
+
* with 'set'.
|
|
6584
|
+
*/
|
|
6585
|
+
add?: WebhookEventType[];
|
|
6586
|
+
/**
|
|
6587
|
+
* The event types to remove. If a provided event type isn't set for
|
|
6588
|
+
* the webhook, then nothing is done. Note this is mutually exclusive
|
|
6589
|
+
* with 'set'.
|
|
6590
|
+
*/
|
|
6591
|
+
remove?: WebhookEventType[];
|
|
6592
|
+
/**
|
|
6593
|
+
* The updated event types, which will replace the webhook's current
|
|
6594
|
+
* event types. Note this is mutually exclusive with 'add' and
|
|
6595
|
+
* 'remove'.
|
|
6596
|
+
*/
|
|
6597
|
+
set?: WebhookEventType[];
|
|
6598
|
+
}
|
|
6599
|
+
/**
|
|
6600
|
+
* webhooks-update-response
|
|
6601
|
+
* The response to updating the webhook.
|
|
6602
|
+
*/
|
|
6603
|
+
export interface WebhooksUpdateResponse {
|
|
6604
|
+
webhook: Webhook;
|
|
6605
|
+
}
|
|
5323
6606
|
/**
|
|
5324
6607
|
* weekly-org-schedule
|
|
5325
6608
|
* The schedule for each week.
|
|
@@ -5433,6 +6716,11 @@ export interface WorksCreateRequestIssue {
|
|
|
5433
6716
|
developed_with?: string[];
|
|
5434
6717
|
/** Priority of the work based upon impact and criticality. */
|
|
5435
6718
|
priority?: IssuePriority;
|
|
6719
|
+
/**
|
|
6720
|
+
* Priority enum id of the work based upon impact and criticality.
|
|
6721
|
+
* @format int64
|
|
6722
|
+
*/
|
|
6723
|
+
priority_v2?: number;
|
|
5436
6724
|
/** The sprint that the issue belongs to. */
|
|
5437
6725
|
sprint?: string;
|
|
5438
6726
|
}
|
|
@@ -5563,8 +6851,15 @@ export interface WorksExportResponse {
|
|
|
5563
6851
|
}
|
|
5564
6852
|
/** works-filter-issue */
|
|
5565
6853
|
export interface WorksFilterIssue {
|
|
6854
|
+
/**
|
|
6855
|
+
* Filters for issues with any of the provided Accounts.
|
|
6856
|
+
* @example ["ACC-12345"]
|
|
6857
|
+
*/
|
|
6858
|
+
accounts?: string[];
|
|
5566
6859
|
/** Filters for issues with any of the provided priorities. */
|
|
5567
6860
|
priority?: IssuePriority[];
|
|
6861
|
+
/** Filters for issues with any of the provided priority enum ids. */
|
|
6862
|
+
priority_v2?: number[];
|
|
5568
6863
|
/**
|
|
5569
6864
|
* Filters for issues with any of the provided Rev organizations.
|
|
5570
6865
|
* @example ["REV-AbCdEfGh"]
|
|
@@ -5718,6 +7013,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
5718
7013
|
reported_by?: WorksUpdateRequestReportedBy;
|
|
5719
7014
|
/** Updates an object's stage. */
|
|
5720
7015
|
stage?: StageUpdate;
|
|
7016
|
+
staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
|
|
5721
7017
|
tags?: WorksUpdateRequestTags;
|
|
5722
7018
|
/**
|
|
5723
7019
|
* Updates the timestamp for when the work is expected to be complete.
|
|
@@ -5742,6 +7038,11 @@ export interface WorksUpdateRequestIssue {
|
|
|
5742
7038
|
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
5743
7039
|
/** Priority of the work based upon impact and criticality. */
|
|
5744
7040
|
priority?: IssuePriority;
|
|
7041
|
+
/**
|
|
7042
|
+
* Priority enum id of the work based upon impact and criticality.
|
|
7043
|
+
* @format int64
|
|
7044
|
+
*/
|
|
7045
|
+
priority_v2?: number;
|
|
5745
7046
|
/** Updates the sprint that the issue belongs to. */
|
|
5746
7047
|
sprint?: string | null;
|
|
5747
7048
|
}
|
|
@@ -5801,6 +7102,11 @@ export interface WorksUpdateRequestReportedBy {
|
|
|
5801
7102
|
*/
|
|
5802
7103
|
set?: string[];
|
|
5803
7104
|
}
|
|
7105
|
+
/** works-update-request-staged-info-staged-info-update */
|
|
7106
|
+
export interface WorksUpdateRequestStagedInfoStagedInfoUpdate {
|
|
7107
|
+
/** Updates the unresolved fields of the staged work. */
|
|
7108
|
+
unresolved_fields: string[];
|
|
7109
|
+
}
|
|
5804
7110
|
/** works-update-request-tags */
|
|
5805
7111
|
export interface WorksUpdateRequestTags {
|
|
5806
7112
|
/** Sets the provided tags on the work item. */
|
|
@@ -5821,8 +7127,8 @@ export interface WorksUpdateRequestTask {
|
|
|
5821
7127
|
}
|
|
5822
7128
|
/** works-update-request-ticket */
|
|
5823
7129
|
export interface WorksUpdateRequestTicket {
|
|
5824
|
-
/**
|
|
5825
|
-
group?: string;
|
|
7130
|
+
/** Updates the group that the ticket is associated with. */
|
|
7131
|
+
group?: string | null;
|
|
5826
7132
|
/** Updates whether the ticket is spam. */
|
|
5827
7133
|
is_spam?: boolean;
|
|
5828
7134
|
/**
|
|
@@ -5879,11 +7185,11 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
5879
7185
|
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
|
|
5880
7186
|
}
|
|
5881
7187
|
/**
|
|
5882
|
-
* @title DevRev
|
|
5883
|
-
* @version
|
|
7188
|
+
* @title DevRev REST API
|
|
7189
|
+
* @version 2022-10-20
|
|
5884
7190
|
* @baseUrl {protocol}://{hostname}
|
|
5885
7191
|
*
|
|
5886
|
-
* DevRev's
|
|
7192
|
+
* DevRev's REST API.
|
|
5887
7193
|
*/
|
|
5888
7194
|
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
5889
7195
|
/**
|
|
@@ -6209,41 +7515,159 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6209
7515
|
owned_by?: string[];
|
|
6210
7516
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
6211
7517
|
/**
|
|
6212
|
-
* @description Lists a collection of articles.
|
|
7518
|
+
* @description Lists a collection of articles.
|
|
7519
|
+
*
|
|
7520
|
+
* @tags articles
|
|
7521
|
+
* @name ListArticlesPost
|
|
7522
|
+
* @request POST:/articles.list
|
|
7523
|
+
* @secure
|
|
7524
|
+
*/
|
|
7525
|
+
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
7526
|
+
/**
|
|
7527
|
+
* @description Updates an article.
|
|
7528
|
+
*
|
|
7529
|
+
* @tags articles
|
|
7530
|
+
* @name UpdateArticle
|
|
7531
|
+
* @request POST:/articles.update
|
|
7532
|
+
* @secure
|
|
7533
|
+
*/
|
|
7534
|
+
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
7535
|
+
/**
|
|
7536
|
+
* @description Gets the download URL for the artifact.
|
|
7537
|
+
*
|
|
7538
|
+
* @tags artifacts
|
|
7539
|
+
* @name ArtifactsLocate
|
|
7540
|
+
* @request GET:/artifacts.locate
|
|
7541
|
+
* @secure
|
|
7542
|
+
*/
|
|
7543
|
+
artifactsLocate: (query: {
|
|
7544
|
+
/**
|
|
7545
|
+
* The ID of the artifact to get the URL for.
|
|
7546
|
+
* @example "ARTIFACT-12345"
|
|
7547
|
+
*/
|
|
7548
|
+
id: string;
|
|
7549
|
+
/** The version of the artifact that needs to be fetched. */
|
|
7550
|
+
version?: string;
|
|
7551
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
7552
|
+
/**
|
|
7553
|
+
* @description Gets the download URL for the artifact.
|
|
7554
|
+
*
|
|
7555
|
+
* @tags artifacts
|
|
7556
|
+
* @name ArtifactsLocatePost
|
|
7557
|
+
* @request POST:/artifacts.locate
|
|
7558
|
+
* @secure
|
|
7559
|
+
*/
|
|
7560
|
+
artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
7561
|
+
/**
|
|
7562
|
+
* @description Creates an artifact and generates an upload URL for its data.
|
|
7563
|
+
*
|
|
7564
|
+
* @tags artifacts
|
|
7565
|
+
* @name ArtifactsPrepare
|
|
7566
|
+
* @request POST:/artifacts.prepare
|
|
7567
|
+
* @secure
|
|
7568
|
+
*/
|
|
7569
|
+
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
|
|
7570
|
+
/**
|
|
7571
|
+
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
7572
|
+
*
|
|
7573
|
+
* @tags artifacts
|
|
7574
|
+
* @name ArtifactsVersionsPrepare
|
|
7575
|
+
* @request POST:/artifacts.versions.prepare
|
|
7576
|
+
* @secure
|
|
7577
|
+
*/
|
|
7578
|
+
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
|
|
7579
|
+
/**
|
|
7580
|
+
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
7581
|
+
*
|
|
7582
|
+
* @tags auth-tokens
|
|
7583
|
+
* @name AuthTokensCreate
|
|
7584
|
+
* @request POST:/auth-tokens.create
|
|
7585
|
+
* @secure
|
|
7586
|
+
*/
|
|
7587
|
+
authTokensCreate: (data: AuthTokensCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensCreateResponse, any>>;
|
|
7588
|
+
/**
|
|
7589
|
+
* @description Revokes the token that matches the given token ID issued under the given Dev organization.
|
|
7590
|
+
*
|
|
7591
|
+
* @tags auth-tokens
|
|
7592
|
+
* @name AuthTokensDelete
|
|
7593
|
+
* @request POST:/auth-tokens.delete
|
|
7594
|
+
* @secure
|
|
7595
|
+
*/
|
|
7596
|
+
authTokensDelete: (data: AuthTokensDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7597
|
+
/**
|
|
7598
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
7599
|
+
*
|
|
7600
|
+
* @tags auth-tokens
|
|
7601
|
+
* @name AuthTokensGet
|
|
7602
|
+
* @request GET:/auth-tokens.get
|
|
7603
|
+
* @secure
|
|
7604
|
+
*/
|
|
7605
|
+
authTokensGet: (query: {
|
|
7606
|
+
/** The unique identifier of the token under a given Dev organization. */
|
|
7607
|
+
token_id: string;
|
|
7608
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
7609
|
+
/**
|
|
7610
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
6213
7611
|
*
|
|
6214
|
-
* @tags
|
|
6215
|
-
* @name
|
|
6216
|
-
* @request POST:/
|
|
7612
|
+
* @tags auth-tokens
|
|
7613
|
+
* @name AuthTokensGetPost
|
|
7614
|
+
* @request POST:/auth-tokens.get
|
|
6217
7615
|
* @secure
|
|
6218
7616
|
*/
|
|
6219
|
-
|
|
7617
|
+
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
|
|
6220
7618
|
/**
|
|
6221
|
-
* @description
|
|
7619
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
6222
7620
|
*
|
|
6223
|
-
* @tags
|
|
6224
|
-
* @name
|
|
6225
|
-
* @request
|
|
7621
|
+
* @tags auth-tokens
|
|
7622
|
+
* @name AuthTokensList
|
|
7623
|
+
* @request GET:/auth-tokens.list
|
|
6226
7624
|
* @secure
|
|
6227
7625
|
*/
|
|
6228
|
-
|
|
7626
|
+
authTokensList: (query?: {
|
|
7627
|
+
/**
|
|
7628
|
+
* An identifier that represents the application, which requested the
|
|
7629
|
+
* token. Only relevant for application access tokens.
|
|
7630
|
+
*/
|
|
7631
|
+
client_id?: string;
|
|
7632
|
+
/**
|
|
7633
|
+
* The type of the requested token. If no value is specified, the
|
|
7634
|
+
* response will include tokens of all the types.
|
|
7635
|
+
*/
|
|
7636
|
+
requested_token_type?: AuthTokenRequestedTokenType;
|
|
7637
|
+
/**
|
|
7638
|
+
* The subject associated with the token. In the absence of this
|
|
7639
|
+
* parameter, the ID of the authenticated entity is treated as the
|
|
7640
|
+
* subject.
|
|
7641
|
+
*/
|
|
7642
|
+
subject?: string;
|
|
7643
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
6229
7644
|
/**
|
|
6230
|
-
* @description
|
|
7645
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
6231
7646
|
*
|
|
6232
|
-
* @tags
|
|
6233
|
-
* @name
|
|
6234
|
-
* @request POST:/
|
|
7647
|
+
* @tags auth-tokens
|
|
7648
|
+
* @name AuthTokensListPost
|
|
7649
|
+
* @request POST:/auth-tokens.list
|
|
6235
7650
|
* @secure
|
|
6236
7651
|
*/
|
|
6237
|
-
|
|
7652
|
+
authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
|
|
6238
7653
|
/**
|
|
6239
|
-
* @description
|
|
7654
|
+
* @description Revokes all the tokens that matches the given token type created by the authenticated user.
|
|
6240
7655
|
*
|
|
6241
|
-
* @tags
|
|
6242
|
-
* @name
|
|
6243
|
-
* @request POST:/
|
|
7656
|
+
* @tags auth-tokens
|
|
7657
|
+
* @name AuthTokensSelfDelete
|
|
7658
|
+
* @request POST:/auth-tokens.self.delete
|
|
6244
7659
|
* @secure
|
|
6245
7660
|
*/
|
|
6246
|
-
|
|
7661
|
+
authTokensSelfDelete: (data: AuthTokensSelfDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7662
|
+
/**
|
|
7663
|
+
* @description Updates token metadata of a token issued under a given Dev organization.
|
|
7664
|
+
*
|
|
7665
|
+
* @tags auth-tokens
|
|
7666
|
+
* @name AuthTokensUpdate
|
|
7667
|
+
* @request POST:/auth-tokens.update
|
|
7668
|
+
* @secure
|
|
7669
|
+
*/
|
|
7670
|
+
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
6247
7671
|
/**
|
|
6248
7672
|
* @description Create CodeChange object.
|
|
6249
7673
|
*
|
|
@@ -6532,6 +7956,164 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6532
7956
|
* @secure
|
|
6533
7957
|
*/
|
|
6534
7958
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
7959
|
+
/**
|
|
7960
|
+
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Keep in mind that at a time, only one authentication connection can be enabled for a Dev organization. At present, only 5 enterprise connections can be created by an organization.
|
|
7961
|
+
*
|
|
7962
|
+
* @tags auth-connection, dev-orgs
|
|
7963
|
+
* @name DevOrgAuthConnectionsCreate
|
|
7964
|
+
* @request POST:/dev-orgs.auth-connections.create
|
|
7965
|
+
* @secure
|
|
7966
|
+
*/
|
|
7967
|
+
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any>>;
|
|
7968
|
+
/**
|
|
7969
|
+
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method.
|
|
7970
|
+
*
|
|
7971
|
+
* @tags auth-connection, dev-orgs
|
|
7972
|
+
* @name DevOrgAuthConnectionsDelete
|
|
7973
|
+
* @request POST:/dev-orgs.auth-connections.delete
|
|
7974
|
+
* @secure
|
|
7975
|
+
*/
|
|
7976
|
+
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
7977
|
+
/**
|
|
7978
|
+
* @description Retrieves the details for an authentication connection.
|
|
7979
|
+
*
|
|
7980
|
+
* @tags auth-connection, dev-orgs
|
|
7981
|
+
* @name DevOrgAuthConnectionsGet
|
|
7982
|
+
* @request GET:/dev-orgs.auth-connections.get
|
|
7983
|
+
* @secure
|
|
7984
|
+
*/
|
|
7985
|
+
devOrgAuthConnectionsGet: (query: {
|
|
7986
|
+
/** ID of the authentication connection. */
|
|
7987
|
+
id: string;
|
|
7988
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
7989
|
+
/**
|
|
7990
|
+
* @description Retrieves the details for an authentication connection.
|
|
7991
|
+
*
|
|
7992
|
+
* @tags auth-connection, dev-orgs
|
|
7993
|
+
* @name DevOrgAuthConnectionsGetPost
|
|
7994
|
+
* @request POST:/dev-orgs.auth-connections.get
|
|
7995
|
+
* @secure
|
|
7996
|
+
*/
|
|
7997
|
+
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
|
|
7998
|
+
/**
|
|
7999
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
8000
|
+
*
|
|
8001
|
+
* @tags auth-connection, dev-orgs
|
|
8002
|
+
* @name DevOrgAuthConnectionsList
|
|
8003
|
+
* @request GET:/dev-orgs.auth-connections.list
|
|
8004
|
+
* @secure
|
|
8005
|
+
*/
|
|
8006
|
+
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
8007
|
+
/**
|
|
8008
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
8009
|
+
*
|
|
8010
|
+
* @tags auth-connection, dev-orgs
|
|
8011
|
+
* @name DevOrgAuthConnectionsListPost
|
|
8012
|
+
* @request POST:/dev-orgs.auth-connections.list
|
|
8013
|
+
* @secure
|
|
8014
|
+
*/
|
|
8015
|
+
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
|
|
8016
|
+
/**
|
|
8017
|
+
* @description Enable or disable an authentication connection for a Dev organization. Currently, only 1 authentication connection can be enabled at a time. When a new authentication connection is enabled, the connection which is currently enabled for the Dev organization is automatically disabled.
|
|
8018
|
+
*
|
|
8019
|
+
* @tags auth-connection, dev-orgs
|
|
8020
|
+
* @name DevOrgAuthConnectionsToggle
|
|
8021
|
+
* @request POST:/dev-orgs.auth-connections.toggle
|
|
8022
|
+
* @secure
|
|
8023
|
+
*/
|
|
8024
|
+
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
8025
|
+
/**
|
|
8026
|
+
* @description Updates an authentication connection.
|
|
8027
|
+
*
|
|
8028
|
+
* @tags auth-connection, dev-orgs
|
|
8029
|
+
* @name DevOrgAuthConnectionsUpdate
|
|
8030
|
+
* @request POST:/dev-orgs.auth-connections.update
|
|
8031
|
+
* @secure
|
|
8032
|
+
*/
|
|
8033
|
+
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
8034
|
+
/**
|
|
8035
|
+
* @description Gets the requested user's information.
|
|
8036
|
+
*
|
|
8037
|
+
* @tags dev-users
|
|
8038
|
+
* @name DevUsersGet
|
|
8039
|
+
* @request GET:/dev-users.get
|
|
8040
|
+
* @secure
|
|
8041
|
+
*/
|
|
8042
|
+
devUsersGet: (query: {
|
|
8043
|
+
/** User ID of the requested Dev user. */
|
|
8044
|
+
id: string;
|
|
8045
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
8046
|
+
/**
|
|
8047
|
+
* @description Gets the requested user's information.
|
|
8048
|
+
*
|
|
8049
|
+
* @tags dev-users
|
|
8050
|
+
* @name DevUsersGetPost
|
|
8051
|
+
* @request POST:/dev-users.get
|
|
8052
|
+
* @secure
|
|
8053
|
+
*/
|
|
8054
|
+
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
8055
|
+
/**
|
|
8056
|
+
* @description Lists users within your organization.
|
|
8057
|
+
*
|
|
8058
|
+
* @tags dev-users
|
|
8059
|
+
* @name DevUsersList
|
|
8060
|
+
* @request GET:/dev-users.list
|
|
8061
|
+
* @secure
|
|
8062
|
+
*/
|
|
8063
|
+
devUsersList: (query?: {
|
|
8064
|
+
/**
|
|
8065
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8066
|
+
* starts from the beginning.
|
|
8067
|
+
*/
|
|
8068
|
+
cursor?: string;
|
|
8069
|
+
/** Filters Dev users based on email addresses. */
|
|
8070
|
+
email?: string[];
|
|
8071
|
+
/** Unique ID of the user in the external source. */
|
|
8072
|
+
'external_identity.id'?: string;
|
|
8073
|
+
/** Issuer of the external identity of the user. */
|
|
8074
|
+
'external_identity.issuer'?: string;
|
|
8075
|
+
/**
|
|
8076
|
+
* The maximum number of Dev users to return. The default is '50'.
|
|
8077
|
+
* @format int32
|
|
8078
|
+
*/
|
|
8079
|
+
limit?: number;
|
|
8080
|
+
/**
|
|
8081
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8082
|
+
* used.
|
|
8083
|
+
*/
|
|
8084
|
+
mode?: ListMode;
|
|
8085
|
+
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
8086
|
+
sort_by?: string[];
|
|
8087
|
+
/** Filters Dev users based on state. */
|
|
8088
|
+
state?: UserState[];
|
|
8089
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
8090
|
+
/**
|
|
8091
|
+
* @description Lists users within your organization.
|
|
8092
|
+
*
|
|
8093
|
+
* @tags dev-users
|
|
8094
|
+
* @name DevUsersListPost
|
|
8095
|
+
* @request POST:/dev-users.list
|
|
8096
|
+
* @secure
|
|
8097
|
+
*/
|
|
8098
|
+
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
8099
|
+
/**
|
|
8100
|
+
* @description Gets the authenticated user's information.
|
|
8101
|
+
*
|
|
8102
|
+
* @tags dev-users
|
|
8103
|
+
* @name DevUsersSelf
|
|
8104
|
+
* @request GET:/dev-users.self
|
|
8105
|
+
* @secure
|
|
8106
|
+
*/
|
|
8107
|
+
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
8108
|
+
/**
|
|
8109
|
+
* @description Gets the authenticated user's information.
|
|
8110
|
+
*
|
|
8111
|
+
* @tags dev-users
|
|
8112
|
+
* @name DevUsersSelfPost
|
|
8113
|
+
* @request POST:/dev-users.self
|
|
8114
|
+
* @secure
|
|
8115
|
+
*/
|
|
8116
|
+
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
6535
8117
|
/**
|
|
6536
8118
|
* @description Counts the engagement records.
|
|
6537
8119
|
*
|
|
@@ -6770,6 +8352,61 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6770
8352
|
* @secure
|
|
6771
8353
|
*/
|
|
6772
8354
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
8355
|
+
/**
|
|
8356
|
+
* @description Adds a member to a group.
|
|
8357
|
+
*
|
|
8358
|
+
* @tags groups
|
|
8359
|
+
* @name GroupMembersAdd
|
|
8360
|
+
* @request POST:/groups.members.add
|
|
8361
|
+
* @secure
|
|
8362
|
+
*/
|
|
8363
|
+
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8364
|
+
/**
|
|
8365
|
+
* @description Lists the members in a group.
|
|
8366
|
+
*
|
|
8367
|
+
* @tags groups
|
|
8368
|
+
* @name GroupMembersList
|
|
8369
|
+
* @request GET:/groups.members.list
|
|
8370
|
+
* @secure
|
|
8371
|
+
*/
|
|
8372
|
+
groupMembersList: (query: {
|
|
8373
|
+
/** ID of the group for which to list members. */
|
|
8374
|
+
group: string;
|
|
8375
|
+
/**
|
|
8376
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8377
|
+
* starts from the beginning.
|
|
8378
|
+
*/
|
|
8379
|
+
cursor?: string;
|
|
8380
|
+
/**
|
|
8381
|
+
* The maximum number of members to return. If not set, then the default
|
|
8382
|
+
* is '50'.
|
|
8383
|
+
* @format int32
|
|
8384
|
+
*/
|
|
8385
|
+
limit?: number;
|
|
8386
|
+
/**
|
|
8387
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8388
|
+
* used.
|
|
8389
|
+
*/
|
|
8390
|
+
mode?: ListMode;
|
|
8391
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8392
|
+
/**
|
|
8393
|
+
* @description Lists the members in a group.
|
|
8394
|
+
*
|
|
8395
|
+
* @tags groups
|
|
8396
|
+
* @name GroupMembersListPost
|
|
8397
|
+
* @request POST:/groups.members.list
|
|
8398
|
+
* @secure
|
|
8399
|
+
*/
|
|
8400
|
+
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8401
|
+
/**
|
|
8402
|
+
* @description Removes a member from a group.
|
|
8403
|
+
*
|
|
8404
|
+
* @tags groups
|
|
8405
|
+
* @name GroupMembersRemove
|
|
8406
|
+
* @request POST:/groups.members.remove
|
|
8407
|
+
* @secure
|
|
8408
|
+
*/
|
|
8409
|
+
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
6773
8410
|
/**
|
|
6774
8411
|
* @description Updates the requested group.
|
|
6775
8412
|
*
|
|
@@ -7174,6 +8811,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7174
8811
|
* @secure
|
|
7175
8812
|
*/
|
|
7176
8813
|
revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any>>;
|
|
8814
|
+
/**
|
|
8815
|
+
* @description Deletes the Rev organization.
|
|
8816
|
+
*
|
|
8817
|
+
* @tags rev-orgs
|
|
8818
|
+
* @name RevOrgsDelete
|
|
8819
|
+
* @request POST:/rev-orgs.delete
|
|
8820
|
+
* @secure
|
|
8821
|
+
*/
|
|
8822
|
+
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
7177
8823
|
/**
|
|
7178
8824
|
* @description Retrieves the Rev organization's information.
|
|
7179
8825
|
*
|
|
@@ -7404,7 +9050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7404
9050
|
* @example "2023-01-01T12:00:00.000Z"
|
|
7405
9051
|
*/
|
|
7406
9052
|
'modified_date.before'?: string;
|
|
7407
|
-
/** List of phone numbers to filter Rev users on. */
|
|
9053
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
7408
9054
|
phone_numbers?: string[];
|
|
7409
9055
|
/**
|
|
7410
9056
|
* List of IDs of Rev organizations to be filtered.
|
|
@@ -7677,6 +9323,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7677
9323
|
* @secure
|
|
7678
9324
|
*/
|
|
7679
9325
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
|
|
9326
|
+
/**
|
|
9327
|
+
* @description Gets snap-in resources for a user in a snap-in.
|
|
9328
|
+
*
|
|
9329
|
+
* @tags snap-ins
|
|
9330
|
+
* @name SnapInsResources
|
|
9331
|
+
* @request GET:/snap-ins.resources
|
|
9332
|
+
* @secure
|
|
9333
|
+
*/
|
|
9334
|
+
snapInsResources: (query: {
|
|
9335
|
+
/** The ID of the snap-in to get resources for. */
|
|
9336
|
+
id: string;
|
|
9337
|
+
/** The ID of the user to get resources for. */
|
|
9338
|
+
user: string;
|
|
9339
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
9340
|
+
/**
|
|
9341
|
+
* @description Gets snap-in resources for a user in a snap-in.
|
|
9342
|
+
*
|
|
9343
|
+
* @tags snap-ins
|
|
9344
|
+
* @name SnapInsResourcesPost
|
|
9345
|
+
* @request POST:/snap-ins.resources
|
|
9346
|
+
* @secure
|
|
9347
|
+
*/
|
|
9348
|
+
snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
7680
9349
|
/**
|
|
7681
9350
|
* @description Lists system users within your organization.
|
|
7682
9351
|
*
|
|
@@ -7723,6 +9392,95 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7723
9392
|
* @secure
|
|
7724
9393
|
*/
|
|
7725
9394
|
sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any>>;
|
|
9395
|
+
/**
|
|
9396
|
+
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
9397
|
+
*
|
|
9398
|
+
* @tags tags
|
|
9399
|
+
* @name TagsCreate
|
|
9400
|
+
* @request POST:/tags.create
|
|
9401
|
+
* @secure
|
|
9402
|
+
*/
|
|
9403
|
+
tagsCreate: (data: TagsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsCreateResponse, any>>;
|
|
9404
|
+
/**
|
|
9405
|
+
* @description Deletes a tag.
|
|
9406
|
+
*
|
|
9407
|
+
* @tags tags
|
|
9408
|
+
* @name TagsDelete
|
|
9409
|
+
* @request POST:/tags.delete
|
|
9410
|
+
* @secure
|
|
9411
|
+
*/
|
|
9412
|
+
tagsDelete: (data: TagsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
9413
|
+
/**
|
|
9414
|
+
* @description Gets a tag's information.
|
|
9415
|
+
*
|
|
9416
|
+
* @tags tags
|
|
9417
|
+
* @name TagsGet
|
|
9418
|
+
* @request GET:/tags.get
|
|
9419
|
+
* @secure
|
|
9420
|
+
*/
|
|
9421
|
+
tagsGet: (query: {
|
|
9422
|
+
/**
|
|
9423
|
+
* The requested tag's ID.
|
|
9424
|
+
* @example "TAG-12345"
|
|
9425
|
+
*/
|
|
9426
|
+
id: string;
|
|
9427
|
+
}, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
9428
|
+
/**
|
|
9429
|
+
* @description Gets a tag's information.
|
|
9430
|
+
*
|
|
9431
|
+
* @tags tags
|
|
9432
|
+
* @name TagsGetPost
|
|
9433
|
+
* @request POST:/tags.get
|
|
9434
|
+
* @secure
|
|
9435
|
+
*/
|
|
9436
|
+
tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
|
|
9437
|
+
/**
|
|
9438
|
+
* @description Lists the available tags.
|
|
9439
|
+
*
|
|
9440
|
+
* @tags tags
|
|
9441
|
+
* @name TagsList
|
|
9442
|
+
* @request GET:/tags.list
|
|
9443
|
+
* @secure
|
|
9444
|
+
*/
|
|
9445
|
+
tagsList: (query?: {
|
|
9446
|
+
/**
|
|
9447
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
9448
|
+
* starts from the beginning.
|
|
9449
|
+
*/
|
|
9450
|
+
cursor?: string;
|
|
9451
|
+
/**
|
|
9452
|
+
* The maximum number of tags to return. The default is '50'.
|
|
9453
|
+
* @format int32
|
|
9454
|
+
*/
|
|
9455
|
+
limit?: number;
|
|
9456
|
+
/**
|
|
9457
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
9458
|
+
* used.
|
|
9459
|
+
*/
|
|
9460
|
+
mode?: ListMode;
|
|
9461
|
+
/** Filters for tags with the provided names. */
|
|
9462
|
+
name?: string[];
|
|
9463
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
9464
|
+
sort_by?: string[];
|
|
9465
|
+
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
9466
|
+
/**
|
|
9467
|
+
* @description Lists the available tags.
|
|
9468
|
+
*
|
|
9469
|
+
* @tags tags
|
|
9470
|
+
* @name TagsListPost
|
|
9471
|
+
* @request POST:/tags.list
|
|
9472
|
+
* @secure
|
|
9473
|
+
*/
|
|
9474
|
+
tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
9475
|
+
/**
|
|
9476
|
+
* @description Updates a tag's information.
|
|
9477
|
+
*
|
|
9478
|
+
* @tags tags
|
|
9479
|
+
* @name TagsUpdate
|
|
9480
|
+
* @request POST:/tags.update
|
|
9481
|
+
* @secure
|
|
9482
|
+
*/
|
|
9483
|
+
tagsUpdate: (data: TagsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsUpdateResponse, any>>;
|
|
7726
9484
|
/**
|
|
7727
9485
|
* @description Creates a new entry on an object's timeline.
|
|
7728
9486
|
*
|
|
@@ -7732,6 +9490,39 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7732
9490
|
* @secure
|
|
7733
9491
|
*/
|
|
7734
9492
|
timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any>>;
|
|
9493
|
+
/**
|
|
9494
|
+
* @description Deletes an entry from an object's timeline.
|
|
9495
|
+
*
|
|
9496
|
+
* @tags timeline-entries
|
|
9497
|
+
* @name TimelineEntriesDelete
|
|
9498
|
+
* @request POST:/timeline-entries.delete
|
|
9499
|
+
* @secure
|
|
9500
|
+
*/
|
|
9501
|
+
timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
9502
|
+
/**
|
|
9503
|
+
* @description Gets an entry on an object's timeline.
|
|
9504
|
+
*
|
|
9505
|
+
* @tags timeline-entries
|
|
9506
|
+
* @name TimelineEntriesGet
|
|
9507
|
+
* @request GET:/timeline-entries.get
|
|
9508
|
+
* @secure
|
|
9509
|
+
*/
|
|
9510
|
+
timelineEntriesGet: (query: {
|
|
9511
|
+
/**
|
|
9512
|
+
* The ID of the timeline entry to get.
|
|
9513
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
9514
|
+
*/
|
|
9515
|
+
id: string;
|
|
9516
|
+
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
9517
|
+
/**
|
|
9518
|
+
* @description Gets an entry on an object's timeline.
|
|
9519
|
+
*
|
|
9520
|
+
* @tags timeline-entries
|
|
9521
|
+
* @name TimelineEntriesGetPost
|
|
9522
|
+
* @request POST:/timeline-entries.get
|
|
9523
|
+
* @secure
|
|
9524
|
+
*/
|
|
9525
|
+
timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
7735
9526
|
/**
|
|
7736
9527
|
* @description Lists the timeline entries for an object.
|
|
7737
9528
|
*
|
|
@@ -7908,6 +9699,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7908
9699
|
* @secure
|
|
7909
9700
|
*/
|
|
7910
9701
|
uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
|
|
9702
|
+
/**
|
|
9703
|
+
* @description Creates a new webhook target.
|
|
9704
|
+
*
|
|
9705
|
+
* @tags webhooks
|
|
9706
|
+
* @name WebhooksCreate
|
|
9707
|
+
* @request POST:/webhooks.create
|
|
9708
|
+
* @secure
|
|
9709
|
+
*/
|
|
9710
|
+
webhooksCreate: (data: WebhooksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksCreateResponse, any>>;
|
|
9711
|
+
/**
|
|
9712
|
+
* @description Deletes the requested webhook.
|
|
9713
|
+
*
|
|
9714
|
+
* @tags webhooks
|
|
9715
|
+
* @name WebhooksDelete
|
|
9716
|
+
* @request POST:/webhooks.delete
|
|
9717
|
+
* @secure
|
|
9718
|
+
*/
|
|
9719
|
+
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
9720
|
+
/**
|
|
9721
|
+
* @description Gets the requested webhook's information.
|
|
9722
|
+
*
|
|
9723
|
+
* @tags webhooks
|
|
9724
|
+
* @name WebhooksGet
|
|
9725
|
+
* @request GET:/webhooks.get
|
|
9726
|
+
* @secure
|
|
9727
|
+
*/
|
|
9728
|
+
webhooksGet: (query: {
|
|
9729
|
+
/**
|
|
9730
|
+
* ID for the webhook.
|
|
9731
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
9732
|
+
*/
|
|
9733
|
+
id: string;
|
|
9734
|
+
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
9735
|
+
/**
|
|
9736
|
+
* @description Gets the requested webhook's information.
|
|
9737
|
+
*
|
|
9738
|
+
* @tags webhooks
|
|
9739
|
+
* @name WebhooksGetPost
|
|
9740
|
+
* @request POST:/webhooks.get
|
|
9741
|
+
* @secure
|
|
9742
|
+
*/
|
|
9743
|
+
webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
|
|
9744
|
+
/**
|
|
9745
|
+
* @description Lists the webhooks.
|
|
9746
|
+
*
|
|
9747
|
+
* @tags webhooks
|
|
9748
|
+
* @name WebhooksList
|
|
9749
|
+
* @request GET:/webhooks.list
|
|
9750
|
+
* @secure
|
|
9751
|
+
*/
|
|
9752
|
+
webhooksList: (params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
9753
|
+
/**
|
|
9754
|
+
* @description Lists the webhooks.
|
|
9755
|
+
*
|
|
9756
|
+
* @tags webhooks
|
|
9757
|
+
* @name WebhooksListPost
|
|
9758
|
+
* @request POST:/webhooks.list
|
|
9759
|
+
* @secure
|
|
9760
|
+
*/
|
|
9761
|
+
webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
|
|
9762
|
+
/**
|
|
9763
|
+
* @description Updates the requested webhook.
|
|
9764
|
+
*
|
|
9765
|
+
* @tags webhooks
|
|
9766
|
+
* @name WebhooksUpdate
|
|
9767
|
+
* @request POST:/webhooks.update
|
|
9768
|
+
* @secure
|
|
9769
|
+
*/
|
|
9770
|
+
webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any>>;
|
|
7911
9771
|
/**
|
|
7912
9772
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
7913
9773
|
*
|
|
@@ -7953,8 +9813,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7953
9813
|
* @format int32
|
|
7954
9814
|
*/
|
|
7955
9815
|
first?: number;
|
|
9816
|
+
/**
|
|
9817
|
+
* Filters for issues with any of the provided Accounts.
|
|
9818
|
+
* @example ["ACC-12345"]
|
|
9819
|
+
*/
|
|
9820
|
+
'issue.accounts'?: string[];
|
|
7956
9821
|
/** Filters for issues with any of the provided priorities. */
|
|
7957
9822
|
'issue.priority'?: IssuePriority[];
|
|
9823
|
+
/** Filters for issues with any of the provided priority enum ids. */
|
|
9824
|
+
'issue.priority_v2'?: number[];
|
|
7958
9825
|
/**
|
|
7959
9826
|
* Filters for issues with any of the provided Rev organizations.
|
|
7960
9827
|
* @example ["REV-AbCdEfGh"]
|
|
@@ -8061,8 +9928,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8061
9928
|
cursor?: string;
|
|
8062
9929
|
/** Filters for custom fields. */
|
|
8063
9930
|
custom_fields?: object;
|
|
9931
|
+
/**
|
|
9932
|
+
* Filters for issues with any of the provided Accounts.
|
|
9933
|
+
* @example ["ACC-12345"]
|
|
9934
|
+
*/
|
|
9935
|
+
'issue.accounts'?: string[];
|
|
8064
9936
|
/** Filters for issues with any of the provided priorities. */
|
|
8065
9937
|
'issue.priority'?: IssuePriority[];
|
|
9938
|
+
/** Filters for issues with any of the provided priority enum ids. */
|
|
9939
|
+
'issue.priority_v2'?: number[];
|
|
8066
9940
|
/**
|
|
8067
9941
|
* Filters for issues with any of the provided Rev organizations.
|
|
8068
9942
|
* @example ["REV-AbCdEfGh"]
|