@coveo/platform-client 52.3.0 → 52.5.0

package/dist/cjs/resources/PushApi/PushApi.js

@@ -4,24 +4,27 @@ const tslib_1 = require("tslib");
 const APICore_js_1 = tslib_1.__importDefault(require("../../APICore.js"));
 const Resource_js_1 = tslib_1.__importDefault(require("../Resource.js"));
 class PushApi extends Resource_js_1.default {
-    static baseUrl = `/push/v1/organizations/${APICore_js_1.default.orgPlaceholder}/providers`;
+    static baseUrl = `/push/v1/organizations/${APICore_js_1.default.orgPlaceholder}`;
+    createFileContainer(options) {
+        return this.serverlessApi.post(this.buildPath(`${PushApi.baseUrl}/files`, options));
+    }
     createOrUpdateSecurityIdentityAlias(securityProviderId, alias, options) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/mappings`, options), alias);
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/mappings`, options), alias);
     }
     deleteSecurityIdentity(securityProviderId, securityIdentity, options) {
-        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), {
+        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), {
             body: JSON.stringify(securityIdentity),
             headers: { 'Content-Type': 'application/json' },
         });
     }
     createOrUpdateSecurityIdentity(securityProviderId, securityIdentity, options) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), securityIdentity);
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), securityIdentity);
     }
     manageSecurityIdentities(securityProviderId, batchConfig) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/batch`, batchConfig));
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/batch`, batchConfig));
     }
     deleteOldSecurityIdentities(securityProviderId, batchDelete) {
-        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/olderthan`, batchDelete));
+        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/olderthan`, batchDelete));
     }
 }
 exports.default = PushApi;

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

@@ -1 +1 @@
-{"version":3,"file":"PushApi.js","sourceRoot":"","sources":["../../../../src/resources/PushApi/PushApi.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;AAUtC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,0BAA0B,oBAAG,CAAC,cAAc,YAAY,CAAC;IAE1E,mCAAmC,CAC/B,kBAA0B,EAC1B,KAAiC,EACjC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,WAAW,EAAE,OAAO,CAAC,EAC5E,KAAK,CACR,CAAC;IACN,CAAC;IAED,sBAAsB,CAClB,kBAA0B,EAC1B,gBAAwC,EACxC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,cAAc,EAAE,OAAO,CAAC,EAC/E;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACtC,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAChD,CACJ,CAAC;IACN,CAAC;IAED,8BAA8B,CAC1B,kBAA0B,EAC1B,gBAAuC,EACvC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,cAAc,EAAE,OAAO,CAAC,EAC/E,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED,wBAAwB,CAAC,kBAA0B,EAAE,WAAwC;QACzF,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,oBAAoB,EAAE,WAAW,CAAC,CAC5F,CAAC;IACN,CAAC;IAED,2BAA2B,CAAC,kBAA0B,EAAE,WAA0C;QAC9F,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,wBAAwB,EAAE,WAAW,CAAC,CAChG,CAAC;IACN,CAAC;;AAjDL,0BAkDC"}
+{"version":3,"file":"PushApi.js","sourceRoot":"","sources":["../../../../src/resources/PushApi/PushApi.ts"],"names":[],"mappings":";;;AAAA,0EAAmC;AACnC,yEAAsC;AAYtC,MAAqB,OAAQ,SAAQ,qBAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,0BAA0B,oBAAG,CAAC,cAAc,EAAE,CAAC;IAEhE,mBAAmB,CAAC,OAA8B;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,mCAAmC,CAC/B,kBAA0B,EAC1B,KAAiC,EACjC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,WAAW,EAAE,OAAO,CAAC,EACtF,KAAK,CACR,CAAC;IACN,CAAC;IAED,sBAAsB,CAClB,kBAA0B,EAC1B,gBAAwC,EACxC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,cAAc,EAAE,OAAO,CAAC,EACzF;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACtC,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAChD,CACJ,CAAC;IACN,CAAC;IAED,8BAA8B,CAC1B,kBAA0B,EAC1B,gBAAuC,EACvC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,cAAc,EAAE,OAAO,CAAC,EACzF,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED,wBAAwB,CAAC,kBAA0B,EAAE,WAAwC;QACzF,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,oBAAoB,EAAE,WAAW,CAAC,CACtG,CAAC;IACN,CAAC;IAED,2BAA2B,CAAC,kBAA0B,EAAE,WAA0C;QAC9F,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,wBAAwB,EAAE,WAAW,CAAC,CAC1G,CAAC;IACN,CAAC;;AArDL,0BAsDC"}

package/dist/esm/resources/PushApi/PushApi.js

@@ -1,24 +1,27 @@
 import API from '../../APICore.js';
 import Resource from '../Resource.js';
 export default class PushApi extends Resource {
-    static baseUrl = `/push/v1/organizations/${API.orgPlaceholder}/providers`;
+    static baseUrl = `/push/v1/organizations/${API.orgPlaceholder}`;
+    createFileContainer(options) {
+        return this.serverlessApi.post(this.buildPath(`${PushApi.baseUrl}/files`, options));
+    }
     createOrUpdateSecurityIdentityAlias(securityProviderId, alias, options) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/mappings`, options), alias);
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/mappings`, options), alias);
     }
     deleteSecurityIdentity(securityProviderId, securityIdentity, options) {
-        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), {
+        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), {
             body: JSON.stringify(securityIdentity),
             headers: { 'Content-Type': 'application/json' },
         });
     }
     createOrUpdateSecurityIdentity(securityProviderId, securityIdentity, options) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), securityIdentity);
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), securityIdentity);
     }
     manageSecurityIdentities(securityProviderId, batchConfig) {
-        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/batch`, batchConfig));
+        return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/batch`, batchConfig));
     }
     deleteOldSecurityIdentities(securityProviderId, batchDelete) {
-        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/olderthan`, batchDelete));
+        return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/olderthan`, batchDelete));
     }
 }
 //# sourceMappingURL=PushApi.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PushApi.js","sourceRoot":"","sources":["../../../../src/resources/PushApi/PushApi.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAUtC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,0BAA0B,GAAG,CAAC,cAAc,YAAY,CAAC;IAE1E,mCAAmC,CAC/B,kBAA0B,EAC1B,KAAiC,EACjC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,WAAW,EAAE,OAAO,CAAC,EAC5E,KAAK,CACR,CAAC;IACN,CAAC;IAED,sBAAsB,CAClB,kBAA0B,EAC1B,gBAAwC,EACxC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,cAAc,EAAE,OAAO,CAAC,EAC/E;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACtC,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAChD,CACJ,CAAC;IACN,CAAC;IAED,8BAA8B,CAC1B,kBAA0B,EAC1B,gBAAuC,EACvC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,cAAc,EAAE,OAAO,CAAC,EAC/E,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED,wBAAwB,CAAC,kBAA0B,EAAE,WAAwC;QACzF,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,oBAAoB,EAAE,WAAW,CAAC,CAC5F,CAAC;IACN,CAAC;IAED,2BAA2B,CAAC,kBAA0B,EAAE,WAA0C;QAC9F,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,wBAAwB,EAAE,WAAW,CAAC,CAChG,CAAC;IACN,CAAC"}
