@scout9/admin 1.0.0-alpha.0.0.5 → 1.0.0-alpha.0.0.7

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/build/api.d.ts CHANGED
@@ -187,7 +187,7 @@ export interface Context {
187
187
  * @type {boolean}
188
188
  * @memberof Context
189
189
  */
190
- 'modifiable': boolean;
190
+ 'modifiable'?: boolean;
191
191
  /**
192
192
  * The description of the context
193
193
  * @type {string}
@@ -205,13 +205,13 @@ export interface Context {
205
205
  * @type {string}
206
206
  * @memberof Context
207
207
  */
208
- 'idColumn': string;
208
+ 'idColumn'?: string;
209
209
  /**
210
210
  * The columns of the context
211
211
  * @type {Array<string>}
212
212
  * @memberof Context
213
213
  */
214
- 'columns': Array<string>;
214
+ 'columns'?: Array<string>;
215
215
  /**
216
216
  * The required columns of the context
217
217
  * @type {Array<string>}
@@ -344,6 +344,11 @@ export interface ContextDetectionTestExpected {
344
344
  */
345
345
  'entities'?: Array<ParsedContextEntity>;
346
346
  }
347
+ /**
348
+ * @type ContextRowValue
349
+ * @export
350
+ */
351
+ export type ContextRowValue = number | string;
347
352
  /**
348
353
  *
349
354
  * @export
@@ -1350,6 +1355,52 @@ export interface CreateAgentsResponse {
1350
1355
  */
1351
1356
  '$operation': string;
1352
1357
  }
1358
+ /**
1359
+ *
1360
+ * @export
1361
+ * @interface CreateContextDataRequest
1362
+ */
1363
+ export interface CreateContextDataRequest {
1364
+ /**
1365
+ * The context id to create data for
1366
+ * @type {string}
1367
+ * @memberof CreateContextDataRequest
1368
+ */
1369
+ 'context': string;
1370
+ /**
1371
+ *
1372
+ * @type {Array<{ [key: string]: ContextRowValue; }>}
1373
+ * @memberof CreateContextDataRequest
1374
+ */
1375
+ 'data': Array<{
1376
+ [key: string]: ContextRowValue;
1377
+ }>;
1378
+ }
1379
+ /**
1380
+ *
1381
+ * @export
1382
+ * @interface CreateContextDataResponse
1383
+ */
1384
+ export interface CreateContextDataResponse {
1385
+ /**
1386
+ *
1387
+ * @type {boolean}
1388
+ * @memberof CreateContextDataResponse
1389
+ */
1390
+ 'success': boolean;
1391
+ /**
1392
+ *
1393
+ * @type {Error}
1394
+ * @memberof CreateContextDataResponse
1395
+ */
1396
+ 'error'?: Error;
1397
+ /**
1398
+ * The id of the document that was created, updated, or deleted
1399
+ * @type {string}
1400
+ * @memberof CreateContextDataResponse
1401
+ */
1402
+ 'id': string;
1403
+ }
1353
1404
  /**
1354
1405
  *
1355
1406
  * @export
@@ -1367,7 +1418,7 @@ export interface CreateContextRequest {
1367
1418
  * @type {boolean}
1368
1419
  * @memberof CreateContextRequest
1369
1420
  */
1370
- 'modifiable': boolean;
1421
+ 'modifiable'?: boolean;
1371
1422
  /**
1372
1423
  * The description of the context
1373
1424
  * @type {string}
@@ -1385,13 +1436,13 @@ export interface CreateContextRequest {
1385
1436
  * @type {string}
1386
1437
  * @memberof CreateContextRequest
1387
1438
  */
1388
- 'idColumn': string;
1439
+ 'idColumn'?: string;
1389
1440
  /**
1390
1441
  * The columns of the context
1391
1442
  * @type {Array<string>}
1392
1443
  * @memberof CreateContextRequest
1393
1444
  */
1394
- 'columns': Array<string>;
1445
+ 'columns'?: Array<string>;
1395
1446
  /**
1396
1447
  * The required columns of the context
1397
1448
  * @type {Array<string>}
@@ -1454,7 +1505,7 @@ export interface CreateContextsRequestContextsInner {
1454
1505
  * @type {boolean}
1455
1506
  * @memberof CreateContextsRequestContextsInner
1456
1507
  */
1457
- 'modifiable': boolean;
1508
+ 'modifiable'?: boolean;
1458
1509
  /**
1459
1510
  * The description of the context
1460
1511
  * @type {string}
@@ -1472,13 +1523,13 @@ export interface CreateContextsRequestContextsInner {
1472
1523
  * @type {string}
1473
1524
  * @memberof CreateContextsRequestContextsInner
1474
1525
  */
