@coveo/platform-client 52.3.0 → 52.4.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/PushApi/PushApi.js +9 -6
  2. package/dist/cjs/resources/PushApi/PushApi.js.map +1 -1
  3. package/dist/esm/resources/PushApi/PushApi.js +9 -6
  4. package/dist/esm/resources/PushApi/PushApi.js.map +1 -1
  5. package/dist/types/resources/PushApi/PushApi.d.ts +2 -1
  6. package/dist/types/resources/PushApi/PushApiInterfaces.d.ts +13 -0
  7. package/package.json +1 -1
package/dist/cjs/resources/PushApi/PushApi.js CHANGED
@@ -4,24 +4,27 @@ const tslib_1 = require("tslib");
4
4
  const APICore_js_1 = tslib_1.__importDefault(require("../../APICore.js"));
5
5
  const Resource_js_1 = tslib_1.__importDefault(require("../Resource.js"));
6
6
  class PushApi extends Resource_js_1.default {
7
- static baseUrl = `/push/v1/organizations/${APICore_js_1.default.orgPlaceholder}/providers`;
7
+ static baseUrl = `/push/v1/organizations/${APICore_js_1.default.orgPlaceholder}`;
8
+ createFileContainer(options) {
9
+ return this.serverlessApi.post(this.buildPath(`${PushApi.baseUrl}/files`, options));
10
+ }
8
11
  createOrUpdateSecurityIdentityAlias(securityProviderId, alias, options) {
9
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/mappings`, options), alias);
12
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/mappings`, options), alias);
10
13
  }
11
14
  deleteSecurityIdentity(securityProviderId, securityIdentity, options) {
12
- return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), {
15
+ return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), {
13
16
  body: JSON.stringify(securityIdentity),
14
17
  headers: { 'Content-Type': 'application/json' },
15
18
  });
16
19
  }
17
20
  createOrUpdateSecurityIdentity(securityProviderId, securityIdentity, options) {
18
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), securityIdentity);
21
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), securityIdentity);
19
22
  }
20
23
  manageSecurityIdentities(securityProviderId, batchConfig) {
21
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/batch`, batchConfig));
24
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/batch`, batchConfig));
22
25
  }
23
26
  deleteOldSecurityIdentities(securityProviderId, batchDelete) {
24
- return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/olderthan`, batchDelete));
27
+ return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/olderthan`, batchDelete));
25
28
  }
26
29
  }
27
30
  exports.default = PushApi;
package/dist/cjs/resources/PushApi/PushApi.js.map CHANGED
@@ -1 +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"}
1
+ {"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 CHANGED
@@ -1,24 +1,27 @@
1
1
  import API from '../../APICore.js';
2
2
  import Resource from '../Resource.js';
3
3
  export default class PushApi extends Resource {
4
- static baseUrl = `/push/v1/organizations/${API.orgPlaceholder}/providers`;
4
+ static baseUrl = `/push/v1/organizations/${API.orgPlaceholder}`;
5
+ createFileContainer(options) {
6
+ return this.serverlessApi.post(this.buildPath(`${PushApi.baseUrl}/files`, options));
7
+ }
5
8
  createOrUpdateSecurityIdentityAlias(securityProviderId, alias, options) {
6
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/mappings`, options), alias);
9
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/mappings`, options), alias);
7
10
  }
8
11
  deleteSecurityIdentity(securityProviderId, securityIdentity, options) {
9
- return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), {
12
+ return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), {
10
13
  body: JSON.stringify(securityIdentity),
11
14
  headers: { 'Content-Type': 'application/json' },
12
15
  });
13
16
  }
14
17
  createOrUpdateSecurityIdentity(securityProviderId, securityIdentity, options) {
15
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions`, options), securityIdentity);
18
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions`, options), securityIdentity);
16
19
  }
17
20
  manageSecurityIdentities(securityProviderId, batchConfig) {
18
- return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/batch`, batchConfig));
21
+ return this.serverlessApi.put(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/batch`, batchConfig));
19
22
  }
20
23
  deleteOldSecurityIdentities(securityProviderId, batchDelete) {
21
- return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/${securityProviderId}/permissions/olderthan`, batchDelete));
24
+ return this.serverlessApi.delete(this.buildPath(`${PushApi.baseUrl}/providers/${securityProviderId}/permissions/olderthan`, batchDelete));
22
25
  }
23
26
  }
24
27
  //# sourceMappingURL=PushApi.js.map
package/dist/esm/resources/PushApi/PushApi.js.map CHANGED
@@ -1 +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"}
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;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/PushApi/PushApi.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import Resource from '../Resource.js';
2
- import { SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces.js';
2
+ import { FileContainer, FileContainerOptions, SecurityIdentityAliasModel, SecurityIdentityBatchConfig, SecurityIdentityDelete, SecurityIdentityDeleteOptions, SecurityIdentityModel, SecurityIdentityOptions } from './PushApiInterfaces.js';
3
3
  export default class PushApi extends Resource {
4
4
  static baseUrl: string;
5
+ createFileContainer(options?: FileContainerOptions): Promise<FileContainer>;
5
6
  createOrUpdateSecurityIdentityAlias(securityProviderId: string, alias: SecurityIdentityAliasModel, options?: SecurityIdentityOptions): Promise<void>;
6
7
  deleteSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityDelete, options?: SecurityIdentityOptions): Promise<void>;
7
8
  createOrUpdateSecurityIdentity(securityProviderId: string, securityIdentity: SecurityIdentityModel, options?: SecurityIdentityOptions): Promise<void>;
package/dist/types/resources/PushApi/PushApiInterfaces.d.ts CHANGED
@@ -1,4 +1,17 @@
1
1
  import { SinglePermissionResult, SinglePermissionIdentityType } from '../Enums.js';
2
+ export interface FileContainer {
3
+ uploadUri: string;
4
+ fileId: string;
5
+ requiredHeaders: Record<string, string>;
6
+ }
7
+ export interface FileContainerOptions {
8
+ /**
9
+ * Whether to generate the presigned URL using the virtual hosted-style URL.
10
+ *
11
+ * 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[...]`
12
+ */
13
+ useVirtualHostedStyleUrl?: boolean;
14
+ }
2
15
  export interface SecurityIdentityAliasModel extends SecurityIdentityBase {
3
16
  mappings: AliasMappings;
4
17
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/platform-client",
3
- "version": "52.3.0",
3
+ "version": "52.4.0",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "exports": {