@wix/activity-counters_activity-counters - npm Package Compare versions

Comparing version 1.0.30 to 1.0.31

build/es/src/members-v1-activity-counter-activity-counters.context.d.ts

@@ -10,5 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters } from './members-v1-activity-counter-activity-counters.public';
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  */
@@ -15,0 +13,0 @@ export declare const onActivityCounterUpdated: ReturnType<typeof createEventModule<typeof publicOnActivityCounterUpdated>>;

build/es/src/members-v1-activity-counter-activity-counters.context.js

@@ -10,5 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters, } from './members-v1-activity-counter-activity-counters.public';
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  */
@@ -15,0 +13,0 @@ export const onActivityCounterUpdated = createEventModule(publicOnActivityCounterUpdated);

build/es/src/members-v1-activity-counter-activity-counters.http.d.ts

 import { RequestOptionsFactory } from '@wix/sdk-types';
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  */
@@ -15,3 +17,3 @@ export declare function setActivityCounters(payload: object): RequestOptionsFactory<any>;
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
@@ -21,3 +23,8 @@ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
 export declare function incrementActivityCounters(payload: object): RequestOptionsFactory<any>;
-/** Retrieves activity counters. */
+/**
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
+ */
 export declare function getActivityCounters(payload: object): RequestOptionsFactory<any>;
@@ -24,0 +31,0 @@ /**

build/es/src/members-v1-activity-counter-activity-counters.http.js

@@ -64,7 +64,9 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  */
@@ -94,3 +96,3 @@ export function setActivityCounters(payload) {
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
@@ -117,3 +119,8 @@ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
 }
