@coveo/platform-client 55.6.1 → 55.7.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.
- package/dist/cjs/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +15 -0
- package/dist/cjs/resources/UsageAnalytics/Read/Snowflake/Snowflake.js.map +1 -1
- package/dist/esm/resources/UsageAnalytics/Read/Snowflake/Snowflake.js +15 -0
- package/dist/esm/resources/UsageAnalytics/Read/Snowflake/Snowflake.js.map +1 -1
- package/dist/types/resources/UsageAnalytics/Read/Snowflake/Snowflake.d.ts +14 -1
- package/dist/types/resources/UsageAnalytics/Read/Snowflake/SnowflakeInterfaces.d.ts +3 -0
- package/package.json +2 -2
|
@@ -12,6 +12,8 @@ class Snowflake extends ReadServiceResource_js_1.default {
|
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
14
|
* Create a new user within a Snowflake reader account.
|
|
15
|
+
*
|
|
16
|
+
* @param model The user to create.
|
|
15
17
|
*/
|
|
16
18
|
createUser(model) {
|
|
17
19
|
return this.api.post(this.buildPathWithOrg(`${Snowflake.baseUrl}/users`), model);
|
|
@@ -40,6 +42,15 @@ class Snowflake extends ReadServiceResource_js_1.default {
|
|
|
40
42
|
resetPassword(snowflakeUser) {
|
|
41
43
|
return this.api.post(this.buildPathWithOrg(`${Snowflake.baseUrl}/users/${snowflakeUser}/passwordreset`));
|
|
42
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* Reactivate and set a user's expiration in a Snowflake reader account.
|
|
47
|
+
*
|
|
48
|
+
* @param snowflakeUser The login name for the Snowflake user.
|
|
49
|
+
* @param params The number of days until the user's expiration date.
|
|
50
|
+
*/
|
|
51
|
+
reactivateUser(snowflakeUser, params) {
|
|
52
|
+
return this.api.put(this.buildPathWithOrg(`${Snowflake.baseUrl}/users/${snowflakeUser}/expiration`), params);
|
|
53
|
+
}
|
|
43
54
|
/**
|
|
44
55
|
* Get the details of the active network policy for a Snowflake reader account.
|
|
45
56
|
*/
|
|
@@ -48,12 +59,16 @@ class Snowflake extends ReadServiceResource_js_1.default {
|
|
|
48
59
|
}
|
|
49
60
|
/**
|
|
50
61
|
* Set the details of the active network policy for a Snowflake reader account.
|
|
62
|
+
*
|
|
63
|
+
* @param model The network policy to create.
|
|
51
64
|
*/
|
|
52
65
|
updateNetworkPolicy(model) {
|
|
53
66
|
return this.api.put(this.buildPathWithOrg(`${Snowflake.baseUrl}/networkpolicy`), model);
|
|
54
67
|
}
|
|
55
68
|
/**
|
|
56
69
|
* Get the amount of compute credits used by a Snowflake reader account within a date range.
|
|
70
|
+
*
|
|
71
|
+
* @param params The time range to get the amount of compute credits.
|
|
57
72
|
*/
|
|
58
73
|
getCreditUsage(params) {
|
|
59
74
|
return this.api.get(this.buildPathWithOrg(`${Snowflake.baseUrl}/creditusage`, params));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;
|
|
1
|
+
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":";;;AAAA,+FAA4D;AAY5D,MAAqB,SAAU,SAAQ,gCAAmB;IACtD,MAAM,CAAC,OAAO,GAAG,8BAA8B,CAAC;IAEhD;;OAEG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAyB;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,aAAqB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,aAAqB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,gBAAgB,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,aAAqB,EAAE,MAA4B;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,aAAa,CAAC,EAC/E,MAAM,CACT,CAAC;IACN,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA8B,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,KAAkC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAA4B;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,cAAc,EAAE,MAAM,CAAC,CACpE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,iCAAiC;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,yBAAyB,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC9F,CAAC;;AApHL,4BAqHC"}
|
|
@@ -9,6 +9,8 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* Create a new user within a Snowflake reader account.
|
|
12
|
+
*
|
|
13
|
+
* @param model The user to create.
|
|
12
14
|
*/
|
|
13
15
|
createUser(model) {
|
|
14
16
|
return this.api.post(this.buildPathWithOrg(`${Snowflake.baseUrl}/users`), model);
|
|
@@ -37,6 +39,15 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
37
39
|
resetPassword(snowflakeUser) {
|
|
38
40
|
return this.api.post(this.buildPathWithOrg(`${Snowflake.baseUrl}/users/${snowflakeUser}/passwordreset`));
|
|
39
41
|
}
|
|
42
|
+
/**
|
|
43
|
+
* Reactivate and set a user's expiration in a Snowflake reader account.
|
|
44
|
+
*
|
|
45
|
+
* @param snowflakeUser The login name for the Snowflake user.
|
|
46
|
+
* @param params The number of days until the user's expiration date.
|
|
47
|
+
*/
|
|
48
|
+
reactivateUser(snowflakeUser, params) {
|
|
49
|
+
return this.api.put(this.buildPathWithOrg(`${Snowflake.baseUrl}/users/${snowflakeUser}/expiration`), params);
|
|
50
|
+
}
|
|
40
51
|
/**
|
|
41
52
|
* Get the details of the active network policy for a Snowflake reader account.
|
|
42
53
|
*/
|
|
@@ -45,12 +56,16 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
45
56
|
}
|
|
46
57
|
/**
|
|
47
58
|
* Set the details of the active network policy for a Snowflake reader account.
|
|
59
|
+
*
|
|
60
|
+
* @param model The network policy to create.
|
|
48
61
|
*/
|
|
49
62
|
updateNetworkPolicy(model) {
|
|
50
63
|
return this.api.put(this.buildPathWithOrg(`${Snowflake.baseUrl}/networkpolicy`), model);
|
|
51
64
|
}
|
|
52
65
|
/**
|
|
53
66
|
* Get the amount of compute credits used by a Snowflake reader account within a date range.
|
|
67
|
+
*
|
|
68
|
+
* @param params The time range to get the amount of compute credits.
|
|
54
69
|
*/
|
|
55
70
|
getCreditUsage(params) {
|
|
56
71
|
return this.api.get(this.buildPathWithOrg(`${Snowflake.baseUrl}/creditusage`, params));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"Snowflake.js","sourceRoot":"","sources":["../../../../../../src/resources/UsageAnalytics/Read/Snowflake/Snowflake.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,2BAA2B,CAAC;AAY5D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,mBAAmB;IACtD,MAAM,CAAC,OAAO,GAAG,8BAA8B,CAAC;IAEhD;;OAEG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAsB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,KAAyB;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,aAAqB;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,aAAqB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAqB,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,EAAE,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,gBAAgB,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,aAAqB,EAAE,MAA4B;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,UAAU,aAAa,aAAa,CAAC,EAC/E,MAAM,CACT,CAAC;IACN,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA8B,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAClH,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,KAAkC;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,EAAE,KAAK,CAAC,CAAC;IAClG,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAA4B;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,cAAc,EAAE,MAAM,CAAC,CACpE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,yBAAyB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAC9D,CAAC;IACN,CAAC;IAED;;OAEG;IACH,iCAAiC;QAC7B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,yBAAyB,CAAC,CACvE,CAAC;IACN,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,4BAA4B;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAC9F,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import ReadServiceResource from '../ReadServiceResource.js';
|
|
2
|
-
import { GetCreditUsageParams, SnowflakeCreditUsageModel, SnowflakeNetworkPolicyModel, SnowflakeReaderAccountEndpointModel, SnowflakeReaderAccountStatusModel, SnowflakeUserModel, SnowflakeUsersModel } from './SnowflakeInterfaces.js';
|
|
2
|
+
import { GetCreditUsageParams, ReactivateUserParams, SnowflakeCreditUsageModel, SnowflakeNetworkPolicyModel, SnowflakeReaderAccountEndpointModel, SnowflakeReaderAccountStatusModel, SnowflakeUserModel, SnowflakeUsersModel } from './SnowflakeInterfaces.js';
|
|
3
3
|
export default class Snowflake extends ReadServiceResource {
|
|
4
4
|
static baseUrl: string;
|
|
5
5
|
/**
|
|
@@ -8,6 +8,8 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
8
8
|
listUsers(): Promise<SnowflakeUsersModel>;
|
|
9
9
|
/**
|
|
10
10
|
* Create a new user within a Snowflake reader account.
|
|
11
|
+
*
|
|
12
|
+
* @param model The user to create.
|
|
11
13
|
*/
|
|
12
14
|
createUser(model: SnowflakeUserModel): Promise<SnowflakeUserModel>;
|
|
13
15
|
/**
|
|
@@ -28,16 +30,27 @@ export default class Snowflake extends ReadServiceResource {
|
|
|
28
30
|
* @param snowflakeUser The login name for the Snowflake user.
|
|
29
31
|
*/
|
|
30
32
|
resetPassword(snowflakeUser: string): Promise<void>;
|
|
33
|
+
/**
|
|
34
|
+
* Reactivate and set a user's expiration in a Snowflake reader account.
|
|
35
|
+
*
|
|
36
|
+
* @param snowflakeUser The login name for the Snowflake user.
|
|
37
|
+
* @param params The number of days until the user's expiration date.
|
|
38
|
+
*/
|
|
39
|
+
reactivateUser(snowflakeUser: string, params: ReactivateUserParams): Promise<void>;
|
|
31
40
|
/**
|
|
32
41
|
* Get the details of the active network policy for a Snowflake reader account.
|
|
33
42
|
*/
|
|
34
43
|
getNetworkPolicy(): Promise<SnowflakeNetworkPolicyModel>;
|
|
35
44
|
/**
|
|
36
45
|
* Set the details of the active network policy for a Snowflake reader account.
|
|
46
|
+
*
|
|
47
|
+
* @param model The network policy to create.
|
|
37
48
|
*/
|
|
38
49
|
updateNetworkPolicy(model: SnowflakeNetworkPolicyModel): Promise<void>;
|
|
39
50
|
/**
|
|
40
51
|
* Get the amount of compute credits used by a Snowflake reader account within a date range.
|
|
52
|
+
*
|
|
53
|
+
* @param params The time range to get the amount of compute credits.
|
|
41
54
|
*/
|
|
42
55
|
getCreditUsage(params: GetCreditUsageParams): Promise<SnowflakeCreditUsageModel>;
|
|
43
56
|
/**
|
|
@@ -18,6 +18,9 @@ export interface SnowflakeUserModel {
|
|
|
18
18
|
*/
|
|
19
19
|
daysToExpiry?: number;
|
|
20
20
|
}
|
|
21
|
+
export interface ReactivateUserParams {
|
|
22
|
+
daysToExpiry: number;
|
|
23
|
+
}
|
|
21
24
|
export interface SnowflakeNetworkPolicyModel {
|
|
22
25
|
allowedIpAddresses: string[];
|
|
23
26
|
blockedIpAddresses: string[];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveo/platform-client",
|
|
3
|
-
"version": "55.
|
|
3
|
+
"version": "55.7.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"@typescript-eslint/parser": "7.18.0",
|
|
40
40
|
"abortcontroller-polyfill": "1.7.5",
|
|
41
41
|
"cz-conventional-changelog": "3.3.0",
|
|
42
|
-
"eslint": "8.57.
|
|
42
|
+
"eslint": "8.57.1",
|
|
43
43
|
"eslint-config-prettier": "9.1.0",
|
|
44
44
|
"eslint-config-typescript": "3.0.0",
|
|
45
45
|
"eslint-plugin-jest": "28.8.3",
|