+{"version":3,"file":"PushApi.js","sourceRoot":"","sources":["../../../../src/resources/PushApi/PushApi.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AACnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAYtC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,MAAM,CAAC,OAAO,GAAG,0BAA0B,GAAG,CAAC,cAAc,EAAE,CAAC;IAEhE,mBAAmB,CAAC,OAA8B;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACvG,CAAC;IAED,mCAAmC,CAC/B,kBAA0B,EAC1B,KAAiC,EACjC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,WAAW,EAAE,OAAO,CAAC,EACtF,KAAK,CACR,CAAC;IACN,CAAC;IAED,sBAAsB,CAClB,kBAA0B,EAC1B,gBAAwC,EACxC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,cAAc,EAAE,OAAO,CAAC,EACzF;YACI,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YACtC,OAAO,EAAE,EAAC,cAAc,EAAE,kBAAkB,EAAC;SAChD,CACJ,CAAC;IACN,CAAC;IAED,8BAA8B,CAC1B,kBAA0B,EAC1B,gBAAuC,EACvC,OAAiC;QAEjC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,cAAc,EAAE,OAAO,CAAC,EACzF,gBAAgB,CACnB,CAAC;IACN,CAAC;IAED,wBAAwB,CAAC,kBAA0B,EAAE,WAAwC;QACzF,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CACzB,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,oBAAoB,EAAE,WAAW,CAAC,CACtG,CAAC;IACN,CAAC;IAED,2BAA2B,CAAC,kBAA0B,EAAE,WAA0C;QAC9F,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,OAAO,cAAc,kBAAkB,wBAAwB,EAAE,WAAW,CAAC,CAC1G,CAAC;IACN,CAAC"}

package/dist/types/resources/Catalogs/CatalogInterfaces.d.ts

@@ -11,6 +11,14 @@ export interface CatalogsListOptions {
      * The number of catalogs to list per page.
      */
     pageSize?: number;
+    /**
+     * List of the unique identifiers of the catalog to show.
+     */
+    catalogIds?: string[];
+    /**
+     * List of the unique identifiers of the sources.
+     */
+    sourceIds?: string[];
 }
 export type CatalogConfigurationsListOptions = Omit<CatalogsListOptions, 'filter'>;
 export interface CatalogFieldsOptions {

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

@@ -1,7 +1,8 @@
 import Resource from '../Resource.js';
-import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces.js';
+import { FileContainer, FileContainerOptions, SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces.js';
 export default class PushApi extends Resource {
     static baseUrl: string;
+    createFileContainer(options?: FileContainerOptions): Promise<FileContainer>;
     createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
     deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
     createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;

package/dist/types/resources/PushApi/PushApiInterfaces.d.ts

@@ -1,4 +1,17 @@
 import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums.js';
+export interface FileContainer {
+    uploadUri: string;
+    fileId: string;
+    requiredHeaders: Record<string, string>;
+}
+export interface FileContainerOptions {
+    /**
+     * Whether to generate the presigned URL using the virtual hosted-style URL.
+     *
+     * Example of a virtual hosted-style url: `https://coveo-nprod-customer-data.s3.us-east-1.amazonaws.com/proda/blobstore/mycoveocloudv2organizationg8tp8wu3/b5e8767e-8f0d-4a89-9095-1127915c89c7[...]`
+     */
+    useVirtualHostedStyleUrl?: boolean;
+}
 export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
     mappings: AliasMappings;
 }

package/package.json

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