@wix/auto_sdk_pricing-plans_pricing-plans-settings 1.0.0

package/build/internal/es/index.typings.d.mts

@@ -0,0 +1,217 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface PricingPlansSettings {
+    /**
+     * Revision number, which increments by 1 each time the PricingPlans settings are updated. To prevent conflicting changes, the current revision must be passed when updating the PricingPlans settings.
+     * Ignored when creating a PricingPlans settings.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the PricingPlansSettings was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the PricingPlansSettings was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** Site's taxable address, which determines how tax is calculated for pricing plans. */
+    taxableAddress?: TaxableAddressWithLiterals;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+}
+declare enum TaxableAddress {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    BILLING = "BILLING",
+    BUSINESS = "BUSINESS"
+}
+/** @enumType */
+type TaxableAddressWithLiterals = TaxableAddress | 'UNKNOWN_TYPE' | 'BILLING' | 'BUSINESS';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface GetPricingPlansSettingsRequest {
+}
+interface GetPricingPlansSettingsResponse {
+    /** Pricing Plans settings */
+    pricingPlansSettings?: PricingPlansSettings;
+}
+interface UpdatePricingPlansSettingsRequest {
+    /** PricingPlansSettings to be updated, may be partial. */
+    pricingPlansSettings: PricingPlansSettings;
+}
+interface UpdatePricingPlansSettingsResponse {
+    /** Updated PricingPlansSettings. */
+    pricingPlansSettings?: PricingPlansSettings;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/**
+ * Retrieves a site's Pricing Plans Settings.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId PRICING_PLANS.PRICING_PLANS_SETTINGS_READ
+ * @returns Pricing Plans settings
+ * @fqn wix.pricing_plans.settings.v1.PricingPlansSettingsService.GetPricingPlansSettings
+ */
+declare function getPricingPlansSettings(): Promise<NonNullablePaths<PricingPlansSettings, `taxableAddress`, 2>>;
+/**
+ * Updates a site's Pricing Plans settings, or creates them if none exist.
+ *
+ * Each time the Pricing Plans settings are updated, `revision` increments by 1.
+ * The current `revision` must be passed when updating the Pricing Plans settings.
+ * This ensures you're working with the latest Pricing Plans settings and prevents unintended overwrites.
+ * @param pricingPlansSettings - PricingPlansSettings to be updated, may be partial.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField pricingPlansSettings
+ * @requiredField pricingPlansSettings.revision
+ * @permissionId PRICING_PLANS.PRICING_PLANS_SETTINGS_UPDATE
+ * @returns Updated PricingPlansSettings.
+ * @fqn wix.pricing_plans.settings.v1.PricingPlansSettingsService.UpdatePricingPlansSettings
+ */
+declare function updatePricingPlansSettings(pricingPlansSettings: NonNullablePaths<PricingPlansSettings, `revision`, 2>): Promise<NonNullablePaths<PricingPlansSettings, `taxableAddress`, 2>>;
+
+export { type ActionEvent, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetPricingPlansSettingsRequest, type GetPricingPlansSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type PricingPlansSettings, type RestoreInfo, TaxableAddress, type TaxableAddressWithLiterals, type UpdatePricingPlansSettingsRequest, type UpdatePricingPlansSettingsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getPricingPlansSettings, updatePricingPlansSettings };

package/build/internal/es/index.typings.mjs

@@ -0,0 +1,167 @@
+// src/pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.universal.ts
+import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+
+// src/pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformSDKTimestampToRESTTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformSDKFieldMaskToRESTFieldMask } from "@wix/sdk-runtime/transformations/field-mask";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
+function resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl(opts) {
+  const domainToMappings = {};
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_pricing-plans_pricing-plans-settings";
+function getPricingPlansSettings(payload) {
+  function __getPricingPlansSettings({ host }) {
+    const metadata = {
+      entityFqdn: "wix.pricing_plans.settings.v1.pricing_plans_settings",
+      method: "GET",
+      methodFqn: "wix.pricing_plans.settings.v1.PricingPlansSettingsService.GetPricingPlansSettings",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl({
+        protoPath: "/v1/pricing-plans-settings",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "pricingPlansSettings.createdDate" },
+            { path: "pricingPlansSettings.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getPricingPlansSettings;
+}
+function updatePricingPlansSettings(payload) {
+  function __updatePricingPlansSettings({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKFieldMaskToRESTFieldMask,
+        paths: [{ path: "fieldMask" }]
+      },
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "pricingPlansSettings.createdDate" },
+          { path: "pricingPlansSettings.updatedDate" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.pricing_plans.settings.v1.pricing_plans_settings",
+      method: "PATCH",
+      methodFqn: "wix.pricing_plans.settings.v1.PricingPlansSettingsService.UpdatePricingPlansSettings",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl({
+        protoPath: "/v1/pricing-plans-settings",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "pricingPlansSettings.createdDate" },
+            { path: "pricingPlansSettings.updatedDate" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __updatePricingPlansSettings;
+}
+
+// src/pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.universal.ts
+var TaxableAddress = /* @__PURE__ */ ((TaxableAddress2) => {
+  TaxableAddress2["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+  TaxableAddress2["BILLING"] = "BILLING";
+  TaxableAddress2["BUSINESS"] = "BUSINESS";
+  return TaxableAddress2;
+})(TaxableAddress || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+async function getPricingPlansSettings2() {
+  const { httpClient, sideEffects } = arguments[0];
+  const payload = renameKeysFromSDKRequestToRESTRequest({});
+  const reqOpts = getPricingPlansSettings(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data)?.pricingPlansSettings;
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {},
+        singleArgumentUnchanged: false
+      },
+      []
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function updatePricingPlansSettings2(pricingPlansSettings) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    pricingPlansSettings
+  });
+  const reqOpts = updatePricingPlansSettings(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data)?.pricingPlansSettings;
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { pricingPlansSettings: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["pricingPlansSettings"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+export {
+  TaxableAddress,
+  WebhookIdentityType,
+  getPricingPlansSettings2 as getPricingPlansSettings,
+  updatePricingPlansSettings2 as updatePricingPlansSettings
+};
+//# sourceMappingURL=index.typings.mjs.map

package/build/internal/es/index.typings.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.universal.ts","../../../src/pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.http.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixPricingPlansSettingsV1PricingPlansSettings from './pricing-plans-settings-v1-pricing-plans-settings-pricing-plans-settings.http.js';\n\nexport interface PricingPlansSettings {\n  /**\n   * Revision number, which increments by 1 each time the PricingPlans settings are updated. To prevent conflicting changes, the current revision must be passed when updating the PricingPlans settings.\n   * Ignored when creating a PricingPlans settings.\n   * @readonly\n   */\n  revision?: string | null;\n  /**\n   * Date and time the PricingPlansSettings was created.\n   * @readonly\n   */\n  _createdDate?: Date | null;\n  /**\n   * Date and time the PricingPlansSettings was last updated.\n   * @readonly\n   */\n  _updatedDate?: Date | null;\n  /** Site's taxable address, which determines how tax is calculated for pricing plans. */\n  taxableAddress?: TaxableAddressWithLiterals;\n  /** Data Extensions */\n  extendedFields?: ExtendedFields;\n}\n\nexport enum TaxableAddress {\n  UNKNOWN_TYPE = 'UNKNOWN_TYPE',\n  BILLING = 'BILLING',\n  BUSINESS = 'BUSINESS',\n}\n\n/** @enumType */\nexport type TaxableAddressWithLiterals =\n  | TaxableAddress\n  | 'UNKNOWN_TYPE'\n  | 'BILLING'\n  | 'BUSINESS';\n\nexport interface ExtendedFields {\n  /**\n   * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\n   * The value of each key is structured according to the schema defined when the extended fields were configured.\n   *\n   * You can only access fields for which you have the appropriate permissions.\n   *\n   * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).\n   */\n  namespaces?: Record<string, Record<string, any>>;\n}\n\nexport interface GetPricingPlansSettingsRequest {}\n\nexport interface GetPricingPlansSettingsResponse {\n  /** Pricing Plans settings */\n  pricingPlansSettings?: PricingPlansSettings;\n}\n\nexport interface UpdatePricingPlansSettingsRequest {\n  /** PricingPlansSettings to be updated, may be partial. */\n  pricingPlansSettings: PricingPlansSettings;\n}\n\nexport interface UpdatePricingPlansSettingsResponse {\n  /** Updated PricingPlansSettings. */\n  pricingPlansSettings?: PricingPlansSettings;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\n/**\n * Retrieves a site's Pricing Plans Settings.\n * @internal\n * @documentationMaturity preview\n * @permissionId PRICING_PLANS.PRICING_PLANS_SETTINGS_READ\n * @returns Pricing Plans settings\n * @fqn wix.pricing_plans.settings.v1.PricingPlansSettingsService.GetPricingPlansSettings\n */\nexport async function getPricingPlansSettings(): Promise<\n  NonNullablePaths<PricingPlansSettings, `taxableAddress`, 2>\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({});\n\n  const reqOpts =\n    ambassadorWixPricingPlansSettingsV1PricingPlansSettings.getPricingPlansSettings(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)\n      ?.pricingPlansSettings!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: {},\n        singleArgumentUnchanged: false,\n      },\n      []\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Updates a site's Pricing Plans settings, or creates them if none exist.\n *\n * Each time the Pricing Plans settings are updated, `revision` increments by 1.\n * The current `revision` must be passed when updating the Pricing Plans settings.\n * This ensures you're working with the latest Pricing Plans settings and prevents unintended overwrites.\n * @param pricingPlansSettings - PricingPlansSettings to be updated, may be partial.\n * @internal\n * @documentationMaturity preview\n * @requiredField pricingPlansSettings\n * @requiredField pricingPlansSettings.revision\n * @permissionId PRICING_PLANS.PRICING_PLANS_SETTINGS_UPDATE\n * @returns Updated PricingPlansSettings.\n * @fqn wix.pricing_plans.settings.v1.PricingPlansSettingsService.UpdatePricingPlansSettings\n */\nexport async function updatePricingPlansSettings(\n  pricingPlansSettings: NonNullablePaths<PricingPlansSettings, `revision`, 2>\n): Promise<NonNullablePaths<PricingPlansSettings, `taxableAddress`, 2>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    pricingPlansSettings: pricingPlansSettings,\n  });\n\n  const reqOpts =\n    ambassadorWixPricingPlansSettingsV1PricingPlansSettings.updatePricingPlansSettings(\n      payload\n    );\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)\n      ?.pricingPlansSettings!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { pricingPlansSettings: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['pricingPlansSettings']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformSDKTimestampToRESTTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformSDKFieldMaskToRESTFieldMask } from '@wix/sdk-runtime/transformations/field-mask';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {};\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_pricing-plans_pricing-plans-settings';\n\n/** Retrieves a site's Pricing Plans Settings. */\nexport function getPricingPlansSettings(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getPricingPlansSettings({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.pricing_plans.settings.v1.pricing_plans_settings',\n      method: 'GET' as any,\n      methodFqn:\n        'wix.pricing_plans.settings.v1.PricingPlansSettingsService.GetPricingPlansSettings',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl({\n        protoPath: '/v1/pricing-plans-settings',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'pricingPlansSettings.createdDate' },\n              { path: 'pricingPlansSettings.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getPricingPlansSettings;\n}\n\n/**\n * Updates a site's Pricing Plans settings, or creates them if none exist.\n *\n * Each time the Pricing Plans settings are updated, `revision` increments by 1.\n * The current `revision` must be passed when updating the Pricing Plans settings.\n * This ensures you're working with the latest Pricing Plans settings and prevents unintended overwrites.\n */\nexport function updatePricingPlansSettings(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __updatePricingPlansSettings({ host }: any) {\n    const serializedData = transformPaths(payload, [\n      {\n        transformFn: transformSDKFieldMaskToRESTFieldMask,\n        paths: [{ path: 'fieldMask' }],\n      },\n      {\n        transformFn: transformSDKTimestampToRESTTimestamp,\n        paths: [\n          { path: 'pricingPlansSettings.createdDate' },\n          { path: 'pricingPlansSettings.updatedDate' },\n        ],\n      },\n    ]);\n    const metadata = {\n      entityFqdn: 'wix.pricing_plans.settings.v1.pricing_plans_settings',\n      method: 'PATCH' as any,\n      methodFqn:\n        'wix.pricing_plans.settings.v1.PricingPlansSettingsService.UpdatePricingPlansSettings',\n      packageName: PACKAGE_NAME,\n      migrationOptions: {\n        optInTransformResponse: true,\n      },\n      url: resolveWixPricingPlansSettingsV1PricingPlansSettingsServiceUrl({\n        protoPath: '/v1/pricing-plans-settings',\n        data: serializedData,\n        host,\n      }),\n      data: serializedData,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [\n              { path: 'pricingPlansSettings.createdDate' },\n              { path: 'pricingPlansSettings.updatedDate' },\n            ],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __updatePricingPlansSettings;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,4CAA4C;AACrD,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,+DACP,MACA;AACA,QAAM,mBAAmB,CAAC;AAE1B,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAGd,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,+DAA+D;AAAA,QAClE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,mCAAmC;AAAA,YAC3C,EAAE,MAAM,mCAAmC;AAAA,UAC7C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AASO,SAAS,2BACd,SAC4B;AAC5B,WAAS,6BAA6B,EAAE,KAAK,GAAQ;AACnD,UAAM,iBAAiB,eAAe,SAAS;AAAA,MAC7C;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,YAAY,CAAC;AAAA,MAC/B;AAAA,MACA;AAAA,QACE,aAAa;AAAA,QACb,OAAO;AAAA,UACL,EAAE,MAAM,mCAAmC;AAAA,UAC3C,EAAE,MAAM,mCAAmC;AAAA,QAC7C;AAAA,MACF;AAAA,IACF,CAAC;AACD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,kBAAkB;AAAA,QAChB,wBAAwB;AAAA,MAC1B;AAAA,MACA,KAAK,+DAA+D;AAAA,QAClE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO;AAAA,YACL,EAAE,MAAM,mCAAmC;AAAA,YAC3C,EAAE,MAAM,mCAAmC;AAAA,UAC7C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADjFO,IAAK,iBAAL,kBAAKC,oBAAL;AACL,EAAAA,gBAAA,kBAAe;AACf,EAAAA,gBAAA,aAAU;AACV,EAAAA,gBAAA,cAAW;AAHD,SAAAA;AAAA,GAAA;AAiLL,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AAyBZ,eAAsBC,2BAEpB;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,CAAC,CAAC;AAExD,QAAM,UACoD;AAAA,IACtD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,CAAC;AAAA,QAC3B,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC;AAAA,IACH;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAiBA,eAAsBC,4BACpB,sBACsE;AAEtE,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UACoD;AAAA,IACtD;AAAA,EACF;AAEF,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI,GACtD;AAAA,EACN,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,sBAAsB,OAAO;AAAA,QACzD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,sBAAsB;AAAA,IACzB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","TaxableAddress","WebhookIdentityType","getPricingPlansSettings","updatePricingPlansSettings"]}

package/build/internal/es/meta.d.mts

@@ -0,0 +1,208 @@
+import { GetPricingPlansSettingsRequest as GetPricingPlansSettingsRequest$1, GetPricingPlansSettingsResponse as GetPricingPlansSettingsResponse$1, UpdatePricingPlansSettingsRequest as UpdatePricingPlansSettingsRequest$1, UpdatePricingPlansSettingsResponse as UpdatePricingPlansSettingsResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+interface PricingPlansSettings {
+    /**
+     * Revision number, which increments by 1 each time the PricingPlans settings are updated. To prevent conflicting changes, the current revision must be passed when updating the PricingPlans settings.
+     * Ignored when creating a PricingPlans settings.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the PricingPlansSettings was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the PricingPlansSettings was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Site's taxable address, which determines how tax is calculated for pricing plans. */
+    taxableAddress?: TaxableAddressWithLiterals;
+    /** Data Extensions */
+    extendedFields?: ExtendedFields;
+}
+declare enum TaxableAddress {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    BILLING = "BILLING",
+    BUSINESS = "BUSINESS"
+}
+/** @enumType */
+type TaxableAddressWithLiterals = TaxableAddress | 'UNKNOWN_TYPE' | 'BILLING' | 'BUSINESS';
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface GetPricingPlansSettingsRequest {
+}
+interface GetPricingPlansSettingsResponse {
+    /** Pricing Plans settings */
+    pricingPlansSettings?: PricingPlansSettings;
+}
+interface UpdatePricingPlansSettingsRequest {
+    /** PricingPlansSettings to be updated, may be partial. */
+    pricingPlansSettings: PricingPlansSettings;
+}
+interface UpdatePricingPlansSettingsResponse {
+    /** Updated PricingPlansSettings. */
+    pricingPlansSettings?: PricingPlansSettings;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getPricingPlansSettings(): __PublicMethodMetaInfo<'GET', {}, GetPricingPlansSettingsRequest$1, GetPricingPlansSettingsRequest, GetPricingPlansSettingsResponse$1, GetPricingPlansSettingsResponse>;
+declare function updatePricingPlansSettings(): __PublicMethodMetaInfo<'PATCH', {}, UpdatePricingPlansSettingsRequest$1, UpdatePricingPlansSettingsRequest, UpdatePricingPlansSettingsResponse$1, UpdatePricingPlansSettingsResponse>;
+
+export { type ActionEvent as ActionEventOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type GetPricingPlansSettingsRequest as GetPricingPlansSettingsRequestOriginal, type GetPricingPlansSettingsResponse as GetPricingPlansSettingsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PricingPlansSettings as PricingPlansSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, TaxableAddress as TaxableAddressOriginal, type TaxableAddressWithLiterals as TaxableAddressWithLiteralsOriginal, type UpdatePricingPlansSettingsRequest as UpdatePricingPlansSettingsRequestOriginal, type UpdatePricingPlansSettingsResponse as UpdatePricingPlansSettingsResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, getPricingPlansSettings, updatePricingPlansSettings };