@coveo/platform-client 42.0.0 → 42.1.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.
|
@@ -9,6 +9,7 @@ class Limits extends Resource_js_1.default {
|
|
|
9
9
|
static getBaseUrl = () => `/rest/organizations/${APICore_js_1.default.orgPlaceholder}/limits`;
|
|
10
10
|
static getWithSection = (sectionName) => `${Limits.getBaseUrl()}/${sectionName}`;
|
|
11
11
|
static getWithSectionAndHistory = (sectionName, limitKey) => `${Limits.getWithSection(sectionName)}/${limitKey}/history`;
|
|
12
|
+
static getSpecificLimit = (sectionName, limitKey) => `${Limits.getWithSection(sectionName)}/${limitKey}`;
|
|
12
13
|
get(sectionName) {
|
|
13
14
|
return this.api.get(Limits.getWithSection(sectionName));
|
|
14
15
|
}
|
|
@@ -18,6 +19,15 @@ class Limits extends Resource_js_1.default {
|
|
|
18
19
|
getAllPerLimitType(limitType) {
|
|
19
20
|
return this.api.get(this.buildPath(Limits.getBaseUrl(), { limitType: limitType }));
|
|
20
21
|
}
|
|
22
|
+
/**
|
|
23
|
+
* Shows the status of a specific limit in an organization
|
|
24
|
+
*
|
|
25
|
+
* @param sectionName The name of the target license section
|
|
26
|
+
* @param limitKey The unique identifier of the target limit status to show
|
|
27
|
+
*/
|
|
28
|
+
getSpecificLimitStatus(sectionName, limitKey) {
|
|
29
|
+
return this.api.get(Limits.getSpecificLimit(sectionName, limitKey));
|
|
30
|
+
}
|
|
21
31
|
getHistoryLimit(sectionName, limitKey, options) {
|
|
22
32
|
return this.api.get(this.buildPath(Limits.getWithSectionAndHistory(sectionName, limitKey), options));
|
|
23
33
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Limits.js","sourceRoot":"","sources":["../../../../src/resources/Limits/Limits.ts"],"names":[],"mappings":";;;;;AAAA,kEAAmC;AAEnC,iEAAsC;
|
|
1
|
+
{"version":3,"file":"Limits.js","sourceRoot":"","sources":["../../../../src/resources/Limits/Limits.ts"],"names":[],"mappings":";;;;;AAAA,kEAAmC;AAEnC,iEAAsC;AAUtC,MAAqB,MAAO,SAAQ,qBAAQ;IACxC,MAAM,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,uBAAuB,oBAAG,CAAC,cAAc,SAAS,CAAC;IAC7E,MAAM,CAAC,cAAc,GAAG,CAAC,WAA2B,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,IAAI,WAAW,EAAE,CAAC;IACjG,MAAM,CAAC,wBAAwB,GAAG,CAAC,WAA2B,EAAE,QAAgB,EAAE,EAAE,CAChF,GAAG,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC;IAChE,MAAM,CAAC,gBAAgB,GAAG,CAAC,WAA2B,EAAE,QAAgB,EAAE,EAAE,CACxE,GAAG,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,QAAQ,EAAE,CAAC;IAExD,GAAG,CAAC,WAA2B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,kBAAkB,CAAC,SAAoB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAC,SAAS,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;;;;OAKG;IACH,sBAAsB,CAAC,WAA2B,EAAE,QAAgB;QAChE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAa,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,eAAe,CAAC,WAA2B,EAAE,QAAgB,EAAE,OAA6B;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAClF,CAAC;IACN,CAAC;;AAlCL,yBAmCC"}
|
|
@@ -4,6 +4,7 @@ export default class Limits extends Resource {
|
|
|
4
4
|
static getBaseUrl = () => `/rest/organizations/${API.orgPlaceholder}/limits`;
|
|
5
5
|
static getWithSection = (sectionName) => `${Limits.getBaseUrl()}/${sectionName}`;
|
|
6
6
|
static getWithSectionAndHistory = (sectionName, limitKey) => `${Limits.getWithSection(sectionName)}/${limitKey}/history`;
|
|
7
|
+
static getSpecificLimit = (sectionName, limitKey) => `${Limits.getWithSection(sectionName)}/${limitKey}`;
|
|
7
8
|
get(sectionName) {
|
|
8
9
|
return this.api.get(Limits.getWithSection(sectionName));
|
|
9
10
|
}
|
|
@@ -13,6 +14,15 @@ export default class Limits extends Resource {
|
|
|
13
14
|
getAllPerLimitType(limitType) {
|
|
14
15
|
return this.api.get(this.buildPath(Limits.getBaseUrl(), { limitType: limitType }));
|
|
15
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* Shows the status of a specific limit in an organization
|
|
19
|
+
*
|
|
20
|
+
* @param sectionName The name of the target license section
|
|
21
|
+
* @param limitKey The unique identifier of the target limit status to show
|
|
22
|
+
*/
|
|
23
|
+
getSpecificLimitStatus(sectionName, limitKey) {
|
|
24
|
+
return this.api.get(Limits.getSpecificLimit(sectionName, limitKey));
|
|
25
|
+
}
|
|
16
26
|
getHistoryLimit(sectionName, limitKey, options) {
|
|
17
27
|
return this.api.get(this.buildPath(Limits.getWithSectionAndHistory(sectionName, limitKey), options));
|
|
18
28
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Limits.js","sourceRoot":"","sources":["../../../../src/resources/Limits/Limits.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"Limits.js","sourceRoot":"","sources":["../../../../src/resources/Limits/Limits.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,kBAAkB,CAAC;AAEnC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAUtC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,MAAM,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,uBAAuB,GAAG,CAAC,cAAc,SAAS,CAAC;IAC7E,MAAM,CAAC,cAAc,GAAG,CAAC,WAA2B,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,IAAI,WAAW,EAAE,CAAC;IACjG,MAAM,CAAC,wBAAwB,GAAG,CAAC,WAA2B,EAAE,QAAgB,EAAE,EAAE,CAChF,GAAG,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC;IAChE,MAAM,CAAC,gBAAgB,GAAG,CAAC,WAA2B,EAAE,QAAgB,EAAE,EAAE,CACxE,GAAG,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,QAAQ,EAAE,CAAC;IAExD,GAAG,CAAC,WAA2B;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAc,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,kBAAkB,CAAC,SAAoB;QACnC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,EAAC,SAAS,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;IACrG,CAAC;IAED;;;;;OAKG;IACH,sBAAsB,CAAC,WAA2B,EAAE,QAAgB;QAChE,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAa,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IACpF,CAAC;IAED,eAAe,CAAC,WAA2B,EAAE,QAAgB,EAAE,OAA6B;QACxF,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAClF,CAAC;IACN,CAAC"}
|
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
import { LicenseSection } from '../Enums.js';
|
|
2
2
|
import Resource from '../Resource.js';
|
|
3
|
-
import { AllLimitsModel, LimitHistoryDataPointModel, LimitHistoryOptions, LimitsModel, LimitType } from './LimitsInterfaces.js';
|
|
3
|
+
import { AllLimitsModel, LimitHistoryDataPointModel, LimitHistoryOptions, LimitsModel, LimitType, LimitModel } from './LimitsInterfaces.js';
|
|
4
4
|
export default class Limits extends Resource {
|
|
5
5
|
static getBaseUrl: () => string;
|
|
6
6
|
static getWithSection: (sectionName: LicenseSection) => string;
|
|
7
7
|
static getWithSectionAndHistory: (sectionName: LicenseSection, limitKey: string) => string;
|
|
8
|
+
static getSpecificLimit: (sectionName: LicenseSection, limitKey: string) => string;
|
|
8
9
|
get(sectionName: LicenseSection): Promise<LimitsModel>;
|
|
9
10
|
getAll(): Promise<AllLimitsModel>;
|
|
10
11
|
getAllPerLimitType(limitType: LimitType): Promise<AllLimitsModel>;
|
|
12
|
+
/**
|
|
13
|
+
* Shows the status of a specific limit in an organization
|
|
14
|
+
*
|
|
15
|
+
* @param sectionName The name of the target license section
|
|
16
|
+
* @param limitKey The unique identifier of the target limit status to show
|
|
17
|
+
*/
|
|
18
|
+
getSpecificLimitStatus(sectionName: LicenseSection, limitKey: string): Promise<LimitModel>;
|
|
11
19
|
getHistoryLimit(sectionName: LicenseSection, limitKey: string, options?: LimitHistoryOptions): Promise<LimitHistoryDataPointModel[]>;
|
|
12
20
|
}
|