@coveo/platform-client 56.2.0 → 56.4.0

package/dist/cjs/resources/ApiKeys/ApiKeys.js

@@ -24,6 +24,12 @@ class ApiKey extends Resource_js_1.default {
     delete(apiKeyId) {
         return this.api.delete(`${ApiKey.baseUrl}/${apiKeyId}`);
     }
+    extend(apiKeyId) {
+        return this.api.put(`${ApiKey.baseUrl}/${apiKeyId}/activation/extend`);
+    }
+    duplicate(apiKeyId, options) {
+        return this.api.put(this.buildPath(`${ApiKey.baseUrl}/${apiKeyId}/duplicate`), options);
+    }
 }
 exports.default = ApiKey;
 //# sourceMappingURL=ApiKeys.js.map

package/dist/cjs/resources/ApiKeys/ApiKeys.js.map

@@ -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;;AA3BL,yBA4BC"}
+{"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,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"}

package/dist/esm/resources/ApiKeys/ApiKeys.js

@@ -21,5 +21,11 @@ export default class ApiKey extends Resource {
     delete(apiKeyId) {
         return this.api.delete(`${ApiKey.baseUrl}/${apiKeyId}`);
     }
+    extend(apiKeyId) {
+        return this.api.put(`${ApiKey.baseUrl}/${apiKeyId}/activation/extend`);
+    }
+    duplicate(apiKeyId, options) {
+        return this.api.put(this.buildPath(`${ApiKey.baseUrl}/${apiKeyId}/duplicate`), options);
+    }
 }
 //# sourceMappingURL=ApiKeys.js.map

package/dist/esm/resources/ApiKeys/ApiKeys.js.map

@@ -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"}
+{"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,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"}

package/dist/types/resources/ApiKeys/ApiKeys.d.ts

@@ -1,12 +1,13 @@
-import { New } from '../BaseInterfaces.js';
 import Resource from '../Resource.js';
