@wix/auto_sdk_table-reservations_reservations 1.0.22 → 1.0.23

package/build/cjs/index.d.ts

@@ -1,7 +1,8 @@
-import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { R as Reservation, C as CreateReservationOptions, a as CreateReservationApplicationErrors, b as CreateReservationValidationErrors, G as GetReservationOptions, U as UpdateReservation, c as UpdateReservationOptions, d as UpdateReservationApplicationErrors, e as UpdateReservationValidationErrors, H as HeldReservationDetails, f as CreateHeldReservationResponse, g as CreateHeldReservationApplicationErrors, h as Reservee, i as ReserveReservationResponse, j as ReserveReservationApplicationErrors, k as CancelReservationOptions, l as CancelReservationResponse, m as CancelReservationApplicationErrors, L as ListReservationsOptions, n as ListReservationsResponse, o as ReservationsQueryBuilder, p as ReservationSearch, S as SearchReservationsResponse, B as BulkArchiveReservationsResponse, q as BulkUnArchiveReservationsResponse, r as ReservationCreatedEnvelope, s as ReservationDeletedEnvelope, t as ReservationUpdatedEnvelope } from './table-reservations-v1-reservation-reservations.universal-Z8xq195Z.js';
 export { bb as ActionEvent, as as Aggregation, aF as AggregationData, at as AggregationKindOneOf, aY as AggregationResults, aZ as AggregationResultsResultOneOf, aM as AggregationResultsScalarResult, E as AggregationType, b1 as ApplicationError, bn as BaseEventMetadata, b2 as BulkActionMetadata, a_ as BulkArchiveReservationsRequest, a$ as BulkArchiveReservationsResult, b3 as BulkUnArchiveReservationsRequest, b4 as BulkUnArchiveReservationsResult, ac as CancelReservationRequest, aa as CreateHeldReservationRequest, a1 as CreateReservationRequest, a2 as CreateReservationResponse, ah as CursorPaging, aj as CursorPagingMetadata, am as CursorQuery, an as CursorQueryPagingMethodOneOf, aq as CursorSearch, ar as CursorSearchPagingMethodOneOf, ak as Cursors, aA as DateHistogramAggregation, aU as DateHistogramResult, aW as DateHistogramResults, ae as DeleteReservationRequest, af as DeleteReservationResponse, K as Details, b5 as DomainEvent, b6 as DomainEventBodyOneOf, bc as Empty, b7 as EntityCreatedEvent, ba as EntityDeletedEvent, b9 as EntityUpdatedEvent, bo as EventMetadata, X as ExtendedFields, a6 as GetReservationRequest, a7 as GetReservationResponse, aV as GroupByValueResults, bi as HeadersEntry, bl as IdentificationData, bm as IdentificationDataIdOneOf, av as IncludeMissingValuesOptions, I as Interval, b0 as ItemMetadata, ag as ListReservationsRequest, bk as MessageEnvelope, Q as MigrationNote, M as MissingValues, F as Mode, aD as NestedAggregation, aB as NestedAggregationItem, aC as NestedAggregationItemKindOneOf, aI as NestedAggregationResults, aJ as NestedAggregationResultsResultOneOf, N as NestedAggregationType, aR as NestedResultValue, aS as NestedResultValueResultOneOf, aX as NestedResults, aN as NestedValueAggregationResult, bg as PathParametersEntry, P as PaymentStatus, bh as QueryParametersEntry, al as QueryReservationsRequest, ao as QueryReservationsResponse, ay as RangeAggregation, aH as RangeAggregationResult, au as RangeBucket, aP as RangeResult, aL as RangeResults, bf as RawHttpRequest, bj as RawHttpResponse, bd as RemoveReservationMigrationNotesRequest, be as RemoveReservationMigrationNotesResponse, ad as ReservationCanceled, _ as ReservationCreated, Y as ReservationDelayedDomainEvent, Z as ReservationDelayedDomainEventBodyTypeOneOf, a0 as ReservationDelayedDomainEventReservationCanceled, a3 as ReservationDetailsConflicts, a5 as ReservationLocationConflict, bq as ReservationSearchSpec, $ as ReservationUpdated, bp as ReservationsQueryResult, ab as ReserveReservationRequest, O as ReservedBy, b8 as RestoreInfo, aT as Results, az as ScalarAggregation, aQ as ScalarResult, D as ScalarType, aE as SearchDetails, ap as SearchReservationsRequest, x as Set, A as SortDirection, y as SortOrder, z as SortType, ai as Sorting, v as Source, u as Status, a4 as TableCombinationConflict, T as TableCombinationConflictType, V as TableWithReservationConflicts, J as Tables, w as Type, a8 as UpdateReservationRequest, a9 as UpdateReservationResponse, aw as ValueAggregation, ax as ValueAggregationOptionsOneOf, aG as ValueAggregationResult, aO as ValueResult, aK as ValueResults, W as WebhookIdentityType } from './table-reservations-v1-reservation-reservations.universal-Z8xq195Z.js';
 
+type ReservationNonNullablePaths = `status` | `source` | `details.tableIds` | `details.tables.ids` | `paymentStatus`;
 declare function createReservation$1(httpClient: HttpClient): CreateReservationSignature;
 interface CreateReservationSignature {
     /**
@@ -30,9 +31,9 @@ interface CreateReservationSignature {
      * @param - Options for creating the reservation.
      * @returns Reservation.
      */
-    (reservation: Reservation, options?: CreateReservationOptions | undefined): Promise<Reservation & {
-        __applicationErrorsType?: CreateReservationApplicationErrors | undefined;
-        __validationErrorsType?: CreateReservationValidationErrors | undefined;
+    (reservation: NonNullablePaths<Reservation, `details` | `details.partySize` | `details.reservationLocationId` | `details.startDate`>, options?: CreateReservationOptions): Promise<NonNullablePaths<Reservation, ReservationNonNullablePaths> & {
+        __applicationErrorsType?: CreateReservationApplicationErrors;
+        __validationErrorsType?: CreateReservationValidationErrors;
     }>;
 }
 declare function getReservation$1(httpClient: HttpClient): GetReservationSignature;
@@ -44,7 +45,7 @@ interface GetReservationSignature {
      * @param - Reservation ID.
      * @returns Reservation.
      */
-    (reservationId: string, options?: GetReservationOptions | undefined): Promise<Reservation>;
+    (reservationId: string, options?: GetReservationOptions): Promise<NonNullablePaths<Reservation, ReservationNonNullablePaths>>;
 }
 declare function updateReservation$1(httpClient: HttpClient): UpdateReservationSignature;
 interface UpdateReservationSignature {
@@ -59,9 +60,9 @@ interface UpdateReservationSignature {
      * @param - Reservation information to update.
      * @returns Reservation.
      */
-    (_id: string, reservation: UpdateReservation, options?: UpdateReservationOptions | undefined): Promise<Reservation & {
-        __applicationErrorsType?: UpdateReservationApplicationErrors | undefined;
-        __validationErrorsType?: UpdateReservationValidationErrors | undefined;
+    (_id: string, reservation: NonNullablePaths<UpdateReservation, `revision`>, options?: UpdateReservationOptions): Promise<NonNullablePaths<Reservation, ReservationNonNullablePaths> & {
+        __applicationErrorsType?: UpdateReservationApplicationErrors;
+        __validationErrorsType?: UpdateReservationValidationErrors;
     }>;
 }
 declare function createHeldReservation$1(httpClient: HttpClient): CreateHeldReservationSignature;
@@ -77,8 +78,10 @@ interface CreateHeldReservationSignature {
      *
      * @param - Held reservation information to update.
      */
-    (reservationDetails: HeldReservationDetails): Promise<CreateHeldReservationResponse & {
-        __applicationErrorsType?: CreateHeldReservationApplicationErrors | undefined;
+    (reservationDetails: NonNullablePaths<HeldReservationDetails, `partySize` | `reservationLocationId` | `startDate`>): Promise<NonNullablePaths<CreateHeldReservationResponse, {
+        [P in ReservationNonNullablePaths]: `reservation.${P}`;
+    }[ReservationNonNullablePaths]> & {
+        __applicationErrorsType?: CreateHeldReservationApplicationErrors;
     }>;
 }
 declare function reserveReservation$1(httpClient: HttpClient): ReserveReservationSignature;
@@ -99,8 +102,10 @@ interface ReserveReservationSignature {
      *
      * Specify the existing `revision` to prevent conflicting updates to reservations.
      */
-    (reservationId: string, reservee: Reservee, revision: string): Promise<ReserveReservationResponse & {
-        __applicationErrorsType?: ReserveReservationApplicationErrors | undefined;
+    (reservationId: string, reservee: NonNullablePaths<Reservee, `firstName` | `phone`>, revision: string): Promise<NonNullablePaths<ReserveReservationResponse, {
+        [P in ReservationNonNullablePaths]: `reservation.${P}`;
+    }[ReservationNonNullablePaths]> & {
+        __applicationErrorsType?: ReserveReservationApplicationErrors;
     }>;
 }
 declare function cancelReservation$1(httpClient: HttpClient): CancelReservationSignature;
@@ -115,8 +120,10 @@ interface CancelReservationSignature {
      * Specify the existing `revision` to prevent conflicting updates to reservations.
      * @param - Options for canceling the reservation.
      */
-    (reservationId: string, revision: string, options?: CancelReservationOptions | undefined): Promise<CancelReservationResponse & {
-        __applicationErrorsType?: CancelReservationApplicationErrors | undefined;
+    (reservationId: string, revision: string, options?: CancelReservationOptions): Promise<NonNullablePaths<CancelReservationResponse, {
+        [P in ReservationNonNullablePaths]: `reservation.${P}`;
+    }[ReservationNonNullablePaths]> & {
+        __applicationErrorsType?: CancelReservationApplicationErrors;
     }>;
 }
 declare function deleteReservation$1(httpClient: HttpClient): DeleteReservationSignature;
@@ -133,7 +140,9 @@ interface ListReservationsSignature {
      * Retrieves a list of up to 100 reservations.
      * @param - Options for listing the reservations.
      */
-    (options?: ListReservationsOptions | undefined): Promise<ListReservationsResponse>;
+    (options?: ListReservationsOptions): Promise<NonNullablePaths<ListReservationsResponse, {
+        [P in ReservationNonNullablePaths]: `reservations.${number}.${P}`;
+    }[ReservationNonNullablePaths]>>;
 }
 declare function queryReservations$1(httpClient: HttpClient): QueryReservationsSignature;
 interface QueryReservationsSignature {
@@ -164,7 +173,9 @@ interface SearchReservationsSignature {
      * For a detailed list of supported operations, see the [Sorting, Filtering, and Search](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/reservations/reservations/sorting-filtering-and-search) article.
      * @param - Search query.
      */
-    (search: ReservationSearch): Promise<SearchReservationsResponse>;
+    (search: ReservationSearch): Promise<NonNullablePaths<SearchReservationsResponse, {
+        [P in ReservationNonNullablePaths]: `reservations.${number}.${P}`;
+    }[ReservationNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
 }
 declare function bulkArchiveReservations$1(httpClient: HttpClient): BulkArchiveReservationsSignature;
 interface BulkArchiveReservationsSignature {
@@ -172,7 +183,7 @@ interface BulkArchiveReservationsSignature {
      * Bulk archive reservations.
      * @param - Reservation IDs to archive.
      */
-    (reservationIds: string[]): Promise<BulkArchiveReservationsResponse>;
+    (reservationIds: string[]): Promise<NonNullablePaths<BulkArchiveReservationsResponse, `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`>>;
 }
 declare function bulkUnArchiveReservations$1(httpClient: HttpClient): BulkUnArchiveReservationsSignature;
 interface BulkUnArchiveReservationsSignature {
@@ -180,7 +191,7 @@ interface BulkUnArchiveReservationsSignature {
      * Bulk unarchive reservations.
      * @param - Reservation IDs to unarchive.
      */
-    (reservationIds: string[]): Promise<BulkUnArchiveReservationsResponse>;
+    (reservationIds: string[]): Promise<NonNullablePaths<BulkUnArchiveReservationsResponse, `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`>>;
 }
 declare const onReservationCreated$1: EventDefinition<ReservationCreatedEnvelope, "wix.table_reservations.v1.reservation_created">;
 declare const onReservationDeleted$1: EventDefinition<ReservationDeletedEnvelope, "wix.table_reservations.v1.reservation_deleted">;