1475
- 'idColumn': string;
1526
+ 'idColumn'?: string;
1476
1527
  /**
1477
1528
  * The columns of the context
1478
1529
  * @type {Array<string>}
1479
1530
  * @memberof CreateContextsRequestContextsInner
1480
1531
  */
1481
- 'columns': Array<string>;
1532
+ 'columns'?: Array<string>;
1482
1533
  /**
1483
1534
  * The required columns of the context
1484
1535
  * @type {Array<string>}
@@ -2181,6 +2232,31 @@ export interface DeleteAgentsResponse {
2181
2232
  */
2182
2233
  '$operation': string;
2183
2234
  }
2235
+ /**
2236
+ *
2237
+ * @export
2238
+ * @interface DeleteContextDataResponse
2239
+ */
2240
+ export interface DeleteContextDataResponse {
2241
+ /**
2242
+ *
2243
+ * @type {boolean}
2244
+ * @memberof DeleteContextDataResponse
2245
+ */
2246
+ 'success': boolean;
2247
+ /**
2248
+ *
2249
+ * @type {Error}
2250
+ * @memberof DeleteContextDataResponse
2251
+ */
2252
+ 'error'?: Error;
2253
+ /**
2254
+ * The id of the document that was created, updated, or deleted
2255
+ * @type {string}
2256
+ * @memberof DeleteContextDataResponse
2257
+ */
2258
+ 'id': string;
2259
+ }
2184
2260
  /**
2185
2261
  *
2186
2262
  * @export
@@ -2689,6 +2765,19 @@ export interface GetApiOperationResponseAllOf {
2689
2765
  */
2690
2766
  '$id': string;
2691
2767
  }
2768
+ /**
2769
+ *
2770
+ * @export
2771
+ * @interface GetContextDataResponse
2772
+ */
2773
+ export interface GetContextDataResponse {
2774
+ /**
2775
+ * The ID of the context
2776
+ * @type {string}
2777
+ * @memberof GetContextDataResponse
2778
+ */
2779
+ '$id': string;
2780
+ }
2692
2781
  /**
2693
2782
  *
2694
2783
  * @export
@@ -2706,7 +2795,7 @@ export interface GetContextResponse {
2706
2795
  * @type {boolean}
2707
2796
  * @memberof GetContextResponse
2708
2797
  */
2709
- 'modifiable': boolean;
2798
+ 'modifiable'?: boolean;
2710
2799
  /**
2711
2800
  * The description of the context
2712
2801
  * @type {string}
@@ -2724,13 +2813,13 @@ export interface GetContextResponse {
2724
2813
  * @type {string}
2725
2814
  * @memberof GetContextResponse
2726
2815
  */
2727
- 'idColumn': string;
2816
+ 'idColumn'?: string;
2728
2817
  /**
2729
2818
  * The columns of the context
2730
2819
  * @type {Array<string>}
2731
2820
  * @memberof GetContextResponse
2732
2821
  */
2733
- 'columns': Array<string>;
2822
+ 'columns'?: Array<string>;
2734
2823
  /**
2735
2824
  * The required columns of the context
2736
2825
  * @type {Array<string>}
@@ -3216,7 +3305,7 @@ export interface ListContextsResponseInner {
3216
3305
  * @type {boolean}
3217
3306
  * @memberof ListContextsResponseInner
3218
3307
  */
3219
- 'modifiable': boolean;
3308
+ 'modifiable'?: boolean;
3220
3309
  /**
3221
3310
  * The description of the context
3222
3311
  * @type {string}
@@ -3234,13 +3323,13 @@ export interface ListContextsResponseInner {
3234
3323
  * @type {string}
3235
3324
  * @memberof ListContextsResponseInner
3236
3325
  */
3237
- 'idColumn': string;
3326
+ 'idColumn'?: string;
3238
3327
  /**
3239
3328
  * The columns of the context
3240
3329
  * @type {Array<string>}
3241
3330
  * @memberof ListContextsResponseInner
3242
3331
  */
3243
- 'columns': Array<string>;
3332
+ 'columns'?: Array<string>;
3244
3333
  /**
3245
3334
  * The required columns of the context
3246
3335
  * @type {Array<string>}
@@ -5106,6 +5195,52 @@ export interface UpdateAgentsResponse {
5106
5195
  */
5107
5196
  '$operation': string;
5108
5197
  }
