@wix/auto_sdk_bookings_add-ons 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,103 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { AddOn, UpdateAddOn, AddOnsQueryBuilder, BulkCreateAddOnsOptions, BulkCreateAddOnsResponse, MaskedAddOn, BulkUpdateAddOnsOptions, BulkUpdateAddOnsResponse, BulkDeleteAddOnsResponse, AddOnCreatedEnvelope, AddOnDeletedEnvelope, AddOnUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, AddOnAddOnInfoOneOf, AddOnsQueryResult, Address, AddressHint, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAddOnResult, BulkCreateAddOnsRequest, BulkDeleteAddOnsRequest, BulkDeleteAddOnsResponseBulkAddOnResult, BulkUpdateAddOnTagsByFilterRequest, BulkUpdateAddOnTagsByFilterResponse, BulkUpdateAddOnTagsRequest, BulkUpdateAddOnTagsResponse, BulkUpdateAddOnTagsResult, BulkUpdateAddOnsRequest, BulkUpdateAddOnsResponseBulkAddOnResult, BusinessSchedule, Categories, ChangeContext, ChangeContextPayloadOneOf, ConsentPolicy, CreateAddOnRequest, CreateAddOnResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DayOfWeek, DayOfWeekWithLiterals, DeleteAddOnRequest, DeleteAddOnResponse, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GeoCoordinates, GetAddOnRequest, GetAddOnResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, Locale, MessageEnvelope, Money, Multilingual, PlacementType, PlacementTypeWithLiterals, Properties, PropertiesChange, QueryAddOnsRequest, QueryAddOnsResponse, ResolutionMethod, ResolutionMethodWithLiterals, RestoreInfo, SiteCloned, SiteCreated, SitePropertiesEvent, SitePropertiesNotification, SortOrder, SortOrderWithLiterals, Sorting, SpecialHourPeriod, SupportedLanguage, TagList, Tags, TimePeriod, Translation, UpdateAddOnRequest, UpdateAddOnResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+
+declare function createAddOn$1(httpClient: HttpClient): CreateAddOnSignature;
+interface CreateAddOnSignature {
+    /**
+     * Creates an add-on.
+     * @param - Add-on to create.
+     * @returns Created add-on.
+     */
+    (addOn: AddOn): Promise<NonNullablePaths<AddOn, `durationInMinutes` | `maxQuantity` | `price.value` | `price.currency` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function getAddOn$1(httpClient: HttpClient): GetAddOnSignature;
+interface GetAddOnSignature {
+    /**
+     * Retrieves an add-on.
+     * @param - ID of the add-on to retrieve.
+     * @returns Retrieved add-on.
+     */
+    (addOnId: string): Promise<NonNullablePaths<AddOn, `durationInMinutes` | `maxQuantity` | `price.value` | `price.currency` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function updateAddOn$1(httpClient: HttpClient): UpdateAddOnSignature;
+interface UpdateAddOnSignature {
+    /**
+     * Updates an existing add-on.
+     *
+     * Each time an add-on is updated, its revision number increments by 1.
+     * The current revision must be passed when updating to ensure you're working with the latest version and prevent unintended overwrites.
+     * @param - Add-on ID.
+     * @returns Updated add-on.
+     */
+    (_id: string, addOn: NonNullablePaths<UpdateAddOn, `revision`, 2>): Promise<NonNullablePaths<AddOn, `durationInMinutes` | `maxQuantity` | `price.value` | `price.currency` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function deleteAddOn$1(httpClient: HttpClient): DeleteAddOnSignature;
+interface DeleteAddOnSignature {
+    /**
+     * Deletes an add-on and removes it from all add-on groups.
+     * @param - ID of the add-on to delete.
+     */
+    (addOnId: string): Promise<void>;
+}
+declare function queryAddOns$1(httpClient: HttpClient): QueryAddOnsSignature;
+interface QueryAddOnsSignature {
+    /**
+     * Retrieves up to 100 add-ons, given the specified filtering, sorting, and paging.
+     *
+     * By default, results are sorted by `id` in ascending order.
+     *
+     * For supported filtering options, see [Supported Filters](https://dev.wix.com/docs/rest/business-solutions/bookings/services/add-ons/supported-filters).
+     */
+    (): AddOnsQueryBuilder;
+}
+declare function bulkCreateAddOns$1(httpClient: HttpClient): BulkCreateAddOnsSignature;
+interface BulkCreateAddOnsSignature {
+    /**
+     * Creates multiple add-ons in a single synchronous request.
+     * @param - List of add-ons to create.
+     */
+    (addOns: AddOn[], options?: BulkCreateAddOnsOptions): Promise<NonNullablePaths<BulkCreateAddOnsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.durationInMinutes` | `results.${number}.item.maxQuantity` | `results.${number}.item.price.value` | `results.${number}.item.price.currency` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkUpdateAddOns$1(httpClient: HttpClient): BulkUpdateAddOnsSignature;
+interface BulkUpdateAddOnsSignature {
+    /**
+     * Updates multiple add-ons in a single synchronous request.
+     * @param - List of add-ons to update.
+     */
+    (addOns: NonNullablePaths<MaskedAddOn, `addOn._id` | `addOn.revision`, 3>[], options?: BulkUpdateAddOnsOptions): Promise<NonNullablePaths<BulkUpdateAddOnsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.durationInMinutes` | `results.${number}.item.maxQuantity` | `results.${number}.item.price.value` | `results.${number}.item.price.currency` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkDeleteAddOns$1(httpClient: HttpClient): BulkDeleteAddOnsSignature;
+interface BulkDeleteAddOnsSignature {
+    /**
+     * Deletes multiple add-ons in a single synchronous request.
+     * @param - IDs of add-ons to delete.
+     */
+    (addOnIds: string[]): Promise<NonNullablePaths<BulkDeleteAddOnsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare const onAddOnCreated$1: EventDefinition<AddOnCreatedEnvelope, "wix.addons.v1.add_on_created">;
+declare const onAddOnDeleted$1: EventDefinition<AddOnDeletedEnvelope, "wix.addons.v1.add_on_deleted">;
+declare const onAddOnUpdated$1: EventDefinition<AddOnUpdatedEnvelope, "wix.addons.v1.add_on_updated">;
+
+declare const createAddOn: MaybeContext<BuildRESTFunction<typeof createAddOn$1> & typeof createAddOn$1>;
+declare const getAddOn: MaybeContext<BuildRESTFunction<typeof getAddOn$1> & typeof getAddOn$1>;
+declare const updateAddOn: MaybeContext<BuildRESTFunction<typeof updateAddOn$1> & typeof updateAddOn$1>;
+declare const deleteAddOn: MaybeContext<BuildRESTFunction<typeof deleteAddOn$1> & typeof deleteAddOn$1>;
+declare const queryAddOns: MaybeContext<BuildRESTFunction<typeof queryAddOns$1> & typeof queryAddOns$1>;
+declare const bulkCreateAddOns: MaybeContext<BuildRESTFunction<typeof bulkCreateAddOns$1> & typeof bulkCreateAddOns$1>;
+declare const bulkUpdateAddOns: MaybeContext<BuildRESTFunction<typeof bulkUpdateAddOns$1> & typeof bulkUpdateAddOns$1>;
+declare const bulkDeleteAddOns: MaybeContext<BuildRESTFunction<typeof bulkDeleteAddOns$1> & typeof bulkDeleteAddOns$1>;
+/**
+ * Triggered when an add-on is created.
+ */
+declare const onAddOnCreated: BuildEventDefinition<typeof onAddOnCreated$1> & typeof onAddOnCreated$1;
+/**
+ * Triggered when an add-on is deleted.
+ */
+declare const onAddOnDeleted: BuildEventDefinition<typeof onAddOnDeleted$1> & typeof onAddOnDeleted$1;
+/**
+ * Triggered when an add-on is updated.
+ */
+declare const onAddOnUpdated: BuildEventDefinition<typeof onAddOnUpdated$1> & typeof onAddOnUpdated$1;
+
+export { AddOn, AddOnCreatedEnvelope, AddOnDeletedEnvelope, AddOnUpdatedEnvelope, AddOnsQueryBuilder, BulkCreateAddOnsOptions, BulkCreateAddOnsResponse, BulkDeleteAddOnsResponse, BulkUpdateAddOnsOptions, BulkUpdateAddOnsResponse, MaskedAddOn, UpdateAddOn, bulkCreateAddOns, bulkDeleteAddOns, bulkUpdateAddOns, createAddOn, deleteAddOn, getAddOn, onAddOnCreated, onAddOnDeleted, onAddOnUpdated, queryAddOns, updateAddOn };