@devrev/typescript-sdk 1.1.20 → 1.1.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -77,10 +77,11 @@ export interface AccountsCreateRequest {
|
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
79
|
* accounts-create-response
|
|
80
|
-
*
|
|
80
|
+
* The response to creating a new account.
|
|
81
81
|
*/
|
|
82
82
|
export interface AccountsCreateResponse {
|
|
83
83
|
account: Account;
|
|
84
|
+
default_rev_org: RevOrg;
|
|
84
85
|
}
|
|
85
86
|
/**
|
|
86
87
|
* accounts-delete-request
|
|
@@ -1192,7 +1193,10 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
|
|
|
1192
1193
|
type: CustomSchemaFragmentType;
|
|
1193
1194
|
};
|
|
1194
1195
|
/** custom-schema-fragment-base */
|
|
1195
|
-
export type CustomSchemaFragmentBase = AtomBase
|
|
1196
|
+
export type CustomSchemaFragmentBase = AtomBase & {
|
|
1197
|
+
/** List of all fields in this custom schema fragment. */
|
|
1198
|
+
fields?: SchemaFieldDescriptor[];
|
|
1199
|
+
};
|
|
1196
1200
|
/**
|
|
1197
1201
|
* custom-schema-fragment-condition
|
|
1198
1202
|
* The condition associated with a field.
|
|
@@ -1974,6 +1978,88 @@ export declare enum GroupMemberType {
|
|
|
1974
1978
|
DevUser = "dev_user",
|
|
1975
1979
|
RevUser = "rev_user"
|
|
1976
1980
|
}
|
|
1981
|
+
/**
|
|
1982
|
+
* group-members-add-request
|
|
1983
|
+
* A request to add a new member to a group.
|
|
1984
|
+
*/
|
|
1985
|
+
export interface GroupMembersAddRequest {
|
|
1986
|
+
/** ID of the group where the member is being added. */
|
|
1987
|
+
group: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* ID of the member to be added.
|
|
1990
|
+
* @example "DEVU-12345"
|
|
1991
|
+
*/
|
|
1992
|
+
member: string;
|
|
1993
|
+
}
|
|
1994
|
+
/** group-members-add-response */
|
|
1995
|
+
export type GroupMembersAddResponse = object;
|
|
1996
|
+
/**
|
|
1997
|
+
* group-members-list-request
|
|
1998
|
+
* A request to list group members.
|
|
1999
|
+
*/
|
|
2000
|
+
export interface GroupMembersListRequest {
|
|
2001
|
+
/**
|
|
2002
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2003
|
+
* iteration starts from the beginning.
|
|
2004
|
+
*/
|
|
2005
|
+
cursor?: string;
|
|
2006
|
+
/** ID of the group for which to list members. */
|
|
2007
|
+
group: string;
|
|
2008
|
+
/**
|
|
2009
|
+
* The maximum number of members to return. If not set, then the
|
|
2010
|
+
* default is '50'.
|
|
2011
|
+
* @format int32
|
|
2012
|
+
*/
|
|
2013
|
+
limit?: number;
|
|
2014
|
+
/**
|
|
2015
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2016
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2017
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2018
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2019
|
+
* always be returned in the specified sort-by order.
|
|
2020
|
+
*/
|
|
2021
|
+
mode?: ListMode;
|
|
2022
|
+
}
|
|
2023
|
+
/**
|
|
2024
|
+
* group-members-list-response
|
|
2025
|
+
* List of group members.
|
|
2026
|
+
*/
|
|
2027
|
+
export interface GroupMembersListResponse {
|
|
2028
|
+
/** List of members. */
|
|
2029
|
+
members: GroupMembersListResponseMember[];
|
|
2030
|
+
/**
|
|
2031
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2032
|
+
* sort order. If not set, then no later elements exist.
|
|
2033
|
+
*/
|
|
2034
|
+
next_cursor?: string;
|
|
2035
|
+
/**
|
|
2036
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2037
|
+
* sort order. If not set, then no prior elements exist.
|
|
2038
|
+
*/
|
|
2039
|
+
prev_cursor?: string;
|
|
2040
|
+
}
|
|
2041
|
+
/**
|
|
2042
|
+
* group-members-list-response-member
|
|
2043
|
+
* A group member.
|
|
2044
|
+
*/
|
|
2045
|
+
export interface GroupMembersListResponseMember {
|
|
2046
|
+
member: MemberSummary;
|
|
2047
|
+
}
|
|
2048
|
+
/**
|
|
2049
|
+
* group-members-remove-request
|
|
2050
|
+
* A request to remove a group member.
|
|
2051
|
+
*/
|
|
2052
|
+
export interface GroupMembersRemoveRequest {
|
|
2053
|
+
/** ID of the group where the member is being removed. */
|
|
2054
|
+
group: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* ID of the member to be removed.
|
|
2057
|
+
* @example "DEVU-12345"
|
|
2058
|
+
*/
|
|
2059
|
+
member: string;
|
|
2060
|
+
}
|
|
2061
|
+
/** group-members-remove-response */
|
|
2062
|
+
export type GroupMembersRemoveResponse = object;
|
|
1977
2063
|
/** group-summary */
|
|
1978
2064
|
export type GroupSummary = AtomBaseSummary & {
|
|
1979
2065
|
/** Name of the group. */
|
|
@@ -2291,6 +2377,15 @@ export declare enum ListMode {
|
|
|
2291
2377
|
After = "after",
|
|
2292
2378
|
Before = "before"
|
|
2293
2379
|
}
|
|
2380
|
+
/** member-summary */
|
|
2381
|
+
export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
2382
|
+
type: MemberType;
|
|
2383
|
+
};
|
|
2384
|
+
export declare enum MemberType {
|
|
2385
|
+
DevUser = "dev_user",
|
|
2386
|
+
RevUser = "rev_user",
|
|
2387
|
+
SysUser = "sys_user"
|
|
2388
|
+
}
|
|
2294
2389
|
/** metric-data-point */
|
|
2295
2390
|
export interface MetricDataPoint {
|
|
2296
2391
|
/**
|
|
@@ -5136,6 +5231,7 @@ export interface UomsUpdateRequest {
|
|
|
5136
5231
|
aggregation_type?: AggregationDetailAggregationType;
|
|
5137
5232
|
/** Description of the Unit of Measurement (UOM). */
|
|
5138
5233
|
description?: string;
|
|
5234
|
+
dimensions?: UomsUpdateRequestDimensions;
|
|
5139
5235
|
/** The Unit of Measurement (UOM)'s DON. */
|
|
5140
5236
|
id: string;
|
|
5141
5237
|
/**
|
|
@@ -5160,6 +5256,13 @@ export interface UomsUpdateRequest {
|
|
|
5160
5256
|
/** Unit name of the Unit of Measurement (UOM). */
|
|
5161
5257
|
unit?: string;
|
|
5162
5258
|
}
|
|
5259
|
+
/** uoms-update-request-dimensions */
|
|
5260
|
+
export interface UomsUpdateRequestDimensions {
|
|
5261
|
+
/** Adds the provided dimensions to the UOM. */
|
|
5262
|
+
add?: string[];
|
|
5263
|
+
/** Removes the provided dimensions from the UOM. */
|
|
5264
|
+
remove?: string[];
|
|
5265
|
+
}
|
|
5163
5266
|
/** uoms-update-response */
|
|
5164
5267
|
export interface UomsUpdateResponse {
|
|
5165
5268
|
uom: Uom;
|
|
@@ -6770,6 +6873,61 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6770
6873
|
* @secure
|
|
6771
6874
|
*/
|
|
6772
6875
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
6876
|
+
/**
|
|
6877
|
+
* @description Adds a member to a group.
|
|
6878
|
+
*
|
|
6879
|
+
* @tags groups
|
|
6880
|
+
* @name GroupMembersAdd
|
|
6881
|
+
* @request POST:/groups.members.add
|
|
6882
|
+
* @secure
|
|
6883
|
+
*/
|
|
6884
|
+
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
6885
|
+
/**
|
|
6886
|
+
* @description Lists the members in a group.
|
|
6887
|
+
*
|
|
6888
|
+
* @tags groups
|
|
6889
|
+
* @name GroupMembersList
|
|
6890
|
+
* @request GET:/groups.members.list
|
|
6891
|
+
* @secure
|
|
6892
|
+
*/
|
|
6893
|
+
groupMembersList: (query: {
|
|
6894
|
+
/** ID of the group for which to list members. */
|
|
6895
|
+
group: string;
|
|
6896
|
+
/**
|
|
6897
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
6898
|
+
* starts from the beginning.
|
|
6899
|
+
*/
|
|
6900
|
+
cursor?: string;
|
|
6901
|
+
/**
|
|
6902
|
+
* The maximum number of members to return. If not set, then the default
|
|
6903
|
+
* is '50'.
|
|
6904
|
+
* @format int32
|
|
6905
|
+
*/
|
|
6906
|
+
limit?: number;
|
|
6907
|
+
/**
|
|
6908
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
6909
|
+
* used.
|
|
6910
|
+
*/
|
|
6911
|
+
mode?: ListMode;
|
|
6912
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
6913
|
+
/**
|
|
6914
|
+
* @description Lists the members in a group.
|
|
6915
|
+
*
|
|
6916
|
+
* @tags groups
|
|
6917
|
+
* @name GroupMembersListPost
|
|
6918
|
+
* @request POST:/groups.members.list
|
|
6919
|
+
* @secure
|
|
6920
|
+
*/
|
|
6921
|
+
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
6922
|
+
/**
|
|
6923
|
+
* @description Removes a member from a group.
|
|
6924
|
+
*
|
|
6925
|
+
* @tags groups
|
|
6926
|
+
* @name GroupMembersRemove
|
|
6927
|
+
* @request POST:/groups.members.remove
|
|
6928
|
+
* @secure
|
|
6929
|
+
*/
|
|
6930
|
+
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
6773
6931
|
/**
|
|
6774
6932
|
* @description Updates the requested group.
|
|
6775
6933
|
*
|
|
@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
37
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = void 0;
|
|
36
|
+
exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = void 0;
|
|
38
38
|
var AccessLevel;
|
|
39
39
|
(function (AccessLevel) {
|
|
40
40
|
AccessLevel["External"] = "external";
|
|
@@ -241,6 +241,12 @@ var ListMode;
|
|
|
241
241
|
ListMode["After"] = "after";
|
|
242
242
|
ListMode["Before"] = "before";
|
|
243
243
|
})(ListMode = exports.ListMode || (exports.ListMode = {}));
|
|
244
|
+
var MemberType;
|
|
245
|
+
(function (MemberType) {
|
|
246
|
+
MemberType["DevUser"] = "dev_user";
|
|
247
|
+
MemberType["RevUser"] = "rev_user";
|
|
248
|
+
MemberType["SysUser"] = "sys_user";
|
|
249
|
+
})(MemberType = exports.MemberType || (exports.MemberType = {}));
|
|
244
250
|
/** The list of item types on which the metric might be applied. */
|
|
245
251
|
var MetricDefinitionAppliesTo;
|
|
246
252
|
(function (MetricDefinitionAppliesTo) {
|
|
@@ -1125,6 +1131,42 @@ class Api extends HttpClient {
|
|
|
1125
1131
|
* @secure
|
|
1126
1132
|
*/
|
|
1127
1133
|
this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1134
|
+
/**
|
|
1135
|
+
* @description Adds a member to a group.
|
|
1136
|
+
*
|
|
1137
|
+
* @tags groups
|
|
1138
|
+
* @name GroupMembersAdd
|
|
1139
|
+
* @request POST:/groups.members.add
|
|
1140
|
+
* @secure
|
|
1141
|
+
*/
|
|
1142
|
+
this.groupMembersAdd = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.add`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1143
|
+
/**
|
|
1144
|
+
* @description Lists the members in a group.
|
|
1145
|
+
*
|
|
1146
|
+
* @tags groups
|
|
1147
|
+
* @name GroupMembersList
|
|
1148
|
+
* @request GET:/groups.members.list
|
|
1149
|
+
* @secure
|
|
1150
|
+
*/
|
|
1151
|
+
this.groupMembersList = (query, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1152
|
+
/**
|
|
1153
|
+
* @description Lists the members in a group.
|
|
1154
|
+
*
|
|
1155
|
+
* @tags groups
|
|
1156
|
+
* @name GroupMembersListPost
|
|
1157
|
+
* @request POST:/groups.members.list
|
|
1158
|
+
* @secure
|
|
1159
|
+
*/
|
|
1160
|
+
this.groupMembersListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1161
|
+
/**
|
|
1162
|
+
* @description Removes a member from a group.
|
|
1163
|
+
*
|
|
1164
|
+
* @tags groups
|
|
1165
|
+
* @name GroupMembersRemove
|
|
1166
|
+
* @request POST:/groups.members.remove
|
|
1167
|
+
* @secure
|
|
1168
|
+
*/
|
|
1169
|
+
this.groupMembersRemove = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1128
1170
|
/**
|
|
1129
1171
|
* @description Updates the requested group.
|
|
1130
1172
|
*
|