5198
+ /**
5199
+ *
5200
+ * @export
5201
+ * @interface UpdateContextDataRequest
5202
+ */
5203
+ export interface UpdateContextDataRequest {
5204
+ /**
5205
+ * The context id to create data for
5206
+ * @type {string}
5207
+ * @memberof UpdateContextDataRequest
5208
+ */
5209
+ 'context': string;
5210
+ /**
5211
+ *
5212
+ * @type {Array<{ [key: string]: ContextRowValue; }>}
5213
+ * @memberof UpdateContextDataRequest
5214
+ */
5215
+ 'data': Array<{
5216
+ [key: string]: ContextRowValue;
5217
+ }>;
5218
+ }
5219
+ /**
5220
+ *
5221
+ * @export
5222
+ * @interface UpdateContextDataResponse
5223
+ */
5224
+ export interface UpdateContextDataResponse {
5225
+ /**
5226
+ *
5227
+ * @type {boolean}
5228
+ * @memberof UpdateContextDataResponse
5229
+ */
5230
+ 'success': boolean;
5231
+ /**
5232
+ *
5233
+ * @type {Error}
5234
+ * @memberof UpdateContextDataResponse
5235
+ */
5236
+ 'error'?: Error;
5237
+ /**
5238
+ * The id of the document that was created, updated, or deleted
5239
+ * @type {string}
5240
+ * @memberof UpdateContextDataResponse
5241
+ */
5242
+ 'id': string;
5243
+ }
5109
5244
  /**
5110
5245
  *
5111
5246
  * @export
@@ -5123,7 +5258,7 @@ export interface UpdateContextRequest {
5123
5258
  * @type {boolean}
5124
5259
  * @memberof UpdateContextRequest
5125
5260
  */
5126
- 'modifiable': boolean;
5261
+ 'modifiable'?: boolean;
5127
5262
  /**
5128
5263
  * The description of the context
5129
5264
  * @type {string}
@@ -5141,13 +5276,13 @@ export interface UpdateContextRequest {
5141
5276
  * @type {string}
5142
5277
  * @memberof UpdateContextRequest
5143
5278
  */
5144
- 'idColumn': string;
5279
+ 'idColumn'?: string;
5145
5280
  /**
5146
5281
  * The columns of the context
5147
5282
  * @type {Array<string>}
5148
5283
  * @memberof UpdateContextRequest
5149
5284
  */
5150
- 'columns': Array<string>;
5285
+ 'columns'?: Array<string>;
5151
5286
  /**
5152
5287
  * The required columns of the context
5153
5288
  * @type {Array<string>}
@@ -5874,6 +6009,38 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
5874
6009
  * @throws {RequiredError}
5875
6010
  */
