@rightbrain/brain-api-client 0.0.1-dev.132.3bba4c0 → 0.0.1-dev.134.8e9e716
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.
- package/api.ts +577 -0
- package/dist/api.d.ts +374 -0
- package/dist/api.js +446 -4
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -135,6 +135,158 @@ export interface AsyncJobResult {
|
|
|
135
135
|
*/
|
|
136
136
|
'task_id': Array<string>;
|
|
137
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @export
|
|
141
|
+
* @interface AuditEventDetail
|
|
142
|
+
*/
|
|
143
|
+
export interface AuditEventDetail {
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @type {string}
|
|
147
|
+
* @memberof AuditEventDetail
|
|
148
|
+
*/
|
|
149
|
+
'id': string;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @type {string}
|
|
153
|
+
* @memberof AuditEventDetail
|
|
154
|
+
*/
|
|
155
|
+
'project_id': string;
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof AuditEventDetail
|
|
160
|
+
*/
|
|
161
|
+
'org_id': string;
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @type {string}
|
|
165
|
+
* @memberof AuditEventDetail
|
|
166
|
+
*/
|
|
167
|
+
'actor_user_id': string | null;
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @type {string}
|
|
171
|
+
* @memberof AuditEventDetail
|
|
172
|
+
*/
|
|
173
|
+
'event_type': string;
|
|
174
|
+
/**
|
|
175
|
+
*
|
|
176
|
+
* @type {string}
|
|
177
|
+
* @memberof AuditEventDetail
|
|
178
|
+
*/
|
|
179
|
+
'resource_type': string | null;
|
|
180
|
+
/**
|
|
181
|
+
*
|
|
182
|
+
* @type {string}
|
|
183
|
+
* @memberof AuditEventDetail
|
|
184
|
+
*/
|
|
185
|
+
'resource_id': string | null;
|
|
186
|
+
/**
|
|
187
|
+
*
|
|
188
|
+
* @type {string}
|
|
189
|
+
* @memberof AuditEventDetail
|
|
190
|
+
*/
|
|
191
|
+
'message': string;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {{ [key: string]: any; }}
|
|
195
|
+
* @memberof AuditEventDetail
|
|
196
|
+
*/
|
|
197
|
+
'labels': { [key: string]: any; };
|
|
198
|
+
/**
|
|
199
|
+
*
|
|
200
|
+
* @type {string}
|
|
201
|
+
* @memberof AuditEventDetail
|
|
202
|
+
*/
|
|
203
|
+
'occurred_at': string;
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @type {string}
|
|
207
|
+
* @memberof AuditEventDetail
|
|
208
|
+
*/
|
|
209
|
+
'created': string;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @type {{ [key: string]: any; }}
|
|
213
|
+
* @memberof AuditEventDetail
|
|
214
|
+
*/
|
|
215
|
+
'payload': { [key: string]: any; } | null;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @export
|
|
220
|
+
* @interface AuditEventListItem
|
|
221
|
+
*/
|
|
222
|
+
export interface AuditEventListItem {
|
|
223
|
+
/**
|
|
224
|
+
*
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof AuditEventListItem
|
|
227
|
+
*/
|
|
228
|
+
'id': string;
|
|
229
|
+
/**
|
|
230
|
+
*
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof AuditEventListItem
|
|
233
|
+
*/
|
|
234
|
+
'project_id': string;
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @type {string}
|
|
238
|
+
* @memberof AuditEventListItem
|
|
239
|
+
*/
|
|
240
|
+
'org_id': string;
|
|
241
|
+
/**
|
|
242
|
+
*
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof AuditEventListItem
|
|
245
|
+
*/
|
|
246
|
+
'actor_user_id': string | null;
|
|
247
|
+
/**
|
|
248
|
+
*
|
|
249
|
+
* @type {string}
|
|
250
|
+
* @memberof AuditEventListItem
|
|
251
|
+
*/
|
|
252
|
+
'event_type': string;
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof AuditEventListItem
|
|
257
|
+
*/
|
|
258
|
+
'resource_type': string | null;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
* @type {string}
|
|
262
|
+
* @memberof AuditEventListItem
|
|
263
|
+
*/
|
|
264
|
+
'resource_id': string | null;
|
|
265
|
+
/**
|
|
266
|
+
*
|
|
267
|
+
* @type {string}
|
|
268
|
+
* @memberof AuditEventListItem
|
|
269
|
+
*/
|
|
270
|
+
'message': string;
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @type {{ [key: string]: any; }}
|
|
274
|
+
* @memberof AuditEventListItem
|
|
275
|
+
*/
|
|
276
|
+
'labels': { [key: string]: any; };
|
|
277
|
+
/**
|
|
278
|
+
*
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof AuditEventListItem
|
|
281
|
+
*/
|
|
282
|
+
'occurred_at': string;
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof AuditEventListItem
|
|
287
|
+
*/
|
|
288
|
+
'created': string;
|
|
289
|
+
}
|
|
138
290
|
/**
|
|
139
291
|
*
|
|
140
292
|
* @export
|
|
@@ -5890,6 +6042,25 @@ export interface PaginatedResultSetAnnotatedUnionAnnotatedWebhookForwarderInDBTa
|
|
|
5890
6042
|
*/
|
|
5891
6043
|
'results': Array<ResultsInner>;
|
|
5892
6044
|
}
|
|
6045
|
+
/**
|
|
6046
|
+
*
|
|
6047
|
+
* @export
|
|
6048
|
+
* @interface PaginatedResultSetAuditEventListItem
|
|
6049
|
+
*/
|
|
6050
|
+
export interface PaginatedResultSetAuditEventListItem {
|
|
6051
|
+
/**
|
|
6052
|
+
*
|
|
6053
|
+
* @type {PaginationDetails}
|
|
6054
|
+
* @memberof PaginatedResultSetAuditEventListItem
|
|
6055
|
+
*/
|
|
6056
|
+
'pagination'?: PaginationDetails;
|
|
6057
|
+
/**
|
|
6058
|
+
* The list of items returned for the current page.
|
|
6059
|
+
* @type {Array<AuditEventListItem>}
|
|
6060
|
+
* @memberof PaginatedResultSetAuditEventListItem
|
|
6061
|
+
*/
|
|
6062
|
+
'results': Array<AuditEventListItem>;
|
|
6063
|
+
}
|
|
5893
6064
|
/**
|
|
5894
6065
|
*
|
|
5895
6066
|
* @export
|
|
@@ -15275,6 +15446,412 @@ export class AgentPackApi extends BaseAPI {
|
|
|
15275
15446
|
|
|
15276
15447
|
|
|
15277
15448
|
|
|
15449
|
+
/**
|
|
15450
|
+
* AuditEventsApi - axios parameter creator
|
|
15451
|
+
* @export
|
|
15452
|
+
*/
|
|
15453
|
+
export const AuditEventsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
15454
|
+
return {
|
|
15455
|
+
/**
|
|
15456
|
+
* Export project audit events as NDJSON. Each line is a full audit event detail record, including the decrypted payload.
|
|
15457
|
+
* @summary Export Project Audit Events
|
|
15458
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15459
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15460
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15461
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15462
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15463
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15464
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15465
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15466
|
+
* @param {*} [options] Override http request option.
|
|
15467
|
+
* @throws {RequiredError}
|
|
15468
|
+
*/
|
|
15469
|
+
exportProjectAuditEvents: async (orgId: string, projectId: string, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15470
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
15471
|
+
assertParamExists('exportProjectAuditEvents', 'orgId', orgId)
|
|
15472
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
15473
|
+
assertParamExists('exportProjectAuditEvents', 'projectId', projectId)
|
|
15474
|
+
const localVarPath = `/org/{org_id}/project/{project_id}/audit_event/export`
|
|
15475
|
+
.replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
|
|
15476
|
+
.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)));
|
|
15477
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15478
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15479
|
+
let baseOptions;
|
|
15480
|
+
if (configuration) {
|
|
15481
|
+
baseOptions = configuration.baseOptions;
|
|
15482
|
+
}
|
|
15483
|
+
|
|
15484
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
15485
|
+
const localVarHeaderParameter = {} as any;
|
|
15486
|
+
const localVarQueryParameter = {} as any;
|
|
15487
|
+
|
|
15488
|
+
// authentication HTTPBearer required
|
|
15489
|
+
// http bearer authentication required
|
|
15490
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15491
|
+
|
|
15492
|
+
if (eventType) {
|
|
15493
|
+
localVarQueryParameter['event_type'] = eventType;
|
|
15494
|
+
}
|
|
15495
|
+
|
|
15496
|
+
if (actorUserId !== undefined) {
|
|
15497
|
+
localVarQueryParameter['actor_user_id'] = actorUserId;
|
|
15498
|
+
}
|
|
15499
|
+
|
|
15500
|
+
if (resourceType !== undefined) {
|
|
15501
|
+
localVarQueryParameter['resource_type'] = resourceType;
|
|
15502
|
+
}
|
|
15503
|
+
|
|
15504
|
+
if (resourceId !== undefined) {
|
|
15505
|
+
localVarQueryParameter['resource_id'] = resourceId;
|
|
15506
|
+
}
|
|
15507
|
+
|
|
15508
|
+
if (startDate !== undefined) {
|
|
15509
|
+
localVarQueryParameter['start_date'] = (startDate as any instanceof Date) ?
|
|
15510
|
+
(startDate as any).toISOString() :
|
|
15511
|
+
startDate;
|
|
15512
|
+
}
|
|
15513
|
+
|
|
15514
|
+
if (endDate !== undefined) {
|
|
15515
|
+
localVarQueryParameter['end_date'] = (endDate as any instanceof Date) ?
|
|
15516
|
+
(endDate as any).toISOString() :
|
|
15517
|
+
endDate;
|
|
15518
|
+
}
|
|
15519
|
+
|
|
15520
|
+
|
|
15521
|
+
|
|
15522
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15523
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15524
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15525
|
+
|
|
15526
|
+
return {
|
|
15527
|
+
url: toPathString(localVarUrlObj),
|
|
15528
|
+
options: localVarRequestOptions,
|
|
15529
|
+
};
|
|
15530
|
+
},
|
|
15531
|
+
/**
|
|
15532
|
+
* Retrieve a single audit event for the project. The detail response includes the decrypted payload captured for the event.
|
|
15533
|
+
* @summary Get Project Audit Event
|
|
15534
|
+
* @param {string} auditEventId
|
|
15535
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15536
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15537
|
+
* @param {*} [options] Override http request option.
|
|
15538
|
+
* @throws {RequiredError}
|
|
15539
|
+
*/
|
|
15540
|
+
getProjectAuditEvent: async (auditEventId: string, orgId: string, projectId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15541
|
+
// verify required parameter 'auditEventId' is not null or undefined
|
|
15542
|
+
assertParamExists('getProjectAuditEvent', 'auditEventId', auditEventId)
|
|
15543
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
15544
|
+
assertParamExists('getProjectAuditEvent', 'orgId', orgId)
|
|
15545
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
15546
|
+
assertParamExists('getProjectAuditEvent', 'projectId', projectId)
|
|
15547
|
+
const localVarPath = `/org/{org_id}/project/{project_id}/audit_event/{audit_event_id}`
|
|
15548
|
+
.replace(`{${"audit_event_id"}}`, encodeURIComponent(String(auditEventId)))
|
|
15549
|
+
.replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
|
|
15550
|
+
.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)));
|
|
15551
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15552
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15553
|
+
let baseOptions;
|
|
15554
|
+
if (configuration) {
|
|
15555
|
+
baseOptions = configuration.baseOptions;
|
|
15556
|
+
}
|
|
15557
|
+
|
|
15558
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
15559
|
+
const localVarHeaderParameter = {} as any;
|
|
15560
|
+
const localVarQueryParameter = {} as any;
|
|
15561
|
+
|
|
15562
|
+
// authentication HTTPBearer required
|
|
15563
|
+
// http bearer authentication required
|
|
15564
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15565
|
+
|
|
15566
|
+
|
|
15567
|
+
|
|
15568
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15569
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15570
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15571
|
+
|
|
15572
|
+
return {
|
|
15573
|
+
url: toPathString(localVarUrlObj),
|
|
15574
|
+
options: localVarRequestOptions,
|
|
15575
|
+
};
|
|
15576
|
+
},
|
|
15577
|
+
/**
|
|
15578
|
+
* List immutable audit events recorded for a project. Results are ordered by `occurred_at` descending, then `id` descending. The `cursor` parameter is an opaque pagination token and must be treated as an unreadable value by clients. Use the filters to narrow the feed by event type, actor, or resource identifiers.
|
|
15579
|
+
* @summary List Project Audit Events
|
|
15580
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15581
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15582
|
+
* @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
|
|
15583
|
+
* @param {number} [pageLimit] The maximum number of items to return per page. Defaults to `100` if not specified.
|
|
15584
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15585
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15586
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15587
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15588
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15589
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15590
|
+
* @param {*} [options] Override http request option.
|
|
15591
|
+
* @throws {RequiredError}
|
|
15592
|
+
*/
|
|
15593
|
+
listProjectAuditEvents: async (orgId: string, projectId: string, cursor?: string | null, pageLimit?: number, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15594
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
15595
|
+
assertParamExists('listProjectAuditEvents', 'orgId', orgId)
|
|
15596
|
+
// verify required parameter 'projectId' is not null or undefined
|
|
15597
|
+
assertParamExists('listProjectAuditEvents', 'projectId', projectId)
|
|
15598
|
+
const localVarPath = `/org/{org_id}/project/{project_id}/audit_event`
|
|
15599
|
+
.replace(`{${"org_id"}}`, encodeURIComponent(String(orgId)))
|
|
15600
|
+
.replace(`{${"project_id"}}`, encodeURIComponent(String(projectId)));
|
|
15601
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15602
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15603
|
+
let baseOptions;
|
|
15604
|
+
if (configuration) {
|
|
15605
|
+
baseOptions = configuration.baseOptions;
|
|
15606
|
+
}
|
|
15607
|
+
|
|
15608
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
15609
|
+
const localVarHeaderParameter = {} as any;
|
|
15610
|
+
const localVarQueryParameter = {} as any;
|
|
15611
|
+
|
|
15612
|
+
// authentication HTTPBearer required
|
|
15613
|
+
// http bearer authentication required
|
|
15614
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15615
|
+
|
|
15616
|
+
if (cursor !== undefined) {
|
|
15617
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
15618
|
+
}
|
|
15619
|
+
|
|
15620
|
+
if (pageLimit !== undefined) {
|
|
15621
|
+
localVarQueryParameter['page_limit'] = pageLimit;
|
|
15622
|
+
}
|
|
15623
|
+
|
|
15624
|
+
if (eventType) {
|
|
15625
|
+
localVarQueryParameter['event_type'] = eventType;
|
|
15626
|
+
}
|
|
15627
|
+
|
|
15628
|
+
if (actorUserId !== undefined) {
|
|
15629
|
+
localVarQueryParameter['actor_user_id'] = actorUserId;
|
|
15630
|
+
}
|
|
15631
|
+
|
|
15632
|
+
if (resourceType !== undefined) {
|
|
15633
|
+
localVarQueryParameter['resource_type'] = resourceType;
|
|
15634
|
+
}
|
|
15635
|
+
|
|
15636
|
+
if (resourceId !== undefined) {
|
|
15637
|
+
localVarQueryParameter['resource_id'] = resourceId;
|
|
15638
|
+
}
|
|
15639
|
+
|
|
15640
|
+
if (startDate !== undefined) {
|
|
15641
|
+
localVarQueryParameter['start_date'] = (startDate as any instanceof Date) ?
|
|
15642
|
+
(startDate as any).toISOString() :
|
|
15643
|
+
startDate;
|
|
15644
|
+
}
|
|
15645
|
+
|
|
15646
|
+
if (endDate !== undefined) {
|
|
15647
|
+
localVarQueryParameter['end_date'] = (endDate as any instanceof Date) ?
|
|
15648
|
+
(endDate as any).toISOString() :
|
|
15649
|
+
endDate;
|
|
15650
|
+
}
|
|
15651
|
+
|
|
15652
|
+
|
|
15653
|
+
|
|
15654
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15655
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15656
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15657
|
+
|
|
15658
|
+
return {
|
|
15659
|
+
url: toPathString(localVarUrlObj),
|
|
15660
|
+
options: localVarRequestOptions,
|
|
15661
|
+
};
|
|
15662
|
+
},
|
|
15663
|
+
}
|
|
15664
|
+
};
|
|
15665
|
+
|
|
15666
|
+
/**
|
|
15667
|
+
* AuditEventsApi - functional programming interface
|
|
15668
|
+
* @export
|
|
15669
|
+
*/
|
|
15670
|
+
export const AuditEventsApiFp = function(configuration?: Configuration) {
|
|
15671
|
+
const localVarAxiosParamCreator = AuditEventsApiAxiosParamCreator(configuration)
|
|
15672
|
+
return {
|
|
15673
|
+
/**
|
|
15674
|
+
* Export project audit events as NDJSON. Each line is a full audit event detail record, including the decrypted payload.
|
|
15675
|
+
* @summary Export Project Audit Events
|
|
15676
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15677
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15678
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15679
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15680
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15681
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15682
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15683
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15684
|
+
* @param {*} [options] Override http request option.
|
|
15685
|
+
* @throws {RequiredError}
|
|
15686
|
+
*/
|
|
15687
|
+
async exportProjectAuditEvents(orgId: string, projectId: string, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
15688
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportProjectAuditEvents(orgId, projectId, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options);
|
|
15689
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15690
|
+
const localVarOperationServerBasePath = operationServerMap['AuditEventsApi.exportProjectAuditEvents']?.[localVarOperationServerIndex]?.url;
|
|
15691
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15692
|
+
},
|
|
15693
|
+
/**
|
|
15694
|
+
* Retrieve a single audit event for the project. The detail response includes the decrypted payload captured for the event.
|
|
15695
|
+
* @summary Get Project Audit Event
|
|
15696
|
+
* @param {string} auditEventId
|
|
15697
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15698
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15699
|
+
* @param {*} [options] Override http request option.
|
|
15700
|
+
* @throws {RequiredError}
|
|
15701
|
+
*/
|
|
15702
|
+
async getProjectAuditEvent(auditEventId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuditEventDetail>> {
|
|
15703
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectAuditEvent(auditEventId, orgId, projectId, options);
|
|
15704
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15705
|
+
const localVarOperationServerBasePath = operationServerMap['AuditEventsApi.getProjectAuditEvent']?.[localVarOperationServerIndex]?.url;
|
|
15706
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15707
|
+
},
|
|
15708
|
+
/**
|
|
15709
|
+
* List immutable audit events recorded for a project. Results are ordered by `occurred_at` descending, then `id` descending. The `cursor` parameter is an opaque pagination token and must be treated as an unreadable value by clients. Use the filters to narrow the feed by event type, actor, or resource identifiers.
|
|
15710
|
+
* @summary List Project Audit Events
|
|
15711
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15712
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15713
|
+
* @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
|
|
15714
|
+
* @param {number} [pageLimit] The maximum number of items to return per page. Defaults to `100` if not specified.
|
|
15715
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15716
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15717
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15718
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15719
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15720
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15721
|
+
* @param {*} [options] Override http request option.
|
|
15722
|
+
* @throws {RequiredError}
|
|
15723
|
+
*/
|
|
15724
|
+
async listProjectAuditEvents(orgId: string, projectId: string, cursor?: string | null, pageLimit?: number, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResultSetAuditEventListItem>> {
|
|
15725
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProjectAuditEvents(orgId, projectId, cursor, pageLimit, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options);
|
|
15726
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
15727
|
+
const localVarOperationServerBasePath = operationServerMap['AuditEventsApi.listProjectAuditEvents']?.[localVarOperationServerIndex]?.url;
|
|
15728
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15729
|
+
},
|
|
15730
|
+
}
|
|
15731
|
+
};
|
|
15732
|
+
|
|
15733
|
+
/**
|
|
15734
|
+
* AuditEventsApi - factory interface
|
|
15735
|
+
* @export
|
|
15736
|
+
*/
|
|
15737
|
+
export const AuditEventsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
15738
|
+
const localVarFp = AuditEventsApiFp(configuration)
|
|
15739
|
+
return {
|
|
15740
|
+
/**
|
|
15741
|
+
* Export project audit events as NDJSON. Each line is a full audit event detail record, including the decrypted payload.
|
|
15742
|
+
* @summary Export Project Audit Events
|
|
15743
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15744
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15745
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15746
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15747
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15748
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15749
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15750
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15751
|
+
* @param {*} [options] Override http request option.
|
|
15752
|
+
* @throws {RequiredError}
|
|
15753
|
+
*/
|
|
15754
|
+
exportProjectAuditEvents(orgId: string, projectId: string, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: any): AxiosPromise<any> {
|
|
15755
|
+
return localVarFp.exportProjectAuditEvents(orgId, projectId, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15756
|
+
},
|
|
15757
|
+
/**
|
|
15758
|
+
* Retrieve a single audit event for the project. The detail response includes the decrypted payload captured for the event.
|
|
15759
|
+
* @summary Get Project Audit Event
|
|
15760
|
+
* @param {string} auditEventId
|
|
15761
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15762
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15763
|
+
* @param {*} [options] Override http request option.
|
|
15764
|
+
* @throws {RequiredError}
|
|
15765
|
+
*/
|
|
15766
|
+
getProjectAuditEvent(auditEventId: string, orgId: string, projectId: string, options?: any): AxiosPromise<AuditEventDetail> {
|
|
15767
|
+
return localVarFp.getProjectAuditEvent(auditEventId, orgId, projectId, options).then((request) => request(axios, basePath));
|
|
15768
|
+
},
|
|
15769
|
+
/**
|
|
15770
|
+
* List immutable audit events recorded for a project. Results are ordered by `occurred_at` descending, then `id` descending. The `cursor` parameter is an opaque pagination token and must be treated as an unreadable value by clients. Use the filters to narrow the feed by event type, actor, or resource identifiers.
|
|
15771
|
+
* @summary List Project Audit Events
|
|
15772
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15773
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15774
|
+
* @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
|
|
15775
|
+
* @param {number} [pageLimit] The maximum number of items to return per page. Defaults to `100` if not specified.
|
|
15776
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15777
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15778
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15779
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15780
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15781
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15782
|
+
* @param {*} [options] Override http request option.
|
|
15783
|
+
* @throws {RequiredError}
|
|
15784
|
+
*/
|
|
15785
|
+
listProjectAuditEvents(orgId: string, projectId: string, cursor?: string | null, pageLimit?: number, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: any): AxiosPromise<PaginatedResultSetAuditEventListItem> {
|
|
15786
|
+
return localVarFp.listProjectAuditEvents(orgId, projectId, cursor, pageLimit, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options).then((request) => request(axios, basePath));
|
|
15787
|
+
},
|
|
15788
|
+
};
|
|
15789
|
+
};
|
|
15790
|
+
|
|
15791
|
+
/**
|
|
15792
|
+
* AuditEventsApi - object-oriented interface
|
|
15793
|
+
* @export
|
|
15794
|
+
* @class AuditEventsApi
|
|
15795
|
+
* @extends {BaseAPI}
|
|
15796
|
+
*/
|
|
15797
|
+
export class AuditEventsApi extends BaseAPI {
|
|
15798
|
+
/**
|
|
15799
|
+
* Export project audit events as NDJSON. Each line is a full audit event detail record, including the decrypted payload.
|
|
15800
|
+
* @summary Export Project Audit Events
|
|
15801
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15802
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15803
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15804
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15805
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15806
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15807
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15808
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15809
|
+
* @param {*} [options] Override http request option.
|
|
15810
|
+
* @throws {RequiredError}
|
|
15811
|
+
* @memberof AuditEventsApi
|
|
15812
|
+
*/
|
|
15813
|
+
public exportProjectAuditEvents(orgId: string, projectId: string, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: RawAxiosRequestConfig) {
|
|
15814
|
+
return AuditEventsApiFp(this.configuration).exportProjectAuditEvents(orgId, projectId, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
15815
|
+
}
|
|
15816
|
+
|
|
15817
|
+
/**
|
|
15818
|
+
* Retrieve a single audit event for the project. The detail response includes the decrypted payload captured for the event.
|
|
15819
|
+
* @summary Get Project Audit Event
|
|
15820
|
+
* @param {string} auditEventId
|
|
15821
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15822
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15823
|
+
* @param {*} [options] Override http request option.
|
|
15824
|
+
* @throws {RequiredError}
|
|
15825
|
+
* @memberof AuditEventsApi
|
|
15826
|
+
*/
|
|
15827
|
+
public getProjectAuditEvent(auditEventId: string, orgId: string, projectId: string, options?: RawAxiosRequestConfig) {
|
|
15828
|
+
return AuditEventsApiFp(this.configuration).getProjectAuditEvent(auditEventId, orgId, projectId, options).then((request) => request(this.axios, this.basePath));
|
|
15829
|
+
}
|
|
15830
|
+
|
|
15831
|
+
/**
|
|
15832
|
+
* List immutable audit events recorded for a project. Results are ordered by `occurred_at` descending, then `id` descending. The `cursor` parameter is an opaque pagination token and must be treated as an unreadable value by clients. Use the filters to narrow the feed by event type, actor, or resource identifiers.
|
|
15833
|
+
* @summary List Project Audit Events
|
|
15834
|
+
* @param {string} orgId The unique identifier of the organization.
|
|
15835
|
+
* @param {string} projectId The unique identifier of the project.
|
|
15836
|
+
* @param {string | null} [cursor] A cursor for pagination. Use the `next_cursor` value from the previous response to get the next page of results.
|
|
15837
|
+
* @param {number} [pageLimit] The maximum number of items to return per page. Defaults to `100` if not specified.
|
|
15838
|
+
* @param {Array<string> | null} [eventType] Filter by one or more audit event types.
|
|
15839
|
+
* @param {string | null} [actorUserId] Filter by the acting user.
|
|
15840
|
+
* @param {string | null} [resourceType] Filter by resource type.
|
|
15841
|
+
* @param {string | null} [resourceId] Filter by resource identifier.
|
|
15842
|
+
* @param {string | null} [startDate] Only include events occurring at or after this UTC timestamp.
|
|
15843
|
+
* @param {string | null} [endDate] Only include events occurring at or before this UTC timestamp.
|
|
15844
|
+
* @param {*} [options] Override http request option.
|
|
15845
|
+
* @throws {RequiredError}
|
|
15846
|
+
* @memberof AuditEventsApi
|
|
15847
|
+
*/
|
|
15848
|
+
public listProjectAuditEvents(orgId: string, projectId: string, cursor?: string | null, pageLimit?: number, eventType?: Array<string> | null, actorUserId?: string | null, resourceType?: string | null, resourceId?: string | null, startDate?: string | null, endDate?: string | null, options?: RawAxiosRequestConfig) {
|
|
15849
|
+
return AuditEventsApiFp(this.configuration).listProjectAuditEvents(orgId, projectId, cursor, pageLimit, eventType, actorUserId, resourceType, resourceId, startDate, endDate, options).then((request) => request(this.axios, this.basePath));
|
|
15850
|
+
}
|
|
15851
|
+
}
|
|
15852
|
+
|
|
15853
|
+
|
|
15854
|
+
|
|
15278
15855
|
/**
|
|
15279
15856
|
* CollectionApi - axios parameter creator
|
|
15280
15857
|
* @export
|