@wix/bookings 1.0.452 → 1.0.454
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/bookings",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.454",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -26,12 +26,12 @@
|
|
|
26
26
|
"@wix/bookings_booking-policy-snapshots": "1.0.1",
|
|
27
27
|
"@wix/bookings_bookings": "1.0.57",
|
|
28
28
|
"@wix/bookings_categories": "1.0.37",
|
|
29
|
-
"@wix/bookings_extended-bookings": "1.0.
|
|
29
|
+
"@wix/bookings_extended-bookings": "1.0.48",
|
|
30
30
|
"@wix/bookings_external-calendars": "1.0.34",
|
|
31
31
|
"@wix/bookings_multi-service-availability-time-slots": "1.0.31",
|
|
32
32
|
"@wix/bookings_pricing": "1.0.37",
|
|
33
33
|
"@wix/bookings_resource-types": "1.0.3",
|
|
34
|
-
"@wix/bookings_resources": "1.0.
|
|
34
|
+
"@wix/bookings_resources": "1.0.43",
|
|
35
35
|
"@wix/bookings_service-options-and-variants": "1.0.46",
|
|
36
36
|
"@wix/bookings_services": "1.0.70",
|
|
37
37
|
"@wix/bookings_staff-members": "1.0.7"
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"fqdn": ""
|
|
60
60
|
}
|
|
61
61
|
},
|
|
62
|
-
"falconPackageHash": "
|
|
62
|
+
"falconPackageHash": "521044b9fac64e05d8dda18eac542452a6915e8b0abe0efc052e8c6e"
|
|
63
63
|
}
|
|
@@ -8834,7 +8834,7 @@ declare enum BookingFeeStatus {
|
|
|
8834
8834
|
}
|
|
8835
8835
|
interface QueryExtendedBookingRequest {
|
|
8836
8836
|
/** Information about filters, paging, and sorting. */
|
|
8837
|
-
query
|
|
8837
|
+
query: QueryV2$3;
|
|
8838
8838
|
/**
|
|
8839
8839
|
* Whether information about which actions the customer can perform
|
|
8840
8840
|
* for the bookings is returned.
|
|
@@ -9106,9 +9106,33 @@ interface ExtendedBookingNonNullableFields {
|
|
|
9106
9106
|
attendance?: AttendanceNonNullableFields$1;
|
|
9107
9107
|
bookingFeeDetails?: BookingFeeDetailsNonNullableFields;
|
|
9108
9108
|
}
|
|
9109
|
+
interface QueryExtendedBookingResponseNonNullableFields {
|
|
9110
|
+
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
9111
|
+
}
|
|
9109
9112
|
interface QueryExtendedBookingsResponseNonNullableFields {
|
|
9110
9113
|
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
9111
9114
|
}
|
|
9115
|
+
interface QueryOptions {
|
|
9116
|
+
/**
|
|
9117
|
+
* Whether information about which actions the customer can perform
|
|
9118
|
+
* for the bookings is returned.
|
|
9119
|
+
*/
|
|
9120
|
+
withBookingAllowedActions?: boolean;
|
|
9121
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
9122
|
+
withBookingAttendanceInfo?: boolean;
|
|
9123
|
+
/**
|
|
9124
|
+
* Filters the retrieved bookings by the booking ID that corresponds to
|
|
9125
|
+
* specified `sessionId`. The `booking.id` is calculated by calling
|
|
9126
|
+
* [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)
|
|
9127
|
+
* and saving the returned values for `participants.Id`.
|
|
9128
|
+
* These participant IDs are then used as `booking.id`.
|
|
9129
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
9130
|
+
*
|
|
9131
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
9132
|
+
* bookings, you must use this field to filter by session ID.
|
|
9133
|
+
*/
|
|
9134
|
+
sessionId?: string | null;
|
|
9135
|
+
}
|
|
9112
9136
|
interface QueryExtendedBookingsOptions {
|
|
9113
9137
|
/**
|
|
9114
9138
|
* Whether information about which actions the customer can perform
|
|
@@ -9121,6 +9145,55 @@ interface QueryExtendedBookingsOptions {
|
|
|
9121
9145
|
withBookingConferencingDetails?: boolean;
|
|
9122
9146
|
}
|
|
9123
9147
|
|
|
9148
|
+
declare function query$1(httpClient: HttpClient): QuerySignature;
|
|
9149
|
+
interface QuerySignature {
|
|
9150
|
+
/**
|
|
9151
|
+
* > **Deprecation Notice**
|
|
9152
|
+
* >
|
|
9153
|
+
* > **This endpoint has been replaced with [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) and will be removed on May 31, 2025.**
|
|
9154
|
+
* > **If your app uses this endpoint, we recommend updating your code as soon as possible.**
|
|
9155
|
+
*
|
|
9156
|
+
*
|
|
9157
|
+
* Retrieves a list of bookings, given the provided paging, filtering, and sorting.
|
|
9158
|
+
*
|
|
9159
|
+
*
|
|
9160
|
+
* You can also retrieve information about which actions the customer can perform
|
|
9161
|
+
* for the bookings. To do so, pass `withBookingAllowedActions` as `true`.
|
|
9162
|
+
*
|
|
9163
|
+
* Query Bookings runs with these defaults:
|
|
9164
|
+
*
|
|
9165
|
+
* - `createdDate` sorted in `DESC` order
|
|
9166
|
+
* - `cursorPaging.limit` is `50`
|
|
9167
|
+
*
|
|
9168
|
+
* You can check the overview about all
|
|
9169
|
+
* [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/supported-filters)
|
|
9170
|
+
* for more information.
|
|
9171
|
+
*
|
|
9172
|
+
* `query.fields` and `query.fieldsets` aren't supported for this endpoint.
|
|
9173
|
+
*
|
|
9174
|
+
* You can only specify a filter only once per query. If a filter is provided
|
|
9175
|
+
* more than once, only the first occurrence affects the returned bookings.
|
|
9176
|
+
*
|
|
9177
|
+
* When using filters for dates, you must use [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
9178
|
+
*
|
|
9179
|
+
* Bookings belonging to a schedule don't have a `sessionId`. Therefore you
|
|
9180
|
+
* must use the `sessionId` filter that isn't part of the `query` object to
|
|
9181
|
+
* filter bookings for courses.
|
|
9182
|
+
*
|
|
9183
|
+
* To learn about working with _Query_ endpoints, see
|
|
9184
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
9185
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),
|
|
9186
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
9187
|
+
*
|
|
9188
|
+
* When calling Query Bookings, the retrieved data may not contain your most recent changes. See
|
|
9189
|
+
* [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency)
|
|
9190
|
+
* for more information.
|
|
9191
|
+
* @param - Information about filters, paging, and sorting.
|
|
9192
|
+
* @param - Additional options for performing the query.
|
|
9193
|
+
* @deprecated
|
|
9194
|
+
*/
|
|
9195
|
+
(query: QueryV2$3, options?: QueryOptions | undefined): Promise<QueryExtendedBookingResponse & QueryExtendedBookingResponseNonNullableFields>;
|
|
9196
|
+
}
|
|
9124
9197
|
declare function queryExtendedBookings$1(httpClient: HttpClient): QueryExtendedBookingsSignature;
|
|
9125
9198
|
interface QueryExtendedBookingsSignature {
|
|
9126
9199
|
/**
|
|
@@ -9152,6 +9225,7 @@ interface QueryExtendedBookingsSignature {
|
|
|
9152
9225
|
(query: CommonQueryV2, options?: QueryExtendedBookingsOptions | undefined): Promise<QueryExtendedBookingsResponse & QueryExtendedBookingsResponseNonNullableFields>;
|
|
9153
9226
|
}
|
|
9154
9227
|
|
|
9228
|
+
declare const query: MaybeContext<BuildRESTFunction<typeof query$1> & typeof query$1>;
|
|
9155
9229
|
declare const queryExtendedBookings: MaybeContext<BuildRESTFunction<typeof queryExtendedBookings$1> & typeof queryExtendedBookings$1>;
|
|
9156
9230
|
|
|
9157
9231
|
type context$9_BookingFeeDetails = BookingFeeDetails;
|
|
@@ -9164,13 +9238,16 @@ type context$9_ConferencingDetails = ConferencingDetails;
|
|
|
9164
9238
|
type context$9_ExtendedBooking = ExtendedBooking;
|
|
9165
9239
|
type context$9_QueryExtendedBookingRequest = QueryExtendedBookingRequest;
|
|
9166
9240
|
type context$9_QueryExtendedBookingResponse = QueryExtendedBookingResponse;
|
|
9241
|
+
type context$9_QueryExtendedBookingResponseNonNullableFields = QueryExtendedBookingResponseNonNullableFields;
|
|
9167
9242
|
type context$9_QueryExtendedBookingsOptions = QueryExtendedBookingsOptions;
|
|
9168
9243
|
type context$9_QueryExtendedBookingsRequest = QueryExtendedBookingsRequest;
|
|
9169
9244
|
type context$9_QueryExtendedBookingsResponse = QueryExtendedBookingsResponse;
|
|
9170
9245
|
type context$9_QueryExtendedBookingsResponseNonNullableFields = QueryExtendedBookingsResponseNonNullableFields;
|
|
9246
|
+
type context$9_QueryOptions = QueryOptions;
|
|
9247
|
+
declare const context$9_query: typeof query;
|
|
9171
9248
|
declare const context$9_queryExtendedBookings: typeof queryExtendedBookings;
|
|
9172
9249
|
declare namespace context$9 {
|
|
9173
|
-
export { Actor$2 as Actor, type Address$5 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type AllowedActions$1 as AllowedActions, type Attendance$1 as Attendance, AttendanceStatus$1 as AttendanceStatus, type BookedEntity$2 as BookedEntity, type BookedEntityItemOneOf$2 as BookedEntityItemOneOf, type BookedResource$2 as BookedResource, type BookedSchedule$2 as BookedSchedule, type BookedSlot$2 as BookedSlot, type Booking$2 as Booking, type context$9_BookingFeeDetails as BookingFeeDetails, context$9_BookingFeeStatus as BookingFeeStatus, type BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf, type BookingPolicySettings$1 as BookingPolicySettings, type BookingSource$2 as BookingSource, BookingStatus$2 as BookingStatus, type context$9_CommonPaging as CommonPaging, type context$9_CommonQueryV2 as CommonQueryV2, type context$9_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, type context$9_ConferencingDetails as ConferencingDetails, type ContactDetails$2 as ContactDetails, type CursorPaging$7 as CursorPaging, type Cursors$7 as Cursors, type CustomFormField$2 as CustomFormField, type context$9_ExtendedBooking as ExtendedBooking, type ExtendedFields$7 as ExtendedFields, type FlowControlSettings$2 as FlowControlSettings, type IdentificationData$9 as IdentificationData, type IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type Location$4 as Location, LocationType$4 as LocationType, type MultiServiceBookingInfo$2 as MultiServiceBookingInfo, MultiServiceBookingType$2 as MultiServiceBookingType, type Paging$3 as Paging, type PagingMetadataV2$2 as PagingMetadataV2, type ParticipantChoices$2 as ParticipantChoices, type ParticipantNotification$5 as ParticipantNotification, PaymentStatus$2 as PaymentStatus, Platform$2 as Platform, type context$9_QueryExtendedBookingRequest as QueryExtendedBookingRequest, type context$9_QueryExtendedBookingResponse as QueryExtendedBookingResponse, type context$9_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions, type context$9_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest, type context$9_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse, type context$9_QueryExtendedBookingsResponseNonNullableFields as QueryExtendedBookingsResponseNonNullableFields, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, SelectedPaymentOption$2 as SelectedPaymentOption, type ServiceChoice$2 as ServiceChoice, type ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf, type ServiceChoices$2 as ServiceChoices, SortOrder$7 as SortOrder, type Sorting$7 as Sorting, type StreetAddress$4 as StreetAddress, type Subdivision$4 as Subdivision, ValueType$2 as ValueType, context$9_queryExtendedBookings as queryExtendedBookings };
|
|
9250
|
+
export { Actor$2 as Actor, type Address$5 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type AllowedActions$1 as AllowedActions, type Attendance$1 as Attendance, AttendanceStatus$1 as AttendanceStatus, type BookedEntity$2 as BookedEntity, type BookedEntityItemOneOf$2 as BookedEntityItemOneOf, type BookedResource$2 as BookedResource, type BookedSchedule$2 as BookedSchedule, type BookedSlot$2 as BookedSlot, type Booking$2 as Booking, type context$9_BookingFeeDetails as BookingFeeDetails, context$9_BookingFeeStatus as BookingFeeStatus, type BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf, type BookingPolicySettings$1 as BookingPolicySettings, type BookingSource$2 as BookingSource, BookingStatus$2 as BookingStatus, type context$9_CommonPaging as CommonPaging, type context$9_CommonQueryV2 as CommonQueryV2, type context$9_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, type context$9_ConferencingDetails as ConferencingDetails, type ContactDetails$2 as ContactDetails, type CursorPaging$7 as CursorPaging, type Cursors$7 as Cursors, type CustomFormField$2 as CustomFormField, type context$9_ExtendedBooking as ExtendedBooking, type ExtendedFields$7 as ExtendedFields, type FlowControlSettings$2 as FlowControlSettings, type IdentificationData$9 as IdentificationData, type IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type Location$4 as Location, LocationType$4 as LocationType, type MultiServiceBookingInfo$2 as MultiServiceBookingInfo, MultiServiceBookingType$2 as MultiServiceBookingType, type Paging$3 as Paging, type PagingMetadataV2$2 as PagingMetadataV2, type ParticipantChoices$2 as ParticipantChoices, type ParticipantNotification$5 as ParticipantNotification, PaymentStatus$2 as PaymentStatus, Platform$2 as Platform, type context$9_QueryExtendedBookingRequest as QueryExtendedBookingRequest, type context$9_QueryExtendedBookingResponse as QueryExtendedBookingResponse, type context$9_QueryExtendedBookingResponseNonNullableFields as QueryExtendedBookingResponseNonNullableFields, type context$9_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions, type context$9_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest, type context$9_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse, type context$9_QueryExtendedBookingsResponseNonNullableFields as QueryExtendedBookingsResponseNonNullableFields, type context$9_QueryOptions as QueryOptions, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, SelectedPaymentOption$2 as SelectedPaymentOption, type ServiceChoice$2 as ServiceChoice, type ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf, type ServiceChoices$2 as ServiceChoices, SortOrder$7 as SortOrder, type Sorting$7 as Sorting, type StreetAddress$4 as StreetAddress, type Subdivision$4 as Subdivision, ValueType$2 as ValueType, context$9_query as query, context$9_queryExtendedBookings as queryExtendedBookings };
|
|
9174
9251
|
}
|
|
9175
9252
|
|
|
9176
9253
|
/**
|
|
@@ -8834,7 +8834,7 @@ declare enum BookingFeeStatus {
|
|
|
8834
8834
|
}
|
|
8835
8835
|
interface QueryExtendedBookingRequest {
|
|
8836
8836
|
/** Information about filters, paging, and sorting. */
|
|
8837
|
-
query
|
|
8837
|
+
query: QueryV2$3;
|
|
8838
8838
|
/**
|
|
8839
8839
|
* Whether information about which actions the customer can perform
|
|
8840
8840
|
* for the bookings is returned.
|
|
@@ -9106,9 +9106,33 @@ interface ExtendedBookingNonNullableFields {
|
|
|
9106
9106
|
attendance?: AttendanceNonNullableFields$1;
|
|
9107
9107
|
bookingFeeDetails?: BookingFeeDetailsNonNullableFields;
|
|
9108
9108
|
}
|
|
9109
|
+
interface QueryExtendedBookingResponseNonNullableFields {
|
|
9110
|
+
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
9111
|
+
}
|
|
9109
9112
|
interface QueryExtendedBookingsResponseNonNullableFields {
|
|
9110
9113
|
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
9111
9114
|
}
|
|
9115
|
+
interface QueryOptions {
|
|
9116
|
+
/**
|
|
9117
|
+
* Whether information about which actions the customer can perform
|
|
9118
|
+
* for the bookings is returned.
|
|
9119
|
+
*/
|
|
9120
|
+
withBookingAllowedActions?: boolean;
|
|
9121
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
9122
|
+
withBookingAttendanceInfo?: boolean;
|
|
9123
|
+
/**
|
|
9124
|
+
* Filters the retrieved bookings by the booking ID that corresponds to
|
|
9125
|
+
* specified `sessionId`. The `booking.id` is calculated by calling
|
|
9126
|
+
* [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)
|
|
9127
|
+
* and saving the returned values for `participants.Id`.
|
|
9128
|
+
* These participant IDs are then used as `booking.id`.
|
|
9129
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
9130
|
+
*
|
|
9131
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
9132
|
+
* bookings, you must use this field to filter by session ID.
|
|
9133
|
+
*/
|
|
9134
|
+
sessionId?: string | null;
|
|
9135
|
+
}
|
|
9112
9136
|
interface QueryExtendedBookingsOptions {
|
|
9113
9137
|
/**
|
|
9114
9138
|
* Whether information about which actions the customer can perform
|
|
@@ -9121,6 +9145,55 @@ interface QueryExtendedBookingsOptions {
|
|
|
9121
9145
|
withBookingConferencingDetails?: boolean;
|
|
9122
9146
|
}
|
|
9123
9147
|
|
|
9148
|
+
declare function query$1(httpClient: HttpClient): QuerySignature;
|
|
9149
|
+
interface QuerySignature {
|
|
9150
|
+
/**
|
|
9151
|
+
* > **Deprecation Notice**
|
|
9152
|
+
* >
|
|
9153
|
+
* > **This endpoint has been replaced with [Query Extended Bookings](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings) and will be removed on May 31, 2025.**
|
|
9154
|
+
* > **If your app uses this endpoint, we recommend updating your code as soon as possible.**
|
|
9155
|
+
*
|
|
9156
|
+
*
|
|
9157
|
+
* Retrieves a list of bookings, given the provided paging, filtering, and sorting.
|
|
9158
|
+
*
|
|
9159
|
+
*
|
|
9160
|
+
* You can also retrieve information about which actions the customer can perform
|
|
9161
|
+
* for the bookings. To do so, pass `withBookingAllowedActions` as `true`.
|
|
9162
|
+
*
|
|
9163
|
+
* Query Bookings runs with these defaults:
|
|
9164
|
+
*
|
|
9165
|
+
* - `createdDate` sorted in `DESC` order
|
|
9166
|
+
* - `cursorPaging.limit` is `50`
|
|
9167
|
+
*
|
|
9168
|
+
* You can check the overview about all
|
|
9169
|
+
* [supported filters](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/supported-filters)
|
|
9170
|
+
* for more information.
|
|
9171
|
+
*
|
|
9172
|
+
* `query.fields` and `query.fieldsets` aren't supported for this endpoint.
|
|
9173
|
+
*
|
|
9174
|
+
* You can only specify a filter only once per query. If a filter is provided
|
|
9175
|
+
* more than once, only the first occurrence affects the returned bookings.
|
|
9176
|
+
*
|
|
9177
|
+
* When using filters for dates, you must use [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
9178
|
+
*
|
|
9179
|
+
* Bookings belonging to a schedule don't have a `sessionId`. Therefore you
|
|
9180
|
+
* must use the `sessionId` filter that isn't part of the `query` object to
|
|
9181
|
+
* filter bookings for courses.
|
|
9182
|
+
*
|
|
9183
|
+
* To learn about working with _Query_ endpoints, see
|
|
9184
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
9185
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging),
|
|
9186
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
9187
|
+
*
|
|
9188
|
+
* When calling Query Bookings, the retrieved data may not contain your most recent changes. See
|
|
9189
|
+
* [Wix-data and Eventual Consistency](reference/wix-data/introduction#wix-data_introduction_wix-data-and-eventual-consistency)
|
|
9190
|
+
* for more information.
|
|
9191
|
+
* @param - Information about filters, paging, and sorting.
|
|
9192
|
+
* @param - Additional options for performing the query.
|
|
9193
|
+
* @deprecated
|
|
9194
|
+
*/
|
|
9195
|
+
(query: QueryV2$3, options?: QueryOptions | undefined): Promise<QueryExtendedBookingResponse & QueryExtendedBookingResponseNonNullableFields>;
|
|
9196
|
+
}
|
|
9124
9197
|
declare function queryExtendedBookings$1(httpClient: HttpClient): QueryExtendedBookingsSignature;
|
|
9125
9198
|
interface QueryExtendedBookingsSignature {
|
|
9126
9199
|
/**
|
|
@@ -9152,6 +9225,7 @@ interface QueryExtendedBookingsSignature {
|
|
|
9152
9225
|
(query: CommonQueryV2, options?: QueryExtendedBookingsOptions | undefined): Promise<QueryExtendedBookingsResponse & QueryExtendedBookingsResponseNonNullableFields>;
|
|
9153
9226
|
}
|
|
9154
9227
|
|
|
9228
|
+
declare const query: MaybeContext<BuildRESTFunction<typeof query$1> & typeof query$1>;
|
|
9155
9229
|
declare const queryExtendedBookings: MaybeContext<BuildRESTFunction<typeof queryExtendedBookings$1> & typeof queryExtendedBookings$1>;
|
|
9156
9230
|
|
|
9157
9231
|
type index_d$9_BookingFeeDetails = BookingFeeDetails;
|
|
@@ -9164,13 +9238,16 @@ type index_d$9_ConferencingDetails = ConferencingDetails;
|
|
|
9164
9238
|
type index_d$9_ExtendedBooking = ExtendedBooking;
|
|
9165
9239
|
type index_d$9_QueryExtendedBookingRequest = QueryExtendedBookingRequest;
|
|
9166
9240
|
type index_d$9_QueryExtendedBookingResponse = QueryExtendedBookingResponse;
|
|
9241
|
+
type index_d$9_QueryExtendedBookingResponseNonNullableFields = QueryExtendedBookingResponseNonNullableFields;
|
|
9167
9242
|
type index_d$9_QueryExtendedBookingsOptions = QueryExtendedBookingsOptions;
|
|
9168
9243
|
type index_d$9_QueryExtendedBookingsRequest = QueryExtendedBookingsRequest;
|
|
9169
9244
|
type index_d$9_QueryExtendedBookingsResponse = QueryExtendedBookingsResponse;
|
|
9170
9245
|
type index_d$9_QueryExtendedBookingsResponseNonNullableFields = QueryExtendedBookingsResponseNonNullableFields;
|
|
9246
|
+
type index_d$9_QueryOptions = QueryOptions;
|
|
9247
|
+
declare const index_d$9_query: typeof query;
|
|
9171
9248
|
declare const index_d$9_queryExtendedBookings: typeof queryExtendedBookings;
|
|
9172
9249
|
declare namespace index_d$9 {
|
|
9173
|
-
export { Actor$2 as Actor, type Address$5 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type AllowedActions$1 as AllowedActions, type Attendance$1 as Attendance, AttendanceStatus$1 as AttendanceStatus, type BookedEntity$2 as BookedEntity, type BookedEntityItemOneOf$2 as BookedEntityItemOneOf, type BookedResource$2 as BookedResource, type BookedSchedule$2 as BookedSchedule, type BookedSlot$2 as BookedSlot, type Booking$2 as Booking, type index_d$9_BookingFeeDetails as BookingFeeDetails, index_d$9_BookingFeeStatus as BookingFeeStatus, type BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf, type BookingPolicySettings$1 as BookingPolicySettings, type BookingSource$2 as BookingSource, BookingStatus$2 as BookingStatus, type index_d$9_CommonPaging as CommonPaging, type index_d$9_CommonQueryV2 as CommonQueryV2, type index_d$9_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, type index_d$9_ConferencingDetails as ConferencingDetails, type ContactDetails$2 as ContactDetails, type CursorPaging$7 as CursorPaging, type Cursors$7 as Cursors, type CustomFormField$2 as CustomFormField, type index_d$9_ExtendedBooking as ExtendedBooking, type ExtendedFields$7 as ExtendedFields, type FlowControlSettings$2 as FlowControlSettings, type IdentificationData$9 as IdentificationData, type IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type Location$4 as Location, LocationType$4 as LocationType, type MultiServiceBookingInfo$2 as MultiServiceBookingInfo, MultiServiceBookingType$2 as MultiServiceBookingType, type Paging$3 as Paging, type PagingMetadataV2$2 as PagingMetadataV2, type ParticipantChoices$2 as ParticipantChoices, type ParticipantNotification$5 as ParticipantNotification, PaymentStatus$2 as PaymentStatus, Platform$2 as Platform, type index_d$9_QueryExtendedBookingRequest as QueryExtendedBookingRequest, type index_d$9_QueryExtendedBookingResponse as QueryExtendedBookingResponse, type index_d$9_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions, type index_d$9_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest, type index_d$9_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse, type index_d$9_QueryExtendedBookingsResponseNonNullableFields as QueryExtendedBookingsResponseNonNullableFields, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, SelectedPaymentOption$2 as SelectedPaymentOption, type ServiceChoice$2 as ServiceChoice, type ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf, type ServiceChoices$2 as ServiceChoices, SortOrder$7 as SortOrder, type Sorting$7 as Sorting, type StreetAddress$4 as StreetAddress, type Subdivision$4 as Subdivision, ValueType$2 as ValueType, index_d$9_queryExtendedBookings as queryExtendedBookings };
|
|
9250
|
+
export { Actor$2 as Actor, type Address$5 as Address, type AddressLocation$4 as AddressLocation, type AddressStreetOneOf$4 as AddressStreetOneOf, type AllowedActions$1 as AllowedActions, type Attendance$1 as Attendance, AttendanceStatus$1 as AttendanceStatus, type BookedEntity$2 as BookedEntity, type BookedEntityItemOneOf$2 as BookedEntityItemOneOf, type BookedResource$2 as BookedResource, type BookedSchedule$2 as BookedSchedule, type BookedSlot$2 as BookedSlot, type Booking$2 as Booking, type index_d$9_BookingFeeDetails as BookingFeeDetails, index_d$9_BookingFeeStatus as BookingFeeStatus, type BookingParticipantsInfoOneOf$2 as BookingParticipantsInfoOneOf, type BookingPolicySettings$1 as BookingPolicySettings, type BookingSource$2 as BookingSource, BookingStatus$2 as BookingStatus, type index_d$9_CommonPaging as CommonPaging, type index_d$9_CommonQueryV2 as CommonQueryV2, type index_d$9_CommonQueryV2PagingMethodOneOf as CommonQueryV2PagingMethodOneOf, type index_d$9_ConferencingDetails as ConferencingDetails, type ContactDetails$2 as ContactDetails, type CursorPaging$7 as CursorPaging, type Cursors$7 as Cursors, type CustomFormField$2 as CustomFormField, type index_d$9_ExtendedBooking as ExtendedBooking, type ExtendedFields$7 as ExtendedFields, type FlowControlSettings$2 as FlowControlSettings, type IdentificationData$9 as IdentificationData, type IdentificationDataIdOneOf$9 as IdentificationDataIdOneOf, IdentityType$3 as IdentityType, type Location$4 as Location, LocationType$4 as LocationType, type MultiServiceBookingInfo$2 as MultiServiceBookingInfo, MultiServiceBookingType$2 as MultiServiceBookingType, type Paging$3 as Paging, type PagingMetadataV2$2 as PagingMetadataV2, type ParticipantChoices$2 as ParticipantChoices, type ParticipantNotification$5 as ParticipantNotification, PaymentStatus$2 as PaymentStatus, Platform$2 as Platform, type index_d$9_QueryExtendedBookingRequest as QueryExtendedBookingRequest, type index_d$9_QueryExtendedBookingResponse as QueryExtendedBookingResponse, type index_d$9_QueryExtendedBookingResponseNonNullableFields as QueryExtendedBookingResponseNonNullableFields, type index_d$9_QueryExtendedBookingsOptions as QueryExtendedBookingsOptions, type index_d$9_QueryExtendedBookingsRequest as QueryExtendedBookingsRequest, type index_d$9_QueryExtendedBookingsResponse as QueryExtendedBookingsResponse, type index_d$9_QueryExtendedBookingsResponseNonNullableFields as QueryExtendedBookingsResponseNonNullableFields, type index_d$9_QueryOptions as QueryOptions, type QueryV2$3 as QueryV2, type QueryV2PagingMethodOneOf$3 as QueryV2PagingMethodOneOf, SelectedPaymentOption$2 as SelectedPaymentOption, type ServiceChoice$2 as ServiceChoice, type ServiceChoiceChoiceOneOf$2 as ServiceChoiceChoiceOneOf, type ServiceChoices$2 as ServiceChoices, SortOrder$7 as SortOrder, type Sorting$7 as Sorting, type StreetAddress$4 as StreetAddress, type Subdivision$4 as Subdivision, ValueType$2 as ValueType, index_d$9_query as query, index_d$9_queryExtendedBookings as queryExtendedBookings };
|
|
9174
9251
|
}
|
|
9175
9252
|
|
|
9176
9253
|
/**
|
|
@@ -126,7 +126,7 @@ interface BookingPolicyViolations$7 {
|
|
|
126
126
|
}
|
|
127
127
|
interface QueryAvailabilityRequest$1 {
|
|
128
128
|
/** Query options. */
|
|
129
|
-
query: QueryV2$
|
|
129
|
+
query: QueryV2$9;
|
|
130
130
|
/**
|
|
131
131
|
* The timezone for which session availability is to be calculated. If specified,
|
|
132
132
|
* dates are based on the local date/time, meaning that the timezone offset
|
|
@@ -148,7 +148,7 @@ interface QueryAvailabilityRequest$1 {
|
|
|
148
148
|
*/
|
|
149
149
|
slotsPerDay?: number | null;
|
|
150
150
|
}
|
|
151
|
-
interface QueryV2$
|
|
151
|
+
interface QueryV2$9 extends QueryV2PagingMethodOneOf$9 {
|
|
152
152
|
/**
|
|
153
153
|
* Filter object. For a list of
|
|
154
154
|
* fields you can filter by, see [Calendar Availability: Supported Fields, Filters, and Sorting](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/supported-fields,-filters,-and-sorting).
|
|
@@ -163,7 +163,7 @@ interface QueryV2$7 extends QueryV2PagingMethodOneOf$7 {
|
|
|
163
163
|
sort?: Sorting$h[];
|
|
164
164
|
}
|
|
165
165
|
/** @oneof */
|
|
166
|
-
interface QueryV2PagingMethodOneOf$
|
|
166
|
+
interface QueryV2PagingMethodOneOf$9 {
|
|
167
167
|
}
|
|
168
168
|
interface Sorting$h {
|
|
169
169
|
/** Name of the field to sort by. */
|
|
@@ -429,7 +429,7 @@ interface BookingPolicyViolations$6 {
|
|
|
429
429
|
}
|
|
430
430
|
interface QueryAvailabilityRequest {
|
|
431
431
|
/** Query options. */
|
|
432
|
-
query: QueryV2$
|
|
432
|
+
query: QueryV2$8;
|
|
433
433
|
/**
|
|
434
434
|
* The timezone for which slot availability is to be calculated. If specified,
|
|
435
435
|
* dates are based on the local date/time, meaning that the timezone offset
|
|
@@ -447,7 +447,7 @@ interface QueryAvailabilityRequest {
|
|
|
447
447
|
*/
|
|
448
448
|
slotsPerDay?: number | null;
|
|
449
449
|
}
|
|
450
|
-
interface QueryV2$
|
|
450
|
+
interface QueryV2$8 extends QueryV2PagingMethodOneOf$8 {
|
|
451
451
|
/**
|
|
452
452
|
* Filter object. You must include `serviceId`, `startDate` and `endDate` in the filter. This avoids large results that can impact performance.
|
|
453
453
|
*/
|
|
@@ -456,7 +456,7 @@ interface QueryV2$6 extends QueryV2PagingMethodOneOf$6 {
|
|
|
456
456
|
sort?: Sorting$g[];
|
|
457
457
|
}
|
|
458
458
|
/** @oneof */
|
|
459
|
-
interface QueryV2PagingMethodOneOf$
|
|
459
|
+
interface QueryV2PagingMethodOneOf$8 {
|
|
460
460
|
}
|
|
461
461
|
interface Sorting$g {
|
|
462
462
|
/** Name of the field to sort by. */
|
|
@@ -3574,11 +3574,11 @@ interface DeleteServiceOptionsAndVariantsResponse$1 {
|
|
|
3574
3574
|
}
|
|
3575
3575
|
interface QueryServiceOptionsAndVariantsRequest$1 {
|
|
3576
3576
|
/** Information about filters, paging, and returned fields. */
|
|
3577
|
-
query: QueryV2$
|
|
3577
|
+
query: QueryV2$7;
|
|
3578
3578
|
}
|
|
3579
|
-
interface QueryV2$
|
|
3579
|
+
interface QueryV2$7 extends QueryV2PagingMethodOneOf$7 {
|
|
3580
3580
|
/** Paging options to limit and skip the number of items. */
|
|
3581
|
-
paging?: Paging$
|
|
3581
|
+
paging?: Paging$5;
|
|
3582
3582
|
/** 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`. */
|
|
3583
3583
|
cursorPaging?: CursorPaging$f;
|
|
3584
3584
|
/**
|
|
@@ -3595,9 +3595,9 @@ interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {
|
|
|
3595
3595
|
sort?: Sorting$f[];
|
|
3596
3596
|
}
|
|
3597
3597
|
/** @oneof */
|
|
3598
|
-
interface QueryV2PagingMethodOneOf$
|
|
3598
|
+
interface QueryV2PagingMethodOneOf$7 {
|
|
3599
3599
|
/** Paging options to limit and skip the number of items. */
|
|
3600
|
-
paging?: Paging$
|
|
3600
|
+
paging?: Paging$5;
|
|
3601
3601
|
/** 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`. */
|
|
3602
3602
|
cursorPaging?: CursorPaging$f;
|
|
3603
3603
|
}
|
|
@@ -3611,7 +3611,7 @@ declare enum SortOrder$f {
|
|
|
3611
3611
|
ASC = "ASC",
|
|
3612
3612
|
DESC = "DESC"
|
|
3613
3613
|
}
|
|
3614
|
-
interface Paging$
|
|
3614
|
+
interface Paging$5 {
|
|
3615
3615
|
/** Number of items to load. */
|
|
3616
3616
|
limit?: number | null;
|
|
3617
3617
|
/** Number of items to skip in the current sort order. */
|
|
@@ -3902,11 +3902,11 @@ interface DeleteServiceOptionsAndVariantsResponse {
|
|
|
3902
3902
|
}
|
|
3903
3903
|
interface QueryServiceOptionsAndVariantsRequest {
|
|
3904
3904
|
/** Information about filters, paging, and returned fields. */
|
|
3905
|
-
query: QueryV2$
|
|
3905
|
+
query: QueryV2$6;
|
|
3906
3906
|
}
|
|
3907
|
-
interface QueryV2$
|
|
3907
|
+
interface QueryV2$6 extends QueryV2PagingMethodOneOf$6 {
|
|
3908
3908
|
/** Paging options to limit and skip the number of items. */
|
|
3909
|
-
paging?: Paging$
|
|
3909
|
+
paging?: Paging$4;
|
|
3910
3910
|
/** 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`. */
|
|
3911
3911
|
cursorPaging?: CursorPaging$e;
|
|
3912
3912
|
/**
|
|
@@ -3923,9 +3923,9 @@ interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {
|
|
|
3923
3923
|
sort?: Sorting$e[];
|
|
3924
3924
|
}
|
|
3925
3925
|
/** @oneof */
|
|
3926
|
-
interface QueryV2PagingMethodOneOf$
|
|
3926
|
+
interface QueryV2PagingMethodOneOf$6 {
|
|
3927
3927
|
/** Paging options to limit and skip the number of items. */
|
|
3928
|
-
paging?: Paging$
|
|
3928
|
+
paging?: Paging$4;
|
|
3929
3929
|
/** 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`. */
|
|
3930
3930
|
cursorPaging?: CursorPaging$e;
|
|
3931
3931
|
}
|
|
@@ -3939,7 +3939,7 @@ declare enum SortOrder$e {
|
|
|
3939
3939
|
ASC = "ASC",
|
|
3940
3940
|
DESC = "DESC"
|
|
3941
3941
|
}
|
|
3942
|
-
interface Paging$
|
|
3942
|
+
interface Paging$4 {
|
|
3943
3943
|
/** Number of items to load. */
|
|
3944
3944
|
limit?: number | null;
|
|
3945
3945
|
/** Number of items to skip in the current sort order. */
|
|
@@ -5628,6 +5628,63 @@ declare enum BookingFeeStatus$1 {
|
|
|
5628
5628
|
NOT_YET_APPLIED_TO_ORDER = "NOT_YET_APPLIED_TO_ORDER",
|
|
5629
5629
|
APPLIED_TO_ORDER = "APPLIED_TO_ORDER"
|
|
5630
5630
|
}
|
|
5631
|
+
interface QueryExtendedBookingRequest$1 {
|
|
5632
|
+
/**
|
|
5633
|
+
* Information about filters, paging, and sorting.
|
|
5634
|
+
* __Note__: `fields` and `fieldsets` aren't supported.
|
|
5635
|
+
*/
|
|
5636
|
+
query: QueryV2$5;
|
|
5637
|
+
/**
|
|
5638
|
+
* Whether information about which actions the customer can perform
|
|
5639
|
+
* for the bookings is returned.
|
|
5640
|
+
*/
|
|
5641
|
+
withBookingAllowedActions?: boolean;
|
|
5642
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
5643
|
+
withBookingAttendanceInfo?: boolean;
|
|
5644
|
+
/**
|
|
5645
|
+
* Filters the retrieved bookings by the booking ID that corresponds to
|
|
5646
|
+
* specified `sessionId`. The `booking.id` is calculated by calling
|
|
5647
|
+
* [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)
|
|
5648
|
+
* and saving the returned values for `participants.Id`.
|
|
5649
|
+
* These participant IDs are then used as `booking.id`.
|
|
5650
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
5651
|
+
*
|
|
5652
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
5653
|
+
* bookings, you must use this field to filter by session ID.
|
|
5654
|
+
*/
|
|
5655
|
+
sessionId?: string | null;
|
|
5656
|
+
}
|
|
5657
|
+
interface QueryV2$5 extends QueryV2PagingMethodOneOf$5 {
|
|
5658
|
+
/** Paging options to limit and skip the number of items. */
|
|
5659
|
+
paging?: Paging$3;
|
|
5660
|
+
/** 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`. */
|
|
5661
|
+
cursorPaging?: CursorPaging$d;
|
|
5662
|
+
/**
|
|
5663
|
+
* Filter object in the following format:
|
|
5664
|
+
* `"filter" : {
|
|
5665
|
+
* "fieldName1": "value1",
|
|
5666
|
+
* "fieldName2":{"$operator":"value2"}
|
|
5667
|
+
* }`
|
|
5668
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
5669
|
+
*/
|
|
5670
|
+
filter?: Record<string, any> | null;
|
|
5671
|
+
/**
|
|
5672
|
+
* Sort object in the following format:
|
|
5673
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
5674
|
+
*/
|
|
5675
|
+
sort?: Sorting$d[];
|
|
5676
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
5677
|
+
fields?: string[];
|
|
5678
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
5679
|
+
fieldsets?: string[];
|
|
5680
|
+
}
|
|
5681
|
+
/** @oneof */
|
|
5682
|
+
interface QueryV2PagingMethodOneOf$5 {
|
|
5683
|
+
/** Paging options to limit and skip the number of items. */
|
|
5684
|
+
paging?: Paging$3;
|
|
5685
|
+
/** 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`. */
|
|
5686
|
+
cursorPaging?: CursorPaging$d;
|
|
5687
|
+
}
|
|
5631
5688
|
interface Sorting$d {
|
|
5632
5689
|
/** Name of the field to sort by. */
|
|
5633
5690
|
fieldName?: string;
|
|
@@ -5638,6 +5695,12 @@ declare enum SortOrder$d {
|
|
|
5638
5695
|
ASC = "ASC",
|
|
5639
5696
|
DESC = "DESC"
|
|
5640
5697
|
}
|
|
5698
|
+
interface Paging$3 {
|
|
5699
|
+
/** Number of items to load. */
|
|
5700
|
+
limit?: number | null;
|
|
5701
|
+
/** Number of items to skip in the current sort order. */
|
|
5702
|
+
offset?: number | null;
|
|
5703
|
+
}
|
|
5641
5704
|
interface CursorPaging$d {
|
|
5642
5705
|
/** Maximum number of items to return in the results. */
|
|
5643
5706
|
limit?: number | null;
|
|
@@ -5649,6 +5712,15 @@ interface CursorPaging$d {
|
|
|
5649
5712
|
*/
|
|
5650
5713
|
cursor?: string | null;
|
|
5651
5714
|
}
|
|
5715
|
+
interface QueryExtendedBookingResponse$1 {
|
|
5716
|
+
/**
|
|
5717
|
+
* Retrieved bookings. May include information about the attendance or actions
|
|
5718
|
+
* the customer can perform, depending on your request.
|
|
5719
|
+
*/
|
|
5720
|
+
extendedBookings?: ExtendedBooking$1[];
|
|
5721
|
+
/** Paging metadata. */
|
|
5722
|
+
pagingMetadata?: PagingMetadataV2$3;
|
|
5723
|
+
}
|
|
5652
5724
|
interface PagingMetadataV2$3 {
|
|
5653
5725
|
/** Number of items returned in the response. */
|
|
5654
5726
|
count?: number | null;
|
|
@@ -5836,6 +5908,9 @@ interface ExtendedBookingNonNullableFields$1 {
|
|
|
5836
5908
|
attendance?: AttendanceNonNullableFields$3;
|
|
5837
5909
|
bookingFeeDetails?: BookingFeeDetailsNonNullableFields$1;
|
|
5838
5910
|
}
|
|
5911
|
+
interface QueryExtendedBookingResponseNonNullableFields$1 {
|
|
5912
|
+
extendedBookings: ExtendedBookingNonNullableFields$1[];
|
|
5913
|
+
}
|
|
5839
5914
|
interface QueryExtendedBookingsResponseNonNullableFields$1 {
|
|
5840
5915
|
extendedBookings: ExtendedBookingNonNullableFields$1[];
|
|
5841
5916
|
}
|
|
@@ -6363,6 +6438,60 @@ declare enum BookingFeeStatus {
|
|
|
6363
6438
|
NOT_YET_APPLIED_TO_ORDER = "NOT_YET_APPLIED_TO_ORDER",
|
|
6364
6439
|
APPLIED_TO_ORDER = "APPLIED_TO_ORDER"
|
|
6365
6440
|
}
|
|
6441
|
+
interface QueryExtendedBookingRequest {
|
|
6442
|
+
/** Information about filters, paging, and sorting. */
|
|
6443
|
+
query: QueryV2$4;
|
|
6444
|
+
/**
|
|
6445
|
+
* Whether information about which actions the customer can perform
|
|
6446
|
+
* for the bookings is returned.
|
|
6447
|
+
*/
|
|
6448
|
+
withBookingAllowedActions?: boolean;
|
|
6449
|
+
/** Whether information about the attendance for the bookings is returned. */
|
|
6450
|
+
withBookingAttendanceInfo?: boolean;
|
|
6451
|
+
/**
|
|
6452
|
+
* Filters the retrieved bookings by the booking ID that corresponds to
|
|
6453
|
+
* specified `sessionId`. The `booking.id` is calculated by calling
|
|
6454
|
+
* [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)
|
|
6455
|
+
* and saving the returned values for `participants.Id`.
|
|
6456
|
+
* These participant IDs are then used as `booking.id`.
|
|
6457
|
+
* This filter overrides the `booking.id` filter inside the query object.
|
|
6458
|
+
*
|
|
6459
|
+
* __Note__: Bookings for courses don't include a `sessionId`. For these
|
|
6460
|
+
* bookings, you must use this field to filter by session ID.
|
|
6461
|
+
*/
|
|
6462
|
+
sessionId?: string | null;
|
|
6463
|
+
}
|
|
6464
|
+
interface QueryV2$4 extends QueryV2PagingMethodOneOf$4 {
|
|
6465
|
+
/** Paging options to limit and skip the number of items. */
|
|
6466
|
+
paging?: Paging$2;
|
|
6467
|
+
/** 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`. */
|
|
6468
|
+
cursorPaging?: CursorPaging$c;
|
|
6469
|
+
/**
|
|
6470
|
+
* Filter object in the following format:
|
|
6471
|
+
* `"filter" : {
|
|
6472
|
+
* "fieldName1": "value1",
|
|
6473
|
+
* "fieldName2":{"$operator":"value2"}
|
|
6474
|
+
* }`
|
|
6475
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
6476
|
+
*/
|
|
6477
|
+
filter?: Record<string, any> | null;
|
|
6478
|
+
/**
|
|
6479
|
+
* Sort object in the following format:
|
|
6480
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
6481
|
+
*/
|
|
6482
|
+
sort?: Sorting$c[];
|
|
6483
|
+
/** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
6484
|
+
fields?: string[];
|
|
6485
|
+
/** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
|
|
6486
|
+
fieldsets?: string[];
|
|
6487
|
+
}
|
|
6488
|
+
/** @oneof */
|
|
6489
|
+
interface QueryV2PagingMethodOneOf$4 {
|
|
6490
|
+
/** Paging options to limit and skip the number of items. */
|
|
6491
|
+
paging?: Paging$2;
|
|
6492
|
+
/** 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`. */
|
|
6493
|
+
cursorPaging?: CursorPaging$c;
|
|
6494
|
+
}
|
|
6366
6495
|
interface Sorting$c {
|
|
6367
6496
|
/** Name of the field to sort by. */
|
|
6368
6497
|
fieldName?: string;
|
|
@@ -6373,6 +6502,12 @@ declare enum SortOrder$c {
|
|
|
6373
6502
|
ASC = "ASC",
|
|
6374
6503
|
DESC = "DESC"
|
|
6375
6504
|
}
|
|
6505
|
+
interface Paging$2 {
|
|
6506
|
+
/** Number of items to load. */
|
|
6507
|
+
limit?: number | null;
|
|
6508
|
+
/** Number of items to skip in the current sort order. */
|
|
6509
|
+
offset?: number | null;
|
|
6510
|
+
}
|
|
6376
6511
|
interface CursorPaging$c {
|
|
6377
6512
|
/** Maximum number of items to return in the results. */
|
|
6378
6513
|
limit?: number | null;
|
|
@@ -6384,6 +6519,15 @@ interface CursorPaging$c {
|
|
|
6384
6519
|
*/
|
|
6385
6520
|
cursor?: string | null;
|
|
6386
6521
|
}
|
|
6522
|
+
interface QueryExtendedBookingResponse {
|
|
6523
|
+
/**
|
|
6524
|
+
* Retrieved bookings and additional information about attendance or actions
|
|
6525
|
+
* the customer can perform
|
|
6526
|
+
*/
|
|
6527
|
+
extendedBookings?: ExtendedBooking[];
|
|
6528
|
+
/** Paging metadata. */
|
|
6529
|
+
pagingMetadata?: PagingMetadataV2$2;
|
|
6530
|
+
}
|
|
6387
6531
|
interface PagingMetadataV2$2 {
|
|
6388
6532
|
/** Number of items returned in the response. */
|
|
6389
6533
|
count?: number | null;
|
|
@@ -6568,6 +6712,9 @@ interface ExtendedBookingNonNullableFields {
|
|
|
6568
6712
|
attendance?: AttendanceNonNullableFields$2;
|
|
6569
6713
|
bookingFeeDetails?: BookingFeeDetailsNonNullableFields;
|
|
6570
6714
|
}
|
|
6715
|
+
interface QueryExtendedBookingResponseNonNullableFields {
|
|
6716
|
+
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
6717
|
+
}
|
|
6571
6718
|
interface QueryExtendedBookingsResponseNonNullableFields {
|
|
6572
6719
|
extendedBookings: ExtendedBookingNonNullableFields[];
|
|
6573
6720
|
}
|
|
@@ -6582,11 +6729,13 @@ type __PublicMethodMetaInfo$9<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
6582
6729
|
__responseType: Q;
|
|
6583
6730
|
__originalResponseType: R;
|
|
6584
6731
|
};
|
|
6732
|
+
declare function query(): __PublicMethodMetaInfo$9<'POST', {}, QueryExtendedBookingRequest, QueryExtendedBookingRequest$1, QueryExtendedBookingResponse & QueryExtendedBookingResponseNonNullableFields, QueryExtendedBookingResponse$1 & QueryExtendedBookingResponseNonNullableFields$1>;
|
|
6585
6733
|
declare function queryExtendedBookings(): __PublicMethodMetaInfo$9<'POST', {}, QueryExtendedBookingsRequest, QueryExtendedBookingsRequest$1, QueryExtendedBookingsResponse & QueryExtendedBookingsResponseNonNullableFields, QueryExtendedBookingsResponse$1 & QueryExtendedBookingsResponseNonNullableFields$1>;
|
|
6586
6734
|
|
|
6735
|
+
declare const meta$9_query: typeof query;
|
|
6587
6736
|
declare const meta$9_queryExtendedBookings: typeof queryExtendedBookings;
|
|
6588
6737
|
declare namespace meta$9 {
|
|
6589
|
-
export { type __PublicMethodMetaInfo$9 as __PublicMethodMetaInfo, meta$9_queryExtendedBookings as queryExtendedBookings };
|
|
6738
|
+
export { type __PublicMethodMetaInfo$9 as __PublicMethodMetaInfo, meta$9_query as query, meta$9_queryExtendedBookings as queryExtendedBookings };
|
|
6590
6739
|
}
|
|
6591
6740
|
|
|
6592
6741
|
/**
|