@devrev/typescript-sdk 1.1.21 → 1.1.23

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.
@@ -109,6 +109,8 @@ export interface AccountsExportRequest {
109
109
  created_date?: DateTimeFilter;
110
110
  /** Filters for custom fields. */
111
111
  custom_fields?: object;
112
+ /** Array of display names of accounts to be filtered. */
113
+ display_name?: string[];
112
114
  /** Domains for accounts to be filtered. */
113
115
  domains?: string[];
114
116
  /** Array of references of accounts to be filtered. */
@@ -138,6 +140,27 @@ export interface AccountsExportResponse {
138
140
  /** The exported accounts. */
139
141
  accounts: Account[];
140
142
  }
143
+ /** accounts-filters */
144
+ export interface AccountsFilters {
145
+ /** Filters for accounts created by the specified user(s). */
146
+ created_by?: string[];
147
+ created_date?: DateTimeFilter;
148
+ /** Filters for custom fields. */
149
+ custom_fields?: object;
150
+ /** Array of display names of accounts to be filtered. */
151
+ display_name?: string[];
152
+ /** Domains for accounts to be filtered. */
153
+ domains?: string[];
154
+ /** Array of references of accounts to be filtered. */
155
+ external_refs?: string[];
156
+ modified_date?: DateTimeFilter;
157
+ /** Filters for accounts owned by the specified user(s). */
158
+ owned_by?: string[];
159
+ /** Filters for accounts on specified stages. */
160
+ stage?: string[];
161
+ /** List of tags to be filtered. */
162
+ tags?: string[];
163
+ }
141
164
  /**
142
165
  * accounts-get-request
143
166
  * Request object to get an account's information.
@@ -171,6 +194,8 @@ export interface AccountsListRequest {
171
194
  cursor?: string;
172
195
  /** Filters for custom fields. */
173
196
  custom_fields?: object;
197
+ /** Array of display names of accounts to be filtered. */
198
+ display_name?: string[];
174
199
  /** Domains for accounts to be filtered. */
175
200
  domains?: string[];
176
201
  /** Array of references of accounts to be filtered. */
@@ -354,7 +379,12 @@ export declare enum AggregationDetailAggregationType {
354
379
  UniqueCount = "unique_count"
355
380
  }
356
381
  /** app-fragment */
357
- export type AppFragment = CustomSchemaFragmentBase;
382
+ export type AppFragment = CustomSchemaFragmentBase & {
383
+ /** App this fragment applies to. */
384
+ app?: string;
385
+ };
386
+ /** app-fragment-summary */
387
+ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
358
388
  /** article */
359
389
  export type Article = AtomBase & {
360
390
  /** Details of the parts relevant to the article. */
@@ -363,6 +393,9 @@ export type Article = AtomBase & {
363
393
  description?: string;
364
394
  /** Artifacts containing the extracted content. */
365
395
  extracted_content?: ArtifactSummary[];
396
+ parent?: DirectorySummary;
397
+ /** Rank of the article. */
398
+ rank?: string;
366
399
  /** Resource details. */
367
400
  resource?: Resource;
368
401
  /** Title of the article. */
@@ -397,6 +430,8 @@ export interface ArticlesCountRequest {
397
430
  * @example ["DEVU-12345"]
398
431
  */
399
432
  owned_by?: string[];
433
+ /** Filter for articles based on intended audience. */
434
+ shared_with?: SharedWithMembershipFilter[];
400
435
  }
401
436
  /** articles-count-response */
402
437
  export interface ArticlesCountResponse {
@@ -437,6 +472,8 @@ export interface ArticlesCreateRequest {
437
472
  * @example ["DEVU-12345"]
438
473
  */
439
474
  owned_by: string[];
475
+ /** The parent directory of the article. */
476
+ parent?: string;
440
477
  /**
441
478
  * The published date of the article.
442
479
  * @format date-time
@@ -444,6 +481,8 @@ export interface ArticlesCreateRequest {
444
481
  */
445
482
  published_at?: string;
446
483
  resource: ArticlesCreateRequestResource;
484
+ /** Information about the role the member receives due to the share. */
485
+ shared_with?: SharedWithMembership[];
447
486
  /** Status of the article. */
448
487
  status?: ArticleStatus;
449
488
  /** Tags associated with the article. */
@@ -544,6 +583,8 @@ export interface ArticlesListRequest {
544
583
  * @example ["DEVU-12345"]
545
584
  */
546
585
  owned_by?: string[];
586
+ /** Filter for articles based on intended audience. */
587
+ shared_with?: SharedWithMembershipFilter[];
547
588
  }
548
589
  /**
549
590
  * articles-list-response
@@ -591,8 +632,12 @@ export interface ArticlesUpdateRequest {
591
632
  /** Updates the language of the article. */
592
633
  language?: string;
593
634
  owned_by?: ArticlesUpdateRequestOwnedBy;
635
+ /** The updated parent directory for the article. */
636
+ parent?: string | null;
594
637
  /** Updates the the latest published version. */
595
638
  published_version?: string;
639
+ reorder?: ArticlesUpdateRequestReorder;
640
+ shared_with?: ArticlesUpdateRequestSharedWith;
596
641
  /** Status of the article. */
597
642
  status?: ArticleStatus;
598
643
  tags?: ArticlesUpdateRequestTags;
@@ -642,6 +687,24 @@ export interface ArticlesUpdateRequestOwnedBy {
642
687
  */
643
688
  set?: string[];
644
689
  }
690
+ /** articles-update-request-reorder */
691
+ export interface ArticlesUpdateRequestReorder {
692
+ /**
693
+ * The article after which the reordered article is placed.
694
+ * @example "ARTICLE-12345"
695
+ */
696
+ after?: string;
697
+ /**
698
+ * The article before which the reordered article is placed.
699
+ * @example "ARTICLE-12345"
700
+ */
701
+ before?: string;
702
+ }
703
+ /** articles-update-request-shared-with */
704
+ export interface ArticlesUpdateRequestSharedWith {
705
+ /** Sets the field to the provided membership list. */
706
+ set?: SharedWithMembership[];
707
+ }
645
708
  /** articles-update-request-tags */
646
709
  export interface ArticlesUpdateRequestTags {
647
710
  /** Sets the provided tags on the article. */
@@ -651,8 +714,90 @@ export interface ArticlesUpdateRequestTags {
651
714
  export interface ArticlesUpdateResponse {
652
715
  article: Article;
653
716
  }
717
+ /** artifact */
718
+ export type Artifact = AtomBase;
654
719
  /** artifact-summary */
655
720
  export type ArtifactSummary = AtomBaseSummary;
721
+ /**
722
+ * artifact-version
723
+ * The version of the artifact.
724
+ */
725
+ export interface ArtifactVersion {
726
+ modified_by?: UserSummary;
727
+ /**
728
+ * The timestamp at which the version was created.
729
+ * @format date-time
730
+ * @example "2023-01-01T12:00:00.000Z"
731
+ */
732
+ timestamp: string;
733
+ /** The version of the artifact. */
734
+ version: string;
735
+ }
736
+ /**
737
+ * artifacts-get-request
738
+ * The request to get an artifact's information.
739
+ */
740
+ export interface ArtifactsGetRequest {
741
+ /**
742
+ * The requested artifact's ID.
743
+ * @example "ARTIFACT-12345"
744
+ */
745
+ id: string;
746
+ /** The version of the artifact that needs to be fetched. */
747
+ version?: string;
748
+ }
749
+ /**
750
+ * artifacts-get-response
751
+ * The response to getting an artifact's information.
752
+ */
753
+ export interface ArtifactsGetResponse {
754
+ artifact: Artifact;
755
+ /** The version of the artifact. */
756
+ version: ArtifactVersion;
757
+ }
758
+ /**
759
+ * artifacts-list-request
760
+ * The request to list artifacts attached to an object.
761
+ */
762
+ export interface ArtifactsListRequest {
763
+ /** The ID of the object to filter artifacts. */
764
+ parent_id: string;
765
+ }
766
+ /**
767
+ * artifacts-list-response
768
+ * The response to list artifacts attached to an object.
769
+ */
770
+ export interface ArtifactsListResponse {
771
+ /** The artifact's information. */
772
+ artifacts: Artifact[];
773
+ }
774
+ /**
775
+ * artifacts-locate-request
776
+ * The request to get an artifact's download URL.
777
+ */
778
+ export interface ArtifactsLocateRequest {
779
+ /**
780
+ * The ID of the artifact to get the URL for.
781
+ * @example "ARTIFACT-12345"
782
+ */
783
+ id: string;
784
+ /** The version of the artifact that needs to be fetched. */
785
+ version?: string;
786
+ }
787
+ /**
788
+ * artifacts-locate-response
789
+ * The response to getting an artifact's download URL.
790
+ */
791
+ export interface ArtifactsLocateResponse {
792
+ /**
793
+ * The expiration timestamp of the URL.
794
+ * @format date-time
795
+ * @example "2023-01-01T12:00:00.000Z"
796
+ */
797
+ expires_at?: string;
798
+ /** The artifact's download URL. */
799
+ url: string;
800
+ }
656
801
  /**
657
802
  * artifacts-prepare-request
658
803
  * The request to prepare a URL to upload a file.
@@ -741,6 +886,421 @@ export interface AtomBaseSummary {
741
886
  /** Globally unique object ID. */
742
887
  id: string;
743
888
  }
889
+ /** atom-summary */
890
+ export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
891
+ type: AtomType;
892
+ };
893
+ export declare enum AtomType {
894
+ Account = "account",
895
+ AppFragment = "app_fragment",
896
+ Capability = "capability",
897
+ Conversation = "conversation",
898
+ CustomTypeFragment = "custom_type_fragment",
899
+ DevUser = "dev_user",
900
+ Engagement = "engagement",
901
+ Enhancement = "enhancement",
902
+ Feature = "feature",
903
+ Issue = "issue",
904
+ Meeting = "meeting",
905
+ Opportunity = "opportunity",
906
+ Product = "product",
907
+ RevOrg = "rev_org",
908
+ RevUser = "rev_user",
909
+ ServiceAccount = "service_account",
910
+ SysUser = "sys_user",
911
+ Tag = "tag",
912
+ Task = "task",
913
+ TenantFragment = "tenant_fragment",
914
+ Ticket = "ticket",
915
+ TimelineComment = "timeline_comment",
916
+ Webhook = "webhook"
917
+ }
918
+ /**
919
+ * auth-connection
920
+ * Connection object that specifies the configuration for an
921
+ * authentication connection that is set up for a Dev organization.
922
+ */
923
+ export type AuthConnection = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | AuthConnectionOptionsSocial) & {
924
+ /**
925
+ * Display name of the authentication connection. This name will be
926
+ * visible to all the users when they sign in to this Dev
927
+ * organization. For example, if the display_name is 'abclogin', then
928
+ * it would appear on the login button as 'Log in to abclogin'.
929
+ */
930
+ display_name?: string;
931
+ /**
932
+ * Whether the authentication connection is enabled or disabled. If
933
+ * set to false, the authentication connection will not show up on the
934
+ * login screen as a login option.
935
+ */
936
+ enabled?: boolean;
937
+ /** ID of the authentication connection. */
938
+ id: string;
939
+ /**
940
+ * Defines the type for the authentication connection. The configuration
941
+ * for each authentication connection will depend on the type value.
942
+ */
943
+ type: AuthConnectionType;
944
+ };
945
+ /**
946
+ * auth-connection-options-azure-ad
947
+ * Object encapsulating the configuration parameters for an Azure AD
948
+ * authentication connection.
949
+ */
950
+ export interface AuthConnectionOptionsAzureAd {
951
+ /** Client ID for the Azure authentication connection. */
952
+ client_id?: string;
953
+ /** Client secret for the Azure authentication connection. */
954
+ client_secret?: string;
955
+ /** Domain URL of the Azure authentication connection. */
956
+ domain?: string;
957
+ }
958
+ /**
959
+ * auth-connection-options-google-apps
960
+ * Object encapsulating the configuration parameters for a Google Apps
961
+ * authentication connection.
962
+ */
963
+ export interface AuthConnectionOptionsGoogleApps {
964
+ /** Client ID for the Google Apps authentication connection. */
965
+ client_id?: string;
966
+ /** Client secret for the Google Apps authentication connection. */
967
+ client_secret?: string;
968
+ /** Tenant domain URL of the Google Apps authentication connection. */
969
+ tenant_domain?: string;
970
+ }
971
+ /**
972
+ * auth-connection-options-oidc
973
+ * Object encapsulating the configuration parameters for an OIDC
974
+ * authentication connection.
975
+ */
976
+ export interface AuthConnectionOptionsOidc {
977
+ /** Client ID for the OIDC authentication connection. */
978
+ client_id?: string;
979
+ /** Client secret for the OIDC authentication connection. */
980
+ client_secret?: string;
981
+ /** Issuer URL of the OIDC authentication connection. */
982
+ issuer?: string;
983
+ }
984
+ /**
985
+ * auth-connection-options-saml
986
+ * Object encapsulating the configuration parameters for a SAML
987
+ * authentication connection.
988
+ */
989
+ export interface AuthConnectionOptionsSaml {
990
+ /** Sign In endpoint for the SAML authentication connection. */
991
+ sign_in_endpoint?: string;
992
+ /** Signing certificate for the SAML authentication connection. */
993
+ signing_cert?: string;
994
+ }
995
+ /** auth-connection-options-social */
996
+ export type AuthConnectionOptionsSocial = object;
997
+ export declare enum AuthConnectionToggle {
998
+ Disable = "disable",
999
+ Enable = "enable"
1000
+ }
1001
+ /**
1002
+ * Defines the type for the authentication connection. The configuration
1003
+ * for each authentication connection will depend on the type value.
1004
+ */
1005
+ export declare enum AuthConnectionType {
1006
+ GoogleApps = "google_apps",
1007
+ Oidc = "oidc",
1008
+ Samlp = "samlp",
1009
+ Social = "social",
1010
+ Waad = "waad"
1011
+ }
1012
+ /** auth-token */
1013
+ export type AuthToken = AtomBase & {
1014
+ /**
1015
+ * An identifier that represents the application that requested the
1016
+ * token. Only applicable for application access tokens.
1017
+ */
1018
+ client_id?: string;
1019
+ /**
1020
+ * The time at which the token expires.
1021
+ * @format date-time
1022
+ * @example "2023-01-01T12:00:00.000Z"
1023
+ */
1024
+ expires_at?: string;
1025
+ /**
1026
+ * The time at which the token was issued.
1027
+ * @format date-time
1028
+ * @example "2023-01-01T12:00:00.000Z"
1029
+ */
1030
+ issued_at?: string;
1031
+ /** The type of the requested token. */
1032
+ requested_token_type?: AuthTokenRequestedTokenType;
1033
+ /** The scopes associated with the issued token. */
1034
+ scopes?: string[];
1035
+ /** The status of the token. */
1036
+ status?: AuthTokenStatus;
1037
+ /** The subject of the token. */
1038
+ subject?: string;
1039
+ /** A hint that identifies the token. */
1040
+ token_hint?: string;
1041
+ };
1042
+ /** Specifies the process of obtaining a token. */
1043
+ export declare enum AuthTokenGrantType {
1044
+ UrnDevrevParamsOauthGrantTypeTokenIssue = "urn:devrev:params:oauth:grant-type:token-issue",
1045
+ UrnIetfParamsOauthGrantTypeTokenExchange = "urn:ietf:params:oauth:grant-type:token-exchange"
1046
+ }
1047
+ /** The type of the requested token. */
1048
+ export declare enum AuthTokenRequestedTokenType {
1049
+ UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
1050
+ UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
1051
+ UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
1052
+ UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
1053
+ UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
1054
+ UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
1055
+ UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
1056
+ UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
1057
+ UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
1058
+ UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
1059
+ UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
1060
+ UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
1061
+ UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
1062
+ UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
1063
+ }
1064
+ /** The status of the token. */
1065
+ export declare enum AuthTokenStatus {
1066
+ Active = "active",
1067
+ Expired = "expired",
1068
+ Revoked = "revoked"
1069
+ }
1070
+ /** The type of the subject token. */
1071
+ export declare enum AuthTokenSubjectTokenType {
1072
+ UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
1073
+ UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
1074
+ UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
1075
+ UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
1076
+ UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
1077
+ UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
1078
+ UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
1079
+ UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
1080
+ UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
1081
+ }
1082
+ /** The type of the issued token. Bearer is the only supported token type. */
1083
+ export declare enum AuthTokenTokenType {
1084
+ Bearer = "bearer"
1085
+ }
1086
+ /**
1087
+ * auth-tokens-create-request
1088
+ * A request to create a new token corresponding to the requested token
1089
+ * type.
1090
+ */
1091
+ export interface AuthTokensCreateRequest {
1092
+ /** The unique ID of the Dev user to impersonate. */
1093
+ act_as?: string;
1094
+ /** The expected audience values with respect to the token. */
1095
+ aud?: string[];
1096
+ /**
1097
+ * An identifier that represents the application which is requesting
1098
+ * the token. If no client_id is present in the request to generate an
1099
+ * application access token (AAT), DevRev will generate a client_id.
1100
+ * This client_id is only associated with an AAT.
1101
+ */
1102
+ client_id?: string;
1103
+ /**
1104
+ * The expected validity lifetime of the token in number of days. In
1105
+ * practice, the value should be based on the usage of the token.
1106
+ * @min 0
1107
+ * @max 4294967295
1108
+ */
1109
+ expires_in?: number;
1110
+ /** Specifies the process of obtaining a token. */
1111
+ grant_type?: AuthTokenGrantType;
1112
+ /** The type of the requested token. */
1113
+ requested_token_type?: AuthTokenRequestedTokenType;
1114
+ /**
1115
+ * Carries info corresponding to the Rev user to be provisioned and/or
1116
+ * issue a Rev session token.
1117
+ */
1118
+ rev_info?: AuthTokensRevInfo;
1119
+ /**
1120
+ * The requested set of scopes associated with the issued token. A
1121
+ * space-delimited list of values in which the order of values does
1122
+ * not matter.
1123
+ */
1124
+ scope?: string;
1125
+ /**
1126
+ * Represents the entity that requests the token. Not required when
1127
+ * requesting an application access token (AAT).
1128
+ */
1129
+ subject_token?: string;
1130
+ /** The type of the subject token. */
1131
+ subject_token_type?: AuthTokenSubjectTokenType;
1132
+ /** A hint that identifies the token. */
1133
+ token_hint?: string;
1134
+ }
1135
+ /**
1136
+ * auth-tokens-create-response
1137
+ * Response for the request to create a new token corresponding to the
1138
+ * requested token type.
1139
+ */
1140
+ export interface AuthTokensCreateResponse {
1141
+ /**
1142
+ * The issued JSON Web Token (JWT) corresponding to the requested
1143
+ * token type.
1144
+ */
1145
+ access_token: string;
1146
+ /**
1147
+ * An identifier that represents the application which is requesting
1148
+ * the token. Only present in a response corresponding to an
1149
+ * application access token (AAT).
1150
+ */
1151
+ client_id?: string;
1152
+ /**
1153
+ * The validity lifetime of the token specified in seconds since Unix
1154
+ * epoch.
1155
+ * @format int64
1156
+ */
1157
+ expires_in: number;
1158
+ /** A token to refresh the issued token. */
1159
+ refresh_token?: string;
1160
+ /**
1161
+ * The scopes associated with the issued token. A space-delimited list
1162
+ * of values in which the order of values does not matter.
1163
+ */
1164
+ scope?: string;
1165
+ /** The type of the issued token. Bearer is the only supported token type. */
1166
+ token_type: AuthTokenTokenType;
1167
+ }
1168
+ /**
1169
+ * auth-tokens-delete-request
1170
+ * The request to revoke the token.
1171
+ */
1172
+ export interface AuthTokensDeleteRequest {
1173
+ /**
1174
+ * The unique identifier for the token under a given Dev organization.
1175
+ * If no token ID is provided, then the token ID will be set from the
1176
+ * JTI claim of the token in the authorization header.
1177
+ */
1178
+ token_id?: string;
1179
+ }
1180
+ /**
1181
+ * auth-tokens-get-request
1182
+ * The request to get the token metadata.
1183
+ */
1184
+ export interface AuthTokensGetRequest {
1185
+ /** The unique identifier of the token under a given Dev organization. */
1186
+ token_id: string;
1187
+ }
1188
+ /**
1189
+ * auth-tokens-get-response
1190
+ * The response to get the token metadata.
1191
+ */
1192
+ export interface AuthTokensGetResponse {
1193
+ token: AuthToken;
1194
+ }
1195
+ /**
1196
+ * auth-tokens-list-request
1197
+ * A request to list the token metadata.
1198
+ */
1199
+ export interface AuthTokensListRequest {
1200
+ /**
1201
+ * An identifier that represents the application, which requested the
1202
+ * token. Only relevant for application access tokens.
1203
+ */
1204
+ client_id?: string;
1205
+ /** The type of the requested token. */
1206
+ requested_token_type?: AuthTokenRequestedTokenType;
1207
+ /**
1208
+ * The subject associated with the token. In the absence of this
1209
+ * parameter, the ID of the authenticated entity is treated as the
1210
+ * subject.
1211
+ */
1212
+ subject?: string;
1213
+ }
1214
+ /**
1215
+ * auth-tokens-list-response
1216
+ * The response to list the token metadata.
1217
+ */
1218
+ export interface AuthTokensListResponse {
1219
+ /** The list of token metadata. */
1220
+ tokens: AuthToken[];
1221
+ }
1222
+ /**
1223
+ * auth-tokens-org-traits
1224
+ * Carries Rev org info.
1225
+ */
1226
+ export interface AuthTokensOrgTraits {
1227
+ /** Application-defined custom fields of the Rev org. */
1228
+ custom_fields?: object;
1229
+ /** The description of the Rev org. */
1230
+ description?: string;
1231
+ /** The display name of the Rev org. */
1232
+ display_name?: string;
1233
+ /** The domain of the Rev org. */
1234
+ domain?: string;
1235
+ /** Phone numbers of the Rev org. */
1236
+ phone_numbers?: string[];
1237
+ /** The tier of the Rev org. */
1238
+ tier?: string;
1239
+ }
1240
+ /**
1241
+ * auth-tokens-rev-info
1242
+ * Carries info corresponding to the Rev user to be provisioned and/or
1243
+ * issue a Rev session token.
1244
+ */
1245
+ export interface AuthTokensRevInfo {
1246
+ /** An identifier which uniquely identifies a Rev org. */
1247
+ org_ref?: string;
1248
+ /** Carries Rev org info. */
1249
+ org_traits?: AuthTokensOrgTraits;
1250
+ /** The unique ID of the Rev user. */
1251
+ user_id?: string;
1252
+ /** An identifier which uniquely identifies a Rev user. */
1253
+ user_ref?: string;
1254
+ /** Carries Rev user info. */
1255
+ user_traits?: AuthTokensUserTraits;
1256
+ }
1257
+ /**
1258
+ * auth-tokens-self-delete-request
1259
+ * The request to delete all the tokens created by the authenticated user,
1260
+ * that match with the provided token type.
1261
+ */
1262
+ export interface AuthTokensSelfDeleteRequest {
1263
+ /** The type of the requested token. */
1264
+ requested_token_type?: AuthTokenRequestedTokenType;
1265
+ }
1266
+ /**
1267
+ * auth-tokens-update-request
1268
+ * A request to update the token metadata.
1269
+ */
1270
+ export interface AuthTokensUpdateRequest {
1271
+ /** A hint that identifies the token. */
1272
+ token_hint: string;
1273
+ /** The unique identifier of the token under a given Dev organization. */
1274
+ token_id: string;
1275
+ }
1276
+ /**
1277
+ * auth-tokens-update-response
1278
+ * Response for the request to update the token metadata.
1279
+ */
1280
+ export interface AuthTokensUpdateResponse {
1281
+ token: AuthToken;
1282
+ }
1283
+ /**
1284
+ * auth-tokens-user-traits
1285
+ * Carries Rev user info.
1286
+ */
1287
+ export interface AuthTokensUserTraits {
1288
+ /** Application-defined custom fields of the Rev user. */
1289
+ custom_fields?: object;
1290
+ /** The description of the Rev user. */
1291
+ description?: string;
1292
+ /** The display name of the Rev user. */
1293
+ display_name?: string;
1294
+ /** The email address of the Rev user. */
1295
+ email?: string;
1296
+ /**
1297
+ * The full name of the Rev user.
1298
+ * @deprecated
1299
+ */
1300
+ full_name?: string;
1301
+ /** Phone numbers of the Rev user. */
1302
+ phone_numbers?: string[];
1303
+ }
744
1304
  /** capability */
745
1305
  export type Capability = PartBase;
746
1306
  /** capability-summary */
@@ -753,12 +1313,16 @@ export type CodeChange = AtomBase & {
753
1313
  description?: string;
754
1314
  /** Unique external identifier for this change.e.g Pull Request URL. */
755
1315
  external_identifier?: string;
1316
+ /** Details of lines of code in this code change. */
1317
+ filtered_loc?: LinesOfCode;
756
1318
  /** URL pointing to the repo this change was on. */
757
1319
  repo_url?: string;
758
1320
  /** Source of the code change object. */
759
1321
  source?: CodeChangeSource;
760
1322
  /** Title describing in brief the contents of this change. */
761
1323
  title?: string;
1324
+ /** Details of lines of code in this code change. */
1325
+ total_loc?: LinesOfCode;
762
1326
  };
763
1327
  /** Source of the code change object. */
764
1328
  export declare enum CodeChangeSource {
@@ -1194,14 +1758,42 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
1194
1758
  };
1195
1759
  /** custom-schema-fragment-base */
1196
1760
  export type CustomSchemaFragmentBase = AtomBase & {
1761
+ /** The conditions associated with the fields. */
1762
+ conditions?: CustomSchemaFragmentCondition[];
1763
+ /**
1764
+ * Indicates if the fragment has been deprecated. Modifications to
1765
+ * this field are done in-place and don't result in creation of a new
1766
+ * fragment in chain.
1767
+ */
1768
+ deprecated?: boolean;
1769
+ /** Description of the custom schema fragment. */
1770
+ description?: string;
1197
1771
  /** List of all fields in this custom schema fragment. */
1198
1772
  fields?: SchemaFieldDescriptor[];
1773
+ /** Type of the custom schema fragment. */
1774
+ fragment_type?: CustomSchemaFragmentFragmentType;
1775
+ /** Leaf type this fragment applies to. */
1776
+ leaf_type?: string;
1777
+ new_fragment_ref?: CustomSchemaFragmentSummary;
1778
+ old_fragment_ref?: CustomSchemaFragmentSummary;
1199
1779
  };
1780
+ /** custom-schema-fragment-base-summary */
1781
+ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
1200
1782
  /**
1201
1783
  * custom-schema-fragment-condition
1202
1784
  * The condition associated with a field.
1203
1785
  */
1204
1786
  export type CustomSchemaFragmentCondition = object;
1787
+ /** Type of the custom schema fragment. */
1788
+ export declare enum CustomSchemaFragmentFragmentType {
1789
+ App = "app",
1790
+ CustomType = "custom_type",
1791
+ Tenant = "tenant"
1792
+ }
1793
+ /** custom-schema-fragment-summary */
1794
+ export type CustomSchemaFragmentSummary = (AppFragmentSummary | CustomTypeFragmentSummary | TenantFragmentSummary) & {
1795
+ type: CustomSchemaFragmentType;
1796
+ };
1205
1797
  export declare enum CustomSchemaFragmentType {
1206
1798
  AppFragment = "app_fragment",
1207
1799
  CustomTypeFragment = "custom_type_fragment",
@@ -1281,15 +1873,16 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
1281
1873
  path?: CustomTypePathComponent[];
1282
1874
  /** The ID of the associated custom stage diagram. */
1283
1875
  stage_diagram?: string;
1284
- /** List of stock field enum overrides. */
1285
- stock_field_uenum_overrides?: StockFieldUenumOverride[];
1286
1876
  /** The string used to populate the subtype in the leaf type. */
1287
1877
  subtype: string;
1288
1878
  /** The display name of the subtype. */
1289
1879
  subtype_display_name?: string;
1290
1880
  }
1291
1881
  /** custom-schema-fragments-set-request-tenant-fragment */
1292
- export type CustomSchemaFragmentsSetRequestTenantFragment = object;
1882
+ export interface CustomSchemaFragmentsSetRequestTenantFragment {
1883
+ /** List of Per-DevOrg stock field overrides. */
1884
+ stock_field_overrides?: StockFieldOverride[];
1885
+ }
1293
1886
  export declare enum CustomSchemaFragmentsSetRequestType {
1294
1887
  AppFragment = "app_fragment",
1295
1888
  CustomTypeFragment = "custom_type_fragment",
@@ -1301,7 +1894,18 @@ export interface CustomSchemaFragmentsSetResponse {
1301
1894
  id: string;
1302
1895
  }
1303
1896
  /** custom-type-fragment */
1304
- export type CustomTypeFragment = CustomSchemaFragmentBase;
1897
+ export type CustomTypeFragment = CustomSchemaFragmentBase & {
1898
+ stage_diagram?: StageDiagramSummary;
1899
+ /** The string used to populate the subtype in the leaf type. */
1900
+ subtype?: string;
1901
+ /**
1902
+ * Display name of the subtype. Modifications to this field are done
1903
+ * in-place and don't result in creation of a new fragment in chain.
1904
+ */
1905
+ subtype_display_name?: string;
1906
+ };
1907
+ /** custom-type-fragment-summary */
1908
+ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
1305
1909
  /**
1306
1910
  * custom-type-path-component
1307
1911
  * Path component for rendering custom type lists in tree form.
@@ -1328,50 +1932,285 @@ export interface DateTimeFilter {
1328
1932
  * @format date-time
1329
1933
  * @example "2023-01-01T12:00:00.000Z"
1330
1934
  */
1331
- after?: string;
1935
+ after?: string;
1936
+ /**
1937
+ * Filters for objects created before the provided timestamp
1938
+ * (inclusive).
1939
+ * @format date-time
1940
+ * @example "2023-01-01T12:00:00.000Z"
1941
+ */
1942
+ before?: string;
1943
+ }
1944
+ /**
1945
+ * date-time-preset
1946
+ * Provides preset types for date filter.
1947
+ */
1948
+ export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
1949
+ /** Type of date preset. */
1950
+ preset_type: DateTimePresetType;
1951
+ };
1952
+ /** date-time-preset-last-n-days */
1953
+ export interface DateTimePresetLastNDays {
1954
+ /**
1955
+ * The range starts from the current timestamp and continues for the
1956
+ * past n days.
1957
+ * @min 0
1958
+ * @max 4294967295
1959
+ */
1960
+ days: number;
1961
+ }
1962
+ /** date-time-preset-next-n-days */
1963
+ export interface DateTimePresetNextNDays {
1964
+ /**
1965
+ * The range starts from the current timestamp and continues for the
1966
+ * next n days.
1967
+ * @min 0
1968
+ * @max 4294967295
1969
+ */
1970
+ days: number;
1971
+ }
1972
+ /** Type of date preset. */
1973
+ export declare enum DateTimePresetType {
1974
+ LastNDays = "last_n_days",
1975
+ NextNDays = "next_n_days"
1976
+ }
1977
+ /**
1978
+ * dev-org-auth-connections-create-request
1979
+ * Request to create a new enterprise authentication connection.
1980
+ */
1981
+ export type DevOrgAuthConnectionsCreateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
1982
+ /**
1983
+ * Display name of the authentication connection. This name will be
1984
+ * visible to all the users when they sign in to this Dev
1985
+ * organization. For example, if the display_name is 'abclogin', then
1986
+ * it would appear on the login button as 'Log in to abclogin'.
1987
+ */
1988
+ display_name?: string;
1989
+ /**
1990
+ * Defines the type for the authentication connection. Different types of
1991
+ * authentication connections have different configuration parameters.
1992
+ */
1993
+ type: DevOrgAuthConnectionsCreateRequestType;
1994
+ };
1995
+ /**
1996
+ * Defines the type for the authentication connection. Different types of
1997
+ * authentication connections have different configuration parameters.
1998
+ */
1999
+ export declare enum DevOrgAuthConnectionsCreateRequestType {
2000
+ GoogleApps = "google_apps",
2001
+ Oidc = "oidc",
2002
+ Samlp = "samlp",
2003
+ Waad = "waad"
2004
+ }
2005
+ /**
2006
+ * dev-org-auth-connections-create-response
2007
+ * Response for the request to create a new enterprise authentication
2008
+ * connection.
2009
+ */
2010
+ export interface DevOrgAuthConnectionsCreateResponse {
2011
+ /**
2012
+ * Connection object that specifies the configuration for an
2013
+ * authentication connection that is set up for a Dev organization.
2014
+ */
2015
+ auth_connection: AuthConnection;
2016
+ }
2017
+ /**
2018
+ * dev-org-auth-connections-delete-request
2019
+ * Request to delete an enterprise authentication connection for a Dev
2020
+ * organization. A default connection and a connection which is currently
2021
+ * enabled cannot be deleted.
2022
+ */
2023
+ export interface DevOrgAuthConnectionsDeleteRequest {
2024
+ /** ID of the authentication connection to be deleted. */
2025
+ id: string;
2026
+ }
2027
+ /**
2028
+ * dev-org-auth-connections-get-request
2029
+ * Request to get configuration details of organization's authentication
2030
+ * Connection.
2031
+ */
2032
+ export interface DevOrgAuthConnectionsGetRequest {
2033
+ /** ID of the authentication connection. */
2034
+ id: string;
2035
+ }
2036
+ /**
2037
+ * dev-org-auth-connections-get-response
2038
+ * Response object encapsulating the configuration details of an
2039
+ * authentication connection.
2040
+ */
2041
+ export interface DevOrgAuthConnectionsGetResponse {
2042
+ /**
2043
+ * Connection object that specifies the configuration for an
2044
+ * authentication connection that is set up for a Dev organization.
2045
+ */
2046
+ auth_connection: AuthConnection;
2047
+ }
2048
+ /**
2049
+ * dev-org-auth-connections-list-response
2050
+ * Response object for the request to list all the social and enterprise
2051
+ * authentication connections configured for a Dev organization.
2052
+ */
2053
+ export interface DevOrgAuthConnectionsListResponse {
2054
+ /**
2055
+ * List of all the authentication connections currently configured for
2056
+ * a Dev organization.
2057
+ */
2058
+ auth_connections: AuthConnection[];
2059
+ }
2060
+ /**
2061
+ * dev-org-auth-connections-toggle-request
2062
+ * Request to enable or disable an authentication connection for a Dev
2063
+ * organization.
2064
+ */
2065
+ export interface DevOrgAuthConnectionsToggleRequest {
2066
+ /** ID of the authentication connection to be toggled. */
2067
+ id: string;
2068
+ toggle?: AuthConnectionToggle;
2069
+ }
2070
+ /**
2071
+ * dev-org-auth-connections-update-request
2072
+ * Request to update an enterprise authentication connection for a Dev
2073
+ * organization.
2074
+ */
2075
+ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
2076
+ /**
2077
+ * New display name of the authentication connection. This name will
2078
+ * be visible to all the users when they sign in to this Dev
2079
+ * organization. For example, if the display_name is 'abclogin', then
2080
+ * it would appear on the login button as 'Log in to abclogin'.
2081
+ */
2082
+ display_name?: string;
2083
+ /** ID of the authentication connection which is to be updated. */
2084
+ id: string;
2085
+ /**
2086
+ * Specifies the type for the authentication connection. Different types
2087
+ * of authentication connections have different configuration parameters
2088
+ * that can be updated.
2089
+ */
2090
+ type?: DevOrgAuthConnectionsUpdateRequestType;
2091
+ };
2092
+ /**
2093
+ * Specifies the type for the authentication connection. Different types
2094
+ * of authentication connections have different configuration parameters
2095
+ * that can be updated.
2096
+ */
2097
+ export declare enum DevOrgAuthConnectionsUpdateRequestType {
2098
+ GoogleApps = "google_apps",
2099
+ None = "none",
2100
+ Oidc = "oidc",
2101
+ Samlp = "samlp",
2102
+ Waad = "waad"
2103
+ }
2104
+ /**
2105
+ * dev-org-auth-connections-update-response
2106
+ * Response for the request to update an enterprise authentication
2107
+ * connection.
2108
+ */
2109
+ export interface DevOrgAuthConnectionsUpdateResponse {
2110
+ /**
2111
+ * Connection object that specifies the configuration for an
2112
+ * authentication connection that is set up for a Dev organization.
2113
+ */
2114
+ auth_connection: AuthConnection;
2115
+ }
2116
+ /** dev-user */
2117
+ export type DevUser = UserBase & {
2118
+ /** IDs of the Dev User outside the DevRev SOR. */
2119
+ external_identities?: ExternalIdentity[];
2120
+ };
2121
+ /** dev-user-external-identity-filter */
2122
+ export interface DevUserExternalIdentityFilter {
2123
+ /** Unique ID of the user in the external source. */
2124
+ id?: string;
2125
+ /** Issuer of the external identity of the user. */
2126
+ issuer?: string;
2127
+ }
2128
+ /** dev-user-summary */
2129
+ export type DevUserSummary = UserBaseSummary;
2130
+ /**
2131
+ * dev-users-get-request
2132
+ * A request to get a Dev user's information.
2133
+ */
2134
+ export interface DevUsersGetRequest {
2135
+ /** User ID of the requested Dev user. */
2136
+ id: string;
2137
+ }
2138
+ /**
2139
+ * dev-users-get-response
2140
+ * The response to getting the information for the Dev user.
2141
+ */
2142
+ export interface DevUsersGetResponse {
2143
+ dev_user: DevUser;
2144
+ }
2145
+ /**
2146
+ * dev-users-list-request
2147
+ * A request to get the list of Dev user's information.
2148
+ */
2149
+ export interface DevUsersListRequest {
2150
+ /**
2151
+ * The cursor to resume iteration from. If not provided, then
2152
+ * iteration starts from the beginning.
2153
+ */
2154
+ cursor?: string;
2155
+ /** Filters Dev users based on email addresses. */
2156
+ email?: string[];
2157
+ /** Filters Dev users based on external identity. */
2158
+ external_identity?: DevUserExternalIdentityFilter[];
2159
+ /**
2160
+ * The maximum number of Dev users to return. The default is '50'.
2161
+ * @format int32
2162
+ */
2163
+ limit?: number;
1332
2164
  /**
1333
- * Filters for objects created before the provided timestamp
1334
- * (inclusive).
1335
- * @format date-time
1336
- * @example "2023-01-01T12:00:00.000Z"
2165
+ * The iteration mode to use. If "after", then entries after the provided
2166
+ * cursor will be returned, or if no cursor is provided, then from the
2167
+ * beginning. If "before", then entries before the provided cursor will be
2168
+ * returned, or if no cursor is provided, then from the end. Entries will
2169
+ * always be returned in the specified sort-by order.
1337
2170
  */
1338
- before?: string;
2171
+ mode?: ListMode;
2172
+ /** Fields to sort the Dev users by and the direction to sort them. */
2173
+ sort_by?: string[];
2174
+ /** Filters Dev users based on state. */
2175
+ state?: UserState[];
1339
2176
  }
1340
2177
  /**
1341
- * date-time-preset
1342
- * Provides preset types for date filter.
2178
+ * dev-users-list-response
2179
+ * The response to listing the Dev users.
1343
2180
  */
1344
- export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
1345
- /** Type of date preset. */
1346
- preset_type: DateTimePresetType;
1347
- };
1348
- /** date-time-preset-last-n-days */
1349
- export interface DateTimePresetLastNDays {
2181
+ export interface DevUsersListResponse {
2182
+ /** The list of Dev users. */
2183
+ dev_users: DevUser[];
1350
2184
  /**
1351
- * The range starts from the current timestamp and continues for the
1352
- * past n days.
1353
- * @min 0
1354
- * @max 4294967295
2185
+ * The cursor used to iterate subsequent results in accordance to the
2186
+ * sort order. If not set, then no later elements exist.
1355
2187
  */
1356
- days: number;
1357
- }
1358
- /** date-time-preset-next-n-days */
1359
- export interface DateTimePresetNextNDays {
2188
+ next_cursor?: string;
1360
2189
  /**
1361
- * The range starts from the current timestamp and continues for the
1362
- * next n days.
1363
- * @min 0
1364
- * @max 4294967295
2190
+ * The cursor used to iterate preceding results in accordance to the
2191
+ * sort order. If not set, then no prior elements exist.
1365
2192
  */
1366
- days: number;
2193
+ prev_cursor?: string;
1367
2194
  }
1368
- /** Type of date preset. */
1369
- export declare enum DateTimePresetType {
1370
- LastNDays = "last_n_days",
1371
- NextNDays = "next_n_days"
2195
+ /**
2196
+ * dev-users-self-request
2197
+ * A request to get the authenticated user's information.
2198
+ */
2199
+ export type DevUsersSelfRequest = object;
2200
+ /**
2201
+ * dev-users-self-response
2202
+ * The response to getting the information for the authenticated user.
2203
+ */
2204
+ export interface DevUsersSelfResponse {
2205
+ dev_user: DevUser;
1372
2206
  }
1373
- /** dev-user-summary */
1374
- export type DevUserSummary = UserBaseSummary;
2207
+ /** directory-summary */
2208
+ export type DirectorySummary = AtomBaseSummary;
2209
+ /**
2210
+ * dynamic-group-info
2211
+ * Information to define dynamic groups.
2212
+ */
2213
+ export type DynamicGroupInfo = object;
1375
2214
  /** empty */
1376
2215
  export type Empty = object;
1377
2216
  /** engagement */
@@ -1379,6 +2218,8 @@ export type Engagement = AtomBase & {
1379
2218
  /** Description of the engagement object. */
1380
2219
  description?: string;
1381
2220
  };
2221
+ /** engagement-summary */
2222
+ export type EngagementSummary = AtomBaseSummary;
1382
2223
  /** Type of engagement. */
1383
2224
  export declare enum EngagementType {
1384
2225
  Call = "call",
@@ -1598,11 +2439,16 @@ export interface Error {
1598
2439
  type?: string;
1599
2440
  }
1600
2441
  /** error-bad-request */
1601
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
2442
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
1602
2443
  type: ErrorBadRequestType;
1603
2444
  };
1604
2445
  /** error-bad-request-bad-request */
1605
2446
  export type ErrorBadRequestBadRequest = object;
2447
+ /** error-bad-request-invalid-api-version */
2448
+ export interface ErrorBadRequestInvalidApiVersion {
2449
+ /** The provided API version. */
2450
+ value: string;
2451
+ }
1606
2452
  /** error-bad-request-invalid-enum-value */
1607
2453
  export interface ErrorBadRequestInvalidEnumValue {
1608
2454
  /** The allowed values for the field. */
@@ -1635,13 +2481,24 @@ export interface ErrorBadRequestMissingRequiredField {
1635
2481
  }
1636
2482
  /** error-bad-request-parse-error */
1637
2483
  export type ErrorBadRequestParseError = object;
2484
+ /**
2485
+ * error-bad-request-stale-schema-fragments
2486
+ * Error indicating that the request contained one or more stale schema
2487
+ * fragments, which are schema fragments that have been replaced by a
2488
+ * newer version and are therefore considered deprecated schema fragments.
2489
+ * The caller should refresh and use the latest schema fragments in their
2490
+ * request.
2491
+ */
2492
+ export type ErrorBadRequestStaleSchemaFragments = object;
1638
2493
  export declare enum ErrorBadRequestType {
1639
2494
  BadRequest = "bad_request",
2495
+ InvalidApiVersion = "invalid_api_version",
1640
2496
  InvalidEnumValue = "invalid_enum_value",
1641
2497
  InvalidField = "invalid_field",
1642
2498
  MissingDependency = "missing_dependency",
1643
2499
  MissingRequiredField = "missing_required_field",
1644
2500
  ParseError = "parse_error",
2501
+ StaleSchemaFragments = "stale_schema_fragments",
1645
2502
  ValueNotPermitted = "value_not_permitted"
1646
2503
  }
1647
2504
  /** error-bad-request-value-not-permitted */
@@ -1722,6 +2579,22 @@ export declare enum ErrorUnauthorizedType {
1722
2579
  }
1723
2580
  /** error-unauthorized-unauthenticated */
1724
2581
  export type ErrorUnauthorizedUnauthenticated = object;
2582
+ /** event-account-created */
2583
+ export interface EventAccountCreated {
2584
+ account: Account;
2585
+ }
2586
+ /** event-account-deleted */
2587
+ export interface EventAccountDeleted {
2588
+ /**
2589
+ * The ID of the account that was deleted.
2590
+ * @example "ACC-12345"
2591
+ */
2592
+ id: string;
2593
+ }
2594
+ /** event-account-updated */
2595
+ export interface EventAccountUpdated {
2596
+ account: Account;
2597
+ }
1725
2598
  /** event-conversation-created */
1726
2599
  export interface EventConversationCreated {
1727
2600
  conversation: Conversation;
@@ -1735,6 +2608,19 @@ export interface EventConversationDeleted {
1735
2608
  export interface EventConversationUpdated {
1736
2609
  conversation: Conversation;
1737
2610
  }
2611
+ /** event-dev-user-created */
2612
+ export interface EventDevUserCreated {
2613
+ dev_user: DevUser;
2614
+ }
2615
+ /** event-dev-user-deleted */
2616
+ export interface EventDevUserDeleted {
2617
+ /** The ID of the Dev user that was deleted. */
2618
+ id: string;
2619
+ }
2620
+ /** event-dev-user-updated */
2621
+ export interface EventDevUserUpdated {
2622
+ dev_user: DevUser;
2623
+ }
1738
2624
  /** event-part-created */
1739
2625
  export interface EventPartCreated {
1740
2626
  part: Part;
@@ -1952,6 +2838,11 @@ export interface EventWorkDeleted {
1952
2838
  export interface EventWorkUpdated {
1953
2839
  work: Work;
1954
2840
  }
2841
+ /**
2842
+ * external-identity
2843
+ * External identity of a user.
2844
+ */
2845
+ export type ExternalIdentity = object;
1955
2846
  /** feature */
1956
2847
  export type Feature = PartBase;
1957
2848
  /** feature-summary */
@@ -2065,6 +2956,11 @@ export type GroupSummary = AtomBaseSummary & {
2065
2956
  /** Name of the group. */
2066
2957
  name?: string;
2067
2958
  };
2959
+ /** Type of the group. */
2960
+ export declare enum GroupType {
2961
+ Dynamic = "dynamic",
2962
+ Static = "static"
2963
+ }
2068
2964
  /**
2069
2965
  * groups-create-request
2070
2966
  * A request to create a new group.
@@ -2072,12 +2968,16 @@ export type GroupSummary = AtomBaseSummary & {
2072
2968
  export interface GroupsCreateRequest {
2073
2969
  /** Description of the group. */
2074
2970
  description: string;
2971
+ /** Information to define dynamic groups. */
2972
+ dynamic_group_info?: DynamicGroupInfo;
2075
2973
  /** Type of the members in the group. */
2076
2974
  member_type?: GroupMemberType;
2077
2975
  /** Unique name of the group. */
2078
2976
  name: string;
2079
2977
  /** Owner of the group. */
2080
2978
  owner?: string;
2979
+ /** Type of the group. */
2980
+ type?: GroupType;
2081
2981
  }
2082
2982
  /**
2083
2983
  * groups-create-response
@@ -2111,6 +3011,8 @@ export interface GroupsListRequest {
2111
3011
  * iteration starts from the beginning.
2112
3012
  */
2113
3013
  cursor?: string;
3014
+ /** Filters the groups based on the group type. */
3015
+ group_type?: GroupType[];
2114
3016
  /**
2115
3017
  * The maximum number of groups to return. The default is '50'.
2116
3018
  * @format int32
@@ -2195,6 +3097,32 @@ export interface LegacyStage {
2195
3097
  /** Current stage name of the work item. */
2196
3098
  name: string;
2197
3099
  }
3100
+ /**
3101
+ * lines-of-code
3102
+ * Details of lines of code in this code change.
3103
+ */
3104
+ export interface LinesOfCode {
3105
+ /**
3106
+ * Count of files involved in this code change.
3107
+ * @format int64
3108
+ */
3109
+ file_count?: number;
3110
+ /**
3111
+ * Number of new lines added in this code change.
3112
+ * @format int64
3113
+ */
3114
+ lines_added?: number;
3115
+ /**
3116
+ * Number of lines deleted in this code change.
3117
+ * @format int64
3118
+ */
3119
+ lines_deleted?: number;
3120
+ /**
3121
+ * Number of lines modified in this code change.
3122
+ * @format int64
3123
+ */
3124
+ lines_modified?: number;
3125
+ }
2198
3126
  /** link */
2199
3127
  export type Link = AtomBase & {
2200
3128
  /** Type of link used to define the relationship. */
@@ -2377,6 +3305,8 @@ export declare enum ListMode {
2377
3305
  After = "after",
2378
3306
  Before = "before"
2379
3307
  }
3308
+ /** meeting-summary */
3309
+ export type MeetingSummary = AtomBaseSummary;
2380
3310
  /** member-summary */
2381
3311
  export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
2382
3312
  type: MemberType;
@@ -2390,7 +3320,7 @@ export declare enum MemberType {
2390
3320
  export interface MetricDataPoint {
2391
3321
  /**
2392
3322
  * Key-value pairs for specifying additional attributes.
2393
- * @maxItems 10
3323
+ * @maxItems 12
2394
3324
  */
2395
3325
  dimensions?: MetricDataPointDimension[];
2396
3326
  /**
@@ -2435,8 +3365,6 @@ export type MetricDefinition = AtomBase;
2435
3365
  /** The list of item types on which the metric might be applied. */
2436
3366
  export declare enum MetricDefinitionAppliesTo {
2437
3367
  Conversation = "conversation",
2438
- Issue = "issue",
2439
- Task = "task",
2440
3368
  Ticket = "ticket"
2441
3369
  }
2442
3370
  /**
@@ -3247,6 +4175,22 @@ export interface RevOrgsCreateRequest {
3247
4175
  export interface RevOrgsCreateResponse {
3248
4176
  rev_org: RevOrg;
3249
4177
  }
4178
+ /**
4179
+ * rev-orgs-delete-request
4180
+ * Request object to delete a Rev organization.
4181
+ */
4182
+ export interface RevOrgsDeleteRequest {
4183
+ /**
4184
+ * The ID of Rev organization to delete.
4185
+ * @example "REV-AbCdEfGh"
4186
+ */
4187
+ id: string;
4188
+ }
4189
+ /**
4190
+ * rev-orgs-delete-response
4191
+ * The response to deleting a Rev organization.
4192
+ */
4193
+ export type RevOrgsDeleteResponse = object;
3250
4194
  /**
3251
4195
  * rev-orgs-get-request
3252
4196
  * Request object to get Rev organization's information.
@@ -3469,7 +4413,7 @@ export interface RevUsersCreateRequest {
3469
4413
  * system-generated identifier will be assigned to the user.
3470
4414
  */
3471
4415
  external_ref?: string;
3472
- /** Phone numbers of the Rev user. */
4416
+ /** Phone numbers, in E.164 format, of the Rev user. */
3473
4417
  phone_numbers?: string[];
3474
4418
  /**
3475
4419
  * The ID of Rev organization for which a Rev user is to be created.
@@ -3550,7 +4494,7 @@ export interface RevUsersListRequest {
3550
4494
  */
3551
4495
  mode?: ListMode;
3552
4496
  modified_date?: DateTimeFilter;
3553
- /** List of phone numbers to filter Rev users on. */
4497
+ /** List of phone numbers, in E.164 format, to filter Rev users on. */
3554
4498
  phone_numbers?: string[];
3555
4499
  /**
3556
4500
  * List of IDs of Rev organizations to be filtered.
@@ -3599,6 +4543,8 @@ export interface RevUsersUpdateRequest {
3599
4543
  external_ref?: string;
3600
4544
  /** The ID of Rev user to update. */
3601
4545
  id: string;
4546
+ /** The phone numbers, in E.164 format, of the Rev user. */
4547
+ phone_numbers?: string[];
3602
4548
  /** Tags associated with the Rev user. */
3603
4549
  tags?: SetTagWithValue[];
3604
4550
  }
@@ -3682,6 +4628,14 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
3682
4628
  /** Default value. */
3683
4629
  default_value?: string[];
3684
4630
  };
4631
+ /**
4632
+ * schema-field-create-view-ui-metadata
4633
+ * Create view UI hint overrides.
4634
+ */
4635
+ export interface SchemaFieldCreateViewUiMetadata {
4636
+ /** Whether field is hidden in the UI create view. */
4637
+ is_hidden?: boolean;
4638
+ }
3685
4639
  /**
3686
4640
  * schema-field-descriptor
3687
4641
  * Set of field attributes.
@@ -3692,6 +4646,11 @@ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaComposite
3692
4646
  /** schema-field-descriptor-array-type */
3693
4647
  export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
3694
4648
  base_type: SchemaFieldDescriptorArrayTypeBaseType;
4649
+ /**
4650
+ * The exact array length.
4651
+ * @format int64
4652
+ */
4653
+ eq_items?: number;
3695
4654
  /**
3696
4655
  * The maximum array length.
3697
4656
  * @format int64
@@ -3755,18 +4714,87 @@ export declare enum SchemaFieldDescriptorFieldType {
3755
4714
  Uenum = "uenum",
3756
4715
  Unknown = "unknown"
3757
4716
  }
4717
+ /**
4718
+ * schema-field-detail-view-ui-metadata
4719
+ * Detail view UI hint overrides.
4720
+ */
4721
+ export interface SchemaFieldDetailViewUiMetadata {
4722
+ /** Whether the field is hidden in the UI detail view. */
4723
+ is_hidden?: boolean;
4724
+ }
4725
+ /**
4726
+ * schema-field-filter-view-ui-metadata
4727
+ * Filter view UI hint overrides.
4728
+ */
4729
+ export interface SchemaFieldFilterViewUiMetadata {
4730
+ /** Whether field is hidden in the UI filter view. */
4731
+ is_hidden?: boolean;
4732
+ }
4733
+ /**
4734
+ * schema-field-list-view-ui-metadata
4735
+ * List view UI hint overrides.
4736
+ */
4737
+ export interface SchemaFieldListViewUiMetadata {
4738
+ /** Whether the field is hidden in the UI list view. */
4739
+ is_hidden?: boolean;
4740
+ }
3758
4741
  /**
3759
4742
  * schema-field-mfz-metadata
3760
4743
  * The schema of MFZ specific fields.
3761
4744
  */
3762
4745
  export type SchemaFieldMfzMetadata = object;
4746
+ /**
4747
+ * schema-field-summary-view-ui-metadata
4748
+ * Summary view UI hint overrides.
4749
+ */
4750
+ export interface SchemaFieldSummaryViewUiMetadata {
4751
+ /** Whether field is hidden in the UI summary view. */
4752
+ is_hidden?: boolean;
4753
+ }
4754
+ /**
4755
+ * schema-field-uenum-value
4756
+ * A unified enum value.
4757
+ */
4758
+ export type SchemaFieldUenumValue = object;
3763
4759
  /**
3764
4760
  * schema-field-ui-metadata
3765
4761
  * The schema of ui specific fields.
3766
4762
  */
3767
4763
  export interface SchemaFieldUiMetadata {
3768
- /** Display name of the field. */
4764
+ /** Create view UI hint overrides. */
4765
+ create_view?: SchemaFieldCreateViewUiMetadata;
4766
+ /** Detail view UI hint overrides. */
4767
+ detail_view?: SchemaFieldDetailViewUiMetadata;
4768
+ /** The display name of the field. */
3769
4769
  display_name?: string;
4770
+ /** Filter view UI hint overrides. */
4771
+ filter_view?: SchemaFieldFilterViewUiMetadata;
4772
+ /** An optional group name for the field. */
4773
+ group_name?: string;
4774
+ /** Whether the field is active in the UI detail view. */
4775
+ is_active_in_detail_view?: boolean;
4776
+ /** Whether the field supports bulk action. */
4777
+ is_bulk_action_enabled?: boolean;
4778
+ /** Whether the field is groupable in the UI. */
4779
+ is_groupable?: boolean;
4780
+ /** Whether the field is hidden in the UI. */
4781
+ is_hidden?: boolean;
4782
+ /** Whether the field is hidden in the UI during creation. */
4783
+ is_hidden_during_create?: boolean;
4784
+ /** Whether the field is read-only in the UI. */
4785
+ is_read_only?: boolean;
4786
+ /** Whether the field is shown in the UI summary view. */
4787
+ is_shown_in_summary?: boolean;
4788
+ /** Whether the field is sortable in the UI. */
4789
+ is_sortable?: boolean;
4790
+ /** List view UI hint overrides. */
4791
+ list_view?: SchemaFieldListViewUiMetadata;
4792
+ /** A placeholder for the field. */
4793
+ placeholder?: string;
4794
+ /** Summary view UI hint overrides. */
4795
+ summary_view?: SchemaFieldSummaryViewUiMetadata;
4796
+ /** Tooltip for the field. */
4797
+ tooltip?: string;
3770
4798
  }
3771
4799
  /** schema-id-field-descriptor */
3772
4800
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
@@ -4016,7 +5044,7 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
4016
5044
  /** schema-uenum-field-descriptor */
4017
5045
  export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
4018
5046
  /** Allowed values for the field. */
4019
- allowed_values: UenumValue[];
5047
+ allowed_values: SchemaFieldUenumValue[];
4020
5048
  /**
4021
5049
  * Default value.
4022
5050
  * @format int64
@@ -4026,7 +5054,7 @@ export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
4026
5054
  /** schema-uenum-list-field-descriptor */
4027
5055
  export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
4028
5056
  /** Allowed values for the field. */
4029
- allowed_values: UenumValue[];
5057
+ allowed_values: SchemaFieldUenumValue[];
4030
5058
  /** Default value. */
4031
5059
  default_value?: number[];
4032
5060
  };
@@ -4087,6 +5115,8 @@ export interface SetSlaSelector {
4087
5115
  severity?: SlaSelectorSeverity[];
4088
5116
  /** The SLA policy applies to conversations with these sources. */
4089
5117
  source_channel?: string[];
5118
+ /** The SLA policy applies to tickets with these subtypes. */
5119
+ subtype?: string[];
4090
5120
  /**
4091
5121
  * The SLA policy applies to items with these tags.
4092
5122
  * @example ["TAG-12345"]
@@ -4146,6 +5176,16 @@ export interface SetWeeklyOrgSchedule {
4146
5176
  */
4147
5177
  period_name: string;
4148
5178
  }
5179
+ /**
5180
+ * shared-with-membership
5181
+ * Information about the role the member receives due to the share.
5182
+ */
5183
+ export type SharedWithMembership = object;
5184
+ /**
5185
+ * shared-with-membership-filter
5186
+ * Filter on target item based on intended audience.
5187
+ */
5188
+ export type SharedWithMembershipFilter = object;
4149
5189
  /** sla */
4150
5190
  export type Sla = AtomBase & {
4151
5191
  /**
@@ -4247,6 +5287,8 @@ export declare enum SlaStatus {
4247
5287
  export interface SlaSummaryFilter {
4248
5288
  /** Filters for records with any of the provided SLA stages. */
4249
5289
  stage?: SlaSummaryStage[];
5290
+ /** Provides ways to specify date ranges on objects. */
5291
+ target_time?: DateFilter;
4250
5292
  }
4251
5293
  /**
4252
5294
  * The stage of the SLA. This is the metric stage which is closest to
@@ -4282,6 +5324,7 @@ export interface SlasAssignResponse {
4282
5324
  }
4283
5325
  /** slas-create-request */
4284
5326
  export interface SlasCreateRequest {
5327
+ account_selector?: AccountsFilters;
4285
5328
  /** Description of the purpose and capabilities of the SLA. */
4286
5329
  description?: string;
4287
5330
  /**
@@ -4369,6 +5412,7 @@ export interface SlasTransitionResponse {
4369
5412
  }
4370
5413
  /** slas-update-request */
4371
5414
  export interface SlasUpdateRequest {
5415
+ account_selector?: AccountsFilters;
4372
5416
  /** Description of the purpose and capabilities of the SLA. */
4373
5417
  description?: string;
4374
5418
  /**
@@ -4395,6 +5439,47 @@ export interface SlasUpdateRequest {
4395
5439
  export interface SlasUpdateResponse {
4396
5440
  sla: Sla;
4397
5441
  }
5442
+ /** snap-in-version-summary */
5443
+ export type SnapInVersionSummary = AtomBaseSummary;
5444
+ /** snap-ins-resources-request */
5445
+ export interface SnapInsResourcesRequest {
5446
+ /** The ID of the snap-in to get resources for. */
5447
+ id: string;
5448
+ /** The ID of the user to get resources for. */
5449
+ user: string;
5450
+ }
5451
+ /** snap-ins-resources-response */
5452
+ export interface SnapInsResourcesResponse {
5453
+ event_sources?: SnapInsResourcesResponseEventSourcesEntry;
5454
+ /** The inputs for the snap-in. */
5455
+ inputs?: object;
5456
+ keyrings?: SnapInsResourcesResponseKeyringsEntry;
5457
+ snap_in_version: SnapInVersionSummary;
5458
+ }
5459
+ /** snap-ins-resources-response-event-sources-entry */
5460
+ export interface SnapInsResourcesResponseEventSourcesEntry {
5461
+ key: string;
5462
+ value: string;
5463
+ }
5464
+ /** snap-ins-resources-response-keyring-data */
5465
+ export interface SnapInsResourcesResponseKeyringData {
5466
+ /** The ID of the keyring. */
5467
+ id: string;
5468
+ /** The secret value of the keyring. This must be handled with caution. */
5469
+ secret: string;
5470
+ }
5471
+ /** snap-ins-resources-response-keyrings-entry */
5472
+ export interface SnapInsResourcesResponseKeyringsEntry {
5473
+ key: string;
5474
+ value: SnapInsResourcesResponseKeyringData;
5475
+ }
5476
+ /** snap-widget */
5477
+ export interface SnapWidget {
5478
+ type: SnapWidgetType;
5479
+ }
5480
+ export type SnapWidgetType = string;
5481
+ /** stage-diagram-summary */
5482
+ export type StageDiagramSummary = AtomBaseSummary;
4398
5483
  /**
4399
5484
  * stage-filter
4400
5485
  * The filter for stages.
@@ -4420,10 +5505,61 @@ export interface StageUpdate {
4420
5505
  name?: string;
4421
5506
  }
4422
5507
  /**
4423
- * stock-field-uenum-override
4424
- * Override for the allowed values of a stock field enum.
5508
+ * stock-field-override
5509
+ * A stock field override.
4425
5510
  */
4426
- export type StockFieldUenumOverride = object;
5511
+ export type StockFieldOverride = object;
5512
+ /** stock-schema-fragment */
5513
+ export type StockSchemaFragment = AtomBase & {
5514
+ /** Description of the schema. */
5515
+ description?: string;
5516
+ /** List of all fields in this schema. */
5517
+ fields: SchemaFieldDescriptor[];
5518
+ /** Leaf type this fragment applies to. */
5519
+ leaf_type?: string;
5520
+ new_fragment_ref?: AtomSummary;
5521
+ old_fragment_ref?: AtomSummary;
5522
+ /** Title of the schema. */
5523
+ title?: string;
5524
+ };
5525
+ /** stock-schema-fragments-get-request */
5526
+ export interface StockSchemaFragmentsGetRequest {
5527
+ /** The ID of the stock schema fragment. */
5528
+ id?: string;
5529
+ /** The leaf type this fragment applies to. */
5530
+ leaf_type?: string;
5531
+ }
5532
+ /** stock-schema-fragments-get-response */
5533
+ export interface StockSchemaFragmentsGetResponse {
5534
+ fragment: StockSchemaFragment;
5535
+ }
5536
+ /** stock-schema-fragments-list-request */
5537
+ export interface StockSchemaFragmentsListRequest {
5538
+ /**
5539
+ * The cursor to resume iteration from, otherwise if not provided,
5540
+ * then iteration starts from the beginning.
5541
+ */
5542
+ cursor?: string;
5543
+ /** The list of leaf types. */
5544
+ leaf_type?: string[];
5545
+ /**
5546
+ * The maximum number of items.
5547
+ * @format int32
5548
+ */
5549
+ limit?: number;
5550
+ /** The list of fields to sort the items by and how to sort them. */
5551
+ sort_by?: string[];
5552
+ }
5553
+ /** stock-schema-fragments-list-response */
5554
+ export interface StockSchemaFragmentsListResponse {
5555
+ /**
5556
+ * The cursor to resume iteration from, otherwise if not provided,
5557
+ * then iteration starts from the beginning.
5558
+ */
5559
+ cursor?: string;
5560
+ /** The stock schema fragments. */
5561
+ result: StockSchemaFragment[];
5562
+ }
4427
5563
  /** subtype */
4428
5564
  export interface Subtype {
4429
5565
  /** Display name of the subtype. */
@@ -4537,44 +5673,181 @@ export type Tag = AtomBase & {
4537
5673
  */
4538
5674
  allowed_values?: string[];
4539
5675
  /**
4540
- * An informative description for the tag that should provide context
4541
- * on the tag's purpose and usage.
5676
+ * An informative description for the tag that should provide context
5677
+ * on the tag's purpose and usage.
5678
+ */
5679
+ description?: string;
5680
+ /**
5681
+ * The name of the tag, which denotes the logical concept by which all
5682
+ * tagged objects will be associated. The name is guaranteed to be
5683
+ * unique.
5684
+ */
5685
+ name: string;
5686
+ };
5687
+ /** tag-summary */
5688
+ export type TagSummary = AtomBaseSummary & {
5689
+ /**
5690
+ * The name of the tag, which denotes the logical concept by which all
5691
+ * tagged objects will be associated. The name is guaranteed to be
5692
+ * unique.
5693
+ */
5694
+ name: string;
5695
+ };
5696
+ /** tag-with-value */
5697
+ export interface TagWithValue {
5698
+ tag: TagSummary;
5699
+ /** The value for the object's association with the tag. */
5700
+ value?: string;
5701
+ }
5702
+ /** tag-with-value-filter */
5703
+ export interface TagWithValueFilter {
5704
+ /**
5705
+ * The ID of the tag.
5706
+ * @example "TAG-12345"
5707
+ */
5708
+ id?: string;
5709
+ /**
5710
+ * The value for the object's association with the tag. If specified,
5711
+ * the value must be one that's specified in the tag's allowed values.
5712
+ */
5713
+ value?: string;
5714
+ }
5715
+ /**
5716
+ * tags-create-request
5717
+ * The request to create a new tag.
5718
+ */
5719
+ export interface TagsCreateRequest {
5720
+ /**
5721
+ * The allowed values for the tag, or empty if no values are
5722
+ * permitted.
5723
+ */
5724
+ allowed_values?: string[];
5725
+ /** The description for the tag. */
5726
+ description?: string;
5727
+ /** The name for the tag, which must be unique across all tags. */
5728
+ name: string;
5729
+ }
5730
+ /**
5731
+ * tags-create-response
5732
+ * The response to creating a new tag.
5733
+ */
5734
+ export interface TagsCreateResponse {
5735
+ tag: Tag;
5736
+ }
5737
+ /**
5738
+ * tags-delete-request
5739
+ * The request to delete a tag.
5740
+ */
5741
+ export interface TagsDeleteRequest {
5742
+ /**
5743
+ * The ID of the tag to delete.
5744
+ * @example "TAG-12345"
5745
+ */
5746
+ id: string;
5747
+ }
5748
+ /**
5749
+ * tags-delete-response
5750
+ * The response for deleting a tag.
5751
+ */
5752
+ export type TagsDeleteResponse = object;
5753
+ /**
5754
+ * tags-get-request
5755
+ * The request to get a tag's information.
5756
+ */
5757
+ export interface TagsGetRequest {
5758
+ /**
5759
+ * The requested tag's ID.
5760
+ * @example "TAG-12345"
5761
+ */
5762
+ id: string;
5763
+ }
5764
+ /**
5765
+ * tags-get-response
5766
+ * The response to getting a tag's information.
5767
+ */
5768
+ export interface TagsGetResponse {
5769
+ tag: Tag;
5770
+ }
5771
+ /**
5772
+ * tags-list-request
5773
+ * The request to get information about a list of tags.
5774
+ */
5775
+ export interface TagsListRequest {
5776
+ /**
5777
+ * The cursor to resume iteration from. If not provided, then
5778
+ * iteration starts from the beginning.
5779
+ */
5780
+ cursor?: string;
5781
+ /**
5782
+ * The maximum number of tags to return. The default is '50'.
5783
+ * @format int32
5784
+ */
5785
+ limit?: number;
5786
+ /**
5787
+ * The iteration mode to use. If "after", then entries after the provided
5788
+ * cursor will be returned, or if no cursor is provided, then from the
5789
+ * beginning. If "before", then entries before the provided cursor will be
5790
+ * returned, or if no cursor is provided, then from the end. Entries will
5791
+ * always be returned in the specified sort-by order.
4542
5792
  */
4543
- description?: string;
5793
+ mode?: ListMode;
5794
+ /** Filters for tags with the provided names. */
5795
+ name?: string[];
5796
+ /** Fields to sort tags by and the direction to sort them. */
5797
+ sort_by?: string[];
5798
+ }
5799
+ /**
5800
+ * tags-list-response
5801
+ * The response to listing the tags.
5802
+ */
5803
+ export interface TagsListResponse {
4544
5804
  /**
4545
- * The name of the tag, which denotes the logical concept by which all
4546
- * tagged objects will be associated. The name is guaranteed to be
4547
- * unique.
5805
+ * The cursor used to iterate subsequent results in accordance to the
5806
+ * sort order. If not set, then no later elements exist.
4548
5807
  */
4549
- name: string;
4550
- };
4551
- /** tag-summary */
4552
- export type TagSummary = AtomBaseSummary & {
5808
+ next_cursor?: string;
4553
5809
  /**
4554
- * The name of the tag, which denotes the logical concept by which all
4555
- * tagged objects will be associated. The name is guaranteed to be
4556
- * unique.
5810
+ * The cursor used to iterate preceding results in accordance to the
5811
+ * sort order. If not set, then no prior elements exist.
4557
5812
  */
4558
- name: string;
4559
- };
4560
- /** tag-with-value */
4561
- export interface TagWithValue {
4562
- tag: TagSummary;
4563
- /** The value for the object's association with the tag. */
4564
- value?: string;
5813
+ prev_cursor?: string;
5814
+ /** The list of tags. */
5815
+ tags: Tag[];
4565
5816
  }
4566
- /** tag-with-value-filter */
4567
- export interface TagWithValueFilter {
5817
+ /**
5818
+ * tags-update-allowed-values
5819
+ * Specifies an update to a tag's allowed values.
5820
+ */
5821
+ export interface TagsUpdateAllowedValues {
5822
+ /** Sets the allowed values for the tag. */
5823
+ set?: string[];
5824
+ }
5825
+ /**
5826
+ * tags-update-request
5827
+ * The request to update a tag.
5828
+ */
5829
+ export interface TagsUpdateRequest {
5830
+ /** Specifies an update to a tag's allowed values. */
5831
+ allowed_values?: TagsUpdateAllowedValues;
5832
+ /** The updated description of the tag. */
5833
+ description?: string;
4568
5834
  /**
4569
- * The ID of the tag.
5835
+ * The ID of the tag to update.
4570
5836
  * @example "TAG-12345"
4571
5837
  */
4572
- id?: string;
5838
+ id: string;
4573
5839
  /**
4574
- * The value for the object's association with the tag. If specified,
4575
- * the value must be one that's specified in the tag's allowed values.
5840
+ * The updated name of the tag. The name must be unique across all
5841
+ * tags.
4576
5842
  */
4577
- value?: string;
5843
+ name?: string;
5844
+ }
5845
+ /**
5846
+ * tags-update-response
5847
+ * The response for updating a tag.
5848
+ */
5849
+ export interface TagsUpdateResponse {
5850
+ tag: Tag;
4578
5851
  }
4579
5852
  /** task */
4580
5853
  export type Task = WorkBase;
@@ -4589,13 +5862,25 @@ export declare enum TaskPriority {
4589
5862
  export type TaskSummary = WorkBaseSummary;
4590
5863
  /** tenant-fragment */
4591
5864
  export type TenantFragment = CustomSchemaFragmentBase;
5865
+ /** tenant-fragment-summary */
5866
+ export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
4592
5867
  /** ticket */
4593
5868
  export type Ticket = WorkBase & {
5869
+ /** Channels of the ticket. */
5870
+ channels?: TicketChannels[];
4594
5871
  group?: GroupSummary;
4595
5872
  rev_org?: OrgSummary;
4596
5873
  /** Severity of the ticket. */
4597
5874
  severity?: TicketSeverity;
5875
+ /** Source channel of the ticket. */
5876
+ source_channel?: string;
4598
5877
  };
5878
+ /** Channels of the ticket. */
5879
+ export declare enum TicketChannels {
5880
+ Email = "email",
5881
+ Plug = "plug",
5882
+ Slack = "slack"
5883
+ }
4599
5884
  /** Severity of the ticket. */
4600
5885
  export declare enum TicketSeverity {
4601
5886
  Blocker = "blocker",
@@ -4622,12 +5907,17 @@ export type TimelineComment = TimelineEntryBase & {
4622
5907
  body_type?: TimelineCommentBodyType;
4623
5908
  /** Snap Kit Body of the comment. */
4624
5909
  snap_kit_body?: TimelineSnapKitBody;
5910
+ /** The snap widget body of the comment. */
5911
+ snap_widget_body?: SnapWidget[];
4625
5912
  };
4626
5913
  /** The type of the body to use for the comment. */
4627
5914
  export declare enum TimelineCommentBodyType {
4628
5915
  SnapKit = "snap_kit",
5916
+ SnapWidget = "snap_widget",
4629
5917
  Text = "text"
4630
5918
  }
5919
+ /** timeline-comment-summary */
5920
+ export type TimelineCommentSummary = TimelineEntryBaseSummary;
4631
5921
  /** Describes collections of timeline entries. */
4632
5922
  export declare enum TimelineEntriesCollection {
4633
5923
  Discussions = "discussions",
@@ -4710,6 +6000,40 @@ export declare enum TimelineEntriesCreateRequestType {
4710
6000
  export interface TimelineEntriesCreateResponse {
4711
6001
  timeline_entry: TimelineEntry;
4712
6002
  }
6003
+ /**
6004
+ * timeline-entries-delete-request
6005
+ * The request to delete a timeline entry from an object.
6006
+ */
6007
+ export interface TimelineEntriesDeleteRequest {
6008
+ /**
6009
+ * The ID of the timeline entry to delete.
6010
+ * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
6011
+ */
6012
+ id: string;
6013
+ }
6014
+ /**
6015
+ * timeline-entries-delete-response
6016
+ * The response to deleting a timeline entry from an object.
6017
+ */
6018
+ export type TimelineEntriesDeleteResponse = object;
6019
+ /**
6020
+ * timeline-entries-get-request
6021
+ * The request to get a timeline entry.
6022
+ */
6023
+ export interface TimelineEntriesGetRequest {
6024
+ /**
6025
+ * The ID of the timeline entry to get.
6026
+ * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
6027
+ */
6028
+ id: string;
6029
+ }
6030
+ /**
6031
+ * timeline-entries-get-response
6032
+ * The request to getting a timeline entry.
6033
+ */
6034
+ export interface TimelineEntriesGetResponse {
6035
+ timeline_entry: TimelineEntry;
6036
+ }
4713
6037
  /**
4714
6038
  * timeline-entries-list-request
4715
6039
  * The request to list timeline entries for an object.
@@ -4866,6 +6190,8 @@ export type TimelineEntryBase = AtomBase & {
4866
6190
  labels?: string[];
4867
6191
  /** The object that the Timeline entry belongs to. */
4868
6192
  object: string;
6193
+ /** The display ID of the object that the Timeline entry belongs to. */
6194
+ object_display_id: string;
4869
6195
  /** The type of object that the Timeline entry belongs to. */
4870
6196
  object_type?: TimelineEntryObjectType;
4871
6197
  /** The reactions to the entry. */
@@ -4881,6 +6207,8 @@ export type TimelineEntryBase = AtomBase & {
4881
6207
  */
4882
6208
  visibility?: TimelineEntryVisibility;
4883
6209
  };
6210
+ /** timeline-entry-base-summary */
6211
+ export type TimelineEntryBaseSummary = AtomBaseSummary;
4884
6212
  /** The type of object that the Timeline entry belongs to. */
4885
6213
  export declare enum TimelineEntryObjectType {
4886
6214
  Account = "account",
@@ -4958,25 +6286,6 @@ export interface TimelineThread {
4958
6286
  */
4959
6287
  total_replies?: number;
4960
6288
  }
4961
- /** uenum-value */
4962
- export interface UenumValue {
4963
- /**
4964
- * The ID of the enum value.
4965
- * @format int64
4966
- */
4967
- id: number;
4968
- /** Whether the enum value is deprecated. */
4969
- is_deprecated?: boolean;
4970
- /** The label of the enum value. */
4971
- label: string;
4972
- /**
4973
- * The ordinal of the enum value.
4974
- * @format int64
4975
- */
4976
- ordinal: number;
4977
- /** The tooltip of the enum value. */
4978
- tooltip?: string;
4979
- }
4980
6289
  /**
4981
6290
  * unit
4982
6291
  * Unit encapsulates the name of the unit and the type of the unit. For
@@ -5328,9 +6637,15 @@ export type Webhook = AtomBase & {
5328
6637
  };
5329
6638
  /** webhook-event-request */
5330
6639
  export interface WebhookEventRequest {
6640
+ account_created?: EventAccountCreated;
6641
+ account_deleted?: EventAccountDeleted;
6642
+ account_updated?: EventAccountUpdated;
5331
6643
  conversation_created?: EventConversationCreated;
5332
6644
  conversation_deleted?: EventConversationDeleted;
5333
6645
  conversation_updated?: EventConversationUpdated;
6646
+ dev_user_created?: EventDevUserCreated;
6647
+ dev_user_deleted?: EventDevUserDeleted;
6648
+ dev_user_updated?: EventDevUserUpdated;
5334
6649
  /** The event's ID. */
5335
6650
  id: string;
5336
6651
  part_created?: EventPartCreated;
@@ -5386,6 +6701,15 @@ export interface WebhookEventResponse {
5386
6701
  }
5387
6702
  /** The event types that the webhook will receive. */
5388
6703
  export declare enum WebhookEventType {
6704
+ AccountCreated = "account_created",
6705
+ AccountDeleted = "account_deleted",
6706
+ AccountUpdated = "account_updated",
6707
+ ConversationCreated = "conversation_created",
6708
+ ConversationDeleted = "conversation_deleted",
6709
+ ConversationUpdated = "conversation_updated",
6710
+ DevUserCreated = "dev_user_created",
6711
+ DevUserDeleted = "dev_user_deleted",
6712
+ DevUserUpdated = "dev_user_updated",
5389
6713
  PartCreated = "part_created",
5390
6714
  PartDeleted = "part_deleted",
5391
6715
  PartUpdated = "part_updated",
@@ -5423,6 +6747,142 @@ export declare enum WebhookStatus {
5423
6747
  Inactive = "inactive",
5424
6748
  Unverified = "unverified"
5425
6749
  }
6750
+ /** webhook-summary */
6751
+ export type WebhookSummary = AtomBaseSummary;
6752
+ /**
6753
+ * webhooks-create-request
6754
+ * The request to create a new webhook.
6755
+ */
6756
+ export interface WebhooksCreateRequest {
6757
+ /** The event types that the webhook endpoint will receive. */
6758
+ event_types?: WebhookEventType[];
6759
+ /**
6760
+ * The secret to use when verifying webhook events. If provided, the
6761
+ * secret must be between 8 and 32 bytes (inclusive). If not set, a
6762
+ * secret will be automatically generated and provided in the
6763
+ * response.
6764
+ * @format byte
6765
+ */
6766
+ secret?: string;
6767
+ /** The URL of the webhook endpoint. */
6768
+ url: string;
6769
+ }
6770
+ /**
6771
+ * webhooks-create-response
6772
+ * The response to creating a new webhook.
6773
+ */
6774
+ export interface WebhooksCreateResponse {
6775
+ webhook: Webhook;
6776
+ }
6777
+ /**
6778
+ * webhooks-delete-request
6779
+ * The request to delete a webhook.
6780
+ */
6781
+ export interface WebhooksDeleteRequest {
6782
+ /**
6783
+ * ID for the webhook.
6784
+ * @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
6785
+ */
6786
+ id: string;
6787
+ }
6788
+ /**
6789
+ * webhooks-delete-response
6790
+ * The response to deleting the webhook.
6791
+ */
6792
+ export type WebhooksDeleteResponse = object;
6793
+ /**
6794
+ * webhooks-get-request
6795
+ * The request to get a webhook's information.
6796
+ */
6797
+ export interface WebhooksGetRequest {
6798
+ /**
6799
+ * ID for the webhook.
6800
+ * @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
6801
+ */
6802
+ id: string;
6803
+ }
6804
+ /**
6805
+ * webhooks-get-response
6806
+ * The response to getting the information for the webhook.
6807
+ */
6808
+ export interface WebhooksGetResponse {
6809
+ webhook: Webhook;
6810
+ }
6811
+ /**
6812
+ * webhooks-list-request
6813
+ * The request to list the webhooks.
6814
+ */
6815
+ export type WebhooksListRequest = object;
6816
+ /**
6817
+ * webhooks-list-response
6818
+ * The response to listing the webhooks.
6819
+ */
6820
+ export interface WebhooksListResponse {
6821
+ /** The list of webhooks. */
6822
+ webhooks: Webhook[];
6823
+ }
6824
+ /** The action to update the webhook's status. */
6825
+ export declare enum WebhooksUpdateAction {
6826
+ Activate = "activate",
6827
+ Deactivate = "deactivate"
6828
+ }
6829
+ /**
6830
+ * webhooks-update-request
6831
+ * The request to update a webhook.
6832
+ */
6833
+ export interface WebhooksUpdateRequest {
6834
+ /** The action to update the webhook's status. */
6835
+ action?: WebhooksUpdateAction;
6836
+ event_types?: WebhooksUpdateRequestEventTypes;
6837
+ /**
6838
+ * ID for the webhook.
6839
+ * @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
6840
+ */
6841
+ id: string;
6842
+ /**
6843
+ * If provided, updates the secret that's used when verifying webhook
6844
+ * events, which must be between 8 and 32 bytes (inclusive). Otherwise
6845
+ * if empty, then a new secret is generated. If the webhook is active,
6846
+ * then its status will transition to the 'unverified' state and it
6847
+ * won't receive any object events until successfully verified.
6848
+ * @format byte
6849
+ */
6850
+ secret?: string;
6851
+ /**
6852
+ * The webhook's updated URL. If the webhook is active, then the
6853
+ * webhook's status will transition to the 'unverified' state and it
6854
+ * won't receive any object events until successfully verified.
6855
+ */
6856
+ url?: string;
6857
+ }
6858
+ /** webhooks-update-request-event-types */
6859
+ export interface WebhooksUpdateRequestEventTypes {
6860
+ /**
6861
+ * The event types to add. If a provided event type is already set for
6862
+ * the webhook, then nothing is done. Note this is mutually exclusive
6863
+ * with 'set'.
6864
+ */
6865
+ add?: WebhookEventType[];
6866
+ /**
6867
+ * The event types to remove. If a provided event type isn't set for
6868
+ * the webhook, then nothing is done. Note this is mutually exclusive
6869
+ * with 'set'.
6870
+ */
6871
+ remove?: WebhookEventType[];
6872
+ /**
6873
+ * The updated event types, which will replace the webhook's current
6874
+ * event types. Note this is mutually exclusive with 'add' and
6875
+ * 'remove'.
6876
+ */
6877
+ set?: WebhookEventType[];
6878
+ }
6879
+ /**
6880
+ * webhooks-update-response
6881
+ * The response to updating the webhook.
6882
+ */
6883
+ export interface WebhooksUpdateResponse {
6884
+ webhook: Webhook;
6885
+ }
5426
6886
  /**
5427
6887
  * weekly-org-schedule
5428
6888
  * The schedule for each week.
@@ -5536,6 +6996,11 @@ export interface WorksCreateRequestIssue {
5536
6996
  developed_with?: string[];
5537
6997
  /** Priority of the work based upon impact and criticality. */
5538
6998
  priority?: IssuePriority;
6999
+ /**
7000
+ * Priority enum id of the work based upon impact and criticality.
7001
+ * @format int64
7002
+ */
7003
+ priority_v2?: number;
5539
7004
  /** The sprint that the issue belongs to. */
5540
7005
  sprint?: string;
5541
7006
  }
@@ -5583,6 +7048,8 @@ export interface WorksCreateRequestTask {
5583
7048
  }
5584
7049
  /** works-create-request-ticket */
5585
7050
  export interface WorksCreateRequestTicket {
7051
+ /** Channels of the ticket. */
7052
+ channels?: TicketChannels[];
5586
7053
  /** The group that the ticket is associated with. */
5587
7054
  group?: string;
5588
7055
  /** Whether the ticket is spam. */
@@ -5644,6 +7111,11 @@ export interface WorksExportRequest {
5644
7111
  * @example ["DEVU-12345"]
5645
7112
  */
5646
7113
  owned_by?: string[];
7114
+ /**
7115
+ * Filters for work reported by any of these users.
7116
+ * @example ["DEVU-12345"]
7117
+ */
7118
+ reported_by?: string[];
5647
7119
  /** Fields to sort the work items by and the direction to sort them. */
5648
7120
  sort_by?: string[];
5649
7121
  /** The filter for stages. */
@@ -5666,8 +7138,15 @@ export interface WorksExportResponse {
5666
7138
  }
5667
7139
  /** works-filter-issue */
5668
7140
  export interface WorksFilterIssue {
7141
+ /**
7142
+ * Filters for issues with any of the provided Accounts.
7143
+ * @example ["ACC-12345"]
7144
+ */
7145
+ accounts?: string[];
5669
7146
  /** Filters for issues with any of the provided priorities. */
5670
7147
  priority?: IssuePriority[];
7148
+ /** Filters for issues with any of the provided priority enum ids. */
7149
+ priority_v2?: number[];
5671
7150
  /**
5672
7151
  * Filters for issues with any of the provided Rev organizations.
5673
7152
  * @example ["REV-AbCdEfGh"]
@@ -5687,6 +7166,8 @@ export interface WorksFilterOpportunity {
5687
7166
  }
5688
7167
  /** works-filter-ticket */
5689
7168
  export interface WorksFilterTicket {
7169
+ /** Filters for tickets with any of the provided channels. */
7170
+ channels?: TicketChannels[];
5690
7171
  /** Filters for tickets belonging to specific groups. */
5691
7172
  group?: string[];
5692
7173
  /** Filters for tickets that are spam. */
@@ -5765,6 +7246,11 @@ export interface WorksListRequest {
5765
7246
  * @example ["DEVU-12345"]
5766
7247
  */
5767
7248
  owned_by?: string[];
7249
+ /**
7250
+ * Filters for work reported by any of these users.
7251
+ * @example ["DEVU-12345"]
7252
+ */
7253
+ reported_by?: string[];
5768
7254
  /** Fields to sort the works by and the direction to sort them. */
5769
7255
  sort_by?: string[];
5770
7256
  /** The filter for stages. */
@@ -5821,6 +7307,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5821
7307
  reported_by?: WorksUpdateRequestReportedBy;
5822
7308
  /** Updates an object's stage. */
5823
7309
  stage?: StageUpdate;
7310
+ staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
5824
7311
  tags?: WorksUpdateRequestTags;
5825
7312
  /**
5826
7313
  * Updates the timestamp for when the work is expected to be complete.
@@ -5845,6 +7332,11 @@ export interface WorksUpdateRequestIssue {
5845
7332
  developed_with?: WorksUpdateRequestIssueDevelopedWith;
5846
7333
  /** Priority of the work based upon impact and criticality. */
5847
7334
  priority?: IssuePriority;
7335
+ /**
7336
+ * Priority enum id of the work based upon impact and criticality.
7337
+ * @format int64
7338
+ */
7339
+ priority_v2?: number;
5848
7340
  /** Updates the sprint that the issue belongs to. */
5849
7341
  sprint?: string | null;
5850
7342
  }
@@ -5904,6 +7396,11 @@ export interface WorksUpdateRequestReportedBy {
5904
7396
  */
5905
7397
  set?: string[];
5906
7398
  }
7399
+ /** works-update-request-staged-info-staged-info-update */
7400
+ export interface WorksUpdateRequestStagedInfoStagedInfoUpdate {
7401
+ /** Updates the unresolved fields of the staged work. */
7402
+ unresolved_fields: string[];
7403
+ }
5907
7404
  /** works-update-request-tags */
5908
7405
  export interface WorksUpdateRequestTags {
5909
7406
  /** Sets the provided tags on the work item. */
@@ -5924,8 +7421,9 @@ export interface WorksUpdateRequestTask {
5924
7421
  }
5925
7422
  /** works-update-request-ticket */
5926
7423
  export interface WorksUpdateRequestTicket {
5927
- /** The group that the ticket is associated with. */
5928
- group?: string;
7424
+ channels?: WorksUpdateRequestTicketChannels;
7425
+ /** Updates the group that the ticket is associated with. */
7426
+ group?: string | null;
5929
7427
  /** Updates whether the ticket is spam. */
5930
7428
  is_spam?: boolean;
5931
7429
  /**
@@ -5936,6 +7434,11 @@ export interface WorksUpdateRequestTicket {
5936
7434
  /** Severity of the ticket. */
5937
7435
  severity?: TicketSeverity;
5938
7436
  }
7437
+ /** works-update-request-ticket-channels */
7438
+ export interface WorksUpdateRequestTicketChannels {
7439
+ /** Sets the channels to the provided channels. */
7440
+ set?: TicketChannels[];
7441
+ }
5939
7442
  /** works-update-response */
5940
7443
  export interface WorksUpdateResponse {
5941
7444
  work: Work;
@@ -5982,11 +7485,11 @@ export declare class HttpClient<SecurityDataType = unknown> {
5982
7485
  request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
5983
7486
  }
5984
7487
  /**
5985
- * @title DevRev Beta REST API
5986
- * @version BETA
7488
+ * @title DevRev REST API
7489
+ * @version 2022-10-20
5987
7490
  * @baseUrl {protocol}://{hostname}
5988
7491
  *
5989
- * DevRev's BETA REST API Specification.
7492
+ * DevRev's REST API.
5990
7493
  */
5991
7494
  export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
5992
7495
  /**
@@ -6033,6 +7536,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6033
7536
  'created_date.before'?: string;
6034
7537
  /** Filters for custom fields. */
6035
7538
  custom_fields?: object;
7539
+ /** Array of display names of accounts to be filtered. */
7540
+ display_name?: string[];
6036
7541
  /** Domains for accounts to be filtered. */
6037
7542
  domains?: string[];
6038
7543
  /** Array of references of accounts to be filtered. */
@@ -6130,6 +7635,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6130
7635
  cursor?: string;
6131
7636
  /** Filters for custom fields. */
6132
7637
  custom_fields?: object;
7638
+ /** Array of display names of accounts to be filtered. */
7639
+ display_name?: string[];
6133
7640
  /** Domains for accounts to be filtered. */
6134
7641
  domains?: string[];
6135
7642
  /** Array of references of accounts to be filtered. */
@@ -6319,34 +7826,199 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6319
7826
  * @request POST:/articles.list
6320
7827
  * @secure
6321
7828
  */
6322
- listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
7829
+ listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
7830
+ /**
7831
+ * @description Updates an article.
7832
+ *
7833
+ * @tags articles
7834
+ * @name UpdateArticle
7835
+ * @request POST:/articles.update
7836
+ * @secure
7837
+ */
7838
+ updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
7839
+ /**
7840
+ * @description Gets the requested artifact's information.
7841
+ *
7842
+ * @tags artifacts
7843
+ * @name ArtifactsGet
7844
+ * @request GET:/artifacts.get
7845
+ * @secure
7846
+ */
7847
+ artifactsGet: (query: {
7848
+ /**
7849
+ * The requested artifact's ID.
7850
+ * @example "ARTIFACT-12345"
7851
+ */
7852
+ id: string;
7853
+ /** The version of the artifact that needs to be fetched. */
7854
+ version?: string;
7855
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
7856
+ /**
7857
+ * @description Gets the requested artifact's information.
7858
+ *
7859
+ * @tags artifacts
7860
+ * @name ArtifactsGetPost
7861
+ * @request POST:/artifacts.get
7862
+ * @secure
7863
+ */
7864
+ artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
7865
+ /**
7866
+ * @description List the artifacts attached to an object.
7867
+ *
7868
+ * @tags artifacts
7869
+ * @name ArtifactsList
7870
+ * @request GET:/artifacts.list
7871
+ * @secure
7872
+ */
7873
+ artifactsList: (query: {
7874
+ /** The ID of the object to filter artifacts. */
7875
+ parent_id: string;
7876
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
7877
+ /**
7878
+ * @description List the artifacts attached to an object.
7879
+ *
7880
+ * @tags artifacts
7881
+ * @name ArtifactsListPost
7882
+ * @request POST:/artifacts.list
7883
+ * @secure
7884
+ */
7885
+ artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
7886
+ /**
7887
+ * @description Gets the download URL for the artifact.
7888
+ *
7889
+ * @tags artifacts
7890
+ * @name ArtifactsLocate
7891
+ * @request GET:/artifacts.locate
7892
+ * @secure
7893
+ */
7894
+ artifactsLocate: (query: {
7895
+ /**
7896
+ * The ID of the artifact to get the URL for.
7897
+ * @example "ARTIFACT-12345"
7898
+ */
7899
+ id: string;
7900
+ /** The version of the artifact that needs to be fetched. */
7901
+ version?: string;
7902
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
7903
+ /**
7904
+ * @description Gets the download URL for the artifact.
7905
+ *
7906
+ * @tags artifacts
7907
+ * @name ArtifactsLocatePost
7908
+ * @request POST:/artifacts.locate
7909
+ * @secure
7910
+ */
7911
+ artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
7912
+ /**
7913
+ * @description Creates an artifact and generates an upload URL for its data.
7914
+ *
7915
+ * @tags artifacts
7916
+ * @name ArtifactsPrepare
7917
+ * @request POST:/artifacts.prepare
7918
+ * @secure
7919
+ */
7920
+ artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
7921
+ /**
7922
+ * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
7923
+ *
7924
+ * @tags artifacts
7925
+ * @name ArtifactsVersionsPrepare
7926
+ * @request POST:/artifacts.versions.prepare
7927
+ * @secure
7928
+ */
7929
+ artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
7930
+ /**
7931
+ * @description Creates a JWT corresponding to the requested token type for the authenticated user.
7932
+ *
7933
+ * @tags auth-tokens
7934
+ * @name AuthTokensCreate
7935
+ * @request POST:/auth-tokens.create
7936
+ * @secure
7937
+ */
7938
+ authTokensCreate: (data: AuthTokensCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensCreateResponse, any>>;
7939
+ /**
7940
+ * @description Revokes the token that matches the given token ID issued under the given Dev organization.
7941
+ *
7942
+ * @tags auth-tokens
7943
+ * @name AuthTokensDelete
7944
+ * @request POST:/auth-tokens.delete
7945
+ * @secure
7946
+ */
7947
+ authTokensDelete: (data: AuthTokensDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
7948
+ /**
7949
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
7950
+ *
7951
+ * @tags auth-tokens
7952
+ * @name AuthTokensGet
7953
+ * @request GET:/auth-tokens.get
7954
+ * @secure
7955
+ */
7956
+ authTokensGet: (query: {
7957
+ /** The unique identifier of the token under a given Dev organization. */
7958
+ token_id: string;
7959
+ }, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
7960
+ /**
7961
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
7962
+ *
7963
+ * @tags auth-tokens
7964
+ * @name AuthTokensGetPost
7965
+ * @request POST:/auth-tokens.get
7966
+ * @secure
7967
+ */
7968
+ authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any>>;
7969
+ /**
7970
+ * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
7971
+ *
7972
+ * @tags auth-tokens
7973
+ * @name AuthTokensList
7974
+ * @request GET:/auth-tokens.list
7975
+ * @secure
7976
+ */
7977
+ authTokensList: (query?: {
7978
+ /**
7979
+ * An identifier that represents the application, which requested the
7980
+ * token. Only relevant for application access tokens.
7981
+ */
7982
+ client_id?: string;
7983
+ /**
7984
+ * The type of the requested token. If no value is specified, the
7985
+ * response will include tokens of all the types.
7986
+ */
7987
+ requested_token_type?: AuthTokenRequestedTokenType;
7988
+ /**
7989
+ * The subject associated with the token. In the absence of this
7990
+ * parameter, the ID of the authenticated entity is treated as the
7991
+ * subject.
7992
+ */
7993
+ subject?: string;
7994
+ }, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
6323
7995
  /**
6324
- * @description Updates an article.
7996
+ * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
6325
7997
  *
6326
- * @tags articles
6327
- * @name UpdateArticle
6328
- * @request POST:/articles.update
7998
+ * @tags auth-tokens
7999
+ * @name AuthTokensListPost
8000
+ * @request POST:/auth-tokens.list
6329
8001
  * @secure
6330
8002
  */
6331
- updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
8003
+ authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any>>;
6332
8004
  /**
6333
- * @description Creates an artifact and generates an upload URL for its data.
8005
+ * @description Revokes all the tokens that matches the given token type created by the authenticated user.
6334
8006
  *
6335
- * @tags artifacts
6336
- * @name ArtifactsPrepare
6337
- * @request POST:/artifacts.prepare
8007
+ * @tags auth-tokens
8008
+ * @name AuthTokensSelfDelete
8009
+ * @request POST:/auth-tokens.self.delete
6338
8010
  * @secure
6339
8011
  */
6340
- artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
8012
+ authTokensSelfDelete: (data: AuthTokensSelfDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
6341
8013
  /**
6342
- * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
8014
+ * @description Updates token metadata of a token issued under a given Dev organization.
6343
8015
  *
6344
- * @tags artifacts
6345
- * @name ArtifactsVersionsPrepare
6346
- * @request POST:/artifacts.versions.prepare
8016
+ * @tags auth-tokens
8017
+ * @name AuthTokensUpdate
8018
+ * @request POST:/auth-tokens.update
6347
8019
  * @secure
6348
8020
  */
6349
- artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any>>;
8021
+ authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
6350
8022
  /**
6351
8023
  * @description Create CodeChange object.
6352
8024
  *
@@ -6635,6 +8307,164 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6635
8307
  * @secure
6636
8308
  */
6637
8309
  conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
8310
+ /**
8311
+ * @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.
8312
+ *
8313
+ * @tags auth-connection, dev-orgs
8314
+ * @name DevOrgAuthConnectionsCreate
8315
+ * @request POST:/dev-orgs.auth-connections.create
8316
+ * @secure
8317
+ */
8318
+ devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any>>;
8319
+ /**
8320
+ * @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.
8321
+ *
8322
+ * @tags auth-connection, dev-orgs
8323
+ * @name DevOrgAuthConnectionsDelete
8324
+ * @request POST:/dev-orgs.auth-connections.delete
8325
+ * @secure
8326
+ */
8327
+ devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
8328
+ /**
8329
+ * @description Retrieves the details for an authentication connection.
8330
+ *
8331
+ * @tags auth-connection, dev-orgs
8332
+ * @name DevOrgAuthConnectionsGet
8333
+ * @request GET:/dev-orgs.auth-connections.get
8334
+ * @secure
8335
+ */
8336
+ devOrgAuthConnectionsGet: (query: {
8337
+ /** ID of the authentication connection. */
8338
+ id: string;
8339
+ }, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
8340
+ /**
8341
+ * @description Retrieves the details for an authentication connection.
8342
+ *
8343
+ * @tags auth-connection, dev-orgs
8344
+ * @name DevOrgAuthConnectionsGetPost
8345
+ * @request POST:/dev-orgs.auth-connections.get
8346
+ * @secure
8347
+ */
8348
+ devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any>>;
8349
+ /**
8350
+ * @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.
8351
+ *
8352
+ * @tags auth-connection, dev-orgs
8353
+ * @name DevOrgAuthConnectionsList
8354
+ * @request GET:/dev-orgs.auth-connections.list
8355
+ * @secure
8356
+ */
8357
+ devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
8358
+ /**
8359
+ * @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.
8360
+ *
8361
+ * @tags auth-connection, dev-orgs
8362
+ * @name DevOrgAuthConnectionsListPost
8363
+ * @request POST:/dev-orgs.auth-connections.list
8364
+ * @secure
8365
+ */
8366
+ devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any>>;
8367
+ /**
8368
+ * @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.
8369
+ *
8370
+ * @tags auth-connection, dev-orgs
8371
+ * @name DevOrgAuthConnectionsToggle
8372
+ * @request POST:/dev-orgs.auth-connections.toggle
8373
+ * @secure
8374
+ */
8375
+ devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
8376
+ /**
8377
+ * @description Updates an authentication connection.
8378
+ *
8379
+ * @tags auth-connection, dev-orgs
8380
+ * @name DevOrgAuthConnectionsUpdate
8381
+ * @request POST:/dev-orgs.auth-connections.update
8382
+ * @secure
8383
+ */
8384
+ devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
8385
+ /**
8386
+ * @description Gets the requested user's information.
8387
+ *
8388
+ * @tags dev-users
8389
+ * @name DevUsersGet
8390
+ * @request GET:/dev-users.get
8391
+ * @secure
8392
+ */
8393
+ devUsersGet: (query: {
8394
+ /** User ID of the requested Dev user. */
8395
+ id: string;
8396
+ }, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
8397
+ /**
8398
+ * @description Gets the requested user's information.
8399
+ *
8400
+ * @tags dev-users
8401
+ * @name DevUsersGetPost
8402
+ * @request POST:/dev-users.get
8403
+ * @secure
8404
+ */
8405
+ devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
8406
+ /**
8407
+ * @description Lists users within your organization.
8408
+ *
8409
+ * @tags dev-users
8410
+ * @name DevUsersList
8411
+ * @request GET:/dev-users.list
8412
+ * @secure
8413
+ */
8414
+ devUsersList: (query?: {
8415
+ /**
8416
+ * The cursor to resume iteration from. If not provided, then iteration
8417
+ * starts from the beginning.
8418
+ */
8419
+ cursor?: string;
8420
+ /** Filters Dev users based on email addresses. */
8421
+ email?: string[];
8422
+ /** Unique ID of the user in the external source. */
8423
+ 'external_identity.id'?: string;
8424
+ /** Issuer of the external identity of the user. */
8425
+ 'external_identity.issuer'?: string;
8426
+ /**
8427
+ * The maximum number of Dev users to return. The default is '50'.
8428
+ * @format int32
8429
+ */
8430
+ limit?: number;
8431
+ /**
8432
+ * The iteration mode to use, otherwise if not set, then "after" is
8433
+ * used.
8434
+ */
8435
+ mode?: ListMode;
8436
+ /** Fields to sort the Dev users by and the direction to sort them. */
8437
+ sort_by?: string[];
8438
+ /** Filters Dev users based on state. */
8439
+ state?: UserState[];
8440
+ }, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
8441
+ /**
8442
+ * @description Lists users within your organization.
8443
+ *
8444
+ * @tags dev-users
8445
+ * @name DevUsersListPost
8446
+ * @request POST:/dev-users.list
8447
+ * @secure
8448
+ */
8449
+ devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
8450
+ /**
8451
+ * @description Gets the authenticated user's information.
8452
+ *
8453
+ * @tags dev-users
8454
+ * @name DevUsersSelf
8455
+ * @request GET:/dev-users.self
8456
+ * @secure
8457
+ */
8458
+ devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
8459
+ /**
8460
+ * @description Gets the authenticated user's information.
8461
+ *
8462
+ * @tags dev-users
8463
+ * @name DevUsersSelfPost
8464
+ * @request POST:/dev-users.self
8465
+ * @secure
8466
+ */
8467
+ devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
6638
8468
  /**
6639
8469
  * @description Counts the engagement records.
6640
8470
  *
@@ -6849,6 +8679,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6849
8679
  * starts from the beginning.
6850
8680
  */
6851
8681
  cursor?: string;
8682
+ /** Filters the groups based on the group type. */
8683
+ group_type?: GroupType[];
6852
8684
  /**
6853
8685
  * The maximum number of groups to return. The default is '50'.
6854
8686
  * @format int32
@@ -7332,6 +9164,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7332
9164
  * @secure
7333
9165
  */
7334
9166
  revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any>>;
9167
+ /**
9168
+ * @description Deletes the Rev organization.
9169
+ *
9170
+ * @tags rev-orgs
9171
+ * @name RevOrgsDelete
9172
+ * @request POST:/rev-orgs.delete
9173
+ * @secure
9174
+ */
9175
+ revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
7335
9176
  /**
7336
9177
  * @description Retrieves the Rev organization's information.
7337
9178
  *
@@ -7562,7 +9403,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7562
9403
  * @example "2023-01-01T12:00:00.000Z"
7563
9404
  */
7564
9405
  'modified_date.before'?: string;
7565
- /** List of phone numbers to filter Rev users on. */
9406
+ /** List of phone numbers, in E.164 format, to filter Rev users on. */
7566
9407
  phone_numbers?: string[];
7567
9408
  /**
7568
9409
  * List of IDs of Rev organizations to be filtered.
@@ -7695,6 +9536,62 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7695
9536
  * @secure
7696
9537
  */
7697
9538
  customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
9539
+ /**
9540
+ * @description Gets a stock schema fragment.
9541
+ *
9542
+ * @tags customization
9543
+ * @name StockSchemaFragmentsGet
9544
+ * @request GET:/schemas.stock.get
9545
+ * @secure
9546
+ */
9547
+ stockSchemaFragmentsGet: (query?: {
9548
+ /** The ID of the stock schema fragment. */
9549
+ id?: string;
9550
+ /** The leaf type this fragment applies to. */
9551
+ leaf_type?: string;
9552
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
9553
+ /**
9554
+ * @description Gets a stock schema fragment.
9555
+ *
9556
+ * @tags customization
9557
+ * @name StockSchemaFragmentsGetPost
9558
+ * @request POST:/schemas.stock.get
9559
+ * @secure
9560
+ */
9561
+ stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
9562
+ /**
9563
+ * @description Lists stock schema fragments.
9564
+ *
9565
+ * @tags customization
9566
+ * @name StockSchemaFragmentsList
9567
+ * @request GET:/schemas.stock.list
9568
+ * @secure
9569
+ */
9570
+ stockSchemaFragmentsList: (query?: {
9571
+ /**
9572
+ * The cursor to resume iteration from, otherwise if not provided, then
9573
+ * iteration starts from the beginning.
9574
+ */
9575
+ cursor?: string;
9576
+ /** The list of leaf types. */
9577
+ leaf_type?: string[];
9578
+ /**
9579
+ * The maximum number of items.
9580
+ * @format int32
9581
+ */
9582
+ limit?: number;
9583
+ /** The list of fields to sort the items by and how to sort them. */
9584
+ sort_by?: string[];
9585
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
9586
+ /**
9587
+ * @description Lists stock schema fragments.
9588
+ *
9589
+ * @tags customization
9590
+ * @name StockSchemaFragmentsListPost
9591
+ * @request POST:/schemas.stock.list
9592
+ * @secure
9593
+ */
9594
+ stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
7698
9595
  /**
7699
9596
  * @description Lists subtypes.
7700
9597
  *
@@ -7835,6 +9732,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7835
9732
  * @secure
7836
9733
  */
7837
9734
  slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
9735
+ /**
9736
+ * @description Gets snap-in resources for a user in a snap-in.
9737
+ *
9738
+ * @tags snap-ins
9739
+ * @name SnapInsResources
9740
+ * @request GET:/snap-ins.resources
9741
+ * @secure
9742
+ */
9743
+ snapInsResources: (query: {
9744
+ /** The ID of the snap-in to get resources for. */
9745
+ id: string;
9746
+ /** The ID of the user to get resources for. */
9747
+ user: string;
9748
+ }, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
9749
+ /**
9750
+ * @description Gets snap-in resources for a user in a snap-in.
9751
+ *
9752
+ * @tags snap-ins
9753
+ * @name SnapInsResourcesPost
9754
+ * @request POST:/snap-ins.resources
9755
+ * @secure
9756
+ */
9757
+ snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
7838
9758
  /**
7839
9759
  * @description Lists system users within your organization.
7840
9760
  *
@@ -7881,6 +9801,95 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7881
9801
  * @secure
7882
9802
  */
7883
9803
  sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any>>;
9804
+ /**
9805
+ * @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
9806
+ *
9807
+ * @tags tags
9808
+ * @name TagsCreate
9809
+ * @request POST:/tags.create
9810
+ * @secure
9811
+ */
9812
+ tagsCreate: (data: TagsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsCreateResponse, any>>;
9813
+ /**
9814
+ * @description Deletes a tag.
9815
+ *
9816
+ * @tags tags
9817
+ * @name TagsDelete
9818
+ * @request POST:/tags.delete
9819
+ * @secure
9820
+ */
9821
+ tagsDelete: (data: TagsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
9822
+ /**
9823
+ * @description Gets a tag's information.
9824
+ *
9825
+ * @tags tags
9826
+ * @name TagsGet
9827
+ * @request GET:/tags.get
9828
+ * @secure
9829
+ */
9830
+ tagsGet: (query: {
9831
+ /**
9832
+ * The requested tag's ID.
9833
+ * @example "TAG-12345"
9834
+ */
9835
+ id: string;
9836
+ }, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
9837
+ /**
9838
+ * @description Gets a tag's information.
9839
+ *
9840
+ * @tags tags
9841
+ * @name TagsGetPost
9842
+ * @request POST:/tags.get
9843
+ * @secure
9844
+ */
9845
+ tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any>>;
9846
+ /**
9847
+ * @description Lists the available tags.
9848
+ *
9849
+ * @tags tags
9850
+ * @name TagsList
9851
+ * @request GET:/tags.list
9852
+ * @secure
9853
+ */
9854
+ tagsList: (query?: {
9855
+ /**
9856
+ * The cursor to resume iteration from. If not provided, then iteration
9857
+ * starts from the beginning.
9858
+ */
9859
+ cursor?: string;
9860
+ /**
9861
+ * The maximum number of tags to return. The default is '50'.
9862
+ * @format int32
9863
+ */
9864
+ limit?: number;
9865
+ /**
9866
+ * The iteration mode to use, otherwise if not set, then "after" is
9867
+ * used.
9868
+ */
9869
+ mode?: ListMode;
9870
+ /** Filters for tags with the provided names. */
9871
+ name?: string[];
9872
+ /** Fields to sort tags by and the direction to sort them. */
9873
+ sort_by?: string[];
9874
+ }, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
9875
+ /**
9876
+ * @description Lists the available tags.
9877
+ *
9878
+ * @tags tags
9879
+ * @name TagsListPost
9880
+ * @request POST:/tags.list
9881
+ * @secure
9882
+ */
9883
+ tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
9884
+ /**
9885
+ * @description Updates a tag's information.
9886
+ *
9887
+ * @tags tags
9888
+ * @name TagsUpdate
9889
+ * @request POST:/tags.update
9890
+ * @secure
9891
+ */
9892
+ tagsUpdate: (data: TagsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsUpdateResponse, any>>;
7884
9893
  /**
7885
9894
  * @description Creates a new entry on an object's timeline.
7886
9895
  *
@@ -7890,6 +9899,39 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7890
9899
  * @secure
7891
9900
  */
7892
9901
  timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any>>;
9902
+ /**
9903
+ * @description Deletes an entry from an object's timeline.
9904
+ *
9905
+ * @tags timeline-entries
9906
+ * @name TimelineEntriesDelete
9907
+ * @request POST:/timeline-entries.delete
9908
+ * @secure
9909
+ */
9910
+ timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
9911
+ /**
9912
+ * @description Gets an entry on an object's timeline.
9913
+ *
9914
+ * @tags timeline-entries
9915
+ * @name TimelineEntriesGet
9916
+ * @request GET:/timeline-entries.get
9917
+ * @secure
9918
+ */
9919
+ timelineEntriesGet: (query: {
9920
+ /**
9921
+ * The ID of the timeline entry to get.
9922
+ * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
9923
+ */
9924
+ id: string;
9925
+ }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
9926
+ /**
9927
+ * @description Gets an entry on an object's timeline.
9928
+ *
9929
+ * @tags timeline-entries
9930
+ * @name TimelineEntriesGetPost
9931
+ * @request POST:/timeline-entries.get
9932
+ * @secure
9933
+ */
9934
+ timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
7893
9935
  /**
7894
9936
  * @description Lists the timeline entries for an object.
7895
9937
  *
@@ -8066,6 +10108,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8066
10108
  * @secure
8067
10109
  */
8068
10110
  uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
10111
+ /**
10112
+ * @description Creates a new webhook target.
10113
+ *
10114
+ * @tags webhooks
10115
+ * @name WebhooksCreate
10116
+ * @request POST:/webhooks.create
10117
+ * @secure
10118
+ */
10119
+ webhooksCreate: (data: WebhooksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksCreateResponse, any>>;
10120
+ /**
10121
+ * @description Deletes the requested webhook.
10122
+ *
10123
+ * @tags webhooks
10124
+ * @name WebhooksDelete
10125
+ * @request POST:/webhooks.delete
10126
+ * @secure
10127
+ */
10128
+ webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
10129
+ /**
10130
+ * @description Gets the requested webhook's information.
10131
+ *
10132
+ * @tags webhooks
10133
+ * @name WebhooksGet
10134
+ * @request GET:/webhooks.get
10135
+ * @secure
10136
+ */
10137
+ webhooksGet: (query: {
10138
+ /**
10139
+ * ID for the webhook.
10140
+ * @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
10141
+ */
10142
+ id: string;
10143
+ }, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
10144
+ /**
10145
+ * @description Gets the requested webhook's information.
10146
+ *
10147
+ * @tags webhooks
10148
+ * @name WebhooksGetPost
10149
+ * @request POST:/webhooks.get
10150
+ * @secure
10151
+ */
10152
+ webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any>>;
10153
+ /**
10154
+ * @description Lists the webhooks.
10155
+ *
10156
+ * @tags webhooks
10157
+ * @name WebhooksList
10158
+ * @request GET:/webhooks.list
10159
+ * @secure
10160
+ */
10161
+ webhooksList: (params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
10162
+ /**
10163
+ * @description Lists the webhooks.
10164
+ *
10165
+ * @tags webhooks
10166
+ * @name WebhooksListPost
10167
+ * @request POST:/webhooks.list
10168
+ * @secure
10169
+ */
10170
+ webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any>>;
10171
+ /**
10172
+ * @description Updates the requested webhook.
10173
+ *
10174
+ * @tags webhooks
10175
+ * @name WebhooksUpdate
10176
+ * @request POST:/webhooks.update
10177
+ * @secure
10178
+ */
10179
+ webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any>>;
8069
10180
  /**
8070
10181
  * @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.
8071
10182
  *
@@ -8111,8 +10222,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8111
10222
  * @format int32
8112
10223
  */
8113
10224
  first?: number;
10225
+ /**
10226
+ * Filters for issues with any of the provided Accounts.
10227
+ * @example ["ACC-12345"]
10228
+ */
10229
+ 'issue.accounts'?: string[];
8114
10230
  /** Filters for issues with any of the provided priorities. */
8115
10231
  'issue.priority'?: IssuePriority[];
10232
+ /** Filters for issues with any of the provided priority enum ids. */
10233
+ 'issue.priority_v2'?: number[];
8116
10234
  /**
8117
10235
  * Filters for issues with any of the provided Rev organizations.
8118
10236
  * @example ["REV-AbCdEfGh"]
@@ -8130,6 +10248,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8130
10248
  * @example ["DEVU-12345"]
8131
10249
  */
8132
10250
  owned_by?: string[];
10251
+ /**
10252
+ * Filters for work reported by any of these users.
10253
+ * @example ["DEVU-12345"]
10254
+ */
10255
+ reported_by?: string[];
8133
10256
  /** Fields to sort the work items by and the direction to sort them. */
8134
10257
  sort_by?: string[];
8135
10258
  /** Filters for records in the provided stage(s) by name. */
@@ -8139,6 +10262,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8139
10262
  * @example ["TAG-12345"]
8140
10263
  */
8141
10264
  tags?: string[];
10265
+ /** Filters for tickets with any of the provided channels. */
10266
+ 'ticket.channels'?: TicketChannels[];
8142
10267
  /** Filters for tickets belonging to specific groups. */
8143
10268
  'ticket.group'?: string[];
8144
10269
  /** Filters for tickets that are spam. */
@@ -8219,8 +10344,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8219
10344
  cursor?: string;
8220
10345
  /** Filters for custom fields. */
8221
10346
  custom_fields?: object;
10347
+ /**
10348
+ * Filters for issues with any of the provided Accounts.
10349
+ * @example ["ACC-12345"]
10350
+ */
10351
+ 'issue.accounts'?: string[];
8222
10352
  /** Filters for issues with any of the provided priorities. */
8223
10353
  'issue.priority'?: IssuePriority[];
10354
+ /** Filters for issues with any of the provided priority enum ids. */
10355
+ 'issue.priority_v2'?: number[];
8224
10356
  /**
8225
10357
  * Filters for issues with any of the provided Rev organizations.
8226
10358
  * @example ["REV-AbCdEfGh"]
@@ -8248,6 +10380,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8248
10380
  * @example ["DEVU-12345"]
8249
10381
  */
8250
10382
  owned_by?: string[];
10383
+ /**
10384
+ * Filters for work reported by any of these users.
10385
+ * @example ["DEVU-12345"]
10386
+ */
10387
+ reported_by?: string[];
8251
10388
  /** Fields to sort the works by and the direction to sort them. */
8252
10389
  sort_by?: string[];
8253
10390
  /** Filters for records in the provided stage(s) by name. */
@@ -8257,6 +10394,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8257
10394
  * @example ["TAG-12345"]
8258
10395
  */
8259
10396
  tags?: string[];
10397
+ /** Filters for tickets with any of the provided channels. */
10398
+ 'ticket.channels'?: TicketChannels[];
8260
10399
  /** Filters for tickets belonging to specific groups. */
8261
10400
  'ticket.group'?: string[];
8262
10401
  /** Filters for tickets that are spam. */