@wix/table-reservations 1.0.27 → 1.0.28

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.
Files changed (9) hide show
  1. package/build/cjs/src/table-reservations-v1-reservation.http.d.ts +4 -4
  2. package/build/cjs/src/table-reservations-v1-reservation.http.js +4 -4
  3. package/build/cjs/src/table-reservations-v1-reservation.universal.d.ts +8 -8
  4. package/build/cjs/src/table-reservations-v1-reservation.universal.js +4 -4
  5. package/build/es/src/table-reservations-v1-reservation.http.d.ts +4 -4
  6. package/build/es/src/table-reservations-v1-reservation.http.js +4 -4
  7. package/build/es/src/table-reservations-v1-reservation.universal.d.ts +8 -8
  8. package/build/es/src/table-reservations-v1-reservation.universal.js +4 -4
  9. package/package.json +2 -2
package/build/cjs/src/table-reservations-v1-reservation.http.d.ts CHANGED
@@ -3,20 +3,20 @@ import { CancelReservationRequest, CancelReservationResponse, CreateHeldReservat
3
3
  /**
4
4
  * Creates a new reservation.
5
5
  *
6
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
6
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
7
7
  *
8
8
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
9
9
  *
10
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
10
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
11
11
  *
12
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
12
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
13
13
  * Attempting to create a reservation without these fields will result in an error.
14
14
  */
15
15
  export declare function createReservation(payload: CreateReservationRequest): RequestOptionsFactory<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
16
16
  /**
17
17
  * Retrieves a reservation.
18
18
  *
19
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
19
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
20
20
  */
21
21
  export declare function getReservation(payload: GetReservationRequest): RequestOptionsFactory<GetReservationResponse & GetReservationResponseNonNullableFields>;
22
22
  /**
package/build/cjs/src/table-reservations-v1-reservation.http.js CHANGED
@@ -112,13 +112,13 @@ function resolveWixTableReservationsReservationV1ReservationsServiceUrl(opts) {
112
112
  /**
113
113
  * Creates a new reservation.
114
114
  *
115
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
115
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
116
116
  *
117
117
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
118
118
  *
119
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
119
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
120
120
  *
121
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
121
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
122
122
  * Attempting to create a reservation without these fields will result in an error.
123
123
  */
124
124
  function createReservation(payload) {
@@ -150,7 +150,7 @@ exports.createReservation = createReservation;
150
150
  /**
151
151
  * Retrieves a reservation.
152
152
  *
153
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
153
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
154
154
  */
155
155
  function getReservation(payload) {
156
156
  const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getReservationRequest, {});
package/build/cjs/src/table-reservations-v1-reservation.universal.d.ts CHANGED
@@ -192,9 +192,9 @@ export interface GetReservationRequest {
192
192
  /**
193
193
  * Array of named, predefined sets of projected fields to be returned.
194
194
  *
195
- * Supported values: PUBLIC, FULL.
195
+ * Supported values: `PUBLIC`, `FULL`.
196
196
  *
197
- * >**Note:** To call this method with `fieldsets` set to `FULL`, you will need additional permissions. In Velo you will need to use [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate)."
197
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
198
198
  */
199
199
  fieldsets?: Set[];
200
200
  }
@@ -504,13 +504,13 @@ export interface QueryReservationsResponseNonNullableFields {
504
504
  /**
505
505
  * Creates a new reservation.
506
506
  *
507
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
507
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
508
508
  *
509
509
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
510
510
  *
511
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
511
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
512
512
  *
513
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
513
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
514
514
  * Attempting to create a reservation without these fields will result in an error.
515
515
  * @param reservation - Reservation details.
516
516
  * @public
@@ -538,7 +538,7 @@ export interface CreateReservationOptions {
538
538
  /**
539
539
  * Retrieves a reservation.
540
540
  *
541
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
541
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
542
542
  * @param reservationId - Reservation ID.
543
543
  * @public
544
544
  * @documentationMaturity preview
@@ -556,9 +556,9 @@ export interface GetReservationOptions {
556
556
  /**
557
557
  * Array of named, predefined sets of projected fields to be returned.
558
558
  *
559
- * Supported values: PUBLIC, FULL.
559
+ * Supported values: `PUBLIC`, `FULL`.
560
560
  *
561
- * >**Note:** To call this method with `fieldsets` set to `FULL`, you will need additional permissions. In Velo you will need to use [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate)."
561
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
562
562
  */
563
563
  fieldsets?: Set[];
564
564
  }
package/build/cjs/src/table-reservations-v1-reservation.universal.js CHANGED
@@ -121,13 +121,13 @@ const _updateReservationResponse = {};
121
121
  /**
122
122
  * Creates a new reservation.
123
123
  *
124
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
124
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
125
125
  *
126
126
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
127
127
  *
128
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
128
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
129
129
  *
130
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
130
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
131
131
  * Attempting to create a reservation without these fields will result in an error.
132
132
  * @param reservation - Reservation details.
133
133
  * @public
@@ -197,7 +197,7 @@ exports.createReservation = createReservation;
197
197
  /**
198
198
  * Retrieves a reservation.
199
199
  *
200
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
200
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
201
201
  * @param reservationId - Reservation ID.
202
202
  * @public
203
203
  * @documentationMaturity preview
package/build/es/src/table-reservations-v1-reservation.http.d.ts CHANGED
@@ -3,20 +3,20 @@ import { CancelReservationRequest, CancelReservationResponse, CreateHeldReservat
3
3
  /**
4
4
  * Creates a new reservation.
5
5
  *
6
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
6
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
7
7
  *
8
8
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
9
9
  *
10
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
10
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
11
11
  *
12
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
12
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
13
13
  * Attempting to create a reservation without these fields will result in an error.
14
14
  */
15
15
  export declare function createReservation(payload: CreateReservationRequest): RequestOptionsFactory<CreateReservationResponse & CreateReservationResponseNonNullableFields>;
16
16
  /**
17
17
  * Retrieves a reservation.
18
18
  *
19
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
19
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
20
20
  */
21
21
  export declare function getReservation(payload: GetReservationRequest): RequestOptionsFactory<GetReservationResponse & GetReservationResponseNonNullableFields>;
22
22
  /**
package/build/es/src/table-reservations-v1-reservation.http.js CHANGED
@@ -109,13 +109,13 @@ function resolveWixTableReservationsReservationV1ReservationsServiceUrl(opts) {
109
109
  /**
110
110
  * Creates a new reservation.
111
111
  *
112
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
112
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
113
113
  *
114
114
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
115
115
  *
116
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
116
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
117
117
  *
118
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
118
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
119
119
  * Attempting to create a reservation without these fields will result in an error.
120
120
  */
121
121
  export function createReservation(payload) {
@@ -146,7 +146,7 @@ export function createReservation(payload) {
146
146
  /**
147
147
  * Retrieves a reservation.
148
148
  *
149
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
149
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
150
150
  */
151
151
  export function getReservation(payload) {
152
152
  const { toJSON: toReq, fromJSON: fromReq } = serializer(_getReservationRequest, {});
package/build/es/src/table-reservations-v1-reservation.universal.d.ts CHANGED
@@ -192,9 +192,9 @@ export interface GetReservationRequest {
192
192
  /**
193
193
  * Array of named, predefined sets of projected fields to be returned.
194
194
  *
195
- * Supported values: PUBLIC, FULL.
195
+ * Supported values: `PUBLIC`, `FULL`.
196
196
  *
197
- * >**Note:** To call this method with `fieldsets` set to `FULL`, you will need additional permissions. In Velo you will need to use [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate)."
197
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
198
198
  */
199
199
  fieldsets?: Set[];
200
200
  }
@@ -504,13 +504,13 @@ export interface QueryReservationsResponseNonNullableFields {
504
504
  /**
505
505
  * Creates a new reservation.
506
506
  *
507
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
507
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
508
508
  *
509
509
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
510
510
  *
511
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
511
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
512
512
  *
513
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
513
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
514
514
  * Attempting to create a reservation without these fields will result in an error.
515
515
  * @param reservation - Reservation details.
516
516
  * @public
@@ -538,7 +538,7 @@ export interface CreateReservationOptions {
538
538
  /**
539
539
  * Retrieves a reservation.
540
540
  *
541
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
541
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
542
542
  * @param reservationId - Reservation ID.
543
543
  * @public
544
544
  * @documentationMaturity preview
@@ -556,9 +556,9 @@ export interface GetReservationOptions {
556
556
  /**
557
557
  * Array of named, predefined sets of projected fields to be returned.
558
558
  *
559
- * Supported values: PUBLIC, FULL.
559
+ * Supported values: `PUBLIC`, `FULL`.
560
560
  *
561
- * >**Note:** To call this method with `fieldsets` set to `FULL`, you will need additional permissions. In Velo you will need to use [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate)."
561
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
562
562
  */
563
563
  fieldsets?: Set[];
564
564
  }
package/build/es/src/table-reservations-v1-reservation.universal.js CHANGED
@@ -99,13 +99,13 @@ const _updateReservationResponse = {};
99
99
  /**
100
100
  * Creates a new reservation.
101
101
  *
102
- * If a `status` is not provided, the reservation is created with the `RESERVED` status or the `REQUESTED` status if manual approval is required for confirmation.
102
+ * If a `status` is not provided, the reservation is created with the `RESERVED` status, or the `REQUESTED` status if manual approval is required for confirmation.
103
103
  *
104
104
  * Including the fields `status`, `source`, `reservation.details.tableIds`, `reservation.details.endDate`, `ignoreReservationLocationConflicts`, or `ignoreTableCombinationConflicts` in the request requires additional permissions. See this API's Introduction article for more information.
105
105
  *
106
- * If `source` is not provided, its value will be set depending on the permissions of the user making the call. See this API's Introduction article for more information.
106
+ * If `source` is not provided, its value is set depending on the permissions of the user making the call. See this API's Introduction article for more information.
107
107
  *
108
- * A reservation created with any status other than `WALK_IN` will require the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
108
+ * A reservation created with any status other than `WALK_IN` requires the `reservation.reservee.phone` and `reservation.reservee.firstName` fields.
109
109
  * Attempting to create a reservation without these fields will result in an error.
110
110
  * @param reservation - Reservation details.
111
111
  * @public
@@ -174,7 +174,7 @@ export function createReservation(reservation, options) {
174
174
  /**
175
175
  * Retrieves a reservation.
176
176
  *
177
- * >**Note:** To call this method with `fieldsets` set to `FULL` you will need additional permissions. See this API's Introduction article for more information.
177
+ * Calling this method with `fieldsets` set to `FULL` requires additional permissions. See this API's Introduction article for more information.
178
178
  * @param reservationId - Reservation ID.
179
179
  * @public
180
180
  * @documentationMaturity preview
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/table-reservations",
3
- "version": "1.0.27",
3
+ "version": "1.0.28",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -34,5 +34,5 @@
34
34
  "groupId": "com.wixpress.public-sdk-autogen"
35
35
  }
36
36
  },
37
- "falconPackageHash": "50ff7e523b25a29150eae49dd3a5bbe66e0dcc69215f9bee4e18d531"
37
+ "falconPackageHash": "b1485fbb7381bbe506ed7a04ccbfcc1a081807f773191cad6e26c20a"
38
38
  }