-import { ApiKeyModel, CreateApiKeyOptions } from './ApiKeysInterfaces.js';
+import { ApiKeyModel, CreateApiKeyModel, CreateApiKeyOptions, DuplicateApiKeyOptions } from './ApiKeysInterfaces.js';
 export default class ApiKey extends Resource {
     static baseUrl: string;
     list(): Promise<ApiKeyModel[]>;
-    create(apiKey: New<ApiKeyModel, 'resourceId' | 'id'>, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
+    create(apiKey: CreateApiKeyModel, options?: CreateApiKeyOptions): Promise<ApiKeyModel>;
     get(apiKeyId: string): Promise<ApiKeyModel>;
     update(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
     toggle(apiKey: ApiKeyModel): Promise<Record<string, unknown>>;
     delete(apiKeyId: string): Promise<Record<string, unknown>>;
+    extend(apiKeyId: string): Promise<void>;
+    duplicate(apiKeyId: string, options: DuplicateApiKeyOptions): Promise<ApiKeyModel>;
 }

package/dist/types/resources/ApiKeys/ApiKeysInterfaces.d.ts

@@ -1,14 +1,51 @@
 import { GranularResource, PrivilegeModel } from '../BaseInterfaces.js';
 import { ApiKeyStatus } from '../Enums.js';
-export interface ApiKeyModel extends GranularResource {
+export interface ApiKeyBaseModel extends GranularResource {
+    /**
+     * The display name for the API key.
+     * @example PushApiKey
+     */
+    displayName?: string;
+    /**
+     * A brief description of the API key.
+     * @example API key used for managing sources.
+     */
+    description?: string;
+    /**
+     * A set of IP addresses allowed to use the API key.
+     *
+     * Notes:
+     * - IP ranges using CIDR notation are also supported.
+     * - If an IP address is included in both the `allowedIps` and the `deniedIps`, the IP address will be denied.
+     * @example ["192.168.0.0/16", "29.186.225.13"]
+     */
+    allowedIps?: string[];
+    /**
+     * A set of IP addresses that will be denied access when attempting to use the API key.
+     *
+     * Notes:
+     * - IP ranges using CIDR notation are also supported.
+     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
+     * @example [`"192.168.0.0/16"`, `"29.186.225.13"`]
+     */
+    deniedIps?: string[];
+    /**
+     * A set of privileges.
+     */
+    privileges?: PrivilegeModel[];
+    /**
+     * Additional configuration to be included in an API key. [to be revised]
+     */
+    additionalConfiguration?: AdditionalConfigurationModel;
+}
+export interface ApiKeyModel extends ApiKeyBaseModel {
     /**
      * The unique identifier of the [organization](https://docs.coveo.com/en/222/) the API key was created for.
      */
     organizationId?: string;
     /**
      * The unique identifier of the API key.
-     *
-     * **Example:** t4hk287bfj5sg6wskg64ckk5a
+     * @example t4hk287bfj5sg6wskg64ckk5a
      */
     id: string;
     /**
@@ -17,72 +54,28 @@ export interface ApiKeyModel extends GranularResource {
     enabled?: boolean;
     /**
      * The value of the API key.
-     *
-     * **Example:** xx65151ec3-7b30-4772-a99a-09b4c0f71343
+     * @example xx65151ec3-7b30-4772-a99a-09b4c0f71343
      */
     value?: string;
-    /**
-     * The display name for the API key.
-     *
-     * **Example:** PushApiKey
-     */
-    displayName?: string;
-    /**
-     * A brief description of the API key.
-     *
-     * **Example:** API key used for managing sources.
-     */
-    description?: string;
     /**
      * The username or the email address that was used to create this API key.
      */
     createdBy?: any;
     /**
      * The API key creation date in Unix timestamp in milliseconds.
-     *
-     * **Example:** 1614969486000
+     * @example 1614969486000
      */
     createdDate?: number;
     /**
      * The approximate API key last used date in Unix timestamp in milliseconds.
-     *
-     * **Example:** 1624575600000
+     * @example 1624575600000
      */
     lastUsedDate?: number;
-    /**
-     * A set of IP addresses allowed to use the API key.
-     *
-     * **Notes:**
-     * - IP ranges using CIDR notation are also supported.
-     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
-     *
-     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
-     */
-    allowedIps?: string[];
-    /**
-     * A set of IP addresses that will be denied access when attempting to use the API key.
-     *
-     * **Notes:**
-     * - IP ranges using CIDR notation are also supported.
-     * - If an IP address is included in both the `allowedIps` as well as the `deniedIps`, the IP address will be denied.
-     *
-     * **Example:** [`"192.168.0.0/16"`, `"29.186.225.13"`]
-     */
-    deniedIps?: string[];
-    /**
-     * A set of privileges.
-     */
-    privileges?: PrivilegeModel[];
     /**
      * The unique identifier of the API key.
-     *
-     * **Example:** t4hk287bfj5sg6wskg64ckk5a
+     * @example t4hk287bfj5sg6wskg64ckk5a
      */
     resourceId?: string;
-    /**
-     * Additional configuration to be included in an API key. [to be revised]
-     */
-    additionalConfiguration?: AdditionalConfigurationModel;
     /**
      * The expiration date of the API key.
      */
@@ -104,12 +97,40 @@ export interface ApiKeyModel extends GranularResource {
      */
     disabledDate?: number;
 }
+export interface CreateApiKeyModel extends ApiKeyBaseModel {
+    /**
+     * The duration of the API key in ISO-8601 format. Once the duration is reached the key expires and cannot be used anymore.
+     * @example
+     * 'P1Y' for 1 year
+     * 'P14D' for 14 days
+     * 'P1M' for 1 month.
+     * 'P1Y3M14D' for 1 year, 3 months, and 14 days.
+     */
+    lifetimeDuration?: string;
+}
 export interface CreateApiKeyOptions {
     /**
      * The unique identifier of the template on which to base the API key.
      */
     apiKeyTemplateId?: string;
 }
+export interface DuplicateApiKeyOptions {
+    /**
+     * The display name for the API key.
+     *
+     */
+    displayName?: string;
+    /**
+     * A brief description of the API key.
+     *
+     */
+    description?: string;
+    /**
+     * The lifetime duration of the API key (iso8601 format).
+     * @example 'P1M'
+     */
+    lifetimeDuration: string;
+}
 interface AdditionalConfigurationModel {
     /**
      * Configuration specific to commerce organization. [to be revised]

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coveo/platform-client",
-    "version": "56.2.0",
+    "version": "56.4.0",
     "description": "",
     "type": "module",
     "exports": {