-/** Retrieves activity counters. */
+/**
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
+ */
 export function getActivityCounters(payload) {
@@ -120,0 +127,0 @@ function __getActivityCounters({ host }) {

build/es/src/members-v1-activity-counter-activity-counters.public.d.ts

@@ -9,10 +9,11 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types';
     /**
-     * Sets activity counters for a member.
+     * Sets activity counters for a requested site member.
      *
-     * If a counter doesn't exist, it's created.
+     * If a counter does not yet exist, it will be created.
      *
-     * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+     * Counters are set under a custom key, which is an ID for the counter, and is unique.
+     *
+     * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
      * @param - ID of the member to upsert an activity counter for.
      * @param - Details of the counter to be set.
-     * @returns Upserted activity counter.
      */
@@ -28,6 +29,6 @@ (memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;
      *
-     * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+     * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
      *
      * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
-     * @param - Site member ID whose counter will be increment.
+     * @param - Site member ID whose counter will increment.
      */
@@ -39,5 +40,7 @@ (memberId: string, counter: Counter): Promise<IncrementActivityCountersResponse & IncrementActivityCountersResponseNonNullableFields>;
     /**
-     * Retrieves activity counters.
+     * Returns activity counters for a requested site member.
+     * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+     *
+     * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
      * @param - ID of the member to retrieve activity counters for.
-     * @returns Retrieved activity counter.
      */
@@ -44,0 +47,0 @@ (memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

build/es/src/members-v1-activity-counter-activity-counters.types.d.ts

 export interface ActivityCounter {
     /** Member ID. */
     memberId?: string;
-    /** App ID. */
+    /**
+     * App ID.
+     *
+     * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+     */
     appId?: string;
-    /** Counters for this member and this app. */
+    /** Counters for this member. */
     counters?: Counter[];
@@ -12,5 +16,5 @@ /** @readonly */
 export interface Counter {
-    /** Key of the counter. Must be unique within a given app. */
+    /** Key of the counter. Must be unique. */
     key?: string;
-    /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+    /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
     public?: boolean;
@@ -41,3 +45,3 @@ /** Count of activity. */
     memberId: string;
-    /** Site member ID whose counter will be increment. */
+    /** Site member ID whose counter will increment. */
     counter: Counter;
@@ -44,0 +48,0 @@ }

build/es/src/members-v1-activity-counter-activity-counters.universal.d.ts

 export interface ActivityCounter {
     /** Member ID. */
     memberId?: string;
-    /** App ID. */
+    /**
+     * App ID.
+     *
+     * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+     */
     appId?: string;
-    /** Counters for this member and this app. */
+    /** Counters for this member. */
     counters?: Counter[];
@@ -12,5 +16,5 @@ /** @readonly */
 export interface Counter {
-    /** Key of the counter. Must be unique within a given app. */
+    /** Key of the counter. Must be unique. */
     key?: string;
-    /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+    /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
     public?: boolean;
@@ -32,3 +36,2 @@ /** Count of activity. */
 export interface SetActivityCountersRequest {
-    /** ID of the member to count activities for. */
     memberId: string;
@@ -39,3 +42,2 @@ /** Site member ID whose counter will be set. */
 export interface SetActivityCountersResponse {
-    /** Information about a member's activity counter. */
     activityCounter?: ActivityCounter;
@@ -45,3 +47,3 @@ }
     memberId: string;
-    /** Site member ID whose counter will be increment. */
+    /** Site member ID whose counter will increment. */
     counter: Counter;
@@ -53,7 +55,5 @@ }
 export interface GetActivityCountersRequest {
-    /** ID of the member to retrieve activity counters for. */
     memberId: string;
 }
 export interface GetActivityCountersResponse {
-    /** Information about a member's activity counters. */
     activityCounters?: ActivityCounter[];
@@ -278,5 +278,3 @@ }
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  * @permissionScope Manage Activity Counters
@@ -293,7 +291,9 @@ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -309,3 +309,2 @@ * @documentationMaturity preview
  * @applicableIdentity APP
- * @returns Upserted activity counter.
  */
@@ -318,6 +317,6 @@ export declare function setActivityCounters(memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
  * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @param counter - Site member ID whose counter will be increment.
+ * @param counter - Site member ID whose counter will increment.
  * @public
@@ -334,3 +333,6 @@ * @documentationMaturity preview
 /**
- * Retrieves activity counters.
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -347,3 +349,2 @@ * @documentationMaturity preview
  * @applicableIdentity VISITOR
- * @returns Retrieved activity counter.
  */
@@ -350,0 +351,0 @@ export declare function getActivityCounters(memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

build/es/src/members-v1-activity-counter-activity-counters.universal.js

@@ -14,7 +14,9 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -30,3 +32,2 @@ * @documentationMaturity preview
  * @applicableIdentity APP
- * @returns Upserted activity counter.
  */
@@ -62,6 +63,6 @@ export async function setActivityCounters(memberId, counter) {
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
  * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @param counter - Site member ID whose counter will be increment.
+ * @param counter - Site member ID whose counter will increment.
  * @public
@@ -101,3 +102,6 @@ * @documentationMaturity preview
 /**
- * Retrieves activity counters.
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -114,3 +118,2 @@ * @documentationMaturity preview
  * @applicableIdentity VISITOR
- * @returns Retrieved activity counter.
  */
@@ -117,0 +120,0 @@ export async function getActivityCounters(memberId) {

docs/members-v1-activity-counter/onActivityCounterUpdated/description.md

@@ -1,3 +0,1 @@
-Increment activity counter event
-
-This event happens after updating a counter.
+Triggered when an activity counter is updated.

package.json

 {
   "name": "@wix/activity-counters_activity-counters",
-  "version": "1.0.30",
+  "version": "1.0.31",
   "publishConfig": {
@@ -54,3 +54,3 @@ "registry": "https://registry.npmjs.org/",
   },
-  "falconPackageHash": "c1a651b44fd944d11e1bc8c29f4ad6f98c15666a522af0ac2ccaf57a"
+  "falconPackageHash": "162eedf4f439d8b4fd6369ddc44cc536e4f9f1632d04ae2f18307945"
 }

src/members-v1-activity-counter-activity-counters.context.d.ts

@@ -10,5 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters } from './members-v1-activity-counter-activity-counters.public';
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  */
@@ -15,0 +13,0 @@ export declare const onActivityCounterUpdated: ReturnType<typeof createEventModule<typeof publicOnActivityCounterUpdated>>;

src/members-v1-activity-counter-activity-counters.context.js

@@ -13,5 +13,3 @@ "use strict";
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  */
@@ -18,0 +16,0 @@ exports.onActivityCounterUpdated = (0, event_definition_modules_1.createEventModule)(members_v1_activity_counter_activity_counters_public_2.onActivityCounterUpdated);

src/members-v1-activity-counter-activity-counters.context.ts

@@ -29,5 +29,3 @@ import {
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  */
@@ -34,0 +32,0 @@ export const onActivityCounterUpdated: ReturnType<

src/members-v1-activity-counter-activity-counters.http.d.ts

 import { RequestOptionsFactory } from '@wix/sdk-types';
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  */
@@ -15,3 +17,3 @@ export declare function setActivityCounters(payload: object): RequestOptionsFactory<any>;
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
@@ -21,3 +23,8 @@ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
 export declare function incrementActivityCounters(payload: object): RequestOptionsFactory<any>;
-/** Retrieves activity counters. */
+/**
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
+ */
 export declare function getActivityCounters(payload: object): RequestOptionsFactory<any>;
@@ -24,0 +31,0 @@ /**

src/members-v1-activity-counter-activity-counters.http.js

@@ -67,7 +67,9 @@ "use strict";
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  */
@@ -98,3 +100,3 @@ function setActivityCounters(payload) {
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
@@ -122,3 +124,8 @@ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
 exports.incrementActivityCounters = incrementActivityCounters;
-/** Retrieves activity counters. */
+/**
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
+ */
 function getActivityCounters(payload) {
@@ -125,0 +132,0 @@ function __getActivityCounters({ host }) {

src/members-v1-activity-counter-activity-counters.http.ts

@@ -72,7 +72,9 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  */
@@ -108,3 +110,3 @@ export function setActivityCounters(
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
@@ -137,3 +139,8 @@ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
 
-/** Retrieves activity counters. */
+/**
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
+ */
 export function getActivityCounters(
@@ -140,0 +147,0 @@ payload: object

src/members-v1-activity-counter-activity-counters.public.d.ts

@@ -9,10 +9,11 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types';
     /**
-     * Sets activity counters for a member.
+     * Sets activity counters for a requested site member.
      *
-     * If a counter doesn't exist, it's created.
+     * If a counter does not yet exist, it will be created.
      *
-     * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+     * Counters are set under a custom key, which is an ID for the counter, and is unique.
+     *
+     * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
      * @param - ID of the member to upsert an activity counter for.
      * @param - Details of the counter to be set.
-     * @returns Upserted activity counter.
      */
@@ -28,6 +29,6 @@ (memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;
      *
-     * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+     * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
      *
      * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
-     * @param - Site member ID whose counter will be increment.
+     * @param - Site member ID whose counter will increment.
      */
@@ -39,5 +40,7 @@ (memberId: string, counter: Counter): Promise<IncrementActivityCountersResponse & IncrementActivityCountersResponseNonNullableFields>;
     /**
-     * Retrieves activity counters.
+     * Returns activity counters for a requested site member.
+     * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+     *
+     * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
      * @param - ID of the member to retrieve activity counters for.
-     * @returns Retrieved activity counter.
      */
@@ -44,0 +47,0 @@ (memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

src/members-v1-activity-counter-activity-counters.public.ts

@@ -37,10 +37,11 @@ import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
   /**
-   * Sets activity counters for a member.
+   * Sets activity counters for a requested site member.
    *
-   * If a counter doesn't exist, it's created.
+   * If a counter does not yet exist, it will be created.
    *
-   * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+   * Counters are set under a custom key, which is an ID for the counter, and is unique.
+   *
+   * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
    * @param - ID of the member to upsert an activity counter for.
    * @param - Details of the counter to be set.
-   * @returns Upserted activity counter.
    */
@@ -70,6 +71,6 @@ (memberId: string, counter: Counter): Promise<
    *
-   * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+   * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
    *
    * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
-   * @param - Site member ID whose counter will be increment.
+   * @param - Site member ID whose counter will increment.
    */
@@ -95,5 +96,7 @@ (memberId: string, counter: Counter): Promise<
   /**
-   * Retrieves activity counters.
+   * Returns activity counters for a requested site member.
+   * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+   *
+   * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
    * @param - ID of the member to retrieve activity counters for.
-   * @returns Retrieved activity counter.
    */
@@ -100,0 +103,0 @@ (memberId: string): Promise<

src/members-v1-activity-counter-activity-counters.types.d.ts

 export interface ActivityCounter {
     /** Member ID. */
     memberId?: string;
-    /** App ID. */
+    /**
+     * App ID.
+     *
+     * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+     */
     appId?: string;
-    /** Counters for this member and this app. */
+    /** Counters for this member. */
     counters?: Counter[];
@@ -12,5 +16,5 @@ /** @readonly */
 export interface Counter {
-    /** Key of the counter. Must be unique within a given app. */
+    /** Key of the counter. Must be unique. */
     key?: string;
-    /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+    /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
     public?: boolean;
@@ -41,3 +45,3 @@ /** Count of activity. */
     memberId: string;
-    /** Site member ID whose counter will be increment. */
+    /** Site member ID whose counter will increment. */
     counter: Counter;
@@ -44,0 +48,0 @@ }

src/members-v1-activity-counter-activity-counters.types.ts

 export interface ActivityCounter {
   /** Member ID. */
   memberId?: string;
-  /** App ID. */
+  /**
+   * App ID.
+   *
+   * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+   */
   appId?: string;
-  /** Counters for this member and this app. */
+  /** Counters for this member. */
   counters?: Counter[];
@@ -13,5 +17,5 @@ /** @readonly */
 export interface Counter {
-  /** Key of the counter. Must be unique within a given app. */
+  /** Key of the counter. Must be unique. */
   key?: string;
-  /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+  /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
   public?: boolean;
@@ -47,3 +51,3 @@ /** Count of activity. */
   memberId: string;
-  /** Site member ID whose counter will be increment. */
+  /** Site member ID whose counter will increment. */
   counter: Counter;
@@ -50,0 +54,0 @@ }

src/members-v1-activity-counter-activity-counters.universal.d.ts

 export interface ActivityCounter {
     /** Member ID. */
     memberId?: string;
-    /** App ID. */
+    /**
+     * App ID.
+     *
+     * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+     */
     appId?: string;
-    /** Counters for this member and this app. */
+    /** Counters for this member. */
     counters?: Counter[];
@@ -12,5 +16,5 @@ /** @readonly */
 export interface Counter {
-    /** Key of the counter. Must be unique within a given app. */
+    /** Key of the counter. Must be unique. */
     key?: string;
-    /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+    /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
     public?: boolean;
@@ -32,3 +36,2 @@ /** Count of activity. */
 export interface SetActivityCountersRequest {
-    /** ID of the member to count activities for. */
     memberId: string;
@@ -39,3 +42,2 @@ /** Site member ID whose counter will be set. */
 export interface SetActivityCountersResponse {
-    /** Information about a member's activity counter. */
     activityCounter?: ActivityCounter;
@@ -45,3 +47,3 @@ }
     memberId: string;
-    /** Site member ID whose counter will be increment. */
+    /** Site member ID whose counter will increment. */
     counter: Counter;
@@ -53,7 +55,5 @@ }
 export interface GetActivityCountersRequest {
-    /** ID of the member to retrieve activity counters for. */
     memberId: string;
 }
 export interface GetActivityCountersResponse {
-    /** Information about a member's activity counters. */
     activityCounters?: ActivityCounter[];
@@ -278,5 +278,3 @@ }
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  * @permissionScope Manage Activity Counters
@@ -293,7 +291,9 @@ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -309,3 +309,2 @@ * @documentationMaturity preview
  * @applicableIdentity APP
- * @returns Upserted activity counter.
  */
@@ -318,6 +317,6 @@ export declare function setActivityCounters(memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
  * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @param counter - Site member ID whose counter will be increment.
+ * @param counter - Site member ID whose counter will increment.
  * @public
@@ -334,3 +333,6 @@ * @documentationMaturity preview
 /**
- * Retrieves activity counters.
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -347,3 +349,2 @@ * @documentationMaturity preview
  * @applicableIdentity VISITOR
- * @returns Retrieved activity counter.
  */
@@ -350,0 +351,0 @@ export declare function getActivityCounters(memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

src/members-v1-activity-counter-activity-counters.universal.js

@@ -40,7 +40,9 @@ "use strict";
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -56,3 +58,2 @@ * @documentationMaturity preview
  * @applicableIdentity APP
- * @returns Upserted activity counter.
  */
@@ -89,6 +90,6 @@ async function setActivityCounters(memberId, counter) {
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
  * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @param counter - Site member ID whose counter will be increment.
+ * @param counter - Site member ID whose counter will increment.
  * @public
@@ -129,3 +130,6 @@ * @documentationMaturity preview
 /**
- * Retrieves activity counters.
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -142,3 +146,2 @@ * @documentationMaturity preview
  * @applicableIdentity VISITOR
- * @returns Retrieved activity counter.
  */
@@ -145,0 +148,0 @@ async function getActivityCounters(memberId) {

src/members-v1-activity-counter-activity-counters.universal.ts

@@ -14,5 +14,9 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
   memberId?: string;
-  /** App ID. */
+  /**
+   * App ID.
+   *
+   * If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
+   */
   appId?: string;
-  /** Counters for this member and this app. */
+  /** Counters for this member. */
   counters?: Counter[];
@@ -24,5 +28,5 @@ /** @readonly */
 export interface Counter {
-  /** Key of the counter. Must be unique within a given app. */
+  /** Key of the counter. Must be unique. */
   key?: string;
-  /** Whether count is available to all (if `public` is false, the counter is only available to the data owner; the site member, or the third party app that created the counter). */
+  /** Whether count is available to all. If `false`, the counter is only available to the data owner: the site member and the app or Wix user that created the counter. */
   public?: boolean;
@@ -47,3 +51,2 @@ /** Count of activity. */
 export interface SetActivityCountersRequest {
-  /** ID of the member to count activities for. */
   memberId: string;
@@ -55,3 +58,2 @@ /** Site member ID whose counter will be set. */
 export interface SetActivityCountersResponse {
-  /** Information about a member's activity counter. */
   activityCounter?: ActivityCounter;
@@ -62,3 +64,3 @@ }
   memberId: string;
-  /** Site member ID whose counter will be increment. */
+  /** Site member ID whose counter will increment. */
   counter: Counter;
@@ -72,3 +74,2 @@ }
 export interface GetActivityCountersRequest {
-  /** ID of the member to retrieve activity counters for. */
   memberId: string;
@@ -78,3 +79,2 @@ }
 export interface GetActivityCountersResponse {
-  /** Information about a member's activity counters. */
   activityCounters?: ActivityCounter[];
@@ -325,5 +325,3 @@ }
 /**
- * Increment activity counter event
- *
- * This event happens after updating a counter.
+ * Triggered when an activity counter is updated.
  * @permissionScope Manage Activity Counters
@@ -343,7 +341,9 @@ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS
 /**
- * Sets activity counters for a member.
+ * Sets activity counters for a requested site member.
  *
- * If a counter doesn't exist, it's created.
+ * If a counter does not yet exist, it will be created.
  *
- * Counters are set under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are set under a custom key, which is an ID for the counter, and is unique.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When specifying the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -359,3 +359,2 @@ * @documentationMaturity preview
  * @applicableIdentity APP
- * @returns Upserted activity counter.
  */
@@ -409,6 +408,6 @@ export async function setActivityCounters(
  *
- * Counters are incremented under a custom key, which is an ID for the counter, and is unique per app.
+ * Counters are incremented under a custom key, which is an ID for the counter, and is unique.
  *
  * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
- * @param counter - Site member ID whose counter will be increment.
+ * @param counter - Site member ID whose counter will increment.
  * @public
@@ -467,3 +466,6 @@ * @documentationMaturity preview
 /**
- * Retrieves activity counters.
+ * Returns activity counters for a requested site member.
+ * A third party can read all the public counters, set by any app or site. However, third parties can only read their own private counters, not those from others' apps or sites.
+ *
+ * Members are typically associated with a contact, each having a distinct member and contact ID. When passing the ID as a parameter, avoid presuming the IDs are identical since they represent separate entities.
  * @public
@@ -480,3 +482,2 @@ * @documentationMaturity preview
  * @applicableIdentity VISITOR
- * @returns Retrieved activity counter.
  */
@@ -483,0 +484,0 @@ export async function getActivityCounters(

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

407396

increased by1.69%

Lines of code

9879

increased by0.15%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes