@wix/auto_sdk_app-management_external-billing 1.0.0

package/build/internal/es/src/market-aim-v1-external-billing-event-external-billing.universal.d.ts

@@ -0,0 +1,80 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+export interface ExternalBillingEvent {
+    /**
+     * The app ID linked to this transaction.
+     * @format GUID
+     */
+    appId?: string | null;
+    /**
+     * The app instance ID linked to this transaction.
+     *
+     * This connects the transaction to a specific instance of your app installed on a Wix site.
+     * Learn more [about app instances](https://dev.wix.com/docs/build-apps/develop-your-app/access/app-instances/about-app-instances).
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * The total amount of the transaction in USD, not including tax.
+     * This value can be negative, such as for adjustments or refunds.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:10 }
+     */
+    grossRevenue?: string;
+    /**
+     * The amount charged minus agreed-upon expenses, such as shipping fees.
+     * This value can be negative.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:10 }
+     */
+    netRevenue?: string | null;
+    /**
+     * Wix's share of the transaction in USD.
+     * This value can be negative, such as for adjustments or refunds.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:10 }
+     */
+    wixShare?: string;
+    /** The date and time of the transaction. */
+    _createdDate?: Date | null;
+    /** The type of billing event, either charge or refund. */
+    billingType?: BillingType;
+}
+export declare enum BillingType {
+    UNKNOWN = "UNKNOWN",
+    CHARGE = "CHARGE",
+    REFUND = "REFUND"
+}
+export interface ReportExternalBillingEventRequest {
+    /**
+     * The billing event with details of the external transaction, including the gross revenue,
+     * net revenue, and billing type (charge or refund).
+     */
+    event?: ExternalBillingEvent;
+}
+export interface ReportExternalBillingEventResponse {
+}
+/**
+ * Sends an external billing event to Wix.
+ * Use this to report charges or refunds for your [Partner Billed App](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/partner-billed-apps-reporting).
+ * The reported event enables Wix to track revenue, deductions, and shares related to third-party billing.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.event.billingType
+ * @requiredField options.event.grossRevenue
+ * @requiredField options.event.wixShare
+ * @permissionId WIX_DEVELOPERS.SEND_BI_EVENTS
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.ExternalBillingBIService.ReportExternalBillingEvent
+ */
+export declare function reportExternalBillingEvent(options?: NonNullablePaths<ReportExternalBillingEventOptions, `event.billingType` | `event.grossRevenue` | `event.wixShare`>): Promise<void>;
+export interface ReportExternalBillingEventOptions {
+    /**
+     * The billing event with details of the external transaction, including the gross revenue,
+     * net revenue, and billing type (charge or refund).
+     */
+    event?: ExternalBillingEvent;
+}

package/build/internal/es/src/market-aim-v1-external-billing-event-external-billing.universal.js

@@ -0,0 +1,49 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixMarketAimV1ExternalBillingEvent from './market-aim-v1-external-billing-event-external-billing.http.js';
+export var BillingType;
+(function (BillingType) {
+    BillingType["UNKNOWN"] = "UNKNOWN";
+    BillingType["CHARGE"] = "CHARGE";
+    BillingType["REFUND"] = "REFUND";
+})(BillingType || (BillingType = {}));
+/**
+ * Sends an external billing event to Wix.
+ * Use this to report charges or refunds for your [Partner Billed App](https://dev.wix.com/docs/build-apps/launch-your-app/pricing-and-billing/partner-billed-apps-reporting).
+ * The reported event enables Wix to track revenue, deductions, and shares related to third-party billing.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.event.billingType
+ * @requiredField options.event.grossRevenue
+ * @requiredField options.event.wixShare
+ * @permissionId WIX_DEVELOPERS.SEND_BI_EVENTS
+ * @permissionScope Manage Your App
+ * @permissionScopeId SCOPE.DC.MANAGE-YOUR-APP
+ * @permissionScope Read site, business, and email details
+ * @permissionScopeId SCOPE.DEV_CENTER.APP-INSTANCE-READ-BASIC-INFO
+ * @applicableIdentity APP
+ * @fqn com.wixpress.market.aim.api.ExternalBillingBIService.ReportExternalBillingEvent
+ */
+export async function reportExternalBillingEvent(options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        event: options?.event,
+    });
+    const reqOpts = ambassadorWixMarketAimV1ExternalBillingEvent.reportExternalBillingEvent(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { event: '$[0].event' },
+            singleArgumentUnchanged: false,
+        }, ['options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=market-aim-v1-external-billing-event-external-billing.universal.js.map

package/build/internal/es/src/market-aim-v1-external-billing-event-external-billing.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"market-aim-v1-external-billing-event-external-billing.universal.js","sourceRoot":"","sources":["../../../../src/market-aim-v1-external-billing-event-external-billing.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAEhG,OAAO,KAAK,4CAA4C,MAAM,iEAAiE,CAAC;AA2ChI,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,gCAAiB,CAAA;AACnB,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAYD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,OAGC;IAED,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,OAAO,EAAE,KAAK;KACtB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,4CAA4C,CAAC,0BAA0B,CACrE,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;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE;YACjD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,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_app-management_external-billing",
+  "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.42",
+    "@wix/sdk-types": "^1.13.16"
+  },
+  "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-app-management-external-billing",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "externalBilling",
+      "fqdn": "wix.market.aim.v1.external_billing_event"
+    }
+  },
+  "falconPackageHash": "7df40c66f1d37e1cd8bc2fab5046983986784cd35408bc76548800b7"
+}