@wix/auto_sdk_loyalty_social-media 1.0.0

package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.d.ts

@@ -0,0 +1,270 @@
+export interface FollowedChannel {
+    /**
+     * Followed social media channel ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ID of the account that has followed a social media channel.
+     * @readonly
+     */
+    accountId?: string;
+    /** Followed social media channel type. */
+    channel?: Type;
+    /**
+     * Date when an entity for following a social media channel was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+}
+export declare enum Type {
+    /** Unknown social media channel type. */
+    UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
+    /** Facebook social media channel. */
+    FACEBOOK = "FACEBOOK",
+    /** Instagram social media channel. */
+    INSTAGRAM = "INSTAGRAM",
+    /** LinkedIn social media channel. */
+    LINKEDIN = "LINKEDIN",
+    /** X social media channel. */
+    X = "X",
+    /** TikTok social media channel. */
+    TIKTOK = "TIKTOK"
+}
+export interface CreateFollowedChannelRequest {
+    /** Followed social media channel details. */
+    followedChannel: FollowedChannel;
+}
+export interface CreateFollowedChannelResponse {
+    /** Followed social media channel details. */
+    followedChannel?: FollowedChannel;
+}
+export interface ListFollowedChannelsRequest {
+}
+export interface ListFollowedChannelsResponse {
+    /** List of followed social media channels. */
+    followedChannels?: FollowedChannel[];
+}
+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 {
+    entity?: string;
+}
+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.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: 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"
+}
+export interface FollowedChannelNonNullableFields {
+    _id: string;
+    accountId: string;
+    channel: Type;
+}
+export interface CreateFollowedChannelResponseNonNullableFields {
+    followedChannel?: FollowedChannelNonNullableFields;
+}
+export interface ListFollowedChannelsResponseNonNullableFields {
+    followedChannels: FollowedChannelNonNullableFields[];
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * 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;
+}
+export interface FollowedChannelCreatedEnvelope {
+    entity: FollowedChannel;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an account follows a new channel.
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @permissionId LOYALTY.FOLLOWED_CHANNEL_READ
+ * @webhook
+ * @eventType wix.loyalty.socialmedia.v1.followed_channel_created
+ * @documentationMaturity preview
+ */
+export declare function onFollowedChannelCreated(handler: (event: FollowedChannelCreatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates an entity for the specified account ID when the account follows a social media channel.
+ *
+ * Members can only follow enabled channels. A site owner has to enable channels in the dashboard.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ * @param followedChannel - Followed social media channel details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField followedChannel
+ * @requiredField followedChannel.channel
+ * @permissionId LOYALTY.FOLLOWED_CHANNEL_CREATE
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns Followed social media channel details.
+ * @fqn wix.loyalty.socialmedia.v1.LoyaltySocialMedia.CreateFollowedChannel
+ */
+export declare function createFollowedChannel(followedChannel: FollowedChannel): Promise<FollowedChannel & FollowedChannelNonNullableFields>;
+/**
+ * Retrieves a list of social media channels followed by the account. The list is ordered by creation date.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId LOYALTY.FOLLOWED_CHANNEL_READ
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.loyalty.socialmedia.v1.LoyaltySocialMedia.ListFollowedChannels
+ */
+export declare function listFollowedChannels(): Promise<ListFollowedChannelsResponse & ListFollowedChannelsResponseNonNullableFields>;

package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js

@@ -0,0 +1,108 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixLoyaltySocialmediaV1FollowedChannel from './loyalty-socialmedia-v1-followed-channel-social-media.http.js';
+export var Type;
+(function (Type) {
+    /** Unknown social media channel type. */
+    Type["UNKNOWN_CHANNEL"] = "UNKNOWN_CHANNEL";
+    /** Facebook social media channel. */
+    Type["FACEBOOK"] = "FACEBOOK";
+    /** Instagram social media channel. */
+    Type["INSTAGRAM"] = "INSTAGRAM";
+    /** LinkedIn social media channel. */
+    Type["LINKEDIN"] = "LINKEDIN";
+    /** X social media channel. */
+    Type["X"] = "X";
+    /** TikTok social media channel. */
+    Type["TIKTOK"] = "TIKTOK";
+})(Type || (Type = {}));
+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 = {}));
+/**
+ * Creates an entity for the specified account ID when the account follows a social media channel.
+ *
+ * Members can only follow enabled channels. A site owner has to enable channels in the dashboard.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ * @param followedChannel - Followed social media channel details.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField followedChannel
+ * @requiredField followedChannel.channel
+ * @permissionId LOYALTY.FOLLOWED_CHANNEL_CREATE
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns Followed social media channel details.
+ * @fqn wix.loyalty.socialmedia.v1.LoyaltySocialMedia.CreateFollowedChannel
+ */
+export async function createFollowedChannel(followedChannel) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        followedChannel: followedChannel,
+    });
+    const reqOpts = ambassadorWixLoyaltySocialmediaV1FollowedChannel.createFollowedChannel(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data)
+            ?.followedChannel;
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { followedChannel: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['followedChannel']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Retrieves a list of social media channels followed by the account. The list is ordered by creation date.
+ *
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities).
+ * @public
+ * @documentationMaturity preview
+ * @permissionId LOYALTY.FOLLOWED_CHANNEL_READ
+ * @permissionScope Manage Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
+ * @permissionScope Read Loyalty
+ * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @fqn wix.loyalty.socialmedia.v1.LoyaltySocialMedia.ListFollowedChannels
+ */
+export async function listFollowedChannels() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = renameKeysFromSDKRequestToRESTRequest({});
+    const reqOpts = ambassadorWixLoyaltySocialmediaV1FollowedChannel.listFollowedChannels(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map

package/build/internal/es/src/loyalty-socialmedia-v1-followed-channel-social-media.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-socialmedia-v1-followed-channel-social-media.universal.js","sourceRoot":"","sources":["../../../../src/loyalty-socialmedia-v1-followed-channel-social-media.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,gDAAgD,MAAM,gEAAgE,CAAC;AAsBnI,MAAM,CAAN,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,KAAJ,IAAI,QAaf;AAsID,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;AAoFD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,eAAgC;IAEhC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,eAAe,EAAE,eAAe;KACjC,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,gDAAgD,CAAC,qBAAqB,CACpE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAC;YACzD,EAAE,eAAgB,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,eAAe,EAAE,MAAM,EAAE;YACrD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,iBAAiB,CAAC,CACpB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB;IAGxC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GACX,gDAAgD,CAAC,oBAAoB,CACnE,OAAO,CACR,CAAC;IAEJ,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_loyalty_social-media",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.35",
+    "@wix/sdk-types": "^1.12.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-loyalty-social-media",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "socialMedia",
+      "fqdn": "wix.loyalty.socialmedia.v1.followed_channel"
+    }
+  },
+  "falconPackageHash": "471aa1bfdf4df1f33bbeed8481f376b14bf33505b64175caf2d5adc8"
+}