@wix/auto_sdk_ecom_tip-settings 1.0.6 → 1.0.8

package/build/internal/{es/src/tips-settings-v1-tip-settings-tip-settings.universal.d.ts → tips-settings-v1-tip-settings-tip-settings.universal-BvU_OtgN.d.ts}

@@ -1,4 +1,3 @@
-import { NonNullablePaths } from '@wix/sdk-types';
 /**
  * Tip settings define how tips are calculated and distributed among staff. When
  * Wix Tips is installed, default settings are automatically created. You can't
@@ -6,7 +5,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * settings allows Wix users to customize tip screens for different payment
  * terminals or set specific presets for various products or services.
  */
-export interface TipSettings extends TipSettingsIdentifierOneOf {
+interface TipSettings extends TipSettingsIdentifierOneOf {
     /**
      * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
@@ -125,7 +124,7 @@ export interface TipSettings extends TipSettingsIdentifierOneOf {
     extendedFields?: ExtendedFields;
 }
 /** @oneof */
-export interface TipSettingsIdentifierOneOf {
+interface TipSettingsIdentifierOneOf {
     /**
      * ID of the location ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/location-object))
      * for which the tip settings apply.
@@ -147,7 +146,7 @@ export interface TipSettingsIdentifierOneOf {
      */
     userId?: string | null;
 }
-export declare enum TipType {
+declare enum TipType {
     /** There is no information about the tip type. */
     UNKNOWN_TIP_TYPE = "UNKNOWN_TIP_TYPE",
     /** The tip is calculated as a percentage of the subtotal of all related line items. */
@@ -155,7 +154,7 @@ export declare enum TipType {
     /** The tip is a fixed amount. */
     AMOUNT = "AMOUNT"
 }
-export interface Preset {
+interface Preset {
     /**
      * Value of the preset tip choice that's displayed to customers in the
      * eCommerce checkout ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction)).
@@ -172,7 +171,7 @@ export interface Preset {
      */
     default?: boolean | null;
 }
-export declare enum StaffDistributionMethod {
+declare enum StaffDistributionMethod {
     /** There is no information about the staff distribution method. */
     UNKNOWN_SPLIT_METHOD = "UNKNOWN_SPLIT_METHOD",
     /** All staff receive an equal amount of the tip. */
@@ -180,7 +179,7 @@ export declare enum StaffDistributionMethod {
     /** Staff receive a proportional amount of the tip. */
     PROPORTIONAL = "PROPORTIONAL"
 }
-export interface ExtendedFields {
+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.
@@ -191,11 +190,11 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface QueryTipSettingsRequest {
+interface QueryTipSettingsRequest {
     /** WQL expression */
     query: QueryV2;
 }
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
+interface QueryV2 extends QueryV2PagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
@@ -229,13 +228,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
     fieldsets?: string[];
 }
 /** @oneof */
-export interface QueryV2PagingMethodOneOf {
+interface QueryV2PagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -244,17 +243,17 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrder;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface Paging {
+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 CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -269,13 +268,13 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryTipSettingsResponse {
+interface QueryTipSettingsResponse {
     /** Retrieved `tipSettings` objects. */
     tipSettings?: TipSettings[];
     /** Metadate for the paged set of retrieved `tipSettings` objects. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface PagingMetadataV2 {
+interface PagingMetadataV2 {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -287,7 +286,7 @@ export interface PagingMetadataV2 {
     /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -299,40 +298,40 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface UpdateTipSettingsRequest {
+interface UpdateTipSettingsRequest {
     /** Tip settings to update. */
     tipSettings: TipSettings;
 }
-export interface UpdateTipSettingsResponse {
+interface UpdateTipSettingsResponse {
     /** Updated tip settings. */
     tipSettings?: TipSettings;
 }
-export interface CreateTipSettingsRequest {
+interface CreateTipSettingsRequest {
     /** Tip settings to create. */
     tipSettings: TipSettings;
 }
-export interface CreateTipSettingsResponse {
+interface CreateTipSettingsResponse {
     /** Created tip settings. */
     tipSettings?: TipSettings;
 }
-export interface CreateDefaultTipSettingsRequest {
+interface CreateDefaultTipSettingsRequest {
     /** Default tip settings to create. */
     tipSettings: TipSettings;
 }
-export interface CreateDefaultTipSettingsResponse {
+interface CreateDefaultTipSettingsResponse {
     /** Created default tip settings. */
     tipSettings?: TipSettings;
 }
-export interface DeleteTipSettingsRequest {
+interface DeleteTipSettingsRequest {
     /**
      * ID of the `tipSettings` object to delete.
      * @format GUID
      */
     tipSettingsId: string | null;
 }
-export interface DeleteTipSettingsResponse {
+interface DeleteTipSettingsResponse {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
@@ -375,19 +374,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     entityEventSequence?: string | null;
 }
 /** @oneof */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -395,14 +394,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
+interface EntityDeletedEvent {
     /** Entity that was deleted */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -418,7 +417,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -443,7 +442,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -465,43 +464,13 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-type TipSettingsNonNullablePaths = `tipType` | `presets` | `staffDistributionMethod`;
-/**
- * Creates a query to retrieve a list of tip settings.
- *
- * The `queryTipSettings()` function builds a query to retrieve a list of tip settings and returns a `TipSettingsQueryBuilder` object.
- *
- * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/ecom/tip-settings/tip-settings-query-builder/find) function.
- *
- * You can refine the query by chaining `TipSettingsQueryBuilder` functions onto the query. `TipSettingsQueryBuilder` functions enable you to sort, filter, and control the results that `queryTipSettings()` returns.
- *
- * `queryTipSettings()` runs with the following `TipSettingsQueryBuilder` default that you can override:
- *
- * + `limit` is `50`.
- * + Sorted by `id` in ascending order.
- *
- * The functions that are chained to `queryTipSettings()` are applied in the order they are called. For example, if you apply `ascending("tipType")` and then `ascending("locationId")`, the results are sorted first by the `"tipType"`, and then, if there are multiple results with the same `"tipType"`, the items are sorted by `"locationId"`.
- *
- * The following `TipSettingsQueryBuilder` functions are supported for the `queryTipSettings()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/ecom/tip-settings/tip-settings-query-result/items) property in `TipSettingsQueryResult`.
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionId WIX_TIPS.TIP_SETTINGS_READ
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn wix.tips.settings.v1.TipSettingsService.QueryTipSettings
- */
-export declare function queryTipSettings(): TipSettingsQueryBuilder;
 interface QueryCursorResult {
     cursors: Cursors;
     hasNext: () => boolean;
@@ -509,13 +478,13 @@ interface QueryCursorResult {
     length: number;
     pageSize: number;
 }
-export interface TipSettingsQueryResult extends QueryCursorResult {
+interface TipSettingsQueryResult extends QueryCursorResult {
     items: TipSettings[];
     query: TipSettingsQueryBuilder;
     next: () => Promise<TipSettingsQueryResult>;
     prev: () => Promise<TipSettingsQueryResult>;
 }
-export interface TipSettingsQueryBuilder {
+interface TipSettingsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      * @documentationMaturity preview
@@ -559,81 +528,5 @@ export interface TipSettingsQueryBuilder {
     /** @documentationMaturity preview */
     find: () => Promise<TipSettingsQueryResult>;
 }
-/**
- * Updates a `tipSettings` object.
- *
- *
- * You can't update the `default` field.
- * @param tipSettings - Tip settings to update.
- * @public
- * @documentationMaturity preview
- * @requiredField tipSettings
- * @param options - Options to use when updating tip settings.
- * @permissionId WIX_TIPS.TIP_SETTINGS_UPDATE
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @returns Updated tip settings.
- * @fqn wix.tips.settings.v1.TipSettingsService.UpdateTipSettings
- */
-export declare function updateTipSettings(tipSettings: TipSettings): Promise<NonNullablePaths<TipSettings, TipSettingsNonNullablePaths>>;
-/**
- * Creates a `tipSettings` object.
- *
- *
- * You can't create a `tipSettings` object with `{"default": true}`.
- * @param tipSettings - Tip settings to create.
- * @public
- * @documentationMaturity preview
- * @requiredField tipSettings
- * @permissionId WIX_TIPS.TIP_SETTINGS_CREATE
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @returns Created tip settings.
- * @fqn wix.tips.settings.v1.TipSettingsService.CreateTipSettings
- */
-export declare function createTipSettings(tipSettings: TipSettings): Promise<NonNullablePaths<TipSettings, TipSettingsNonNullablePaths>>;
-/**
- * Creates a default `tipSettings` object.
- *
- *
- * The call fails if there is already an existing default `tipSettings` object.
- * @param tipSettings - Default tip settings to create.
- * @public
- * @documentationMaturity preview
- * @requiredField tipSettings
- * @permissionId WIX_TIPS.TIP_SETTINGS_CREATE
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @fqn wix.tips.settings.v1.TipSettingsService.CreateDefaultTipSettings
- */
-export declare function createDefaultTipSettings(tipSettings: TipSettings): Promise<NonNullablePaths<CreateDefaultTipSettingsResponse, {
-    [P in TipSettingsNonNullablePaths]: `tipSettings.${P}`;
-}[TipSettingsNonNullablePaths]>>;
-/**
- * Deletes a `tipSettings` object.
- *
- *
- * You can't delete the default `tipSettings` object.
- * @param tipSettingsId - ID of the `tipSettings` object to delete.
- * @public
- * @documentationMaturity preview
- * @requiredField tipSettingsId
- * @permissionId WIX_TIPS.TIP_SETTINGS_DELETE
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @fqn wix.tips.settings.v1.TipSettingsService.DeleteTipSettings
- */
-export declare function deleteTipSettings(tipSettingsId: string): Promise<void>;
-export {};
+
+export { type ActionEvent as A, type CreateDefaultTipSettingsResponse as C, type DeleteTipSettingsRequest as D, type ExtendedFields as E, type IdentificationData as I, type MessageEnvelope as M, type Preset as P, type QueryTipSettingsRequest as Q, type RestoreInfo as R, StaffDistributionMethod as S, type TipSettingsQueryBuilder as T, type UpdateTipSettingsRequest as U, WebhookIdentityType as W, type TipSettings as a, TipType as b, SortOrder as c, type TipSettingsIdentifierOneOf as d, type QueryV2 as e, type QueryV2PagingMethodOneOf as f, type Sorting as g, type Paging as h, type CursorPaging as i, type QueryTipSettingsResponse as j, type PagingMetadataV2 as k, type Cursors as l, type UpdateTipSettingsResponse as m, type CreateTipSettingsRequest as n, type CreateTipSettingsResponse as o, type CreateDefaultTipSettingsRequest as p, type DeleteTipSettingsResponse as q, type DomainEvent as r, type DomainEventBodyOneOf as s, type EntityCreatedEvent as t, type EntityUpdatedEvent as u, type EntityDeletedEvent as v, type IdentificationDataIdOneOf as w, type TipSettingsQueryResult as x };