New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@wix/activity-counters_activity-counters

Package Overview
Dependencies
Maintainers
0
Versions
33
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

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

Comparing version 1.0.36 to 1.0.37

2

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

@@ -10,3 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters } from './members-v1-activity-counter-activity-counters.public.js';

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
*/

@@ -13,0 +13,0 @@ export declare const onActivityCounterUpdated: ReturnType<typeof createEventModule<typeof publicOnActivityCounterUpdated>>;

@@ -13,3 +13,3 @@ "use strict";

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
*/

@@ -16,0 +16,0 @@ exports.onActivityCounterUpdated = (0, event_definition_modules_1.createEventModule)(members_v1_activity_counter_activity_counters_public_js_2.onActivityCounterUpdated);

@@ -5,35 +5,35 @@ import { RequestOptionsFactory } from '@wix/sdk-types';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function setActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function incrementActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function getActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -43,2 +43,3 @@ * - $eq

* - $in
*
* Logical:

@@ -45,0 +46,0 @@ * - $and

@@ -69,7 +69,7 @@ "use strict";

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -96,9 +96,9 @@ function setActivityCounters(payload) {

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -125,6 +125,5 @@ function incrementActivityCounters(payload) {

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -151,10 +150,11 @@ function getActivityCounters(payload) {

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -164,2 +164,3 @@ * - $eq

* - $in
*
* Logical:

@@ -166,0 +167,0 @@ * - $and

@@ -11,9 +11,9 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counter will be set.
* @param - Counter data for this site member.
*/

@@ -25,10 +25,11 @@ (memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counter will be incremented.
* @param - Counter data for this site member.
*/

@@ -40,7 +41,6 @@ (memberId: string, counter: Counter): Promise<IncrementActivityCountersResponse & IncrementActivityCountersResponseNonNullableFields>;

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counters will be returned.
*/

@@ -52,10 +52,11 @@ (memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -65,2 +66,3 @@ * - $eq

* - $in
*
* Logical:

@@ -67,0 +69,0 @@ * - $and

@@ -6,4 +6,3 @@ export interface ActivityCounter {

* App ID.
*
* If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
* When developing websites, if you set activity counter data using elevation, the action is assigned to the generic Wix code backend app: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
*/

@@ -17,38 +16,45 @@ appId?: string;

export interface Counter {
/** Key of the counter. Must be unique. */
/** Counter key, unique within the given app. */
key?: string;
/** 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. */
/** Whether this counter data is available to all. If `false`, the counter is only available to the data owner and counter owner. */
public?: boolean;
/** Count of activity. */
/** Activity count. */
count?: number;
}
export interface SetActivityCountersRequest {
/** Member ID whose counter will be set. */
memberId: string;
/** Site member ID whose counter will be set. */
/** Counter data for this site member. */
counter: Counter;
}
export interface SetActivityCountersResponse {
/** Updated activity counter. */
activityCounter?: ActivityCounter;
}
export interface IncrementActivityCountersRequest {
/** Member ID whose counter will be incremented. */
memberId: string;
/** Site member ID whose counter will increment. */
/** Counter data for this site member. */
counter: Counter;
}
export interface IncrementActivityCountersResponse {
/** Incremented activity counter. */
activityCounter?: ActivityCounter;
}
export interface GetActivityCountersRequest {
/** Member ID whose counters will be returned. */
memberId: string;
}
export interface GetActivityCountersResponse {
/** Activity counters. */
activityCounters?: ActivityCounter[];
}
export interface QueryActivityCountersRequest {
/** Query options. */
query?: Query;
}
export interface Query {
/** A filter object. */
/** Filter object. */
filter?: any;
/** Limit number of results. */
/** Paging options. */
paging?: Paging;

@@ -63,4 +69,5 @@ }

export interface QueryActivityCountersResponse {
/** Retrieved activity counters. */
activityCounters?: ActivityCounter[];
/** Retrieved activity counters. */
/** Paging metadata. */
metadata?: PagingMetadata;

@@ -67,0 +74,0 @@ }

@@ -6,4 +6,3 @@ export interface ActivityCounter {

* App ID.
*
* If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
* When developing websites, if you set activity counter data using elevation, the action is assigned to the generic Wix code backend app: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
*/

@@ -17,39 +16,45 @@ appId?: string;

export interface Counter {
/** Key of the counter. Must be unique. */
/** Counter key, unique within the given app. */
key?: string;
/** 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. */
/** Whether this counter data is available to all. If `false`, the counter is only available to the data owner and counter owner. */
public?: boolean;
/** Count of activity. */
/** Activity count. */
count?: number;
}
export interface SetActivityCountersRequest {
/** Member ID whose counter will be set. */
memberId: string;
/** Site member ID whose counter will be set. */
/** Counter data for this site member. */
counter: Counter;
}
export interface SetActivityCountersResponse {
/** Updated activity counter. */
activityCounter?: ActivityCounter;
}
export interface IncrementActivityCountersRequest {
/** Member ID whose counter will be incremented. */
memberId: string;
/** Site member ID whose counter will increment. */
/** Counter data for this site member. */
counter: Counter;
}
export interface IncrementActivityCountersResponse {
/** Incremented activity counter. */
activityCounter?: ActivityCounter;
}
export interface GetActivityCountersRequest {
/** Member ID whose counters will be returned. */
memberId: string;
}
export interface GetActivityCountersResponse {
/** Activity counters. */
activityCounters?: ActivityCounter[];
}
export interface QueryActivityCountersRequest {
/** Information about the activity counters to retrieve. */
/** Query options. */
query?: Query;
}
export interface Query {
/** A filter object. */
/** Filter object. */
filter?: any;
/** Limit number of results. */
/** Paging options. */
paging?: Paging;

@@ -66,3 +71,3 @@ }

activityCounters?: ActivityCounter[];
/** Retrieved activity counters. */
/** Paging metadata. */
metadata?: PagingMetadata;

@@ -265,3 +270,3 @@ }

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
* @permissionScope Manage Activity Counters

@@ -279,7 +284,9 @@ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be set.
* @param counter - Counter data for this site member.
* @public

@@ -289,4 +296,2 @@ * @documentationMaturity preview

* @requiredField memberId
* @param memberId - ID of the member to upsert an activity counter for.
* @param counter - Details of the counter to be set.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE

@@ -299,10 +304,11 @@ * @permissionScope Manage Activity Counters

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be incremented.
* @param counter - Counter data for this site member.
* @public

@@ -319,10 +325,9 @@ * @documentationMaturity preview

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counters will be returned.
* @public
* @documentationMaturity preview
* @requiredField memberId
* @param memberId - ID of the member to retrieve activity counters for.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_READ

@@ -338,10 +343,11 @@ * @permissionScope Manage Activity Counters

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -351,2 +357,3 @@ * - $eq

* - $in
*
* Logical:

@@ -353,0 +360,0 @@ * - $and

@@ -42,7 +42,9 @@ "use strict";

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be set.
* @param counter - Counter data for this site member.
* @public

@@ -52,4 +54,2 @@ * @documentationMaturity preview

* @requiredField memberId
* @param memberId - ID of the member to upsert an activity counter for.
* @param counter - Details of the counter to be set.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE

@@ -86,10 +86,11 @@ * @permissionScope Manage Activity Counters

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be incremented.
* @param counter - Counter data for this site member.
* @public

@@ -130,10 +131,9 @@ * @documentationMaturity preview

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counters will be returned.
* @public
* @documentationMaturity preview
* @requiredField memberId
* @param memberId - ID of the member to retrieve activity counters for.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_READ

@@ -170,10 +170,11 @@ * @permissionScope Manage Activity Counters

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -183,2 +184,3 @@ * - $eq

* - $in
*
* Logical:

@@ -185,0 +187,0 @@ * - $and

@@ -10,3 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters } from './members-v1-activity-counter-activity-counters.public.js';

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
*/

@@ -13,0 +13,0 @@ export declare const onActivityCounterUpdated: ReturnType<typeof createEventModule<typeof publicOnActivityCounterUpdated>>;

@@ -10,3 +10,3 @@ import { setActivityCounters as publicSetActivityCounters, incrementActivityCounters as publicIncrementActivityCounters, getActivityCounters as publicGetActivityCounters, queryActivityCounters as publicQueryActivityCounters, } from './members-v1-activity-counter-activity-counters.public.js';

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
*/

@@ -13,0 +13,0 @@ export const onActivityCounterUpdated = createEventModule(publicOnActivityCounterUpdated);

@@ -5,35 +5,35 @@ import { RequestOptionsFactory } from '@wix/sdk-types';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function setActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function incrementActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/
export declare function getActivityCounters(payload: object): RequestOptionsFactory<any>;
/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -43,2 +43,3 @@ * - $eq

* - $in
*
* Logical:

@@ -45,0 +46,0 @@ * - $and

@@ -66,7 +66,7 @@ import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -92,9 +92,9 @@ export function setActivityCounters(payload) {

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -120,6 +120,5 @@ export function incrementActivityCounters(payload) {

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
*/

@@ -145,10 +144,11 @@ export function getActivityCounters(payload) {

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -158,2 +158,3 @@ * - $eq

* - $in
*
* Logical:

@@ -160,0 +161,0 @@ * - $and

@@ -11,9 +11,9 @@ import { EventDefinition, HttpClient } from '@wix/sdk-types';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counter will be set.
* @param - Counter data for this site member.
*/

@@ -25,10 +25,11 @@ (memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counter will be incremented.
* @param - Counter data for this site member.
*/

@@ -40,7 +41,6 @@ (memberId: string, counter: Counter): Promise<IncrementActivityCountersResponse & IncrementActivityCountersResponseNonNullableFields>;

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param - Member ID whose counters will be returned.
*/

@@ -52,10 +52,11 @@ (memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -65,2 +66,3 @@ * - $eq

* - $in
*
* Logical:

@@ -67,0 +69,0 @@ * - $and

@@ -6,4 +6,3 @@ export interface ActivityCounter {

* App ID.
*
* If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
* When developing websites, if you set activity counter data using elevation, the action is assigned to the generic Wix code backend app: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
*/

@@ -17,38 +16,45 @@ appId?: string;

export interface Counter {
/** Key of the counter. Must be unique. */
/** Counter key, unique within the given app. */
key?: string;
/** 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. */
/** Whether this counter data is available to all. If `false`, the counter is only available to the data owner and counter owner. */
public?: boolean;
/** Count of activity. */
/** Activity count. */
count?: number;
}
export interface SetActivityCountersRequest {
/** Member ID whose counter will be set. */
memberId: string;
/** Site member ID whose counter will be set. */
/** Counter data for this site member. */
counter: Counter;
}
export interface SetActivityCountersResponse {
/** Updated activity counter. */
activityCounter?: ActivityCounter;
}
export interface IncrementActivityCountersRequest {
/** Member ID whose counter will be incremented. */
memberId: string;
/** Site member ID whose counter will increment. */
/** Counter data for this site member. */
counter: Counter;
}
export interface IncrementActivityCountersResponse {
/** Incremented activity counter. */
activityCounter?: ActivityCounter;
}
export interface GetActivityCountersRequest {
/** Member ID whose counters will be returned. */
memberId: string;
}
export interface GetActivityCountersResponse {
/** Activity counters. */
activityCounters?: ActivityCounter[];
}
export interface QueryActivityCountersRequest {
/** Query options. */
query?: Query;
}
export interface Query {
/** A filter object. */
/** Filter object. */
filter?: any;
/** Limit number of results. */
/** Paging options. */
paging?: Paging;

@@ -63,4 +69,5 @@ }

export interface QueryActivityCountersResponse {
/** Retrieved activity counters. */
activityCounters?: ActivityCounter[];
/** Retrieved activity counters. */
/** Paging metadata. */
metadata?: PagingMetadata;

@@ -67,0 +74,0 @@ }

@@ -6,4 +6,3 @@ export interface ActivityCounter {

* App ID.
*
* If you call this API as a site developer, the API returns the following app ID: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
* When developing websites, if you set activity counter data using elevation, the action is assigned to the generic Wix code backend app: `151e476a-715e-ec33-db9a-a7ff4d51f70a`.
*/

@@ -17,39 +16,45 @@ appId?: string;

export interface Counter {
/** Key of the counter. Must be unique. */
/** Counter key, unique within the given app. */
key?: string;
/** 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. */
/** Whether this counter data is available to all. If `false`, the counter is only available to the data owner and counter owner. */
public?: boolean;
/** Count of activity. */
/** Activity count. */
count?: number;
}
export interface SetActivityCountersRequest {
/** Member ID whose counter will be set. */
memberId: string;
/** Site member ID whose counter will be set. */
/** Counter data for this site member. */
counter: Counter;
}
export interface SetActivityCountersResponse {
/** Updated activity counter. */
activityCounter?: ActivityCounter;
}
export interface IncrementActivityCountersRequest {
/** Member ID whose counter will be incremented. */
memberId: string;
/** Site member ID whose counter will increment. */
/** Counter data for this site member. */
counter: Counter;
}
export interface IncrementActivityCountersResponse {
/** Incremented activity counter. */
activityCounter?: ActivityCounter;
}
export interface GetActivityCountersRequest {
/** Member ID whose counters will be returned. */
memberId: string;
}
export interface GetActivityCountersResponse {
/** Activity counters. */
activityCounters?: ActivityCounter[];
}
export interface QueryActivityCountersRequest {
/** Information about the activity counters to retrieve. */
/** Query options. */
query?: Query;
}
export interface Query {
/** A filter object. */
/** Filter object. */
filter?: any;
/** Limit number of results. */
/** Paging options. */
paging?: Paging;

@@ -66,3 +71,3 @@ }

activityCounters?: ActivityCounter[];
/** Retrieved activity counters. */
/** Paging metadata. */
metadata?: PagingMetadata;

@@ -265,3 +270,3 @@ }

/**
* Triggered when an activity counter is updated.
* Triggered when a member's activity counter is updated.
* @permissionScope Manage Activity Counters

@@ -279,7 +284,9 @@ * @permissionScopeId SCOPE.DC-MEMBERS.MANAGE-ACTIVITY-COUNTERS

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be set.
* @param counter - Counter data for this site member.
* @public

@@ -289,4 +296,2 @@ * @documentationMaturity preview

* @requiredField memberId
* @param memberId - ID of the member to upsert an activity counter for.
* @param counter - Details of the counter to be set.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE

@@ -299,10 +304,11 @@ * @permissionScope Manage Activity Counters

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be incremented.
* @param counter - Counter data for this site member.
* @public

@@ -319,10 +325,9 @@ * @documentationMaturity preview

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counters will be returned.
* @public
* @documentationMaturity preview
* @requiredField memberId
* @param memberId - ID of the member to retrieve activity counters for.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_READ

@@ -338,10 +343,11 @@ * @permissionScope Manage Activity Counters

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -351,2 +357,3 @@ * - $eq

* - $in
*
* Logical:

@@ -353,0 +360,0 @@ * - $and

@@ -16,7 +16,9 @@ import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';

*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are set under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be set.
* @param counter - Counter data for this site member.
* @public

@@ -26,4 +28,2 @@ * @documentationMaturity preview

* @requiredField memberId
* @param memberId - ID of the member to upsert an activity counter for.
* @param counter - Details of the counter to be set.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_WRITE

@@ -59,10 +59,11 @@ * @permissionScope Manage Activity Counters

/**
* Increments activity counters for a requested site member by the count provided in counter.
* Increments a specific activity counters for a specified site member.
*
* If a counter does not yet exist, it will be created.
* If the counter does not already exist, it will be created.
*
* Counters are incremented under a custom key, which is an ID for the counter, and is unique.
* Counters are identified with a custom key, which must be 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 increment.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counter will be incremented.
* @param counter - Counter data for this site member.
* @public

@@ -102,10 +103,9 @@ * @documentationMaturity preview

/**
* 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.
* Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
*
* 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.
* > **Note**: Make sure to pass a `memberId` and not a `contactId` to identify the member. Any relationship between a member's `memberId` and `contactId` is coincidental.
* @param memberId - Member ID whose counters will be returned.
* @public
* @documentationMaturity preview
* @requiredField memberId
* @param memberId - ID of the member to retrieve activity counters for.
* @permissionId MEMBERS.ACTIVITY_COUNTERS_READ

@@ -141,10 +141,11 @@ * @permissionScope Manage Activity Counters

/**
* Returns up to 100 activity counters for the provided filter and paging.
* Returns up to 100 public activity counters for the provided filter and paging.
*
* Service will return only counters that are marked as public.
* Only counters that are marked as public are returned.
*
* Supported fields for filtering:
* - memberId
* - `memberId`
*
* Supported operations:
*
* Comparison:

@@ -154,2 +155,3 @@ * - $eq

* - $in
*
* Logical:

@@ -156,0 +158,0 @@ * - $and

{
"name": "@wix/activity-counters_activity-counters",
"version": "1.0.36",
"version": "1.0.37",
"publishConfig": {

@@ -57,3 +57,3 @@ "registry": "https://registry.npmjs.org/",

},
"falconPackageHash": "3fa13d06e942ea535b83a5d411e7b30b6dfe9d4e2f94f0b102da5332"
"falconPackageHash": "f6f8017347b005e3db46b1ec6c458b844c105bf9fe63aca454aebf67"
}

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc