@coveo/platform-client 60.2.0 → 60.4.0

package/dist/cjs/resources/AnalyticsAdmin/Properties/Properties.js

@@ -16,15 +16,28 @@ class Properties extends Resource_js_1.default {
         return super.buildPath(route, { org: this.api.organizationId, ...queryParams });
     }
     /**
-     * List all properties
-     * @param params
+     * List all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
      * @returns Promise<PageModel<PropertyModel>>
      */
     list(params) {
-        return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties/list`, params));
+        return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties`, params));
     }
     /**
-     * Get a property
+     * Query all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
+     * @returns Promise<PageModel<PropertyModel>>
+     */
+    query(params) {
+        return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties`), params);
+    }
+    /**
+     * Get a property.
+     *
      * @param trackingId
      * @returns Promise<PropertyModel>
      */
@@ -32,27 +45,29 @@ class Properties extends Resource_js_1.default {
         return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`));
     }
     /**
-     * Create a property
+     * Create a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     create(trackingId, displayName) {
         return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, { displayName }));
     }
     /**
-     * Edit a property
+     * Edit a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     update(trackingId, displayName) {
         return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, { displayName }));
     }
     /**
-     * Delete a property
+     * Delete a property.
      * @param trackingId
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     delete(trackingId) {
         return this.api.delete(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`));

package/dist/cjs/resources/AnalyticsAdmin/Properties/Properties.js.map

@@ -1 +1 @@
-{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":";;;AAAA,4EAAyC;AACzC,6EAAsC;AAItC,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;;;;OAIG;IACH,IAAI,CAAC,MAA6B;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,kBAAkB,EAAE,MAAM,CAAC,CACzE,CAAC;IACN,CAAC;IAED;;;;OAIG;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;;;;;OAKG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,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;;AAlEL,6BAmEC"}
+{"version":3,"file":"Properties.js","sourceRoot":"","sources":["../../../../../src/resources/AnalyticsAdmin/Properties/Properties.ts"],"names":[],"mappings":";;;AAAA,4EAAyC;AACzC,6EAAsC;AAItC,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,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,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"}

package/dist/cjs/resources/Projects/ProjectInterfaces.js

@@ -15,6 +15,7 @@ exports.projectResourceTypes = [
     'CASE_ASSIST',
     'CRAWLING_MODULE',
     'EXTENSION',
+    'FIELD',
     'IN_PRODUCT_EXPERIENCE',
     'INSIGHT_PANEL',
     'ML_MODEL',
@@ -23,6 +24,8 @@ exports.projectResourceTypes = [
     'SEARCH_PAGE',
     'SECURITY_PROVIDER',
     'SOURCE',
+    'STOREFRONT_ASSOCIATION',
+    'TRACKING_ID',
     'UA_REPORT',
 ];
 /**

package/dist/cjs/resources/Projects/ProjectInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProjectInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/Projects/ProjectInterfaces.ts"],"names":[],"mappings":";;;AAGA,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,oDAAmC,CAAA;AACvC,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB;AAEY,QAAA,oBAAoB,GAAG;IAChC,SAAS;IACT,aAAa;IACb,iBAAiB;IACjB,WAAW;IACX,uBAAuB;IACvB,eAAe;IACf,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,WAAW;CACd,CAAC;AAIF;;GAEG;AACH,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,iDAAkC,CAAA;IAClC,oCAAqB,CAAA;IACrB,mDAAoC,CAAA;IACpC,qDAAsC,CAAA;IACtC,sDAAuC,CAAA;IACvC,oCAAqB,CAAA;IACrB,oDAAqC,CAAA;IACrC,sDAAuC,CAAA;IACvC,8BAAe,CAAA;IACf,uDAAwC,CAAA;IACxC,+CAAgC,CAAA;AACpC,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB"}
+{"version":3,"file":"ProjectInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/Projects/ProjectInterfaces.ts"],"names":[],"mappings":";;;AAGA,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,oDAAmC,CAAA;AACvC,CAAC,EAPW,aAAa,6BAAb,aAAa,QAOxB;AAEY,QAAA,oBAAoB,GAAG;IAChC,SAAS;IACT,aAAa;IACb,iBAAiB;IACjB,WAAW;IACX,OAAO;IACP,uBAAuB;IACvB,eAAe;IACf,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,wBAAwB;IACxB,aAAa;IACb,WAAW;CACd,CAAC;AAIF;;GAEG;AACH,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,iDAAkC,CAAA;IAClC,oCAAqB,CAAA;IACrB,mDAAoC,CAAA;IACpC,qDAAsC,CAAA;IACtC,sDAAuC,CAAA;IACvC,oCAAqB,CAAA;IACrB,oDAAqC,CAAA;IACrC,sDAAuC,CAAA;IACvC,8BAAe,CAAA;IACf,uDAAwC,CAAA;IACxC,+CAAgC,CAAA;AACpC,CAAC,EAZW,WAAW,2BAAX,WAAW,QAYtB"}

package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js

@@ -13,15 +13,28 @@ export default class Properties extends Resource {
         return super.buildPath(route, { org: this.api.organizationId, ...queryParams });
     }
     /**
-     * List all properties
-     * @param params
+     * List all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
      * @returns Promise<PageModel<PropertyModel>>
      */
     list(params) {
-        return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties/list`, params));
+        return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties`, params));
     }
     /**
-     * Get a property
+     * Query all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
+     * @returns Promise<PageModel<PropertyModel>>
+     */
+    query(params) {
+        return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties`), params);
+    }
+    /**
+     * Get a property.
+     *
      * @param trackingId
      * @returns Promise<PropertyModel>
      */
@@ -29,27 +42,29 @@ export default class Properties extends Resource {
         return this.api.get(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`));
     }
     /**
-     * Create a property
+     * Create a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     create(trackingId, displayName) {
         return this.api.post(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, { displayName }));
     }
     /**
-     * Edit a property
+     * Edit a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     update(trackingId, displayName) {
         return this.api.put(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`, { displayName }));
     }
     /**
-     * Delete a property
+     * Delete a property.
      * @param trackingId
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
     delete(trackingId) {
         return this.api.delete(this.buildPathWithOrg(`${Properties.baseUrl}/properties/${trackingId}`));

package/dist/esm/resources/AnalyticsAdmin/Properties/Properties.js.map

@@ -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;AAItC,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;;;;OAIG;IACH,IAAI,CAAC,MAA6B;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,kBAAkB,EAAE,MAAM,CAAC,CACzE,CAAC;IACN,CAAC;IAED;;;;OAIG;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;;;;;OAKG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,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"}
+{"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;AAItC,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,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAChB,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,UAAkB,EAAE,WAAmB;QAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,UAAU,CAAC,OAAO,eAAe,UAAU,EAAE,EAAE,EAAC,WAAW,EAAC,CAAC,CACzF,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"}

package/dist/esm/resources/Projects/ProjectInterfaces.js

@@ -12,6 +12,7 @@ export const projectResourceTypes = [
     'CASE_ASSIST',
     'CRAWLING_MODULE',
     'EXTENSION',
+    'FIELD',
     'IN_PRODUCT_EXPERIENCE',
     'INSIGHT_PANEL',
     'ML_MODEL',
@@ -20,6 +21,8 @@ export const projectResourceTypes = [
     'SEARCH_PAGE',
     'SECURITY_PROVIDER',
     'SOURCE',
+    'STOREFRONT_ASSOCIATION',
+    'TRACKING_ID',
     'UA_REPORT',
 ];
 /**

package/dist/esm/resources/Projects/ProjectInterfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProjectInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/Projects/ProjectInterfaces.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,oDAAmC,CAAA;AACvC,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAChC,SAAS;IACT,aAAa;IACb,iBAAiB;IACjB,WAAW;IACX,uBAAuB;IACvB,eAAe;IACf,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,WAAW;CACd,CAAC;AAIF;;GAEG;AACH,MAAM,CAAN,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,iDAAkC,CAAA;IAClC,oCAAqB,CAAA;IACrB,mDAAoC,CAAA;IACpC,qDAAsC,CAAA;IACtC,sDAAuC,CAAA;IACvC,oCAAqB,CAAA;IACrB,oDAAqC,CAAA;IACrC,sDAAuC,CAAA;IACvC,8BAAe,CAAA;IACf,uDAAwC,CAAA;IACxC,+CAAgC,CAAA;AACpC,CAAC,EAZW,WAAW,KAAX,WAAW,QAYtB"}
+{"version":3,"file":"ProjectInterfaces.js","sourceRoot":"","sources":["../../../../src/resources/Projects/ProjectInterfaces.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,8BAAa,CAAA;IACb,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,yCAAwB,CAAA;IACxB,6CAA4B,CAAA;IAC5B,oDAAmC,CAAA;AACvC,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAChC,SAAS;IACT,aAAa;IACb,iBAAiB;IACjB,WAAW;IACX,OAAO;IACP,uBAAuB;IACvB,eAAe;IACf,UAAU;IACV,gBAAgB;IAChB,YAAY;IACZ,aAAa;IACb,mBAAmB;IACnB,QAAQ;IACR,wBAAwB;IACxB,aAAa;IACb,WAAW;CACd,CAAC;AAIF;;GAEG;AACH,MAAM,CAAN,IAAY,WAYX;AAZD,WAAY,WAAW;IACnB,iDAAkC,CAAA;IAClC,oCAAqB,CAAA;IACrB,mDAAoC,CAAA;IACpC,qDAAsC,CAAA;IACtC,sDAAuC,CAAA;IACvC,oCAAqB,CAAA;IACrB,oDAAqC,CAAA;IACrC,sDAAuC,CAAA;IACvC,8BAAe,CAAA;IACf,uDAAwC,CAAA;IACxC,+CAAgC,CAAA;AACpC,CAAC,EAZW,WAAW,KAAX,WAAW,QAYtB"}

package/dist/types/resources/AnalyticsAdmin/Properties/Properties.d.ts

@@ -1,6 +1,6 @@
 import Resource from '../../Resource.js';
 import { PageModel } from '../../BaseInterfaces.js';
-import { ListPropertiesParams, PropertiesResponseMessage, PropertyModel } from './PropertiesInterfaces.js';
+import { ListPropertiesRequest, PropertyActionResponse, PropertyModel } from './PropertiesInterfaces.js';
 export default class Properties extends Resource {
     static baseUrl: string;
     /**
@@ -12,35 +12,48 @@ export default class Properties extends Resource {
      */
     protected buildPathWithOrg(route: string, queryParams?: object): string;
     /**
-     * List all properties
-     * @param params
+     * List all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
      * @returns Promise<PageModel<PropertyModel>>
      */
-    list(params?: ListPropertiesParams): Promise<PageModel<PropertyModel>>;
+    list(params?: ListPropertiesRequest): Promise<PageModel<PropertyModel>>;
     /**
-     * Get a property
+     * Query all properties, optionally using filters.
+     * Note that `list` and `query` are equivalent, with the only difference being that `list` uses GET and `query` uses POST.
+     *
+     * @param params Optional parameters to filter the listing by.
+     * @returns Promise<PageModel<PropertyModel>>
+     */
+    query(params?: ListPropertiesRequest): Promise<PageModel<PropertyModel>>;
+    /**
+     * Get a property.
+     *
      * @param trackingId
      * @returns Promise<PropertyModel>
      */
     get(trackingId: string): Promise<PropertyModel>;
     /**
-     * Create a property
+     * Create a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
-    create(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
+    create(trackingId: string, displayName: string): Promise<PropertyActionResponse>;
     /**
-     * Edit a property
+     * Edit a property.
+     *
      * @param trackingId
      * @param displayName
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
-    update(trackingId: string, displayName: string): Promise<PropertiesResponseMessage>;
+    update(trackingId: string, displayName: string): Promise<PropertyActionResponse>;
     /**
-     * Delete a property
+     * Delete a property.
      * @param trackingId
-     * @returns Promise<PropertiesResponseMessage>
+     * @returns Promise<PropertyActionResponse>
      */
-    delete(trackingId: string): Promise<PropertiesResponseMessage>;
+    delete(trackingId: string): Promise<PropertyActionResponse>;
 }

package/dist/types/resources/AnalyticsAdmin/Properties/PropertiesInterfaces.d.ts

@@ -1,12 +1,57 @@
 import { Paginated } from '../../BaseInterfaces.js';
 export interface PropertyModel {
-    trackingId: string | null;
+    /**
+     * The Organization ID that owns the property.
+     */
+    organizationId: string;
+    /**
+     * The string used to represent the tracking ID when sending a event request.
+     */
+    trackingId: string;
+    /**
+     * The name used for the property in the UI.
+     */
     displayName: string;
+    /**
+     * Optional list of project identifiers the property is mapped to.
+     * Project IDs are only included on request.
+     */
+    projectIds?: string[] | null;
 }
-export interface PropertiesResponseMessage {
+export interface PropertyActionResponse {
+    /**
+     * A message detailing the result of the requested operation.
+     */
     message: string;
 }
-export interface ListPropertiesParams extends Paginated {
-    filter?: string;
+export interface ListPropertiesRequest extends Paginated {
+    /**
+     * Whether the default property should be included.
+     */
     includeDefault?: boolean;
+    /**
+     * Optional filter on tracking id or display name.
+     */
+    filter?: string;
+    /**
+     * Optional filter on project id, requiring the view projects privilege.
+     */
+    projectId?: string;
+    /**
+     * Whether the projectIds of properties should be included.
+     * The default value is based on whether a `projectId` is specified:
+     * this property defaults to `false`, unless a `projectId` is specified.
+     */
+    includeProjectIds?: boolean;
+    /**
+     * Optional filter on a list of tracking IDs (exact case-sensitive match).
+     * When specified, it is recommended to use the `query` (POST) method over the `list` (GET) method,
+     * especially if the list of tracking IDs may have many entries.
+     * Note that if this is an empty array, the result will always be empty.
+     */
+    trackingIds?: string[];
 }
+/** @deprecated Deprecated alias for `ListPropertiesRequest`. */
+export type ListPropertiesParams = ListPropertiesRequest;
+/** @deprecated Deprecated alias for `PropertyActionResponse`. */
+export type PropertiesResponseMessage = PropertyActionResponse;

package/package.json

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