@connectedxm/admin-sdk 13.2.0 → 13.4.0
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/.openapi-generator/FILES +31 -0
- package/AdminApi.ts +9 -0
- package/README.md +2 -2
- package/api.ts +2619 -19
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +4 -1
- package/dist/AdminApi.js +3 -0
- package/dist/api.d.ts +1433 -4
- package/dist/api.js +1828 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +4 -1
- package/dist/esm/AdminApi.js +4 -1
- package/dist/esm/api.d.ts +1433 -4
- package/dist/esm/api.js +1788 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseBooking.md +4 -0
- package/docs/BaseBookingPlaceMembership.md +24 -0
- package/docs/BaseBookingSpace.md +2 -0
- package/docs/BaseExport.md +38 -0
- package/docs/BasePayment.md +2 -2
- package/docs/BasePaymentIntent.md +4 -0
- package/docs/BasePaymentIntentLineItem.md +2 -0
- package/docs/BasePaymentLineItem.md +2 -0
- package/docs/BasePlaceMembership.md +32 -0
- package/docs/BasePlaceMembershipType.md +40 -0
- package/docs/Booking.md +4 -0
- package/docs/BookingSpace.md +2 -0
- package/docs/BookingSpaceCreateInputs.md +2 -0
- package/docs/BookingSpaceUpdateInputs.md +2 -0
- package/docs/BookingsMembershipsApi.md +840 -0
- package/docs/BookingsMembershipsTranslationsApi.md +252 -0
- package/docs/CreatePlaceMembershipMember200Response.md +24 -0
- package/docs/CreatePlaceMembershipType200Response.md +24 -0
- package/docs/Export.md +40 -0
- package/docs/ExportsApi.md +123 -0
- package/docs/GetExport200Response.md +24 -0
- package/docs/GetExports200Response.md +26 -0
- package/docs/GetPlaceMembership200Response.md +24 -0
- package/docs/GetPlaceMembershipMembers200Response.md +26 -0
- package/docs/GetPlaceMembershipTypeTranslation200Response.md +24 -0
- package/docs/GetPlaceMembershipTypeTranslations200Response.md +26 -0
- package/docs/GetPlaceMembershipTypes200Response.md +26 -0
- package/docs/GetPlaceMemberships200Response.md +26 -0
- package/docs/Payment.md +4 -2
- package/docs/PaymentIntent.md +6 -0
- package/docs/PaymentIntentSource.md +2 -0
- package/docs/PaymentLineItem.md +4 -0
- package/docs/PaymentLineItemType.md +2 -0
- package/docs/PlaceMembership.md +38 -0
- package/docs/PlaceMembershipAllOfCount.md +20 -0
- package/docs/PlaceMembershipCreateInputs.md +26 -0
- package/docs/PlaceMembershipMember.md +28 -0
- package/docs/PlaceMembershipMemberCreateInputs.md +22 -0
- package/docs/PlaceMembershipMemberUpdateInputs.md +22 -0
- package/docs/PlaceMembershipType.md +60 -0
- package/docs/PlaceMembershipTypeCreateInputs.md +44 -0
- package/docs/PlaceMembershipTypeTranslation.md +30 -0
- package/docs/PlaceMembershipTypeTranslationUpdateInputs.md +22 -0
- package/docs/PlaceMembershipTypeUpdateInputs.md +46 -0
- package/docs/PlaceMembershipUpdateInputs.md +24 -0
- package/docs/UpdatePlaceMembershipTypeTranslation200Response.md +24 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.4.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1247,6 +1247,8 @@ export interface BaseBooking {
|
|
|
1247
1247
|
'duration': number;
|
|
1248
1248
|
'checkedIn': string | null;
|
|
1249
1249
|
'status': PurchaseStatus;
|
|
1250
|
+
'placeMembershipId': string | null;
|
|
1251
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
1250
1252
|
'account': BaseAccount;
|
|
1251
1253
|
'space': BaseBookingSpace;
|
|
1252
1254
|
}
|
|
@@ -1262,6 +1264,11 @@ export interface BaseBookingPlace {
|
|
|
1262
1264
|
'paymentIntegrationId': string | null;
|
|
1263
1265
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1264
1266
|
}
|
|
1267
|
+
export interface BaseBookingPlaceMembership {
|
|
1268
|
+
'id': string;
|
|
1269
|
+
'expiresAt': string | null;
|
|
1270
|
+
'placeMembershipType': BasePassAttributeAttribute;
|
|
1271
|
+
}
|
|
1265
1272
|
export interface BaseBookingQuestionResponse {
|
|
1266
1273
|
'id': string;
|
|
1267
1274
|
'value': string;
|
|
@@ -1285,6 +1292,7 @@ export interface BaseBookingSpace {
|
|
|
1285
1292
|
'bookingLimitPerAccount': number | null;
|
|
1286
1293
|
'slotDuration': number;
|
|
1287
1294
|
'price': number;
|
|
1295
|
+
'membershipPrice': number | null;
|
|
1288
1296
|
'description': string | null;
|
|
1289
1297
|
'image': BaseImage | null;
|
|
1290
1298
|
'start': string | null;
|
|
@@ -1984,6 +1992,18 @@ export interface BaseEventTrack {
|
|
|
1984
1992
|
'description': string | null;
|
|
1985
1993
|
'color': string;
|
|
1986
1994
|
}
|
|
1995
|
+
export interface BaseExport {
|
|
1996
|
+
'id': string;
|
|
1997
|
+
'type': string;
|
|
1998
|
+
'status': ExportStatus;
|
|
1999
|
+
'message': string | null;
|
|
2000
|
+
'eventId': string | null;
|
|
2001
|
+
'userId': string | null;
|
|
2002
|
+
'expiration': string | null;
|
|
2003
|
+
'downloadUrl': string | null;
|
|
2004
|
+
'createdAt': string;
|
|
2005
|
+
'updatedAt': string;
|
|
2006
|
+
}
|
|
1987
2007
|
export interface BaseFaq {
|
|
1988
2008
|
'id': string;
|
|
1989
2009
|
'slug': string;
|
|
@@ -2321,10 +2341,10 @@ export interface BasePayment {
|
|
|
2321
2341
|
'passId': string | null;
|
|
2322
2342
|
'sessionId': string | null;
|
|
2323
2343
|
'spaceId': string | null;
|
|
2324
|
-
'membershipId': string | null;
|
|
2325
2344
|
'couponId': string | null;
|
|
2326
2345
|
'invoiceId': string | null;
|
|
2327
2346
|
'seriesId': string | null;
|
|
2347
|
+
'placeMembershipTypeId': string | null;
|
|
2328
2348
|
'taxIntegrationCompanyCode': string | null;
|
|
2329
2349
|
'taxIntegrationCustomerId': string | null;
|
|
2330
2350
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -2357,6 +2377,8 @@ export interface BasePaymentIntent {
|
|
|
2357
2377
|
'couponId': string | null;
|
|
2358
2378
|
'invoiceId': string | null;
|
|
2359
2379
|
'seriesId': string | null;
|
|
2380
|
+
'placeMembershipTypeId': string | null;
|
|
2381
|
+
'placeMembershipId': string | null;
|
|
2360
2382
|
'address1': string | null;
|
|
2361
2383
|
'address2': string | null;
|
|
2362
2384
|
'city': string | null;
|
|
@@ -2408,6 +2430,7 @@ export interface BasePaymentIntentLineItem {
|
|
|
2408
2430
|
'bookingId': string | null;
|
|
2409
2431
|
'couponId': string | null;
|
|
2410
2432
|
'seriesRegistrationId': string | null;
|
|
2433
|
+
'placeMembershipId': string | null;
|
|
2411
2434
|
'createdAt': string;
|
|
2412
2435
|
}
|
|
2413
2436
|
export interface BasePaymentIntentTaxIntegration {
|
|
@@ -2438,6 +2461,29 @@ export interface BasePaymentLineItem {
|
|
|
2438
2461
|
'reservationId': string | null;
|
|
2439
2462
|
'accessId': string | null;
|
|
2440
2463
|
'bookingId': string | null;
|
|
2464
|
+
'placeMembershipId': string | null;
|
|
2465
|
+
}
|
|
2466
|
+
export interface BasePlaceMembership {
|
|
2467
|
+
'id': string;
|
|
2468
|
+
'status': PurchaseStatus;
|
|
2469
|
+
'startsAt': string | null;
|
|
2470
|
+
'expiresAt': string | null;
|
|
2471
|
+
'account': BaseAccount;
|
|
2472
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
2473
|
+
'createdAt': string;
|
|
2474
|
+
}
|
|
2475
|
+
export interface BasePlaceMembershipType {
|
|
2476
|
+
'id': string;
|
|
2477
|
+
'slug': string;
|
|
2478
|
+
'name': string;
|
|
2479
|
+
'description': string | null;
|
|
2480
|
+
'image': BaseImage | null;
|
|
2481
|
+
'price': number;
|
|
2482
|
+
'termDays': number;
|
|
2483
|
+
'maxMembers': number;
|
|
2484
|
+
'sortOrder': number;
|
|
2485
|
+
'visible': boolean;
|
|
2486
|
+
'archived': boolean;
|
|
2441
2487
|
}
|
|
2442
2488
|
export interface BasePreset {
|
|
2443
2489
|
'id': string;
|
|
@@ -3106,6 +3152,8 @@ export interface Booking {
|
|
|
3106
3152
|
'duration': number;
|
|
3107
3153
|
'checkedIn': string | null;
|
|
3108
3154
|
'status': PurchaseStatus;
|
|
3155
|
+
'placeMembershipId': string | null;
|
|
3156
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
3109
3157
|
'account': BaseAccount;
|
|
3110
3158
|
'space': BaseBookingSpace;
|
|
3111
3159
|
'lineItem': PaymentLineItem | null;
|
|
@@ -3214,6 +3262,7 @@ export interface BookingSpace {
|
|
|
3214
3262
|
'bookingLimitPerAccount': number | null;
|
|
3215
3263
|
'slotDuration': number;
|
|
3216
3264
|
'price': number;
|
|
3265
|
+
'membershipPrice': number | null;
|
|
3217
3266
|
'description': string | null;
|
|
3218
3267
|
'image': BaseImage | null;
|
|
3219
3268
|
'start': string | null;
|
|
@@ -3289,6 +3338,7 @@ export interface BookingSpaceCreateInputs {
|
|
|
3289
3338
|
'bookingLimitPerAccount'?: number | null;
|
|
3290
3339
|
'slotDuration': number;
|
|
3291
3340
|
'price'?: number;
|
|
3341
|
+
'membershipPrice'?: number | null;
|
|
3292
3342
|
'description'?: string | null;
|
|
3293
3343
|
'imageId'?: string | null;
|
|
3294
3344
|
'start'?: string | null;
|
|
@@ -3478,6 +3528,7 @@ export interface BookingSpaceUpdateInputs {
|
|
|
3478
3528
|
'supply'?: number;
|
|
3479
3529
|
'bookingLimitPerAccount'?: number | null;
|
|
3480
3530
|
'price'?: number;
|
|
3531
|
+
'membershipPrice'?: number | null;
|
|
3481
3532
|
'description'?: string | null;
|
|
3482
3533
|
'imageId'?: string | null;
|
|
3483
3534
|
'start'?: string | null;
|
|
@@ -4527,6 +4578,22 @@ export interface CreateOrganizationTeamMember200Response {
|
|
|
4527
4578
|
export declare enum CreateOrganizationTeamMember200ResponseStatusEnum {
|
|
4528
4579
|
Ok = "ok"
|
|
4529
4580
|
}
|
|
4581
|
+
export interface CreatePlaceMembershipMember200Response {
|
|
4582
|
+
'status': CreatePlaceMembershipMember200ResponseStatusEnum;
|
|
4583
|
+
'message': string;
|
|
4584
|
+
'data': PlaceMembershipMember;
|
|
4585
|
+
}
|
|
4586
|
+
export declare enum CreatePlaceMembershipMember200ResponseStatusEnum {
|
|
4587
|
+
Ok = "ok"
|
|
4588
|
+
}
|
|
4589
|
+
export interface CreatePlaceMembershipType200Response {
|
|
4590
|
+
'status': CreatePlaceMembershipType200ResponseStatusEnum;
|
|
4591
|
+
'message': string;
|
|
4592
|
+
'data': PlaceMembershipType;
|
|
4593
|
+
}
|
|
4594
|
+
export declare enum CreatePlaceMembershipType200ResponseStatusEnum {
|
|
4595
|
+
Ok = "ok"
|
|
4596
|
+
}
|
|
4530
4597
|
export interface CreatePreset200Response {
|
|
4531
4598
|
'status': CreatePreset200ResponseStatusEnum;
|
|
4532
4599
|
'message': string;
|
|
@@ -6881,6 +6948,19 @@ export declare enum ExchangeType {
|
|
|
6881
6948
|
Downgrade = "downgrade",
|
|
6882
6949
|
Swap = "swap"
|
|
6883
6950
|
}
|
|
6951
|
+
export interface Export {
|
|
6952
|
+
'id': string;
|
|
6953
|
+
'type': string;
|
|
6954
|
+
'status': ExportStatus;
|
|
6955
|
+
'message': string | null;
|
|
6956
|
+
'eventId': string | null;
|
|
6957
|
+
'userId': string | null;
|
|
6958
|
+
'expiration': string | null;
|
|
6959
|
+
'downloadUrl': string | null;
|
|
6960
|
+
'createdAt': string;
|
|
6961
|
+
'updatedAt': string;
|
|
6962
|
+
'user': BaseUser | null;
|
|
6963
|
+
}
|
|
6884
6964
|
export declare enum ExportStatus {
|
|
6885
6965
|
Pending = "pending",
|
|
6886
6966
|
Resolved = "resolved",
|
|
@@ -8765,6 +8845,23 @@ export interface GetEvents200Response {
|
|
|
8765
8845
|
export declare enum GetEvents200ResponseStatusEnum {
|
|
8766
8846
|
Ok = "ok"
|
|
8767
8847
|
}
|
|
8848
|
+
export interface GetExport200Response {
|
|
8849
|
+
'status': GetExport200ResponseStatusEnum;
|
|
8850
|
+
'message': string;
|
|
8851
|
+
'data': Export;
|
|
8852
|
+
}
|
|
8853
|
+
export declare enum GetExport200ResponseStatusEnum {
|
|
8854
|
+
Ok = "ok"
|
|
8855
|
+
}
|
|
8856
|
+
export interface GetExports200Response {
|
|
8857
|
+
'status': GetExports200ResponseStatusEnum;
|
|
8858
|
+
'message': string;
|
|
8859
|
+
'data': Array<Export>;
|
|
8860
|
+
'count'?: number;
|
|
8861
|
+
}
|
|
8862
|
+
export declare enum GetExports200ResponseStatusEnum {
|
|
8863
|
+
Ok = "ok"
|
|
8864
|
+
}
|
|
8768
8865
|
export interface GetFiles200Response {
|
|
8769
8866
|
'status': GetFiles200ResponseStatusEnum;
|
|
8770
8867
|
'message': string;
|
|
@@ -9314,6 +9411,58 @@ export interface GetPaymentTaxMetadata200Response {
|
|
|
9314
9411
|
export declare enum GetPaymentTaxMetadata200ResponseStatusEnum {
|
|
9315
9412
|
Ok = "ok"
|
|
9316
9413
|
}
|
|
9414
|
+
export interface GetPlaceMembership200Response {
|
|
9415
|
+
'status': GetPlaceMembership200ResponseStatusEnum;
|
|
9416
|
+
'message': string;
|
|
9417
|
+
'data': PlaceMembership;
|
|
9418
|
+
}
|
|
9419
|
+
export declare enum GetPlaceMembership200ResponseStatusEnum {
|
|
9420
|
+
Ok = "ok"
|
|
9421
|
+
}
|
|
9422
|
+
export interface GetPlaceMembershipMembers200Response {
|
|
9423
|
+
'status': GetPlaceMembershipMembers200ResponseStatusEnum;
|
|
9424
|
+
'message': string;
|
|
9425
|
+
'data': Array<PlaceMembershipMember>;
|
|
9426
|
+
'count'?: number;
|
|
9427
|
+
}
|
|
9428
|
+
export declare enum GetPlaceMembershipMembers200ResponseStatusEnum {
|
|
9429
|
+
Ok = "ok"
|
|
9430
|
+
}
|
|
9431
|
+
export interface GetPlaceMembershipTypeTranslation200Response {
|
|
9432
|
+
'status': GetPlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
9433
|
+
'message': string;
|
|
9434
|
+
'data': PlaceMembershipTypeTranslation | null;
|
|
9435
|
+
}
|
|
9436
|
+
export declare enum GetPlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
9437
|
+
Ok = "ok"
|
|
9438
|
+
}
|
|
9439
|
+
export interface GetPlaceMembershipTypeTranslations200Response {
|
|
9440
|
+
'status': GetPlaceMembershipTypeTranslations200ResponseStatusEnum;
|
|
9441
|
+
'message': string;
|
|
9442
|
+
'data': Array<PlaceMembershipTypeTranslation>;
|
|
9443
|
+
'count'?: number;
|
|
9444
|
+
}
|
|
9445
|
+
export declare enum GetPlaceMembershipTypeTranslations200ResponseStatusEnum {
|
|
9446
|
+
Ok = "ok"
|
|
9447
|
+
}
|
|
9448
|
+
export interface GetPlaceMembershipTypes200Response {
|
|
9449
|
+
'status': GetPlaceMembershipTypes200ResponseStatusEnum;
|
|
9450
|
+
'message': string;
|
|
9451
|
+
'data': Array<PlaceMembershipType>;
|
|
9452
|
+
'count'?: number;
|
|
9453
|
+
}
|
|
9454
|
+
export declare enum GetPlaceMembershipTypes200ResponseStatusEnum {
|
|
9455
|
+
Ok = "ok"
|
|
9456
|
+
}
|
|
9457
|
+
export interface GetPlaceMemberships200Response {
|
|
9458
|
+
'status': GetPlaceMemberships200ResponseStatusEnum;
|
|
9459
|
+
'message': string;
|
|
9460
|
+
'data': Array<PlaceMembership>;
|
|
9461
|
+
'count'?: number;
|
|
9462
|
+
}
|
|
9463
|
+
export declare enum GetPlaceMemberships200ResponseStatusEnum {
|
|
9464
|
+
Ok = "ok"
|
|
9465
|
+
}
|
|
9317
9466
|
export interface GetPreferences200Response {
|
|
9318
9467
|
'status': GetPreferences200ResponseStatusEnum;
|
|
9319
9468
|
'message': string;
|
|
@@ -11790,10 +11939,10 @@ export interface Payment {
|
|
|
11790
11939
|
'passId': string | null;
|
|
11791
11940
|
'sessionId': string | null;
|
|
11792
11941
|
'spaceId': string | null;
|
|
11793
|
-
'membershipId': string | null;
|
|
11794
11942
|
'couponId': string | null;
|
|
11795
11943
|
'invoiceId': string | null;
|
|
11796
11944
|
'seriesId': string | null;
|
|
11945
|
+
'placeMembershipTypeId': string | null;
|
|
11797
11946
|
'taxIntegrationCompanyCode': string | null;
|
|
11798
11947
|
'taxIntegrationCustomerId': string | null;
|
|
11799
11948
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -11825,6 +11974,7 @@ export interface Payment {
|
|
|
11825
11974
|
'coupon': BaseCoupon | null;
|
|
11826
11975
|
'invoice': BaseInvoice | null;
|
|
11827
11976
|
'series': BaseSeries | null;
|
|
11977
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
11828
11978
|
'exchangeTarget': BaseEventPassTypeExchangeTarget | null;
|
|
11829
11979
|
'metadata'?: object;
|
|
11830
11980
|
}
|
|
@@ -11867,6 +12017,8 @@ export interface PaymentIntent {
|
|
|
11867
12017
|
'couponId': string | null;
|
|
11868
12018
|
'invoiceId': string | null;
|
|
11869
12019
|
'seriesId': string | null;
|
|
12020
|
+
'placeMembershipTypeId': string | null;
|
|
12021
|
+
'placeMembershipId': string | null;
|
|
11870
12022
|
'address1': string | null;
|
|
11871
12023
|
'address2': string | null;
|
|
11872
12024
|
'city': string | null;
|
|
@@ -11900,6 +12052,7 @@ export interface PaymentIntent {
|
|
|
11900
12052
|
'space': BaseBookingSpace | null;
|
|
11901
12053
|
'invoice': BaseInvoice | null;
|
|
11902
12054
|
'series': BaseSeries | null;
|
|
12055
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
11903
12056
|
}
|
|
11904
12057
|
export declare enum PaymentIntentSource {
|
|
11905
12058
|
Registration = "registration",
|
|
@@ -11910,7 +12063,8 @@ export declare enum PaymentIntentSource {
|
|
|
11910
12063
|
Coupon = "coupon",
|
|
11911
12064
|
Session = "session",
|
|
11912
12065
|
Booking = "booking",
|
|
11913
|
-
Series = "series"
|
|
12066
|
+
Series = "series",
|
|
12067
|
+
PlaceMembership = "placeMembership"
|
|
11914
12068
|
}
|
|
11915
12069
|
export interface PaymentLineItem {
|
|
11916
12070
|
'id': string;
|
|
@@ -11936,12 +12090,14 @@ export interface PaymentLineItem {
|
|
|
11936
12090
|
'reservationId': string | null;
|
|
11937
12091
|
'accessId': string | null;
|
|
11938
12092
|
'bookingId': string | null;
|
|
12093
|
+
'placeMembershipId': string | null;
|
|
11939
12094
|
'pass': BaseEventPass | null;
|
|
11940
12095
|
'package': BaseEventPackage | null;
|
|
11941
12096
|
'passAddOn': BasePassAddOn | null;
|
|
11942
12097
|
'reservation': BaseEventRoomTypeReservation | null;
|
|
11943
12098
|
'access': BaseEventSessionAccess | null;
|
|
11944
12099
|
'booking': BaseBooking | null;
|
|
12100
|
+
'placeMembership': BasePlaceMembership | null;
|
|
11945
12101
|
'coupon': BaseCoupon | null;
|
|
11946
12102
|
'seriesRegistration': BaseSeriesRegistration | null;
|
|
11947
12103
|
'payment': BasePayment;
|
|
@@ -11957,6 +12113,7 @@ export declare enum PaymentLineItemType {
|
|
|
11957
12113
|
Booking = "booking",
|
|
11958
12114
|
Coupon = "coupon",
|
|
11959
12115
|
Series = "series",
|
|
12116
|
+
PlaceMembership = "placeMembership",
|
|
11960
12117
|
Refund = "refund"
|
|
11961
12118
|
}
|
|
11962
12119
|
export declare enum PaymentType {
|
|
@@ -11973,6 +12130,117 @@ export interface PaypalActivationFormParams {
|
|
|
11973
12130
|
'currencyCode': string;
|
|
11974
12131
|
'name': string;
|
|
11975
12132
|
}
|
|
12133
|
+
export interface PlaceMembership {
|
|
12134
|
+
'id': string;
|
|
12135
|
+
'status': PurchaseStatus;
|
|
12136
|
+
'startsAt': string | null;
|
|
12137
|
+
'expiresAt': string | null;
|
|
12138
|
+
'account': BaseAccount;
|
|
12139
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
12140
|
+
'createdAt': string;
|
|
12141
|
+
'lineItem': PaymentLineItem | null;
|
|
12142
|
+
'members': Array<PlaceMembershipMember>;
|
|
12143
|
+
'_count': PlaceMembershipAllOfCount;
|
|
12144
|
+
}
|
|
12145
|
+
export interface PlaceMembershipAllOfCount {
|
|
12146
|
+
'bookings': number;
|
|
12147
|
+
}
|
|
12148
|
+
export interface PlaceMembershipCreateInputs {
|
|
12149
|
+
'accountId': string;
|
|
12150
|
+
'placeMembershipTypeId': string;
|
|
12151
|
+
'startsAt'?: string | null;
|
|
12152
|
+
'expiresAt'?: string | null;
|
|
12153
|
+
}
|
|
12154
|
+
export interface PlaceMembershipMember {
|
|
12155
|
+
'id': string;
|
|
12156
|
+
'name': string;
|
|
12157
|
+
'image': BaseImage | null;
|
|
12158
|
+
'createdAt': string;
|
|
12159
|
+
'updatedAt': string;
|
|
12160
|
+
}
|
|
12161
|
+
export interface PlaceMembershipMemberCreateInputs {
|
|
12162
|
+
'name': string;
|
|
12163
|
+
'imageId'?: string | null;
|
|
12164
|
+
}
|
|
12165
|
+
export interface PlaceMembershipMemberUpdateInputs {
|
|
12166
|
+
'name'?: string;
|
|
12167
|
+
'imageId'?: string | null;
|
|
12168
|
+
}
|
|
12169
|
+
export interface PlaceMembershipType {
|
|
12170
|
+
'id': string;
|
|
12171
|
+
'slug': string;
|
|
12172
|
+
'name': string;
|
|
12173
|
+
'description': string | null;
|
|
12174
|
+
'image': BaseImage | null;
|
|
12175
|
+
'price': number;
|
|
12176
|
+
'termDays': number;
|
|
12177
|
+
'maxMembers': number;
|
|
12178
|
+
'sortOrder': number;
|
|
12179
|
+
'visible': boolean;
|
|
12180
|
+
'archived': boolean;
|
|
12181
|
+
'taxCode': string | null;
|
|
12182
|
+
'taxIncluded': boolean;
|
|
12183
|
+
'taxLocation': TaxLocationType;
|
|
12184
|
+
'paymentIntegrationId': string | null;
|
|
12185
|
+
'paymentIntegration': BasePaymentIntegration | null;
|
|
12186
|
+
'entityId': string | null;
|
|
12187
|
+
'entity': BaseOrganizationEntity | null;
|
|
12188
|
+
'placeId': string;
|
|
12189
|
+
'createdAt': string;
|
|
12190
|
+
'updatedAt': string;
|
|
12191
|
+
}
|
|
12192
|
+
export interface PlaceMembershipTypeCreateInputs {
|
|
12193
|
+
'name': string;
|
|
12194
|
+
'description'?: string | null;
|
|
12195
|
+
'imageId'?: string | null;
|
|
12196
|
+
'price'?: number;
|
|
12197
|
+
'termDays': number;
|
|
12198
|
+
'maxMembers'?: number;
|
|
12199
|
+
'sortOrder'?: number | null;
|
|
12200
|
+
'visible'?: boolean;
|
|
12201
|
+
'taxCode'?: string | null;
|
|
12202
|
+
'taxIncluded'?: boolean;
|
|
12203
|
+
'taxLocation'?: TaxLocationType;
|
|
12204
|
+
'paymentIntegrationId'?: string | null;
|
|
12205
|
+
'entityId'?: string | null;
|
|
12206
|
+
}
|
|
12207
|
+
export interface PlaceMembershipTypeTranslation {
|
|
12208
|
+
'id': number;
|
|
12209
|
+
'locale': string;
|
|
12210
|
+
'name': string | null;
|
|
12211
|
+
'description': string | null;
|
|
12212
|
+
'createdAt': string;
|
|
12213
|
+
'updatedAt': string;
|
|
12214
|
+
}
|
|
12215
|
+
export interface PlaceMembershipTypeTranslationUpdateInputs {
|
|
12216
|
+
'name'?: string | null;
|
|
12217
|
+
'description'?: string | null;
|
|
12218
|
+
}
|
|
12219
|
+
export interface PlaceMembershipTypeUpdateInputs {
|
|
12220
|
+
'name'?: string;
|
|
12221
|
+
'description'?: string | null;
|
|
12222
|
+
'imageId'?: string | null;
|
|
12223
|
+
'price'?: number;
|
|
12224
|
+
'termDays'?: number;
|
|
12225
|
+
'maxMembers'?: number;
|
|
12226
|
+
'sortOrder'?: number | null;
|
|
12227
|
+
'visible'?: boolean;
|
|
12228
|
+
'archived'?: boolean;
|
|
12229
|
+
'taxCode'?: string | null;
|
|
12230
|
+
'taxIncluded'?: boolean;
|
|
12231
|
+
'taxLocation'?: TaxLocationType;
|
|
12232
|
+
'paymentIntegrationId'?: string | null;
|
|
12233
|
+
'entityId'?: string | null;
|
|
12234
|
+
}
|
|
12235
|
+
export interface PlaceMembershipUpdateInputs {
|
|
12236
|
+
'status'?: PlaceMembershipUpdateInputsStatusEnum;
|
|
12237
|
+
'startsAt'?: string;
|
|
12238
|
+
'expiresAt'?: string;
|
|
12239
|
+
}
|
|
12240
|
+
export declare enum PlaceMembershipUpdateInputsStatusEnum {
|
|
12241
|
+
Ready = "ready",
|
|
12242
|
+
Canceled = "canceled"
|
|
12243
|
+
}
|
|
11976
12244
|
export interface Preset {
|
|
11977
12245
|
'id': string;
|
|
11978
12246
|
'name': string;
|
|
@@ -14187,6 +14455,14 @@ export interface UpdateOrganizationIntegrationsRequest {
|
|
|
14187
14455
|
'ghostAdminKey'?: string;
|
|
14188
14456
|
'ghostContentKey'?: string;
|
|
14189
14457
|
}
|
|
14458
|
+
export interface UpdatePlaceMembershipTypeTranslation200Response {
|
|
14459
|
+
'status': UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
14460
|
+
'message': string;
|
|
14461
|
+
'data': PlaceMembershipTypeTranslation;
|
|
14462
|
+
}
|
|
14463
|
+
export declare enum UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
14464
|
+
Ok = "ok"
|
|
14465
|
+
}
|
|
14190
14466
|
export interface UpdateSelf200Response {
|
|
14191
14467
|
'status': UpdateSelf200ResponseStatusEnum;
|
|
14192
14468
|
'message': string;
|
|
@@ -23126,6 +23402,1033 @@ export declare class BookingsBlackoutsApi extends BaseAPI {
|
|
|
23126
23402
|
*/
|
|
23127
23403
|
updateBookingSpaceBlackout(requestParameters: BookingsBlackoutsApiUpdateBookingSpaceBlackoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingSpaceBlackout200Response, any, {}, any>>;
|
|
23128
23404
|
}
|
|
23405
|
+
/**
|
|
23406
|
+
* BookingsMembershipsApi - axios parameter creator
|
|
23407
|
+
*/
|
|
23408
|
+
export declare const BookingsMembershipsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23409
|
+
/**
|
|
23410
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23411
|
+
* @summary Grant a place membership
|
|
23412
|
+
* @param {string} placeId The place identifier
|
|
23413
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
23414
|
+
* @param {*} [options] Override http request option.
|
|
23415
|
+
* @throws {RequiredError}
|
|
23416
|
+
*/
|
|
23417
|
+
createPlaceMembership: (placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23418
|
+
/**
|
|
23419
|
+
* Adds a named member (optional photo) to a place membership, refused once maxMembers is reached or the membership is canceled; requires the update bookings permission.
|
|
23420
|
+
* @summary Add a member to a place membership
|
|
23421
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23422
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
23423
|
+
* @param {*} [options] Override http request option.
|
|
23424
|
+
* @throws {RequiredError}
|
|
23425
|
+
*/
|
|
23426
|
+
createPlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23427
|
+
/**
|
|
23428
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23429
|
+
* @summary Create a place membership type
|
|
23430
|
+
* @param {string} placeId The place identifier
|
|
23431
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
23432
|
+
* @param {*} [options] Override http request option.
|
|
23433
|
+
* @throws {RequiredError}
|
|
23434
|
+
*/
|
|
23435
|
+
createPlaceMembershipType: (placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23436
|
+
/**
|
|
23437
|
+
* Permanently deletes a named member from a place membership. Does not delete the member\'s image. Refused on a canceled membership; requires the update bookings permission.
|
|
23438
|
+
* @summary Remove a member from a place membership
|
|
23439
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23440
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23441
|
+
* @param {*} [options] Override http request option.
|
|
23442
|
+
* @throws {RequiredError}
|
|
23443
|
+
*/
|
|
23444
|
+
deletePlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23445
|
+
/**
|
|
23446
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23447
|
+
* @summary Delete a place membership type
|
|
23448
|
+
* @param {string} placeId The place identifier
|
|
23449
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23450
|
+
* @param {*} [options] Override http request option.
|
|
23451
|
+
* @throws {RequiredError}
|
|
23452
|
+
*/
|
|
23453
|
+
deletePlaceMembershipType: (placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23454
|
+
/**
|
|
23455
|
+
* Retrieves a single place membership by ID, including the holder, membership type, members, payment line item, and booking count; requires the \"read\" permission on \"bookings\".
|
|
23456
|
+
* @summary Get a place membership
|
|
23457
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23458
|
+
* @param {*} [options] Override http request option.
|
|
23459
|
+
* @throws {RequiredError}
|
|
23460
|
+
*/
|
|
23461
|
+
getPlaceMembership: (placeMembershipId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23462
|
+
/**
|
|
23463
|
+
* Returns a paginated list of bookings that have this place membership applied (it set the booking\'s price), searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
23464
|
+
* @summary List bookings that applied a place membership
|
|
23465
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23466
|
+
* @param {number} [page] Page number
|
|
23467
|
+
* @param {number} [pageSize] Number of items per page
|
|
23468
|
+
* @param {string} [orderBy] Field to order by
|
|
23469
|
+
* @param {string} [search] Search query
|
|
23470
|
+
* @param {*} [options] Override http request option.
|
|
23471
|
+
* @throws {RequiredError}
|
|
23472
|
+
*/
|
|
23473
|
+
getPlaceMembershipBookings: (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23474
|
+
/**
|
|
23475
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23476
|
+
* @summary List a place membership\'s members
|
|
23477
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23478
|
+
* @param {number} [page] Page number
|
|
23479
|
+
* @param {number} [pageSize] Number of items per page
|
|
23480
|
+
* @param {string} [orderBy] Field to order by
|
|
23481
|
+
* @param {string} [search] Search query
|
|
23482
|
+
* @param {*} [options] Override http request option.
|
|
23483
|
+
* @throws {RequiredError}
|
|
23484
|
+
*/
|
|
23485
|
+
getPlaceMembershipMembers: (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23486
|
+
/**
|
|
23487
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23488
|
+
* @summary Get a place membership type
|
|
23489
|
+
* @param {string} placeId The place identifier
|
|
23490
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23491
|
+
* @param {*} [options] Override http request option.
|
|
23492
|
+
* @throws {RequiredError}
|
|
23493
|
+
*/
|
|
23494
|
+
getPlaceMembershipType: (placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23495
|
+
/**
|
|
23496
|
+
* Returns a paginated list of membership types sold on a booking place, optionally filtered by archived status and searchable by name or description; requires the \"read\" permission on \"bookings\".
|
|
23497
|
+
* @summary List a place\'s membership types
|
|
23498
|
+
* @param {string} placeId The place identifier
|
|
23499
|
+
* @param {boolean} [archived] Filter by archived
|
|
23500
|
+
* @param {number} [page] Page number
|
|
23501
|
+
* @param {number} [pageSize] Number of items per page
|
|
23502
|
+
* @param {string} [orderBy] Field to order by
|
|
23503
|
+
* @param {string} [search] Search query
|
|
23504
|
+
* @param {*} [options] Override http request option.
|
|
23505
|
+
* @throws {RequiredError}
|
|
23506
|
+
*/
|
|
23507
|
+
getPlaceMembershipTypes: (placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23508
|
+
/**
|
|
23509
|
+
* Returns a paginated list of place memberships for a booking place, filterable by membership type, purchase status, currently active (ready and within dates), upcoming (ready and not yet started), and expired (ready and past expiresAt), and searchable by the holder\'s name; requires the \"read\" permission on \"bookings\".
|
|
23510
|
+
* @summary List a place\'s memberships
|
|
23511
|
+
* @param {string} placeId The place identifier
|
|
23512
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
23513
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
23514
|
+
* @param {boolean} [active] Filter by active
|
|
23515
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
23516
|
+
* @param {boolean} [expired] Filter by expired
|
|
23517
|
+
* @param {number} [page] Page number
|
|
23518
|
+
* @param {number} [pageSize] Number of items per page
|
|
23519
|
+
* @param {string} [orderBy] Field to order by
|
|
23520
|
+
* @param {string} [search] Search query
|
|
23521
|
+
* @param {*} [options] Override http request option.
|
|
23522
|
+
* @throws {RequiredError}
|
|
23523
|
+
*/
|
|
23524
|
+
getPlaceMemberships: (placeId: string, placeMembershipTypeId?: string, status?: PurchaseStatus, active?: boolean, upcoming?: boolean, expired?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23525
|
+
/**
|
|
23526
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23527
|
+
* @summary Update a place membership
|
|
23528
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23529
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
23530
|
+
* @param {*} [options] Override http request option.
|
|
23531
|
+
* @throws {RequiredError}
|
|
23532
|
+
*/
|
|
23533
|
+
updatePlaceMembership: (placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23534
|
+
/**
|
|
23535
|
+
* Updates a named member on a place membership (name and optional photo; imageId null clears the photo). Refused on a canceled membership; requires the update bookings permission.
|
|
23536
|
+
* @summary Update a place membership member
|
|
23537
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23538
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23539
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
23540
|
+
* @param {*} [options] Override http request option.
|
|
23541
|
+
* @throws {RequiredError}
|
|
23542
|
+
*/
|
|
23543
|
+
updatePlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23544
|
+
/**
|
|
23545
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23546
|
+
* @summary Update a place membership type
|
|
23547
|
+
* @param {string} placeId The place identifier
|
|
23548
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23549
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
23550
|
+
* @param {*} [options] Override http request option.
|
|
23551
|
+
* @throws {RequiredError}
|
|
23552
|
+
*/
|
|
23553
|
+
updatePlaceMembershipType: (placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23554
|
+
};
|
|
23555
|
+
/**
|
|
23556
|
+
* BookingsMembershipsApi - functional programming interface
|
|
23557
|
+
*/
|
|
23558
|
+
export declare const BookingsMembershipsApiFp: (configuration?: Configuration) => {
|
|
23559
|
+
/**
|
|
23560
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23561
|
+
* @summary Grant a place membership
|
|
23562
|
+
* @param {string} placeId The place identifier
|
|
23563
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
23564
|
+
* @param {*} [options] Override http request option.
|
|
23565
|
+
* @throws {RequiredError}
|
|
23566
|
+
*/
|
|
23567
|
+
createPlaceMembership(placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23568
|
+
/**
|
|
23569
|
+
* Adds a named member (optional photo) to a place membership, refused once maxMembers is reached or the membership is canceled; requires the update bookings permission.
|
|
23570
|
+
* @summary Add a member to a place membership
|
|
23571
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23572
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
23573
|
+
* @param {*} [options] Override http request option.
|
|
23574
|
+
* @throws {RequiredError}
|
|
23575
|
+
*/
|
|
23576
|
+
createPlaceMembershipMember(placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>>;
|
|
23577
|
+
/**
|
|
23578
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23579
|
+
* @summary Create a place membership type
|
|
23580
|
+
* @param {string} placeId The place identifier
|
|
23581
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
23582
|
+
* @param {*} [options] Override http request option.
|
|
23583
|
+
* @throws {RequiredError}
|
|
23584
|
+
*/
|
|
23585
|
+
createPlaceMembershipType(placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23586
|
+
/**
|
|
23587
|
+
* Permanently deletes a named member from a place membership. Does not delete the member\'s image. Refused on a canceled membership; requires the update bookings permission.
|
|
23588
|
+
* @summary Remove a member from a place membership
|
|
23589
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23590
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23591
|
+
* @param {*} [options] Override http request option.
|
|
23592
|
+
* @throws {RequiredError}
|
|
23593
|
+
*/
|
|
23594
|
+
deletePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
23595
|
+
/**
|
|
23596
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23597
|
+
* @summary Delete a place membership type
|
|
23598
|
+
* @param {string} placeId The place identifier
|
|
23599
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23600
|
+
* @param {*} [options] Override http request option.
|
|
23601
|
+
* @throws {RequiredError}
|
|
23602
|
+
*/
|
|
23603
|
+
deletePlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
23604
|
+
/**
|
|
23605
|
+
* Retrieves a single place membership by ID, including the holder, membership type, members, payment line item, and booking count; requires the \"read\" permission on \"bookings\".
|
|
23606
|
+
* @summary Get a place membership
|
|
23607
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23608
|
+
* @param {*} [options] Override http request option.
|
|
23609
|
+
* @throws {RequiredError}
|
|
23610
|
+
*/
|
|
23611
|
+
getPlaceMembership(placeMembershipId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23612
|
+
/**
|
|
23613
|
+
* Returns a paginated list of bookings that have this place membership applied (it set the booking\'s price), searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
23614
|
+
* @summary List bookings that applied a place membership
|
|
23615
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23616
|
+
* @param {number} [page] Page number
|
|
23617
|
+
* @param {number} [pageSize] Number of items per page
|
|
23618
|
+
* @param {string} [orderBy] Field to order by
|
|
23619
|
+
* @param {string} [search] Search query
|
|
23620
|
+
* @param {*} [options] Override http request option.
|
|
23621
|
+
* @throws {RequiredError}
|
|
23622
|
+
*/
|
|
23623
|
+
getPlaceMembershipBookings(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountBookings200Response>>;
|
|
23624
|
+
/**
|
|
23625
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23626
|
+
* @summary List a place membership\'s members
|
|
23627
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23628
|
+
* @param {number} [page] Page number
|
|
23629
|
+
* @param {number} [pageSize] Number of items per page
|
|
23630
|
+
* @param {string} [orderBy] Field to order by
|
|
23631
|
+
* @param {string} [search] Search query
|
|
23632
|
+
* @param {*} [options] Override http request option.
|
|
23633
|
+
* @throws {RequiredError}
|
|
23634
|
+
*/
|
|
23635
|
+
getPlaceMembershipMembers(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipMembers200Response>>;
|
|
23636
|
+
/**
|
|
23637
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23638
|
+
* @summary Get a place membership type
|
|
23639
|
+
* @param {string} placeId The place identifier
|
|
23640
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23641
|
+
* @param {*} [options] Override http request option.
|
|
23642
|
+
* @throws {RequiredError}
|
|
23643
|
+
*/
|
|
23644
|
+
getPlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23645
|
+
/**
|
|
23646
|
+
* Returns a paginated list of membership types sold on a booking place, optionally filtered by archived status and searchable by name or description; requires the \"read\" permission on \"bookings\".
|
|
23647
|
+
* @summary List a place\'s membership types
|
|
23648
|
+
* @param {string} placeId The place identifier
|
|
23649
|
+
* @param {boolean} [archived] Filter by archived
|
|
23650
|
+
* @param {number} [page] Page number
|
|
23651
|
+
* @param {number} [pageSize] Number of items per page
|
|
23652
|
+
* @param {string} [orderBy] Field to order by
|
|
23653
|
+
* @param {string} [search] Search query
|
|
23654
|
+
* @param {*} [options] Override http request option.
|
|
23655
|
+
* @throws {RequiredError}
|
|
23656
|
+
*/
|
|
23657
|
+
getPlaceMembershipTypes(placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypes200Response>>;
|
|
23658
|
+
/**
|
|
23659
|
+
* Returns a paginated list of place memberships for a booking place, filterable by membership type, purchase status, currently active (ready and within dates), upcoming (ready and not yet started), and expired (ready and past expiresAt), and searchable by the holder\'s name; requires the \"read\" permission on \"bookings\".
|
|
23660
|
+
* @summary List a place\'s memberships
|
|
23661
|
+
* @param {string} placeId The place identifier
|
|
23662
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
23663
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
23664
|
+
* @param {boolean} [active] Filter by active
|
|
23665
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
23666
|
+
* @param {boolean} [expired] Filter by expired
|
|
23667
|
+
* @param {number} [page] Page number
|
|
23668
|
+
* @param {number} [pageSize] Number of items per page
|
|
23669
|
+
* @param {string} [orderBy] Field to order by
|
|
23670
|
+
* @param {string} [search] Search query
|
|
23671
|
+
* @param {*} [options] Override http request option.
|
|
23672
|
+
* @throws {RequiredError}
|
|
23673
|
+
*/
|
|
23674
|
+
getPlaceMemberships(placeId: string, placeMembershipTypeId?: string, status?: PurchaseStatus, active?: boolean, upcoming?: boolean, expired?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMemberships200Response>>;
|
|
23675
|
+
/**
|
|
23676
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23677
|
+
* @summary Update a place membership
|
|
23678
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23679
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
23680
|
+
* @param {*} [options] Override http request option.
|
|
23681
|
+
* @throws {RequiredError}
|
|
23682
|
+
*/
|
|
23683
|
+
updatePlaceMembership(placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23684
|
+
/**
|
|
23685
|
+
* Updates a named member on a place membership (name and optional photo; imageId null clears the photo). Refused on a canceled membership; requires the update bookings permission.
|
|
23686
|
+
* @summary Update a place membership member
|
|
23687
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23688
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23689
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
23690
|
+
* @param {*} [options] Override http request option.
|
|
23691
|
+
* @throws {RequiredError}
|
|
23692
|
+
*/
|
|
23693
|
+
updatePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>>;
|
|
23694
|
+
/**
|
|
23695
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23696
|
+
* @summary Update a place membership type
|
|
23697
|
+
* @param {string} placeId The place identifier
|
|
23698
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23699
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
23700
|
+
* @param {*} [options] Override http request option.
|
|
23701
|
+
* @throws {RequiredError}
|
|
23702
|
+
*/
|
|
23703
|
+
updatePlaceMembershipType(placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23704
|
+
};
|
|
23705
|
+
/**
|
|
23706
|
+
* BookingsMembershipsApi - factory interface
|
|
23707
|
+
*/
|
|
23708
|
+
export declare const BookingsMembershipsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23709
|
+
/**
|
|
23710
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23711
|
+
* @summary Grant a place membership
|
|
23712
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
23713
|
+
* @param {*} [options] Override http request option.
|
|
23714
|
+
* @throws {RequiredError}
|
|
23715
|
+
*/
|
|
23716
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23717
|
+
/**
|
|
23718
|
+
* Adds a named member (optional photo) to a place membership, refused once maxMembers is reached or the membership is canceled; requires the update bookings permission.
|
|
23719
|
+
* @summary Add a member to a place membership
|
|
23720
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23721
|
+
* @param {*} [options] Override http request option.
|
|
23722
|
+
* @throws {RequiredError}
|
|
23723
|
+
*/
|
|
23724
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response>;
|
|
23725
|
+
/**
|
|
23726
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23727
|
+
* @summary Create a place membership type
|
|
23728
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23729
|
+
* @param {*} [options] Override http request option.
|
|
23730
|
+
* @throws {RequiredError}
|
|
23731
|
+
*/
|
|
23732
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23733
|
+
/**
|
|
23734
|
+
* Permanently deletes a named member from a place membership. Does not delete the member\'s image. Refused on a canceled membership; requires the update bookings permission.
|
|
23735
|
+
* @summary Remove a member from a place membership
|
|
23736
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23737
|
+
* @param {*} [options] Override http request option.
|
|
23738
|
+
* @throws {RequiredError}
|
|
23739
|
+
*/
|
|
23740
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
23741
|
+
/**
|
|
23742
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23743
|
+
* @summary Delete a place membership type
|
|
23744
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23745
|
+
* @param {*} [options] Override http request option.
|
|
23746
|
+
* @throws {RequiredError}
|
|
23747
|
+
*/
|
|
23748
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
23749
|
+
/**
|
|
23750
|
+
* Retrieves a single place membership by ID, including the holder, membership type, members, payment line item, and booking count; requires the \"read\" permission on \"bookings\".
|
|
23751
|
+
* @summary Get a place membership
|
|
23752
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
23753
|
+
* @param {*} [options] Override http request option.
|
|
23754
|
+
* @throws {RequiredError}
|
|
23755
|
+
*/
|
|
23756
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23757
|
+
/**
|
|
23758
|
+
* Returns a paginated list of bookings that have this place membership applied (it set the booking\'s price), searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
23759
|
+
* @summary List bookings that applied a place membership
|
|
23760
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
23761
|
+
* @param {*} [options] Override http request option.
|
|
23762
|
+
* @throws {RequiredError}
|
|
23763
|
+
*/
|
|
23764
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountBookings200Response>;
|
|
23765
|
+
/**
|
|
23766
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23767
|
+
* @summary List a place membership\'s members
|
|
23768
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
23769
|
+
* @param {*} [options] Override http request option.
|
|
23770
|
+
* @throws {RequiredError}
|
|
23771
|
+
*/
|
|
23772
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipMembers200Response>;
|
|
23773
|
+
/**
|
|
23774
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23775
|
+
* @summary Get a place membership type
|
|
23776
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23777
|
+
* @param {*} [options] Override http request option.
|
|
23778
|
+
* @throws {RequiredError}
|
|
23779
|
+
*/
|
|
23780
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23781
|
+
/**
|
|
23782
|
+
* Returns a paginated list of membership types sold on a booking place, optionally filtered by archived status and searchable by name or description; requires the \"read\" permission on \"bookings\".
|
|
23783
|
+
* @summary List a place\'s membership types
|
|
23784
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
23785
|
+
* @param {*} [options] Override http request option.
|
|
23786
|
+
* @throws {RequiredError}
|
|
23787
|
+
*/
|
|
23788
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypes200Response>;
|
|
23789
|
+
/**
|
|
23790
|
+
* Returns a paginated list of place memberships for a booking place, filterable by membership type, purchase status, currently active (ready and within dates), upcoming (ready and not yet started), and expired (ready and past expiresAt), and searchable by the holder\'s name; requires the \"read\" permission on \"bookings\".
|
|
23791
|
+
* @summary List a place\'s memberships
|
|
23792
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
23793
|
+
* @param {*} [options] Override http request option.
|
|
23794
|
+
* @throws {RequiredError}
|
|
23795
|
+
*/
|
|
23796
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMemberships200Response>;
|
|
23797
|
+
/**
|
|
23798
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23799
|
+
* @summary Update a place membership
|
|
23800
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
23801
|
+
* @param {*} [options] Override http request option.
|
|
23802
|
+
* @throws {RequiredError}
|
|
23803
|
+
*/
|
|
23804
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23805
|
+
/**
|
|
23806
|
+
* Updates a named member on a place membership (name and optional photo; imageId null clears the photo). Refused on a canceled membership; requires the update bookings permission.
|
|
23807
|
+
* @summary Update a place membership member
|
|
23808
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23809
|
+
* @param {*} [options] Override http request option.
|
|
23810
|
+
* @throws {RequiredError}
|
|
23811
|
+
*/
|
|
23812
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response>;
|
|
23813
|
+
/**
|
|
23814
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23815
|
+
* @summary Update a place membership type
|
|
23816
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23817
|
+
* @param {*} [options] Override http request option.
|
|
23818
|
+
* @throws {RequiredError}
|
|
23819
|
+
*/
|
|
23820
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23821
|
+
};
|
|
23822
|
+
/**
|
|
23823
|
+
* Request parameters for createPlaceMembership operation in BookingsMembershipsApi.
|
|
23824
|
+
*/
|
|
23825
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipRequest {
|
|
23826
|
+
/**
|
|
23827
|
+
* The place identifier
|
|
23828
|
+
*/
|
|
23829
|
+
readonly placeId: string;
|
|
23830
|
+
readonly placeMembershipCreateInputs: PlaceMembershipCreateInputs;
|
|
23831
|
+
}
|
|
23832
|
+
/**
|
|
23833
|
+
* Request parameters for createPlaceMembershipMember operation in BookingsMembershipsApi.
|
|
23834
|
+
*/
|
|
23835
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipMemberRequest {
|
|
23836
|
+
/**
|
|
23837
|
+
* The placeMembership identifier
|
|
23838
|
+
*/
|
|
23839
|
+
readonly placeMembershipId: string;
|
|
23840
|
+
readonly placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs;
|
|
23841
|
+
}
|
|
23842
|
+
/**
|
|
23843
|
+
* Request parameters for createPlaceMembershipType operation in BookingsMembershipsApi.
|
|
23844
|
+
*/
|
|
23845
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipTypeRequest {
|
|
23846
|
+
/**
|
|
23847
|
+
* The place identifier
|
|
23848
|
+
*/
|
|
23849
|
+
readonly placeId: string;
|
|
23850
|
+
readonly placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs;
|
|
23851
|
+
}
|
|
23852
|
+
/**
|
|
23853
|
+
* Request parameters for deletePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
23854
|
+
*/
|
|
23855
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipMemberRequest {
|
|
23856
|
+
/**
|
|
23857
|
+
* The placeMembership identifier
|
|
23858
|
+
*/
|
|
23859
|
+
readonly placeMembershipId: string;
|
|
23860
|
+
/**
|
|
23861
|
+
* The placeMembershipMember identifier
|
|
23862
|
+
*/
|
|
23863
|
+
readonly placeMembershipMemberId: string;
|
|
23864
|
+
}
|
|
23865
|
+
/**
|
|
23866
|
+
* Request parameters for deletePlaceMembershipType operation in BookingsMembershipsApi.
|
|
23867
|
+
*/
|
|
23868
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipTypeRequest {
|
|
23869
|
+
/**
|
|
23870
|
+
* The place identifier
|
|
23871
|
+
*/
|
|
23872
|
+
readonly placeId: string;
|
|
23873
|
+
/**
|
|
23874
|
+
* The placeMembershipType identifier
|
|
23875
|
+
*/
|
|
23876
|
+
readonly placeMembershipTypeId: string;
|
|
23877
|
+
}
|
|
23878
|
+
/**
|
|
23879
|
+
* Request parameters for getPlaceMembership operation in BookingsMembershipsApi.
|
|
23880
|
+
*/
|
|
23881
|
+
export interface BookingsMembershipsApiGetPlaceMembershipRequest {
|
|
23882
|
+
/**
|
|
23883
|
+
* The placeMembership identifier
|
|
23884
|
+
*/
|
|
23885
|
+
readonly placeMembershipId: string;
|
|
23886
|
+
}
|
|
23887
|
+
/**
|
|
23888
|
+
* Request parameters for getPlaceMembershipBookings operation in BookingsMembershipsApi.
|
|
23889
|
+
*/
|
|
23890
|
+
export interface BookingsMembershipsApiGetPlaceMembershipBookingsRequest {
|
|
23891
|
+
/**
|
|
23892
|
+
* The placeMembership identifier
|
|
23893
|
+
*/
|
|
23894
|
+
readonly placeMembershipId: string;
|
|
23895
|
+
/**
|
|
23896
|
+
* Page number
|
|
23897
|
+
*/
|
|
23898
|
+
readonly page?: number;
|
|
23899
|
+
/**
|
|
23900
|
+
* Number of items per page
|
|
23901
|
+
*/
|
|
23902
|
+
readonly pageSize?: number;
|
|
23903
|
+
/**
|
|
23904
|
+
* Field to order by
|
|
23905
|
+
*/
|
|
23906
|
+
readonly orderBy?: string;
|
|
23907
|
+
/**
|
|
23908
|
+
* Search query
|
|
23909
|
+
*/
|
|
23910
|
+
readonly search?: string;
|
|
23911
|
+
}
|
|
23912
|
+
/**
|
|
23913
|
+
* Request parameters for getPlaceMembershipMembers operation in BookingsMembershipsApi.
|
|
23914
|
+
*/
|
|
23915
|
+
export interface BookingsMembershipsApiGetPlaceMembershipMembersRequest {
|
|
23916
|
+
/**
|
|
23917
|
+
* The placeMembership identifier
|
|
23918
|
+
*/
|
|
23919
|
+
readonly placeMembershipId: string;
|
|
23920
|
+
/**
|
|
23921
|
+
* Page number
|
|
23922
|
+
*/
|
|
23923
|
+
readonly page?: number;
|
|
23924
|
+
/**
|
|
23925
|
+
* Number of items per page
|
|
23926
|
+
*/
|
|
23927
|
+
readonly pageSize?: number;
|
|
23928
|
+
/**
|
|
23929
|
+
* Field to order by
|
|
23930
|
+
*/
|
|
23931
|
+
readonly orderBy?: string;
|
|
23932
|
+
/**
|
|
23933
|
+
* Search query
|
|
23934
|
+
*/
|
|
23935
|
+
readonly search?: string;
|
|
23936
|
+
}
|
|
23937
|
+
/**
|
|
23938
|
+
* Request parameters for getPlaceMembershipType operation in BookingsMembershipsApi.
|
|
23939
|
+
*/
|
|
23940
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypeRequest {
|
|
23941
|
+
/**
|
|
23942
|
+
* The place identifier
|
|
23943
|
+
*/
|
|
23944
|
+
readonly placeId: string;
|
|
23945
|
+
/**
|
|
23946
|
+
* The placeMembershipType identifier
|
|
23947
|
+
*/
|
|
23948
|
+
readonly placeMembershipTypeId: string;
|
|
23949
|
+
}
|
|
23950
|
+
/**
|
|
23951
|
+
* Request parameters for getPlaceMembershipTypes operation in BookingsMembershipsApi.
|
|
23952
|
+
*/
|
|
23953
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypesRequest {
|
|
23954
|
+
/**
|
|
23955
|
+
* The place identifier
|
|
23956
|
+
*/
|
|
23957
|
+
readonly placeId: string;
|
|
23958
|
+
/**
|
|
23959
|
+
* Filter by archived
|
|
23960
|
+
*/
|
|
23961
|
+
readonly archived?: boolean;
|
|
23962
|
+
/**
|
|
23963
|
+
* Page number
|
|
23964
|
+
*/
|
|
23965
|
+
readonly page?: number;
|
|
23966
|
+
/**
|
|
23967
|
+
* Number of items per page
|
|
23968
|
+
*/
|
|
23969
|
+
readonly pageSize?: number;
|
|
23970
|
+
/**
|
|
23971
|
+
* Field to order by
|
|
23972
|
+
*/
|
|
23973
|
+
readonly orderBy?: string;
|
|
23974
|
+
/**
|
|
23975
|
+
* Search query
|
|
23976
|
+
*/
|
|
23977
|
+
readonly search?: string;
|
|
23978
|
+
}
|
|
23979
|
+
/**
|
|
23980
|
+
* Request parameters for getPlaceMemberships operation in BookingsMembershipsApi.
|
|
23981
|
+
*/
|
|
23982
|
+
export interface BookingsMembershipsApiGetPlaceMembershipsRequest {
|
|
23983
|
+
/**
|
|
23984
|
+
* The place identifier
|
|
23985
|
+
*/
|
|
23986
|
+
readonly placeId: string;
|
|
23987
|
+
/**
|
|
23988
|
+
* Filter by placeMembershipTypeId
|
|
23989
|
+
*/
|
|
23990
|
+
readonly placeMembershipTypeId?: string;
|
|
23991
|
+
/**
|
|
23992
|
+
* Filter by status
|
|
23993
|
+
*/
|
|
23994
|
+
readonly status?: PurchaseStatus;
|
|
23995
|
+
/**
|
|
23996
|
+
* Filter by active
|
|
23997
|
+
*/
|
|
23998
|
+
readonly active?: boolean;
|
|
23999
|
+
/**
|
|
24000
|
+
* Filter by upcoming
|
|
24001
|
+
*/
|
|
24002
|
+
readonly upcoming?: boolean;
|
|
24003
|
+
/**
|
|
24004
|
+
* Filter by expired
|
|
24005
|
+
*/
|
|
24006
|
+
readonly expired?: boolean;
|
|
24007
|
+
/**
|
|
24008
|
+
* Page number
|
|
24009
|
+
*/
|
|
24010
|
+
readonly page?: number;
|
|
24011
|
+
/**
|
|
24012
|
+
* Number of items per page
|
|
24013
|
+
*/
|
|
24014
|
+
readonly pageSize?: number;
|
|
24015
|
+
/**
|
|
24016
|
+
* Field to order by
|
|
24017
|
+
*/
|
|
24018
|
+
readonly orderBy?: string;
|
|
24019
|
+
/**
|
|
24020
|
+
* Search query
|
|
24021
|
+
*/
|
|
24022
|
+
readonly search?: string;
|
|
24023
|
+
}
|
|
24024
|
+
/**
|
|
24025
|
+
* Request parameters for updatePlaceMembership operation in BookingsMembershipsApi.
|
|
24026
|
+
*/
|
|
24027
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipRequest {
|
|
24028
|
+
/**
|
|
24029
|
+
* The placeMembership identifier
|
|
24030
|
+
*/
|
|
24031
|
+
readonly placeMembershipId: string;
|
|
24032
|
+
readonly placeMembershipUpdateInputs: PlaceMembershipUpdateInputs;
|
|
24033
|
+
}
|
|
24034
|
+
/**
|
|
24035
|
+
* Request parameters for updatePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
24036
|
+
*/
|
|
24037
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipMemberRequest {
|
|
24038
|
+
/**
|
|
24039
|
+
* The placeMembership identifier
|
|
24040
|
+
*/
|
|
24041
|
+
readonly placeMembershipId: string;
|
|
24042
|
+
/**
|
|
24043
|
+
* The placeMembershipMember identifier
|
|
24044
|
+
*/
|
|
24045
|
+
readonly placeMembershipMemberId: string;
|
|
24046
|
+
readonly placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs;
|
|
24047
|
+
}
|
|
24048
|
+
/**
|
|
24049
|
+
* Request parameters for updatePlaceMembershipType operation in BookingsMembershipsApi.
|
|
24050
|
+
*/
|
|
24051
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipTypeRequest {
|
|
24052
|
+
/**
|
|
24053
|
+
* The place identifier
|
|
24054
|
+
*/
|
|
24055
|
+
readonly placeId: string;
|
|
24056
|
+
/**
|
|
24057
|
+
* The placeMembershipType identifier
|
|
24058
|
+
*/
|
|
24059
|
+
readonly placeMembershipTypeId: string;
|
|
24060
|
+
readonly placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs;
|
|
24061
|
+
}
|
|
24062
|
+
/**
|
|
24063
|
+
* BookingsMembershipsApi - object-oriented interface
|
|
24064
|
+
*/
|
|
24065
|
+
export declare class BookingsMembershipsApi extends BaseAPI {
|
|
24066
|
+
/**
|
|
24067
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
24068
|
+
* @summary Grant a place membership
|
|
24069
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
24070
|
+
* @param {*} [options] Override http request option.
|
|
24071
|
+
* @throws {RequiredError}
|
|
24072
|
+
*/
|
|
24073
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24074
|
+
/**
|
|
24075
|
+
* Adds a named member (optional photo) to a place membership, refused once maxMembers is reached or the membership is canceled; requires the update bookings permission.
|
|
24076
|
+
* @summary Add a member to a place membership
|
|
24077
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24078
|
+
* @param {*} [options] Override http request option.
|
|
24079
|
+
* @throws {RequiredError}
|
|
24080
|
+
*/
|
|
24081
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipMember200Response, any, {}, any>>;
|
|
24082
|
+
/**
|
|
24083
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
24084
|
+
* @summary Create a place membership type
|
|
24085
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24086
|
+
* @param {*} [options] Override http request option.
|
|
24087
|
+
* @throws {RequiredError}
|
|
24088
|
+
*/
|
|
24089
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24090
|
+
/**
|
|
24091
|
+
* Permanently deletes a named member from a place membership. Does not delete the member\'s image. Refused on a canceled membership; requires the update bookings permission.
|
|
24092
|
+
* @summary Remove a member from a place membership
|
|
24093
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24094
|
+
* @param {*} [options] Override http request option.
|
|
24095
|
+
* @throws {RequiredError}
|
|
24096
|
+
*/
|
|
24097
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24098
|
+
/**
|
|
24099
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
24100
|
+
* @summary Delete a place membership type
|
|
24101
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24102
|
+
* @param {*} [options] Override http request option.
|
|
24103
|
+
* @throws {RequiredError}
|
|
24104
|
+
*/
|
|
24105
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24106
|
+
/**
|
|
24107
|
+
* Retrieves a single place membership by ID, including the holder, membership type, members, payment line item, and booking count; requires the \"read\" permission on \"bookings\".
|
|
24108
|
+
* @summary Get a place membership
|
|
24109
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
24110
|
+
* @param {*} [options] Override http request option.
|
|
24111
|
+
* @throws {RequiredError}
|
|
24112
|
+
*/
|
|
24113
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24114
|
+
/**
|
|
24115
|
+
* Returns a paginated list of bookings that have this place membership applied (it set the booking\'s price), searchable by the booking account\'s name or email; requires the \"read\" permission on \"bookings\".
|
|
24116
|
+
* @summary List bookings that applied a place membership
|
|
24117
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
24118
|
+
* @param {*} [options] Override http request option.
|
|
24119
|
+
* @throws {RequiredError}
|
|
24120
|
+
*/
|
|
24121
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountBookings200Response, any, {}, any>>;
|
|
24122
|
+
/**
|
|
24123
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
24124
|
+
* @summary List a place membership\'s members
|
|
24125
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
24126
|
+
* @param {*} [options] Override http request option.
|
|
24127
|
+
* @throws {RequiredError}
|
|
24128
|
+
*/
|
|
24129
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipMembers200Response, any, {}, any>>;
|
|
24130
|
+
/**
|
|
24131
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
24132
|
+
* @summary Get a place membership type
|
|
24133
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24134
|
+
* @param {*} [options] Override http request option.
|
|
24135
|
+
* @throws {RequiredError}
|
|
24136
|
+
*/
|
|
24137
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24138
|
+
/**
|
|
24139
|
+
* Returns a paginated list of membership types sold on a booking place, optionally filtered by archived status and searchable by name or description; requires the \"read\" permission on \"bookings\".
|
|
24140
|
+
* @summary List a place\'s membership types
|
|
24141
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
24142
|
+
* @param {*} [options] Override http request option.
|
|
24143
|
+
* @throws {RequiredError}
|
|
24144
|
+
*/
|
|
24145
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypes200Response, any, {}, any>>;
|
|
24146
|
+
/**
|
|
24147
|
+
* Returns a paginated list of place memberships for a booking place, filterable by membership type, purchase status, currently active (ready and within dates), upcoming (ready and not yet started), and expired (ready and past expiresAt), and searchable by the holder\'s name; requires the \"read\" permission on \"bookings\".
|
|
24148
|
+
* @summary List a place\'s memberships
|
|
24149
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
24150
|
+
* @param {*} [options] Override http request option.
|
|
24151
|
+
* @throws {RequiredError}
|
|
24152
|
+
*/
|
|
24153
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMemberships200Response, any, {}, any>>;
|
|
24154
|
+
/**
|
|
24155
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
24156
|
+
* @summary Update a place membership
|
|
24157
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
24158
|
+
* @param {*} [options] Override http request option.
|
|
24159
|
+
* @throws {RequiredError}
|
|
24160
|
+
*/
|
|
24161
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24162
|
+
/**
|
|
24163
|
+
* Updates a named member on a place membership (name and optional photo; imageId null clears the photo). Refused on a canceled membership; requires the update bookings permission.
|
|
24164
|
+
* @summary Update a place membership member
|
|
24165
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24166
|
+
* @param {*} [options] Override http request option.
|
|
24167
|
+
* @throws {RequiredError}
|
|
24168
|
+
*/
|
|
24169
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipMember200Response, any, {}, any>>;
|
|
24170
|
+
/**
|
|
24171
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
24172
|
+
* @summary Update a place membership type
|
|
24173
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24174
|
+
* @param {*} [options] Override http request option.
|
|
24175
|
+
* @throws {RequiredError}
|
|
24176
|
+
*/
|
|
24177
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24178
|
+
}
|
|
24179
|
+
/**
|
|
24180
|
+
* BookingsMembershipsTranslationsApi - axios parameter creator
|
|
24181
|
+
*/
|
|
24182
|
+
export declare const BookingsMembershipsTranslationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24183
|
+
/**
|
|
24184
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24185
|
+
* @summary Delete a place membership type translation
|
|
24186
|
+
* @param {string} placeId The place identifier
|
|
24187
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24188
|
+
* @param {string} locale The locale identifier
|
|
24189
|
+
* @param {*} [options] Override http request option.
|
|
24190
|
+
* @throws {RequiredError}
|
|
24191
|
+
*/
|
|
24192
|
+
deletePlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24193
|
+
/**
|
|
24194
|
+
* Retrieves the translated name and description of a place membership type in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
24195
|
+
* @summary Get a place membership type\'s translation
|
|
24196
|
+
* @param {string} placeId The place identifier
|
|
24197
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24198
|
+
* @param {string} locale The locale identifier
|
|
24199
|
+
* @param {*} [options] Override http request option.
|
|
24200
|
+
* @throws {RequiredError}
|
|
24201
|
+
*/
|
|
24202
|
+
getPlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24203
|
+
/**
|
|
24204
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24205
|
+
* @summary List a place membership type\'s translations
|
|
24206
|
+
* @param {string} placeId The place identifier
|
|
24207
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24208
|
+
* @param {number} [page] Page number
|
|
24209
|
+
* @param {number} [pageSize] Number of items per page
|
|
24210
|
+
* @param {string} [orderBy] Field to order by
|
|
24211
|
+
* @param {string} [search] Search query
|
|
24212
|
+
* @param {*} [options] Override http request option.
|
|
24213
|
+
* @throws {RequiredError}
|
|
24214
|
+
*/
|
|
24215
|
+
getPlaceMembershipTypeTranslations: (placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24216
|
+
/**
|
|
24217
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24218
|
+
* @summary Update a place membership type\'s translation
|
|
24219
|
+
* @param {string} placeId The place identifier
|
|
24220
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24221
|
+
* @param {string} locale The locale identifier
|
|
24222
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
24223
|
+
* @param {*} [options] Override http request option.
|
|
24224
|
+
* @throws {RequiredError}
|
|
24225
|
+
*/
|
|
24226
|
+
updatePlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24227
|
+
};
|
|
24228
|
+
/**
|
|
24229
|
+
* BookingsMembershipsTranslationsApi - functional programming interface
|
|
24230
|
+
*/
|
|
24231
|
+
export declare const BookingsMembershipsTranslationsApiFp: (configuration?: Configuration) => {
|
|
24232
|
+
/**
|
|
24233
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24234
|
+
* @summary Delete a place membership type translation
|
|
24235
|
+
* @param {string} placeId The place identifier
|
|
24236
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24237
|
+
* @param {string} locale The locale identifier
|
|
24238
|
+
* @param {*} [options] Override http request option.
|
|
24239
|
+
* @throws {RequiredError}
|
|
24240
|
+
*/
|
|
24241
|
+
deletePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
24242
|
+
/**
|
|
24243
|
+
* Retrieves the translated name and description of a place membership type in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
24244
|
+
* @summary Get a place membership type\'s translation
|
|
24245
|
+
* @param {string} placeId The place identifier
|
|
24246
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24247
|
+
* @param {string} locale The locale identifier
|
|
24248
|
+
* @param {*} [options] Override http request option.
|
|
24249
|
+
* @throws {RequiredError}
|
|
24250
|
+
*/
|
|
24251
|
+
getPlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslation200Response>>;
|
|
24252
|
+
/**
|
|
24253
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24254
|
+
* @summary List a place membership type\'s translations
|
|
24255
|
+
* @param {string} placeId The place identifier
|
|
24256
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24257
|
+
* @param {number} [page] Page number
|
|
24258
|
+
* @param {number} [pageSize] Number of items per page
|
|
24259
|
+
* @param {string} [orderBy] Field to order by
|
|
24260
|
+
* @param {string} [search] Search query
|
|
24261
|
+
* @param {*} [options] Override http request option.
|
|
24262
|
+
* @throws {RequiredError}
|
|
24263
|
+
*/
|
|
24264
|
+
getPlaceMembershipTypeTranslations(placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslations200Response>>;
|
|
24265
|
+
/**
|
|
24266
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24267
|
+
* @summary Update a place membership type\'s translation
|
|
24268
|
+
* @param {string} placeId The place identifier
|
|
24269
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24270
|
+
* @param {string} locale The locale identifier
|
|
24271
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
24272
|
+
* @param {*} [options] Override http request option.
|
|
24273
|
+
* @throws {RequiredError}
|
|
24274
|
+
*/
|
|
24275
|
+
updatePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>>;
|
|
24276
|
+
};
|
|
24277
|
+
/**
|
|
24278
|
+
* BookingsMembershipsTranslationsApi - factory interface
|
|
24279
|
+
*/
|
|
24280
|
+
export declare const BookingsMembershipsTranslationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24281
|
+
/**
|
|
24282
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24283
|
+
* @summary Delete a place membership type translation
|
|
24284
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24285
|
+
* @param {*} [options] Override http request option.
|
|
24286
|
+
* @throws {RequiredError}
|
|
24287
|
+
*/
|
|
24288
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
24289
|
+
/**
|
|
24290
|
+
* Retrieves the translated name and description of a place membership type in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
24291
|
+
* @summary Get a place membership type\'s translation
|
|
24292
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24293
|
+
* @param {*} [options] Override http request option.
|
|
24294
|
+
* @throws {RequiredError}
|
|
24295
|
+
*/
|
|
24296
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslation200Response>;
|
|
24297
|
+
/**
|
|
24298
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24299
|
+
* @summary List a place membership type\'s translations
|
|
24300
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
24301
|
+
* @param {*} [options] Override http request option.
|
|
24302
|
+
* @throws {RequiredError}
|
|
24303
|
+
*/
|
|
24304
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslations200Response>;
|
|
24305
|
+
/**
|
|
24306
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24307
|
+
* @summary Update a place membership type\'s translation
|
|
24308
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24309
|
+
* @param {*} [options] Override http request option.
|
|
24310
|
+
* @throws {RequiredError}
|
|
24311
|
+
*/
|
|
24312
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>;
|
|
24313
|
+
};
|
|
24314
|
+
/**
|
|
24315
|
+
* Request parameters for deletePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24316
|
+
*/
|
|
24317
|
+
export interface BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest {
|
|
24318
|
+
/**
|
|
24319
|
+
* The place identifier
|
|
24320
|
+
*/
|
|
24321
|
+
readonly placeId: string;
|
|
24322
|
+
/**
|
|
24323
|
+
* The placeMembershipType identifier
|
|
24324
|
+
*/
|
|
24325
|
+
readonly placeMembershipTypeId: string;
|
|
24326
|
+
/**
|
|
24327
|
+
* The locale identifier
|
|
24328
|
+
*/
|
|
24329
|
+
readonly locale: string;
|
|
24330
|
+
}
|
|
24331
|
+
/**
|
|
24332
|
+
* Request parameters for getPlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24333
|
+
*/
|
|
24334
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest {
|
|
24335
|
+
/**
|
|
24336
|
+
* The place identifier
|
|
24337
|
+
*/
|
|
24338
|
+
readonly placeId: string;
|
|
24339
|
+
/**
|
|
24340
|
+
* The placeMembershipType identifier
|
|
24341
|
+
*/
|
|
24342
|
+
readonly placeMembershipTypeId: string;
|
|
24343
|
+
/**
|
|
24344
|
+
* The locale identifier
|
|
24345
|
+
*/
|
|
24346
|
+
readonly locale: string;
|
|
24347
|
+
}
|
|
24348
|
+
/**
|
|
24349
|
+
* Request parameters for getPlaceMembershipTypeTranslations operation in BookingsMembershipsTranslationsApi.
|
|
24350
|
+
*/
|
|
24351
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest {
|
|
24352
|
+
/**
|
|
24353
|
+
* The place identifier
|
|
24354
|
+
*/
|
|
24355
|
+
readonly placeId: string;
|
|
24356
|
+
/**
|
|
24357
|
+
* The placeMembershipType identifier
|
|
24358
|
+
*/
|
|
24359
|
+
readonly placeMembershipTypeId: string;
|
|
24360
|
+
/**
|
|
24361
|
+
* Page number
|
|
24362
|
+
*/
|
|
24363
|
+
readonly page?: number;
|
|
24364
|
+
/**
|
|
24365
|
+
* Number of items per page
|
|
24366
|
+
*/
|
|
24367
|
+
readonly pageSize?: number;
|
|
24368
|
+
/**
|
|
24369
|
+
* Field to order by
|
|
24370
|
+
*/
|
|
24371
|
+
readonly orderBy?: string;
|
|
24372
|
+
/**
|
|
24373
|
+
* Search query
|
|
24374
|
+
*/
|
|
24375
|
+
readonly search?: string;
|
|
24376
|
+
}
|
|
24377
|
+
/**
|
|
24378
|
+
* Request parameters for updatePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24379
|
+
*/
|
|
24380
|
+
export interface BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest {
|
|
24381
|
+
/**
|
|
24382
|
+
* The place identifier
|
|
24383
|
+
*/
|
|
24384
|
+
readonly placeId: string;
|
|
24385
|
+
/**
|
|
24386
|
+
* The placeMembershipType identifier
|
|
24387
|
+
*/
|
|
24388
|
+
readonly placeMembershipTypeId: string;
|
|
24389
|
+
/**
|
|
24390
|
+
* The locale identifier
|
|
24391
|
+
*/
|
|
24392
|
+
readonly locale: string;
|
|
24393
|
+
readonly placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs;
|
|
24394
|
+
}
|
|
24395
|
+
/**
|
|
24396
|
+
* BookingsMembershipsTranslationsApi - object-oriented interface
|
|
24397
|
+
*/
|
|
24398
|
+
export declare class BookingsMembershipsTranslationsApi extends BaseAPI {
|
|
24399
|
+
/**
|
|
24400
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24401
|
+
* @summary Delete a place membership type translation
|
|
24402
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24403
|
+
* @param {*} [options] Override http request option.
|
|
24404
|
+
* @throws {RequiredError}
|
|
24405
|
+
*/
|
|
24406
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24407
|
+
/**
|
|
24408
|
+
* Retrieves the translated name and description of a place membership type in a specific locale, returning null if no translation exists for that locale; requires the \"read\" permission on \"bookings\".
|
|
24409
|
+
* @summary Get a place membership type\'s translation
|
|
24410
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24411
|
+
* @param {*} [options] Override http request option.
|
|
24412
|
+
* @throws {RequiredError}
|
|
24413
|
+
*/
|
|
24414
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypeTranslation200Response, any, {}, any>>;
|
|
24415
|
+
/**
|
|
24416
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24417
|
+
* @summary List a place membership type\'s translations
|
|
24418
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
24419
|
+
* @param {*} [options] Override http request option.
|
|
24420
|
+
* @throws {RequiredError}
|
|
24421
|
+
*/
|
|
24422
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypeTranslations200Response, any, {}, any>>;
|
|
24423
|
+
/**
|
|
24424
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24425
|
+
* @summary Update a place membership type\'s translation
|
|
24426
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24427
|
+
* @param {*} [options] Override http request option.
|
|
24428
|
+
* @throws {RequiredError}
|
|
24429
|
+
*/
|
|
24430
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePlaceMembershipTypeTranslation200Response, any, {}, any>>;
|
|
24431
|
+
}
|
|
23129
24432
|
/**
|
|
23130
24433
|
* BookingsPlacesApi - axios parameter creator
|
|
23131
24434
|
*/
|
|
@@ -62966,6 +64269,132 @@ export declare class EventsTranslationsApi extends BaseAPI {
|
|
|
62966
64269
|
*/
|
|
62967
64270
|
updateEventTranslation(requestParameters: EventsTranslationsApiUpdateEventTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SyncAccounts200Response, any, {}, any>>;
|
|
62968
64271
|
}
|
|
64272
|
+
/**
|
|
64273
|
+
* ExportsApi - axios parameter creator
|
|
64274
|
+
*/
|
|
64275
|
+
export declare const ExportsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
64276
|
+
/**
|
|
64277
|
+
* Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64278
|
+
* @summary Get a single export
|
|
64279
|
+
* @param {string} exportId The export identifier
|
|
64280
|
+
* @param {*} [options] Override http request option.
|
|
64281
|
+
* @throws {RequiredError}
|
|
64282
|
+
*/
|
|
64283
|
+
getExport: (exportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64284
|
+
/**
|
|
64285
|
+
* Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64286
|
+
* @summary List data exports
|
|
64287
|
+
* @param {ExportStatus} [status] Filter by status
|
|
64288
|
+
* @param {number} [page] Page number
|
|
64289
|
+
* @param {number} [pageSize] Number of items per page
|
|
64290
|
+
* @param {string} [orderBy] Field to order by
|
|
64291
|
+
* @param {string} [search] Search query
|
|
64292
|
+
* @param {*} [options] Override http request option.
|
|
64293
|
+
* @throws {RequiredError}
|
|
64294
|
+
*/
|
|
64295
|
+
getExports: (status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64296
|
+
};
|
|
64297
|
+
/**
|
|
64298
|
+
* ExportsApi - functional programming interface
|
|
64299
|
+
*/
|
|
64300
|
+
export declare const ExportsApiFp: (configuration?: Configuration) => {
|
|
64301
|
+
/**
|
|
64302
|
+
* Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64303
|
+
* @summary Get a single export
|
|
64304
|
+
* @param {string} exportId The export identifier
|
|
64305
|
+
* @param {*} [options] Override http request option.
|
|
64306
|
+
* @throws {RequiredError}
|
|
64307
|
+
*/
|
|
64308
|
+
getExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExport200Response>>;
|
|
64309
|
+
/**
|
|
64310
|
+
* Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64311
|
+
* @summary List data exports
|
|
64312
|
+
* @param {ExportStatus} [status] Filter by status
|
|
64313
|
+
* @param {number} [page] Page number
|
|
64314
|
+
* @param {number} [pageSize] Number of items per page
|
|
64315
|
+
* @param {string} [orderBy] Field to order by
|
|
64316
|
+
* @param {string} [search] Search query
|
|
64317
|
+
* @param {*} [options] Override http request option.
|
|
64318
|
+
* @throws {RequiredError}
|
|
64319
|
+
*/
|
|
64320
|
+
getExports(status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExports200Response>>;
|
|
64321
|
+
};
|
|
64322
|
+
/**
|
|
64323
|
+
* ExportsApi - factory interface
|
|
64324
|
+
*/
|
|
64325
|
+
export declare const ExportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
64326
|
+
/**
|
|
64327
|
+
* Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64328
|
+
* @summary Get a single export
|
|
64329
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
64330
|
+
* @param {*} [options] Override http request option.
|
|
64331
|
+
* @throws {RequiredError}
|
|
64332
|
+
*/
|
|
64333
|
+
getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExport200Response>;
|
|
64334
|
+
/**
|
|
64335
|
+
* Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64336
|
+
* @summary List data exports
|
|
64337
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
64338
|
+
* @param {*} [options] Override http request option.
|
|
64339
|
+
* @throws {RequiredError}
|
|
64340
|
+
*/
|
|
64341
|
+
getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExports200Response>;
|
|
64342
|
+
};
|
|
64343
|
+
/**
|
|
64344
|
+
* Request parameters for getExport operation in ExportsApi.
|
|
64345
|
+
*/
|
|
64346
|
+
export interface ExportsApiGetExportRequest {
|
|
64347
|
+
/**
|
|
64348
|
+
* The export identifier
|
|
64349
|
+
*/
|
|
64350
|
+
readonly exportId: string;
|
|
64351
|
+
}
|
|
64352
|
+
/**
|
|
64353
|
+
* Request parameters for getExports operation in ExportsApi.
|
|
64354
|
+
*/
|
|
64355
|
+
export interface ExportsApiGetExportsRequest {
|
|
64356
|
+
/**
|
|
64357
|
+
* Filter by status
|
|
64358
|
+
*/
|
|
64359
|
+
readonly status?: ExportStatus;
|
|
64360
|
+
/**
|
|
64361
|
+
* Page number
|
|
64362
|
+
*/
|
|
64363
|
+
readonly page?: number;
|
|
64364
|
+
/**
|
|
64365
|
+
* Number of items per page
|
|
64366
|
+
*/
|
|
64367
|
+
readonly pageSize?: number;
|
|
64368
|
+
/**
|
|
64369
|
+
* Field to order by
|
|
64370
|
+
*/
|
|
64371
|
+
readonly orderBy?: string;
|
|
64372
|
+
/**
|
|
64373
|
+
* Search query
|
|
64374
|
+
*/
|
|
64375
|
+
readonly search?: string;
|
|
64376
|
+
}
|
|
64377
|
+
/**
|
|
64378
|
+
* ExportsApi - object-oriented interface
|
|
64379
|
+
*/
|
|
64380
|
+
export declare class ExportsApi extends BaseAPI {
|
|
64381
|
+
/**
|
|
64382
|
+
* Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64383
|
+
* @summary Get a single export
|
|
64384
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
64385
|
+
* @param {*} [options] Override http request option.
|
|
64386
|
+
* @throws {RequiredError}
|
|
64387
|
+
*/
|
|
64388
|
+
getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExport200Response, any, {}, any>>;
|
|
64389
|
+
/**
|
|
64390
|
+
* Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
|
|
64391
|
+
* @summary List data exports
|
|
64392
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
64393
|
+
* @param {*} [options] Override http request option.
|
|
64394
|
+
* @throws {RequiredError}
|
|
64395
|
+
*/
|
|
64396
|
+
getExports(requestParameters?: ExportsApiGetExportsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetExports200Response, any, {}, any>>;
|
|
64397
|
+
}
|
|
62969
64398
|
/**
|
|
62970
64399
|
* FilesApi - axios parameter creator
|
|
62971
64400
|
*/
|