@coveo/platform-client 61.5.1 → 62.0.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/AnalyticsAdmin/Properties/Properties.js +6 -6
- package/dist/cjs/resources/AnalyticsAdmin/Properties/Properties.js.map +1 -1
- package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js +6 -6
- package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js.map +1 -1
- package/dist/types/resources/AnalyticsAdmin/Properties/Properties.d.ts +5 -5
- package/dist/types/resources/AnalyticsAdmin/Properties/PropertiesInterfaces.d.ts +28 -0
- package/package.json +1 -1
|
@@ -48,21 +48,21 @@ class Properties extends Resource_js_1.default {
|
|
|
48
48
|
* Create a property.
|
|
49
49
|
*
|
|
50
50
|
* @param trackingId
|
|
51
|
-
* @param
|
|
51
|
+
* @param params
|
|
52
52
|
* @returns Promise<PropertyActionResponse>
|
|
53
53
|
*/
|
|
54
|
-
create(trackingId,
|
|
55
|
-
return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`,
|
|
54
|
+
create(trackingId, params) {
|
|
55
|
+
return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, params));
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
58
|
* Edit a property.
|
|
59
59
|
*
|
|
60
60
|
* @param trackingId
|
|
61
|
-
* @param
|
|
61
|
+
* @param params
|
|
62
62
|
* @returns Promise<PropertyActionResponse>
|
|
63
63
|
*/
|
|
64
|
-
update(trackingId,
|
|
65
|
-
return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`,
|
|
64
|
+
update(trackingId, params) {
|
|
65
|
+
return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, params));
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
68
|
* Delete a property.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":";;;AAAA,4EAAyC;AACzC,6EAAsC;
|
|
1
|
+
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":";;;AAAA,4EAAyC;AACzC,6EAAsC;AAStC,MAAqB,UAAW,SAAQ,qBAAQ;IAC5C,MAAM,CAAC,OAAO,GAAG,uBAAuB,oBAAG,CAAC,cAAc,oBAAoB,CAAC;IAC/E;;;;;;OAMG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAoB;QAC1D,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAA8B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,aAAa,EAAE,MAAM,CAAC,CACpE,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAA8B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,EACzD,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,MAA2B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,MAA2B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAkB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,CAAC,CAC1E,CAAC;IACN,CAAC;;AArFL,6BAsFC"}
|
|
@@ -45,21 +45,21 @@ export default class Properties extends Resource {
|
|
|
45
45
|
* Create a property.
|
|
46
46
|
*
|
|
47
47
|
* @param trackingId
|
|
48
|
-
* @param
|
|
48
|
+
* @param params
|
|
49
49
|
* @returns Promise<PropertyActionResponse>
|
|
50
50
|
*/
|
|
51
|
-
create(trackingId,
|
|
52
|
-
return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`,
|
|
51
|
+
create(trackingId, params) {
|
|
52
|
+
return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, params));
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
55
|
* Edit a property.
|
|
56
56
|
*
|
|
57
57
|
* @param trackingId
|
|
58
|
-
* @param
|
|
58
|
+
* @param params
|
|
59
59
|
* @returns Promise<PropertyActionResponse>
|
|
60
60
|
*/
|
|
61
|
-
update(trackingId,
|
|
62
|
-
return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`,
|
|
61
|
+
update(trackingId, params) {
|
|
62
|
+
return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, params));
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
65
|
* Delete a property.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,GAAG,MAAM,qBAAqB,CAAC;AAStC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,MAAM,CAAC,OAAO,GAAG,uBAAuB,GAAG,CAAC,cAAc,oBAAoB,CAAC;IAC/E;;;;;;OAMG;IACO,gBAAgB,CAAC,KAAa,EAAE,WAAoB;QAC1D,OAAO,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,EAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,WAAW,EAAC,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,MAA8B;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,aAAa,EAAE,MAAM,CAAC,CACpE,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAA8B;QAChC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,EACzD,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,UAAkB;QAClB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAgB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,CAAC,CAAC,CAAC;IAChH,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,MAA2B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,MAA2B;QAClD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,MAAM,CAAC,CAClF,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,UAAkB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAClB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,CAAC,CAC1E,CAAC;IACN,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import Resource from '../../Resource.js';
|
|
2
2
|
import { PageModel } from '../../BaseInterfaces.js';
|
|
3
|
-
import { ListPropertiesRequest, PropertyActionResponse, PropertyModel } from './PropertiesInterfaces.js';
|
|
3
|
+
import { ListPropertiesRequest, MutatePropertyModel, PropertyActionResponse, PropertyModel } from './PropertiesInterfaces.js';
|
|
4
4
|
export default class Properties extends Resource {
|
|
5
5
|
static baseUrl: string;
|
|
6
6
|
/**
|
|
@@ -38,18 +38,18 @@ export default class Properties extends Resource {
|
|
|
38
38
|
* Create a property.
|
|
39
39
|
*
|
|
40
40
|
* @param trackingId
|
|
41
|
-
* @param
|
|
41
|
+
* @param params
|
|
42
42
|
* @returns Promise<PropertyActionResponse>
|
|
43
43
|
*/
|
|
44
|
-
create(trackingId: string,
|
|
44
|
+
create(trackingId: string, params: MutatePropertyModel): Promise<PropertyActionResponse>;
|
|
45
45
|
/**
|
|
46
46
|
* Edit a property.
|
|
47
47
|
*
|
|
48
48
|
* @param trackingId
|
|
49
|
-
* @param
|
|
49
|
+
* @param params
|
|
50
50
|
* @returns Promise<PropertyActionResponse>
|
|
51
51
|
*/
|
|
52
|
-
update(trackingId: string,
|
|
52
|
+
update(trackingId: string, params: MutatePropertyModel): Promise<PropertyActionResponse>;
|
|
53
53
|
/**
|
|
54
54
|
* Delete a property.
|
|
55
55
|
* @param trackingId
|
|
@@ -17,6 +17,34 @@ export interface PropertyModel {
|
|
|
17
17
|
* Project IDs are only included on request.
|
|
18
18
|
*/
|
|
19
19
|
projectIds?: string[] | null;
|
|
20
|
+
/**
|
|
21
|
+
* Optional: The default time zone associated with the property.
|
|
22
|
+
* Only valid IANA time zones are accepted (UTC, America/Montreal, ...).
|
|
23
|
+
* Leaving this empty will set the value to 'null'.
|
|
24
|
+
*/
|
|
25
|
+
defaultTimeZone?: string;
|
|
26
|
+
/**
|
|
27
|
+
* Optional: The default currency associated with the property.
|
|
28
|
+
* Leaving this empty will set the value to 'null'.
|
|
29
|
+
*/
|
|
30
|
+
defaultCurrency?: string;
|
|
31
|
+
}
|
|
32
|
+
export interface MutatePropertyModel {
|
|
33
|
+
/**
|
|
34
|
+
* The name used for the property in the UI.
|
|
35
|
+
*/
|
|
36
|
+
displayName: string;
|
|
37
|
+
/**
|
|
38
|
+
* Optional: The default time zone associated with the property.
|
|
39
|
+
* Only valid IANA time zones are accepted (UTC, America/Montreal, ...).
|
|
40
|
+
* Leaving this empty will set the value to 'null'.
|
|
41
|
+
*/
|
|
42
|
+
defaultTimeZone?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Optional: The default currency associated with the property.
|
|
45
|
+
* Leaving this empty will set the value to 'null'.
|
|
46
|
+
*/
|
|
47
|
+
defaultCurrency?: string;
|
|
20
48
|
}
|
|
21
49
|
export interface PropertyActionResponse {
|
|
22
50
|
/**
|