5876
6011
  contextCreate: (createContextRequest: CreateContextRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6012
+ /**
6013
+ *
6014
+ * @summary Gets context data
6015
+ * @param {string} id id of entity to query
6016
+ * @param {*} [options] Override http request option.
6017
+ * @throws {RequiredError}
6018
+ */
6019
+ contextData: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6020
+ /**
6021
+ *
6022
+ * @summary Create a new context data
6023
+ * @param {CreateContextDataRequest} createContextDataRequest
6024
+ * @param {*} [options] Override http request option.
6025
+ * @throws {RequiredError}
6026
+ */
6027
+ contextDataCreate: (createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6028
+ /**
6029
+ *
6030
+ * @summary Deletes a schedule
6031
+ * @param {string} id id of entity to query
6032
+ * @param {*} [options] Override http request option.
6033
+ * @throws {RequiredError}
6034
+ */
6035
+ contextDataDelete: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
6036
+ /**
6037
+ *
6038
+ * @summary Update a context data
6039
+ * @param {UpdateContextDataRequest} updateContextDataRequest
6040
+ * @param {*} [options] Override http request option.
6041
+ * @throws {RequiredError}
6042
+ */
6043
+ contextDataUpdate: (updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5877
6044
  /**
5878
6045
  *
5879
6046
  * @summary Deletes a schedule
@@ -6391,6 +6558,38 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
6391
6558
  * @throws {RequiredError}
6392
6559
  */
6393
6560
  contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateContextResponse>>;
6561
+ /**
6562
+ *
6563
+ * @summary Gets context data
6564
+ * @param {string} id id of entity to query
6565
+ * @param {*} [options] Override http request option.
6566
+ * @throws {RequiredError}
6567
+ */
6568
+ contextData(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContextDataResponse>>;
6569
+ /**
6570
+ *
6571
+ * @summary Create a new context data
6572
+ * @param {CreateContextDataRequest} createContextDataRequest
6573
+ * @param {*} [options] Override http request option.
6574
+ * @throws {RequiredError}
6575
+ */
6576
+ contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateContextDataResponse>>;
6577
+ /**
6578
+ *
6579
+ * @summary Deletes a schedule
6580
+ * @param {string} id id of entity to query
6581
+ * @param {*} [options] Override http request option.
6582
+ * @throws {RequiredError}
6583
+ */
6584
+ contextDataDelete(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteContextDataResponse>>;
6585
+ /**
6586
+ *
6587
+ * @summary Update a context data
6588
+ * @param {UpdateContextDataRequest} updateContextDataRequest
6589
+ * @param {*} [options] Override http request option.
6590
+ * @throws {RequiredError}
6591
+ */
6592
+ contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateContextDataResponse>>;
6394
6593
  /**
6395
6594
  *
6396
6595
  * @summary Deletes a schedule
@@ -6908,6 +7107,38 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
6908
7107
  * @throws {RequiredError}
6909
7108
  */
6910
7109
  contextCreate(createContextRequest: CreateContextRequest, options?: any): AxiosPromise<CreateContextResponse>;
7110
+ /**
7111
+ *
7112
+ * @summary Gets context data
7113
+ * @param {string} id id of entity to query
7114
+ * @param {*} [options] Override http request option.
7115
+ * @throws {RequiredError}
7116
+ */
7117
+ contextData(id: string, options?: any): AxiosPromise<GetContextDataResponse>;
7118
+ /**
7119
+ *
7120
+ * @summary Create a new context data
7121
+ * @param {CreateContextDataRequest} createContextDataRequest
7122
+ * @param {*} [options] Override http request option.
7123
+ * @throws {RequiredError}
7124
+ */
7125
+ contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: any): AxiosPromise<CreateContextDataResponse>;
7126
+ /**
7127
+ *
7128
+ * @summary Deletes a schedule
7129
+ * @param {string} id id of entity to query
7130
+ * @param {*} [options] Override http request option.
7131
+ * @throws {RequiredError}
7132
+ */
7133
+ contextDataDelete(id: string, options?: any): AxiosPromise<DeleteContextDataResponse>;
7134
+ /**
7135
+ *
7136
+ * @summary Update a context data
7137
+ * @param {UpdateContextDataRequest} updateContextDataRequest
7138
+ * @param {*} [options] Override http request option.
7139
+ * @throws {RequiredError}
7140
+ */
7141
+ contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: any): AxiosPromise<UpdateContextDataResponse>;
6911
7142
  /**
6912
7143
  *
6913
7144
  * @summary Deletes a schedule
@@ -7437,6 +7668,42 @@ export declare class Scout9Api extends BaseAPI {
7437
7668
  * @memberof Scout9Api
7438
7669
  */
7439
7670
  contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextResponse, any>>;
7671
+ /**
7672
+ *
7673
+ * @summary Gets context data
7674
+ * @param {string} id id of entity to query
7675
+ * @param {*} [options] Override http request option.
7676
+ * @throws {RequiredError}
7677
+ * @memberof Scout9Api
7678
+ */
7679
+ contextData(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextDataResponse, any>>;
7680
+ /**
7681
+ *
7682
+ * @summary Create a new context data
7683
+ * @param {CreateContextDataRequest} createContextDataRequest
7684
+ * @param {*} [options] Override http request option.
7685
+ * @throws {RequiredError}
7686
+ * @memberof Scout9Api
7687
+ */
7688
+ contextDataCreate(createContextDataRequest: CreateContextDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextDataResponse, any>>;
7689
+ /**
7690
+ *
7691
+ * @summary Deletes a schedule
7692
+ * @param {string} id id of entity to query
7693
+ * @param {*} [options] Override http request option.
7694
+ * @throws {RequiredError}
7695
+ * @memberof Scout9Api
7696
+ */
7697
+ contextDataDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextDataResponse, any>>;
7698
+ /**
7699
+ *
7700
+ * @summary Update a context data
7701
+ * @param {UpdateContextDataRequest} updateContextDataRequest
7702
+ * @param {*} [options] Override http request option.
7703
+ * @throws {RequiredError}
7704
+ * @memberof Scout9Api
7705
+ */
7706
+ contextDataUpdate(updateContextDataRequest: UpdateContextDataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextDataResponse, any>>;
7440
7707
  /**
7441
7708
  *
7442
7709
  * @summary Deletes a schedule