@wix/auto_sdk_activity-counters_activity-counters 1.0.0

package/build/es/src/members-v1-activity-counter-activity-counters.meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"members-v1-activity-counter-activity-counters.meta.js","sourceRoot":"","sources":["../../../src/members-v1-activity-counter-activity-counters.meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,qCAAqC,MAAM,yDAAyD,CAAC;AAsBjH,MAAM,UAAU,mBAAmB;IAUjC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAS,CAAC;IAEjD,MAAM,iBAAiB,GACrB,qCAAqC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,kCAAkC;QACxC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE;QACpC,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,yBAAyB;IAUvC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAS,CAAC;IAEjD,MAAM,iBAAiB,GACrB,qCAAqC,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAE3E,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,4CAA4C;QAClD,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE;QACpC,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB;IAUjC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAS,CAAC;IAEjD,MAAM,iBAAiB,GACrB,qCAAqC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAErE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,kCAAkC;QACxC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE;QACpC,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB;IAUnC,MAAM,OAAO,GAAG,EAAS,CAAC;IAE1B,MAAM,iBAAiB,GACrB,qCAAqC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAEvE,MAAM,MAAM,GAAG,CAAC,OAAY,EAAU,EAAE;QACtC,MAAM,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC3C,OAAO,GAAI,CAAC;IACd,CAAC,CAAC;IAEF,OAAO;QACL,MAAM;QACN,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,6BAA6B;QACnC,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,IAAW;QAC1B,qBAAqB,EAAE,IAAW;QAClC,cAAc,EAAE,IAAW;QAC3B,sBAAsB,EAAE,IAAW;KACpC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,72 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { ActivityCounterUpdatedEnvelope, ActivityCountersQueryBuilder, Counter, GetActivityCountersResponse, GetActivityCountersResponseNonNullableFields, IncrementActivityCountersResponse, IncrementActivityCountersResponseNonNullableFields, SetActivityCountersResponse, SetActivityCountersResponseNonNullableFields } from './members-v1-activity-counter-activity-counters.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function setActivityCounters(httpClient: HttpClient): SetActivityCountersSignature;
+interface SetActivityCountersSignature {
+    /**
+     * Sets activity counters for a requested site member.
+     *
+     * If the counter does not already exist, it will be created.
+     *
+     * Counters are identified with a custom key, which must be unique.
+     *
+     * > **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.
+     */
+    (memberId: string, counter: Counter): Promise<SetActivityCountersResponse & SetActivityCountersResponseNonNullableFields>;
+}
+export declare function incrementActivityCounters(httpClient: HttpClient): IncrementActivityCountersSignature;
+interface IncrementActivityCountersSignature {
+    /**
+     * Increments a specific activity counters for a specified site member.
+     *
+     * If the counter does not already exist, it will be created.
+     *
+     * Counters are identified with a custom key, which must be unique.
+     *
+     * > **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.
+     */
+    (memberId: string, counter: Counter): Promise<IncrementActivityCountersResponse & IncrementActivityCountersResponseNonNullableFields>;
+}
+export declare function getActivityCounters(httpClient: HttpClient): GetActivityCountersSignature;
+interface GetActivityCountersSignature {
+    /**
+     * Retrieves activity counters for the specified site member, including all public counters and any private counters owned by the authenticated caller.
+     *
+     * > **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.
+     */
+    (memberId: string): Promise<GetActivityCountersResponse & GetActivityCountersResponseNonNullableFields>;
+}
+export declare function queryActivityCounters(httpClient: HttpClient): QueryActivityCountersSignature;
+interface QueryActivityCountersSignature {
+    /**
+     * Returns up to 100 public activity counters for the provided filter and paging.
+     *
+     * Only counters that are marked as public are returned.
+     *
+     * Supported fields for filtering:
+     * - `memberId`
+     *
+     * Supported operations:
+     *
+     * Comparison:
+     * - $eq
+     * - $ne
+     * - $in
+     *
+     * Logical:
+     * - $and
+     * - $not
+     * - $or
+     * @param - Information about the activity counters to retrieve.
+     */
+    (): ActivityCountersQueryBuilder;
+}
+export declare const onActivityCounterUpdated: EventDefinition<ActivityCounterUpdatedEnvelope, "wix.members.v1.activity_counter_updated">;
+export { ActionEvent, ActivityCounter, ActivityCounterUpdatedEnvelope, ActivityCountersQueryBuilder, ActivityCountersQueryResult, BaseEventMetadata, Counter, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetActivityCountersRequest, GetActivityCountersResponse, GetActivityCountersResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, IncrementActivityCountersRequest, IncrementActivityCountersResponse, IncrementActivityCountersResponseNonNullableFields, MessageEnvelope, Paging, PagingMetadata, Query, QueryActivityCountersRequest, QueryActivityCountersResponse, QueryActivityCountersResponseNonNullableFields, RestoreInfo, SetActivityCountersRequest, SetActivityCountersResponse, SetActivityCountersResponseNonNullableFields, WebhookIdentityType, } from './members-v1-activity-counter-activity-counters.universal.js';

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

@@ -0,0 +1,34 @@
+import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
+import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
+import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
+import { EventDefinition } from '@wix/sdk-types';
+import { getActivityCounters as universalGetActivityCounters, incrementActivityCounters as universalIncrementActivityCounters, queryActivityCounters as universalQueryActivityCounters, setActivityCounters as universalSetActivityCounters, } from './members-v1-activity-counter-activity-counters.universal.js';
+export const __metadata = { PACKAGE_NAME: '@wix/activity-counters' };
+export function setActivityCounters(httpClient) {
+    return (memberId, counter) => universalSetActivityCounters(memberId, counter, 
+    // @ts-ignore
+    { httpClient });
+}
+export function incrementActivityCounters(httpClient) {
+    return (memberId, counter) => universalIncrementActivityCounters(memberId, counter, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getActivityCounters(httpClient) {
+    return (memberId) => universalGetActivityCounters(memberId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryActivityCounters(httpClient) {
+    return () => universalQueryActivityCounters(
+    // @ts-ignore
+    { httpClient });
+}
+export const onActivityCounterUpdated = EventDefinition('wix.members.v1.activity_counter_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
+    {
+        transformFn: transformRESTTimestampToSDKTimestamp,
+        paths: [{ path: 'metadata.eventTime' }],
+    },
+])))();
+export { WebhookIdentityType, } from './members-v1-activity-counter-activity-counters.universal.js';
+//# sourceMappingURL=members-v1-activity-counter-activity-counters.public.js.map

package/build/es/src/members-v1-activity-counter-activity-counters.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"members-v1-activity-counter-activity-counters.public.js","sourceRoot":"","sources":["../../../src/members-v1-activity-counter-activity-counters.public.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,yCAAyC,CAAC;AAClG,OAAO,EAAE,oCAAoC,EAAE,MAAM,4CAA4C,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,kDAAkD,CAAC;AAClF,OAAO,EAAE,eAAe,EAAc,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAUL,mBAAmB,IAAI,4BAA4B,EACnD,yBAAyB,IAAI,kCAAkC,EAC/D,qBAAqB,IAAI,8BAA8B,EACvD,mBAAmB,IAAI,4BAA4B,GACpD,MAAM,8DAA8D,CAAC;AAEtE,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,wBAAwB,EAAE,CAAC;AAErE,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,QAAgB,EAAE,OAAgB,EAAE,EAAE,CAC5C,4BAA4B,CAC1B,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAmBD,MAAM,UAAU,yBAAyB,CACvC,UAAsB;IAEtB,OAAO,CAAC,QAAgB,EAAE,OAAgB,EAAE,EAAE,CAC5C,kCAAkC,CAChC,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAoBD,MAAM,UAAU,mBAAmB,CACjC,UAAsB;IAEtB,OAAO,CAAC,QAAgB,EAAE,EAAE,CAC1B,4BAA4B,CAC1B,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAcD,MAAM,UAAU,qBAAqB,CACnC,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,8BAA8B;IAC5B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AA2BD,MAAM,CAAC,MAAM,wBAAwB,GAAG,eAAe,CACrD,yCAAyC,EACzC,IAAI,EACJ,CAAC,KAAqC,EAAE,EAAE,CACxC,uCAAuC,CACrC,cAAc,CAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,oCAAoC;QACjD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;KACxC;CACF,CAAC,CACH,CACJ,EAAkC,CAAC;AAEpC,OAAO,EAkCL,mBAAmB,GACpB,MAAM,8DAA8D,CAAC"}

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

@@ -0,0 +1,221 @@
+export interface ActivityCounter {
+    /** Member ID. */
+    memberId?: string;
+    /**
+     * App ID.
+     * 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`.
+     */
+    appId?: string;
+    /** Counters for this member. */
+    counters?: Counter[];
+    /**
+     * Revision number, which increments by 1 each time the counter is updated. To prevent conflicting changes, the existing revision must be used when updating a counter.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export interface Counter {
+    /** Counter key, unique within the given app. */
+    key?: string;
+    /** Whether this counter data is available to all. If `false`, the counter is only available to the data owner and counter owner. */
+    public?: boolean;
+    /** Activity count. */
+    count?: number;
+}
+export interface SetActivityCountersRequest {
+    /** Member ID whose counter will be set. */
+    memberId: string;
+    /** 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;
+    /** 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 {
+    /** Filter object. */
+    filter?: any;
+    /** Paging options. */
+    paging?: Paging;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryActivityCountersResponse {
+    /** Retrieved activity counters. */
+    activityCounters?: ActivityCounter[];
+    /** Paging metadata. */
+    metadata?: PagingMetadata;
+}
+export interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface Empty {
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CounterNonNullableFields {
+    key: string;
+    public: boolean;
+    count: number;
+}
+interface ActivityCounterNonNullableFields {
+    memberId: string;
+    appId: string;
+    counters: CounterNonNullableFields[];
+}
+export interface SetActivityCountersResponseNonNullableFields {
+    activityCounter?: ActivityCounterNonNullableFields;
+}
+export interface IncrementActivityCountersResponseNonNullableFields {
+    activityCounter?: ActivityCounterNonNullableFields;
+}
+export interface GetActivityCountersResponseNonNullableFields {
+    activityCounters: ActivityCounterNonNullableFields[];
+}
+export interface QueryActivityCountersResponseNonNullableFields {
+    activityCounters: ActivityCounterNonNullableFields[];
+}
+export {};

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

@@ -0,0 +1,9 @@
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+//# sourceMappingURL=members-v1-activity-counter-activity-counters.types.js.map

package/build/es/src/members-v1-activity-counter-activity-counters.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"members-v1-activity-counter-activity-counters.types.js","sourceRoot":"","sources":["../../../src/members-v1-activity-counter-activity-counters.types.ts"],"names":[],"mappings":"AAsNA,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B"}