@coveo/platform-client 56.3.0 → 56.5.0

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.
Files changed (7) hide show
  1. package/dist/cjs/resources/ApiKeys/ApiKeys.js +17 -2
  2. package/dist/cjs/resources/ApiKeys/ApiKeys.js.map +1 -1
  3. package/dist/esm/resources/ApiKeys/ApiKeys.js +17 -2
  4. package/dist/esm/resources/ApiKeys/ApiKeys.js.map +1 -1
  5. package/dist/types/resources/ApiKeys/ApiKeys.d.ts +5 -4
  6. package/dist/types/resources/ApiKeys/ApiKeysInterfaces.d.ts +55 -51
  7. package/package.json +1 -1
package/dist/cjs/resources/ApiKeys/ApiKeys.js CHANGED
@@ -21,8 +21,11 @@ class ApiKey extends Resource_js_1.default {
21
21
  const path = `${ApiKey.baseUrl}/${apiKey.id}/${apiKey.enabled ? 'disable' : 'activate'}`;
22
22
  return this.api.put(path, apiKey);
23
23
  }
24
- delete(apiKeyId) {
25
- return this.api.delete(`${ApiKey.baseUrl}/${apiKeyId}`);
24
+ delete(apiKeyIds) {
25
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
26
+ return this.api.post(`${ApiKey.baseUrl}/delete/bulk`, apiKeyIds);
27
+ }
28
+ return this.api.delete(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}`);
26
29
  }
27
30
  extend(apiKeyId) {
28
31
  return this.api.put(`${ApiKey.baseUrl}/${apiKeyId}/activation/extend`);
@@ -30,6 +33,18 @@ class ApiKey extends Resource_js_1.default {
30
33
  duplicate(apiKeyId, options) {
31
34
  return this.api.put(this.buildPath(`${ApiKey.baseUrl}/${apiKeyId}/duplicate`), options);
32
35
  }
36
+ activate(apiKeyIds) {
37
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
38
+ return this.api.put(`${ApiKey.baseUrl}/activate/bulk`, apiKeyIds);
39
+ }
40
+ return this.api.put(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}/activate`);
41
+ }
42
+ disable(apiKeyIds) {
43
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
44
+ return this.api.put(`${ApiKey.baseUrl}/disable/bulk`, apiKeyIds);
45
+ }
46
+ return this.api.put(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}/disable`);
47
+ }
33
48
  }
34
49
  exports.default = ApiKey;
35
50
  //# sourceMappingURL=ApiKeys.js.map
package/dist/cjs/resources/ApiKeys/ApiKeys.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiKeys.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeys/ApiKeys.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AAEnC,yEAAsC;AAGtC,MAAqB,MAAO,SAAQ,qBAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,UAAU,CAAC;IAErE,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,MAA6C,EAAE,OAA6B;QAC/E,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAc,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAEzF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,OAA+B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;;AAnCL,yBAoCC"}
1
+ {"version":3,"file":"ApiKeys.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeys/ApiKeys.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;AAGtC,MAAqB,MAAO,SAAQ,qBAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,UAAU,CAAC;IAErE,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAc,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAEzF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,SAA4B;QAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,MAAM,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,OAA+B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED,QAAQ,CAAC,SAA4B;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC;IACnH,CAAC;IAED,OAAO,CAAC,SAA4B;QAChC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC;IAClH,CAAC;;AApDL,yBAqDC"}
package/dist/esm/resources/ApiKeys/ApiKeys.js CHANGED
@@ -18,8 +18,11 @@ export default class ApiKey extends Resource {
18
18
  const path = `${ApiKey.baseUrl}/${apiKey.id}/${apiKey.enabled ? 'disable' : 'activate'}`;
19
19
  return this.api.put(path, apiKey);
20
20
  }
21
- delete(apiKeyId) {
22
- return this.api.delete(`${ApiKey.baseUrl}/${apiKeyId}`);
21
+ delete(apiKeyIds) {
22
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
23
+ return this.api.post(`${ApiKey.baseUrl}/delete/bulk`, apiKeyIds);
24
+ }
25
+ return this.api.delete(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}`);
23
26
  }
24
27
  extend(apiKeyId) {
25
28
  return this.api.put(`${ApiKey.baseUrl}/${apiKeyId}/activation/extend`);
@@ -27,5 +30,17 @@ export default class ApiKey extends Resource {
27
30
  duplicate(apiKeyId, options) {
28
31
  return this.api.put(this.buildPath(`${ApiKey.baseUrl}/${apiKeyId}/duplicate`), options);
29
32
  }
33
+ activate(apiKeyIds) {
34
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
35
+ return this.api.put(`${ApiKey.baseUrl}/activate/bulk`, apiKeyIds);
36
+ }
37
+ return this.api.put(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}/activate`);
38
+ }
39
+ disable(apiKeyIds) {
40
+ if (Array.isArray(apiKeyIds) && apiKeyIds.length > 1) {
41
+ return this.api.put(`${ApiKey.baseUrl}/disable/bulk`, apiKeyIds);
42
+ }
43
+ return this.api.put(`${ApiKey.baseUrl}/${Array.isArray(apiKeyIds) ? apiKeyIds[0] : apiKeyIds}/disable`);
44
+ }
30
45
  }
31
46
  //# sourceMappingURL=ApiKeys.js.map
package/dist/esm/resources/ApiKeys/ApiKeys.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiKeys.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeys/ApiKeys.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,UAAU,CAAC;IAErE,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,MAA6C,EAAE,OAA6B;QAC/E,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAc,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAEzF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,OAA+B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC"}
1
+ {"version":3,"file":"ApiKeys.js","sourceRoot":"","sources":["../../../../src/resources/ApiKeys/ApiKeys.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,UAAU,CAAC;IAErE,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,MAAyB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAc,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IACvF,CAAC;IAED,GAAG,CAAC,QAAgB;QAChB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,MAAmB;QACtB,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAEzF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,CAAC,SAA4B;QAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,GAAG,MAAM,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAC7G,CAAC;IAED,MAAM,CAAC,QAAgB;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,oBAAoB,CAAC,CAAC;IACjF,CAAC;IAED,SAAS,CAAC,QAAgB,EAAE,OAA+B;QACvD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,IAAI,QAAQ,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IAED,QAAQ,CAAC,SAA4B;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,gBAAgB,EAAE,SAAS,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,WAAW,CAAC,CAAC;IACnH,CAAC;IAED,OAAO,CAAC,SAA4B;QAChC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,eAAe,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,GAAG,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,CAAC;IAClH,CAAC"}
package/dist/types/resources/ApiKeys/ApiKeys.d.ts CHANGED
@@ -1,14 +1,15 @@
1
- import { New } from '../BaseInterfaces.js';
2
1
  import Resource from '../Resource.js';
3
- import { ApiKeyModel, CreateApiKeyOptions, DuplicateApiKeyOptions } from './ApiKeysInterfaces.js';
2
+ import { ApiKeyModel, CreateApiKeyModel, CreateApiKeyOptions, DuplicateApiKeyOptions } from './ApiKeysInterfaces.js';
4
3
  export default class ApiKey extends Resource {
5
4
  static baseUrl: string;
6
5
  list(): Promise<ApiKeyModel[]>;
7
- create(apiKey: New<ApiKeyModel, 'resourceId' | 'id'>, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
6
+ create(apiKey: CreateApiKeyModel, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
8
7
  get(apiKeyId: string): Promise<ApiKeyModel>;
9
8
  update(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
10
9
  toggle(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
11
- delete(apiKeyId: string): Promise<Record<string, unknown>>;
10
+ delete(apiKeyIds: string | string[]): Promise<void>;
12
11
  extend(apiKeyId: string): Promise<void>;
13
12
  duplicate(apiKeyId: string, options: DuplicateApiKeyOptions): Promise<ApiKeyModel>;
13
+ activate(apiKeyIds: string | string[]): Promise<void>;
14
+ disable(apiKeyIds: string | string[]): Promise<void>;
14
15
  }
package/dist/types/resources/ApiKeys/ApiKeysInterfaces.d.ts CHANGED
@@ -1,14 +1,51 @@
1
1
  import { GranularResource, PrivilegeModel } from '../BaseInterfaces.js';
2
2
  import { ApiKeyStatus } from '../Enums.js';
3
- export interface ApiKeyModel extends GranularResource {
3
+ export interface ApiKeyBaseModel extends GranularResource {
4
+ /**
5
+ * The display name for the API key.
6
+ * @example PushApiKey
7
+ */
8
+ displayName?: string;
9
+ /**
10
+ * A brief description of the API key.
11
+ * @example API key used for managing sources.
12
+ */
13
+ description?: string;
14
+ /**
15
+ * A set of IP addresses allowed to use the API key.
16
+ *
17
+ * Notes:
18
+ * - IP ranges using CIDR notation are also supported.
19
+ * - If an IP address is included in both the `allowedIps` and the `deniedIps`, the IP address will be denied.
20
+ * @example ["192.168.0.0/16", "29.186.225.13"]
21
+ */
22
+ allowedIps?: string[];
23
+ /**
24
+ * A set of IP addresses that will be denied access when attempting to use the API key.
25
+ *
26
+ * Notes:
27
+ * - IP ranges using CIDR notation are also supported.
28
+ * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
29
+ * @example [`"192.168.0.0/16"`, `"29.186.225.13"`]
30
+ */
31
+ deniedIps?: string[];
32
+ /**
33
+ * A set of privileges.
34
+ */
35
+ privileges?: PrivilegeModel[];
36
+ /**
37
+ * Additional configuration to be included in an API key. [to be revised]
38
+ */
39
+ additionalConfiguration?: AdditionalConfigurationModel;
40
+ }
41
+ export interface ApiKeyModel extends ApiKeyBaseModel {
4
42
  /**
5
43
  * The unique identifier of the [organization](https://docs.coveo.com/en/222/) the API key was created for.
6
44
  */
7
45
  organizationId?: string;
8
46
  /**
9
47
  * The unique identifier of the API key.
10
- *
11
- * **Example:** t4hk287bfj5sg6wskg64ckk5a
48
+ * @example t4hk287bfj5sg6wskg64ckk5a
12
49
  */
13
50
  id: string;
14
51
  /**
@@ -17,72 +54,28 @@ export interface ApiKeyModel extends GranularResource {
17
54
  enabled?: boolean;
18
55
  /**
19
56
  * The value of the API key.
20
- *
21
- * **Example:** xx65151ec3-7b30-4772-a99a-09b4c0f71343
57
+ * @example xx65151ec3-7b30-4772-a99a-09b4c0f71343
22
58
  */
23
59
  value?: string;
24
- /**
25
- * The display name for the API key.
26
- *
27
- * **Example:** PushApiKey
28
- */
29
- displayName?: string;
30
- /**
31
- * A brief description of the API key.
32
- *
33
- * **Example:** API key used for managing sources.
34
- */
35
- description?: string;
36
60
  /**
37
61
  * The username or the email address that was used to create this API key.
38
62
  */
39
63
  createdBy?: any;
40
64
  /**
41
65
  * The API key creation date in Unix timestamp in milliseconds.
42
- *
43
- * **Example:** 1614969486000
66
+ * @example 1614969486000
44
67
  */
45
68
  createdDate?: number;
46
69
  /**
47
70
  * The approximate API key last used date in Unix timestamp in milliseconds.
48
- *
49
- * **Example:** 1624575600000
71
+ * @example 1624575600000
50
72
  */
51
73
  lastUsedDate?: number;
52
- /**
53
- * A set of IP addresses allowed to use the API key.
54
- *
55
- * **Notes:**
56
- * - IP ranges using CIDR notation are also supported.
57
- * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
58
- *
59
- * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
60
- */
61
- allowedIps?: string[];
62
- /**
63
- * A set of IP addresses that will be denied access when attempting to use the API key.
64
- *
65
- * **Notes:**
66
- * - IP ranges using CIDR notation are also supported.
67
- * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
68
- *
69
- * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
70
- */
71
- deniedIps?: string[];
72
- /**
73
- * A set of privileges.
74
- */
75
- privileges?: PrivilegeModel[];
76
74
  /**
77
75
  * The unique identifier of the API key.
78
- *
79
- * **Example:** t4hk287bfj5sg6wskg64ckk5a
76
+ * @example t4hk287bfj5sg6wskg64ckk5a
80
77
  */
81
78
  resourceId?: string;
82
- /**
83
- * Additional configuration to be included in an API key. [to be revised]
84
- */
85
- additionalConfiguration?: AdditionalConfigurationModel;
86
79
  /**
87
80
  * The expiration date of the API key.
88
81
  */
@@ -104,6 +97,17 @@ export interface ApiKeyModel extends GranularResource {
104
97
  */
105
98
  disabledDate?: number;
106
99
  }
100
+ export interface CreateApiKeyModel extends ApiKeyBaseModel {
101
+ /**
102
+ * The duration of the API key in ISO-8601 format. Once the duration is reached the key expires and cannot be used anymore.
103
+ * @example
104
+ * 'P1Y' for 1 year
105
+ * 'P14D' for 14 days
106
+ * 'P1M' for 1 month.
107
+ * 'P1Y3M14D' for 1 year, 3 months, and 14 days.
108
+ */
109
+ lifetimeDuration?: string;
110
+ }
107
111
  export interface CreateApiKeyOptions {
108
112
  /**
109
113
  * The unique identifier of the template on which to base the API key.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "56.3.0",
3
+ "version": "56.5.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {