@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/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.4.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1380,6 +1380,8 @@ export interface BaseBooking {
|
|
|
1380
1380
|
'duration': number;
|
|
1381
1381
|
'checkedIn': string | null;
|
|
1382
1382
|
'status': PurchaseStatus;
|
|
1383
|
+
'placeMembershipId': string | null;
|
|
1384
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
1383
1385
|
'account': BaseAccount;
|
|
1384
1386
|
'space': BaseBookingSpace;
|
|
1385
1387
|
}
|
|
@@ -1397,6 +1399,11 @@ export interface BaseBookingPlace {
|
|
|
1397
1399
|
'paymentIntegrationId': string | null;
|
|
1398
1400
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1399
1401
|
}
|
|
1402
|
+
export interface BaseBookingPlaceMembership {
|
|
1403
|
+
'id': string;
|
|
1404
|
+
'expiresAt': string | null;
|
|
1405
|
+
'placeMembershipType': BasePassAttributeAttribute;
|
|
1406
|
+
}
|
|
1400
1407
|
export interface BaseBookingQuestionResponse {
|
|
1401
1408
|
'id': string;
|
|
1402
1409
|
'value': string;
|
|
@@ -1420,6 +1427,7 @@ export interface BaseBookingSpace {
|
|
|
1420
1427
|
'bookingLimitPerAccount': number | null;
|
|
1421
1428
|
'slotDuration': number;
|
|
1422
1429
|
'price': number;
|
|
1430
|
+
'membershipPrice': number | null;
|
|
1423
1431
|
'description': string | null;
|
|
1424
1432
|
'image': BaseImage | null;
|
|
1425
1433
|
'start': string | null;
|
|
@@ -2154,6 +2162,20 @@ export interface BaseEventTrack {
|
|
|
2154
2162
|
'description': string | null;
|
|
2155
2163
|
'color': string;
|
|
2156
2164
|
}
|
|
2165
|
+
export interface BaseExport {
|
|
2166
|
+
'id': string;
|
|
2167
|
+
'type': string;
|
|
2168
|
+
'status': ExportStatus;
|
|
2169
|
+
'message': string | null;
|
|
2170
|
+
'eventId': string | null;
|
|
2171
|
+
'userId': string | null;
|
|
2172
|
+
'expiration': string | null;
|
|
2173
|
+
'downloadUrl': string | null;
|
|
2174
|
+
'createdAt': string;
|
|
2175
|
+
'updatedAt': string;
|
|
2176
|
+
}
|
|
2177
|
+
|
|
2178
|
+
|
|
2157
2179
|
export interface BaseFaq {
|
|
2158
2180
|
'id': string;
|
|
2159
2181
|
'slug': string;
|
|
@@ -2519,10 +2541,10 @@ export interface BasePayment {
|
|
|
2519
2541
|
'passId': string | null;
|
|
2520
2542
|
'sessionId': string | null;
|
|
2521
2543
|
'spaceId': string | null;
|
|
2522
|
-
'membershipId': string | null;
|
|
2523
2544
|
'couponId': string | null;
|
|
2524
2545
|
'invoiceId': string | null;
|
|
2525
2546
|
'seriesId': string | null;
|
|
2547
|
+
'placeMembershipTypeId': string | null;
|
|
2526
2548
|
'taxIntegrationCompanyCode': string | null;
|
|
2527
2549
|
'taxIntegrationCustomerId': string | null;
|
|
2528
2550
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -2559,6 +2581,8 @@ export interface BasePaymentIntent {
|
|
|
2559
2581
|
'couponId': string | null;
|
|
2560
2582
|
'invoiceId': string | null;
|
|
2561
2583
|
'seriesId': string | null;
|
|
2584
|
+
'placeMembershipTypeId': string | null;
|
|
2585
|
+
'placeMembershipId': string | null;
|
|
2562
2586
|
'address1': string | null;
|
|
2563
2587
|
'address2': string | null;
|
|
2564
2588
|
'city': string | null;
|
|
@@ -2614,6 +2638,7 @@ export interface BasePaymentIntentLineItem {
|
|
|
2614
2638
|
'bookingId': string | null;
|
|
2615
2639
|
'couponId': string | null;
|
|
2616
2640
|
'seriesRegistrationId': string | null;
|
|
2641
|
+
'placeMembershipId': string | null;
|
|
2617
2642
|
'createdAt': string;
|
|
2618
2643
|
}
|
|
2619
2644
|
|
|
@@ -2646,9 +2671,34 @@ export interface BasePaymentLineItem {
|
|
|
2646
2671
|
'reservationId': string | null;
|
|
2647
2672
|
'accessId': string | null;
|
|
2648
2673
|
'bookingId': string | null;
|
|
2674
|
+
'placeMembershipId': string | null;
|
|
2649
2675
|
}
|
|
2650
2676
|
|
|
2651
2677
|
|
|
2678
|
+
export interface BasePlaceMembership {
|
|
2679
|
+
'id': string;
|
|
2680
|
+
'status': PurchaseStatus;
|
|
2681
|
+
'startsAt': string | null;
|
|
2682
|
+
'expiresAt': string | null;
|
|
2683
|
+
'account': BaseAccount;
|
|
2684
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
2685
|
+
'createdAt': string;
|
|
2686
|
+
}
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
export interface BasePlaceMembershipType {
|
|
2690
|
+
'id': string;
|
|
2691
|
+
'slug': string;
|
|
2692
|
+
'name': string;
|
|
2693
|
+
'description': string | null;
|
|
2694
|
+
'image': BaseImage | null;
|
|
2695
|
+
'price': number;
|
|
2696
|
+
'termDays': number;
|
|
2697
|
+
'maxMembers': number;
|
|
2698
|
+
'sortOrder': number;
|
|
2699
|
+
'visible': boolean;
|
|
2700
|
+
'archived': boolean;
|
|
2701
|
+
}
|
|
2652
2702
|
export interface BasePreset {
|
|
2653
2703
|
'id': string;
|
|
2654
2704
|
'name': string;
|
|
@@ -3350,6 +3400,8 @@ export interface Booking {
|
|
|
3350
3400
|
'duration': number;
|
|
3351
3401
|
'checkedIn': string | null;
|
|
3352
3402
|
'status': PurchaseStatus;
|
|
3403
|
+
'placeMembershipId': string | null;
|
|
3404
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
3353
3405
|
'account': BaseAccount;
|
|
3354
3406
|
'space': BaseBookingSpace;
|
|
3355
3407
|
'lineItem': PaymentLineItem | null;
|
|
@@ -3462,6 +3514,7 @@ export interface BookingSpace {
|
|
|
3462
3514
|
'bookingLimitPerAccount': number | null;
|
|
3463
3515
|
'slotDuration': number;
|
|
3464
3516
|
'price': number;
|
|
3517
|
+
'membershipPrice': number | null;
|
|
3465
3518
|
'description': string | null;
|
|
3466
3519
|
'image': BaseImage | null;
|
|
3467
3520
|
'start': string | null;
|
|
@@ -3541,6 +3594,7 @@ export interface BookingSpaceCreateInputs {
|
|
|
3541
3594
|
'bookingLimitPerAccount'?: number | null;
|
|
3542
3595
|
'slotDuration': number;
|
|
3543
3596
|
'price'?: number;
|
|
3597
|
+
'membershipPrice'?: number | null;
|
|
3544
3598
|
'description'?: string | null;
|
|
3545
3599
|
'imageId'?: string | null;
|
|
3546
3600
|
'start'?: string | null;
|
|
@@ -3742,6 +3796,7 @@ export interface BookingSpaceUpdateInputs {
|
|
|
3742
3796
|
'supply'?: number;
|
|
3743
3797
|
'bookingLimitPerAccount'?: number | null;
|
|
3744
3798
|
'price'?: number;
|
|
3799
|
+
'membershipPrice'?: number | null;
|
|
3745
3800
|
'description'?: string | null;
|
|
3746
3801
|
'imageId'?: string | null;
|
|
3747
3802
|
'start'?: string | null;
|
|
@@ -4966,6 +5021,26 @@ export enum CreateOrganizationTeamMember200ResponseStatusEnum {
|
|
|
4966
5021
|
Ok = 'ok'
|
|
4967
5022
|
}
|
|
4968
5023
|
|
|
5024
|
+
export interface CreatePlaceMembershipMember200Response {
|
|
5025
|
+
'status': CreatePlaceMembershipMember200ResponseStatusEnum;
|
|
5026
|
+
'message': string;
|
|
5027
|
+
'data': PlaceMembershipMember;
|
|
5028
|
+
}
|
|
5029
|
+
|
|
5030
|
+
export enum CreatePlaceMembershipMember200ResponseStatusEnum {
|
|
5031
|
+
Ok = 'ok'
|
|
5032
|
+
}
|
|
5033
|
+
|
|
5034
|
+
export interface CreatePlaceMembershipType200Response {
|
|
5035
|
+
'status': CreatePlaceMembershipType200ResponseStatusEnum;
|
|
5036
|
+
'message': string;
|
|
5037
|
+
'data': PlaceMembershipType;
|
|
5038
|
+
}
|
|
5039
|
+
|
|
5040
|
+
export enum CreatePlaceMembershipType200ResponseStatusEnum {
|
|
5041
|
+
Ok = 'ok'
|
|
5042
|
+
}
|
|
5043
|
+
|
|
4969
5044
|
export interface CreatePreset200Response {
|
|
4970
5045
|
'status': CreatePreset200ResponseStatusEnum;
|
|
4971
5046
|
'message': string;
|
|
@@ -7502,6 +7577,21 @@ export enum ExchangeType {
|
|
|
7502
7577
|
}
|
|
7503
7578
|
|
|
7504
7579
|
|
|
7580
|
+
export interface Export {
|
|
7581
|
+
'id': string;
|
|
7582
|
+
'type': string;
|
|
7583
|
+
'status': ExportStatus;
|
|
7584
|
+
'message': string | null;
|
|
7585
|
+
'eventId': string | null;
|
|
7586
|
+
'userId': string | null;
|
|
7587
|
+
'expiration': string | null;
|
|
7588
|
+
'downloadUrl': string | null;
|
|
7589
|
+
'createdAt': string;
|
|
7590
|
+
'updatedAt': string;
|
|
7591
|
+
'user': BaseUser | null;
|
|
7592
|
+
}
|
|
7593
|
+
|
|
7594
|
+
|
|
7505
7595
|
|
|
7506
7596
|
export enum ExportStatus {
|
|
7507
7597
|
Pending = 'pending',
|
|
@@ -9814,6 +9904,27 @@ export enum GetEvents200ResponseStatusEnum {
|
|
|
9814
9904
|
Ok = 'ok'
|
|
9815
9905
|
}
|
|
9816
9906
|
|
|
9907
|
+
export interface GetExport200Response {
|
|
9908
|
+
'status': GetExport200ResponseStatusEnum;
|
|
9909
|
+
'message': string;
|
|
9910
|
+
'data': Export;
|
|
9911
|
+
}
|
|
9912
|
+
|
|
9913
|
+
export enum GetExport200ResponseStatusEnum {
|
|
9914
|
+
Ok = 'ok'
|
|
9915
|
+
}
|
|
9916
|
+
|
|
9917
|
+
export interface GetExports200Response {
|
|
9918
|
+
'status': GetExports200ResponseStatusEnum;
|
|
9919
|
+
'message': string;
|
|
9920
|
+
'data': Array<Export>;
|
|
9921
|
+
'count'?: number;
|
|
9922
|
+
}
|
|
9923
|
+
|
|
9924
|
+
export enum GetExports200ResponseStatusEnum {
|
|
9925
|
+
Ok = 'ok'
|
|
9926
|
+
}
|
|
9927
|
+
|
|
9817
9928
|
export interface GetFiles200Response {
|
|
9818
9929
|
'status': GetFiles200ResponseStatusEnum;
|
|
9819
9930
|
'message': string;
|
|
@@ -10489,6 +10600,70 @@ export enum GetPaymentTaxMetadata200ResponseStatusEnum {
|
|
|
10489
10600
|
Ok = 'ok'
|
|
10490
10601
|
}
|
|
10491
10602
|
|
|
10603
|
+
export interface GetPlaceMembership200Response {
|
|
10604
|
+
'status': GetPlaceMembership200ResponseStatusEnum;
|
|
10605
|
+
'message': string;
|
|
10606
|
+
'data': PlaceMembership;
|
|
10607
|
+
}
|
|
10608
|
+
|
|
10609
|
+
export enum GetPlaceMembership200ResponseStatusEnum {
|
|
10610
|
+
Ok = 'ok'
|
|
10611
|
+
}
|
|
10612
|
+
|
|
10613
|
+
export interface GetPlaceMembershipMembers200Response {
|
|
10614
|
+
'status': GetPlaceMembershipMembers200ResponseStatusEnum;
|
|
10615
|
+
'message': string;
|
|
10616
|
+
'data': Array<PlaceMembershipMember>;
|
|
10617
|
+
'count'?: number;
|
|
10618
|
+
}
|
|
10619
|
+
|
|
10620
|
+
export enum GetPlaceMembershipMembers200ResponseStatusEnum {
|
|
10621
|
+
Ok = 'ok'
|
|
10622
|
+
}
|
|
10623
|
+
|
|
10624
|
+
export interface GetPlaceMembershipTypeTranslation200Response {
|
|
10625
|
+
'status': GetPlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
10626
|
+
'message': string;
|
|
10627
|
+
'data': PlaceMembershipTypeTranslation | null;
|
|
10628
|
+
}
|
|
10629
|
+
|
|
10630
|
+
export enum GetPlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
10631
|
+
Ok = 'ok'
|
|
10632
|
+
}
|
|
10633
|
+
|
|
10634
|
+
export interface GetPlaceMembershipTypeTranslations200Response {
|
|
10635
|
+
'status': GetPlaceMembershipTypeTranslations200ResponseStatusEnum;
|
|
10636
|
+
'message': string;
|
|
10637
|
+
'data': Array<PlaceMembershipTypeTranslation>;
|
|
10638
|
+
'count'?: number;
|
|
10639
|
+
}
|
|
10640
|
+
|
|
10641
|
+
export enum GetPlaceMembershipTypeTranslations200ResponseStatusEnum {
|
|
10642
|
+
Ok = 'ok'
|
|
10643
|
+
}
|
|
10644
|
+
|
|
10645
|
+
export interface GetPlaceMembershipTypes200Response {
|
|
10646
|
+
'status': GetPlaceMembershipTypes200ResponseStatusEnum;
|
|
10647
|
+
'message': string;
|
|
10648
|
+
'data': Array<PlaceMembershipType>;
|
|
10649
|
+
'count'?: number;
|
|
10650
|
+
}
|
|
10651
|
+
|
|
10652
|
+
export enum GetPlaceMembershipTypes200ResponseStatusEnum {
|
|
10653
|
+
Ok = 'ok'
|
|
10654
|
+
}
|
|
10655
|
+
|
|
10656
|
+
export interface GetPlaceMemberships200Response {
|
|
10657
|
+
'status': GetPlaceMemberships200ResponseStatusEnum;
|
|
10658
|
+
'message': string;
|
|
10659
|
+
'data': Array<PlaceMembership>;
|
|
10660
|
+
'count'?: number;
|
|
10661
|
+
}
|
|
10662
|
+
|
|
10663
|
+
export enum GetPlaceMemberships200ResponseStatusEnum {
|
|
10664
|
+
Ok = 'ok'
|
|
10665
|
+
}
|
|
10666
|
+
|
|
10492
10667
|
export interface GetPreferences200Response {
|
|
10493
10668
|
'status': GetPreferences200ResponseStatusEnum;
|
|
10494
10669
|
'message': string;
|
|
@@ -13283,10 +13458,10 @@ export interface Payment {
|
|
|
13283
13458
|
'passId': string | null;
|
|
13284
13459
|
'sessionId': string | null;
|
|
13285
13460
|
'spaceId': string | null;
|
|
13286
|
-
'membershipId': string | null;
|
|
13287
13461
|
'couponId': string | null;
|
|
13288
13462
|
'invoiceId': string | null;
|
|
13289
13463
|
'seriesId': string | null;
|
|
13464
|
+
'placeMembershipTypeId': string | null;
|
|
13290
13465
|
'taxIntegrationCompanyCode': string | null;
|
|
13291
13466
|
'taxIntegrationCustomerId': string | null;
|
|
13292
13467
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -13318,6 +13493,7 @@ export interface Payment {
|
|
|
13318
13493
|
'coupon': BaseCoupon | null;
|
|
13319
13494
|
'invoice': BaseInvoice | null;
|
|
13320
13495
|
'series': BaseSeries | null;
|
|
13496
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
13321
13497
|
'exchangeTarget': BaseEventPassTypeExchangeTarget | null;
|
|
13322
13498
|
'metadata'?: object;
|
|
13323
13499
|
}
|
|
@@ -13369,6 +13545,8 @@ export interface PaymentIntent {
|
|
|
13369
13545
|
'couponId': string | null;
|
|
13370
13546
|
'invoiceId': string | null;
|
|
13371
13547
|
'seriesId': string | null;
|
|
13548
|
+
'placeMembershipTypeId': string | null;
|
|
13549
|
+
'placeMembershipId': string | null;
|
|
13372
13550
|
'address1': string | null;
|
|
13373
13551
|
'address2': string | null;
|
|
13374
13552
|
'city': string | null;
|
|
@@ -13402,6 +13580,7 @@ export interface PaymentIntent {
|
|
|
13402
13580
|
'space': BaseBookingSpace | null;
|
|
13403
13581
|
'invoice': BaseInvoice | null;
|
|
13404
13582
|
'series': BaseSeries | null;
|
|
13583
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
13405
13584
|
}
|
|
13406
13585
|
|
|
13407
13586
|
|
|
@@ -13415,7 +13594,8 @@ export enum PaymentIntentSource {
|
|
|
13415
13594
|
Coupon = 'coupon',
|
|
13416
13595
|
Session = 'session',
|
|
13417
13596
|
Booking = 'booking',
|
|
13418
|
-
Series = 'series'
|
|
13597
|
+
Series = 'series',
|
|
13598
|
+
PlaceMembership = 'placeMembership'
|
|
13419
13599
|
}
|
|
13420
13600
|
|
|
13421
13601
|
|
|
@@ -13443,12 +13623,14 @@ export interface PaymentLineItem {
|
|
|
13443
13623
|
'reservationId': string | null;
|
|
13444
13624
|
'accessId': string | null;
|
|
13445
13625
|
'bookingId': string | null;
|
|
13626
|
+
'placeMembershipId': string | null;
|
|
13446
13627
|
'pass': BaseEventPass | null;
|
|
13447
13628
|
'package': BaseEventPackage | null;
|
|
13448
13629
|
'passAddOn': BasePassAddOn | null;
|
|
13449
13630
|
'reservation': BaseEventRoomTypeReservation | null;
|
|
13450
13631
|
'access': BaseEventSessionAccess | null;
|
|
13451
13632
|
'booking': BaseBooking | null;
|
|
13633
|
+
'placeMembership': BasePlaceMembership | null;
|
|
13452
13634
|
'coupon': BaseCoupon | null;
|
|
13453
13635
|
'seriesRegistration': BaseSeriesRegistration | null;
|
|
13454
13636
|
'payment': BasePayment;
|
|
@@ -13467,6 +13649,7 @@ export enum PaymentLineItemType {
|
|
|
13467
13649
|
Booking = 'booking',
|
|
13468
13650
|
Coupon = 'coupon',
|
|
13469
13651
|
Series = 'series',
|
|
13652
|
+
PlaceMembership = 'placeMembership',
|
|
13470
13653
|
Refund = 'refund'
|
|
13471
13654
|
}
|
|
13472
13655
|
|
|
@@ -13488,6 +13671,127 @@ export interface PaypalActivationFormParams {
|
|
|
13488
13671
|
'currencyCode': string;
|
|
13489
13672
|
'name': string;
|
|
13490
13673
|
}
|
|
13674
|
+
export interface PlaceMembership {
|
|
13675
|
+
'id': string;
|
|
13676
|
+
'status': PurchaseStatus;
|
|
13677
|
+
'startsAt': string | null;
|
|
13678
|
+
'expiresAt': string | null;
|
|
13679
|
+
'account': BaseAccount;
|
|
13680
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
13681
|
+
'createdAt': string;
|
|
13682
|
+
'lineItem': PaymentLineItem | null;
|
|
13683
|
+
'members': Array<PlaceMembershipMember>;
|
|
13684
|
+
'_count': PlaceMembershipAllOfCount;
|
|
13685
|
+
}
|
|
13686
|
+
|
|
13687
|
+
|
|
13688
|
+
export interface PlaceMembershipAllOfCount {
|
|
13689
|
+
'bookings': number;
|
|
13690
|
+
}
|
|
13691
|
+
export interface PlaceMembershipCreateInputs {
|
|
13692
|
+
'accountId': string;
|
|
13693
|
+
'placeMembershipTypeId': string;
|
|
13694
|
+
'startsAt'?: string | null;
|
|
13695
|
+
'expiresAt'?: string | null;
|
|
13696
|
+
}
|
|
13697
|
+
export interface PlaceMembershipMember {
|
|
13698
|
+
'id': string;
|
|
13699
|
+
'name': string;
|
|
13700
|
+
'image': BaseImage | null;
|
|
13701
|
+
'createdAt': string;
|
|
13702
|
+
'updatedAt': string;
|
|
13703
|
+
}
|
|
13704
|
+
export interface PlaceMembershipMemberCreateInputs {
|
|
13705
|
+
'name': string;
|
|
13706
|
+
'imageId'?: string | null;
|
|
13707
|
+
}
|
|
13708
|
+
export interface PlaceMembershipMemberUpdateInputs {
|
|
13709
|
+
'name'?: string;
|
|
13710
|
+
'imageId'?: string | null;
|
|
13711
|
+
}
|
|
13712
|
+
export interface PlaceMembershipType {
|
|
13713
|
+
'id': string;
|
|
13714
|
+
'slug': string;
|
|
13715
|
+
'name': string;
|
|
13716
|
+
'description': string | null;
|
|
13717
|
+
'image': BaseImage | null;
|
|
13718
|
+
'price': number;
|
|
13719
|
+
'termDays': number;
|
|
13720
|
+
'maxMembers': number;
|
|
13721
|
+
'sortOrder': number;
|
|
13722
|
+
'visible': boolean;
|
|
13723
|
+
'archived': boolean;
|
|
13724
|
+
'taxCode': string | null;
|
|
13725
|
+
'taxIncluded': boolean;
|
|
13726
|
+
'taxLocation': TaxLocationType;
|
|
13727
|
+
'paymentIntegrationId': string | null;
|
|
13728
|
+
'paymentIntegration': BasePaymentIntegration | null;
|
|
13729
|
+
'entityId': string | null;
|
|
13730
|
+
'entity': BaseOrganizationEntity | null;
|
|
13731
|
+
'placeId': string;
|
|
13732
|
+
'createdAt': string;
|
|
13733
|
+
'updatedAt': string;
|
|
13734
|
+
}
|
|
13735
|
+
|
|
13736
|
+
|
|
13737
|
+
export interface PlaceMembershipTypeCreateInputs {
|
|
13738
|
+
'name': string;
|
|
13739
|
+
'description'?: string | null;
|
|
13740
|
+
'imageId'?: string | null;
|
|
13741
|
+
'price'?: number;
|
|
13742
|
+
'termDays': number;
|
|
13743
|
+
'maxMembers'?: number;
|
|
13744
|
+
'sortOrder'?: number | null;
|
|
13745
|
+
'visible'?: boolean;
|
|
13746
|
+
'taxCode'?: string | null;
|
|
13747
|
+
'taxIncluded'?: boolean;
|
|
13748
|
+
'taxLocation'?: TaxLocationType;
|
|
13749
|
+
'paymentIntegrationId'?: string | null;
|
|
13750
|
+
'entityId'?: string | null;
|
|
13751
|
+
}
|
|
13752
|
+
|
|
13753
|
+
|
|
13754
|
+
export interface PlaceMembershipTypeTranslation {
|
|
13755
|
+
'id': number;
|
|
13756
|
+
'locale': string;
|
|
13757
|
+
'name': string | null;
|
|
13758
|
+
'description': string | null;
|
|
13759
|
+
'createdAt': string;
|
|
13760
|
+
'updatedAt': string;
|
|
13761
|
+
}
|
|
13762
|
+
export interface PlaceMembershipTypeTranslationUpdateInputs {
|
|
13763
|
+
'name'?: string | null;
|
|
13764
|
+
'description'?: string | null;
|
|
13765
|
+
}
|
|
13766
|
+
export interface PlaceMembershipTypeUpdateInputs {
|
|
13767
|
+
'name'?: string;
|
|
13768
|
+
'description'?: string | null;
|
|
13769
|
+
'imageId'?: string | null;
|
|
13770
|
+
'price'?: number;
|
|
13771
|
+
'termDays'?: number;
|
|
13772
|
+
'maxMembers'?: number;
|
|
13773
|
+
'sortOrder'?: number | null;
|
|
13774
|
+
'visible'?: boolean;
|
|
13775
|
+
'archived'?: boolean;
|
|
13776
|
+
'taxCode'?: string | null;
|
|
13777
|
+
'taxIncluded'?: boolean;
|
|
13778
|
+
'taxLocation'?: TaxLocationType;
|
|
13779
|
+
'paymentIntegrationId'?: string | null;
|
|
13780
|
+
'entityId'?: string | null;
|
|
13781
|
+
}
|
|
13782
|
+
|
|
13783
|
+
|
|
13784
|
+
export interface PlaceMembershipUpdateInputs {
|
|
13785
|
+
'status'?: PlaceMembershipUpdateInputsStatusEnum;
|
|
13786
|
+
'startsAt'?: string;
|
|
13787
|
+
'expiresAt'?: string;
|
|
13788
|
+
}
|
|
13789
|
+
|
|
13790
|
+
export enum PlaceMembershipUpdateInputsStatusEnum {
|
|
13791
|
+
Ready = 'ready',
|
|
13792
|
+
Canceled = 'canceled'
|
|
13793
|
+
}
|
|
13794
|
+
|
|
13491
13795
|
export interface Preset {
|
|
13492
13796
|
'id': string;
|
|
13493
13797
|
'name': string;
|
|
@@ -15917,6 +16221,16 @@ export interface UpdateOrganizationIntegrationsRequest {
|
|
|
15917
16221
|
'ghostAdminKey'?: string;
|
|
15918
16222
|
'ghostContentKey'?: string;
|
|
15919
16223
|
}
|
|
16224
|
+
export interface UpdatePlaceMembershipTypeTranslation200Response {
|
|
16225
|
+
'status': UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
16226
|
+
'message': string;
|
|
16227
|
+
'data': PlaceMembershipTypeTranslation;
|
|
16228
|
+
}
|
|
16229
|
+
|
|
16230
|
+
export enum UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
16231
|
+
Ok = 'ok'
|
|
16232
|
+
}
|
|
16233
|
+
|
|
15920
16234
|
export interface UpdateSelf200Response {
|
|
15921
16235
|
'status': UpdateSelf200ResponseStatusEnum;
|
|
15922
16236
|
'message': string;
|
|
@@ -33522,21 +33836,25 @@ export class BookingsBlackoutsApi extends BaseAPI {
|
|
|
33522
33836
|
|
|
33523
33837
|
|
|
33524
33838
|
/**
|
|
33525
|
-
*
|
|
33839
|
+
* BookingsMembershipsApi - axios parameter creator
|
|
33526
33840
|
*/
|
|
33527
|
-
export const
|
|
33841
|
+
export const BookingsMembershipsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
33528
33842
|
return {
|
|
33529
33843
|
/**
|
|
33530
|
-
* Creates a
|
|
33531
|
-
* @summary
|
|
33532
|
-
* @param {
|
|
33844
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
33845
|
+
* @summary Grant a place membership
|
|
33846
|
+
* @param {string} placeId The place identifier
|
|
33847
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
33533
33848
|
* @param {*} [options] Override http request option.
|
|
33534
33849
|
* @throws {RequiredError}
|
|
33535
33850
|
*/
|
|
33536
|
-
|
|
33537
|
-
// verify required parameter '
|
|
33538
|
-
assertParamExists('
|
|
33539
|
-
|
|
33851
|
+
createPlaceMembership: async (placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33852
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
33853
|
+
assertParamExists('createPlaceMembership', 'placeId', placeId)
|
|
33854
|
+
// verify required parameter 'placeMembershipCreateInputs' is not null or undefined
|
|
33855
|
+
assertParamExists('createPlaceMembership', 'placeMembershipCreateInputs', placeMembershipCreateInputs)
|
|
33856
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
33857
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33540
33858
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33541
33859
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33542
33860
|
let baseOptions;
|
|
@@ -33560,7 +33878,7 @@ export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
33560
33878
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33561
33879
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33562
33880
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33563
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
33881
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipCreateInputs, localVarRequestOptions, configuration)
|
|
33564
33882
|
|
|
33565
33883
|
return {
|
|
33566
33884
|
url: toPathString(localVarUrlObj),
|
|
@@ -33568,16 +33886,2052 @@ export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
33568
33886
|
};
|
|
33569
33887
|
},
|
|
33570
33888
|
/**
|
|
33571
|
-
*
|
|
33572
|
-
* @summary
|
|
33889
|
+
* 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.
|
|
33890
|
+
* @summary Add a member to a place membership
|
|
33891
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
33892
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
33893
|
+
* @param {*} [options] Override http request option.
|
|
33894
|
+
* @throws {RequiredError}
|
|
33895
|
+
*/
|
|
33896
|
+
createPlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33897
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
33898
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
33899
|
+
// verify required parameter 'placeMembershipMemberCreateInputs' is not null or undefined
|
|
33900
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipMemberCreateInputs', placeMembershipMemberCreateInputs)
|
|
33901
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
33902
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
33903
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33904
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33905
|
+
let baseOptions;
|
|
33906
|
+
if (configuration) {
|
|
33907
|
+
baseOptions = configuration.baseOptions;
|
|
33908
|
+
}
|
|
33909
|
+
|
|
33910
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
33911
|
+
const localVarHeaderParameter = {} as any;
|
|
33912
|
+
const localVarQueryParameter = {} as any;
|
|
33913
|
+
|
|
33914
|
+
// authentication ApiKeyAuth required
|
|
33915
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
33916
|
+
|
|
33917
|
+
// authentication OrganizationId required
|
|
33918
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
33919
|
+
|
|
33920
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
33921
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
33922
|
+
|
|
33923
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33924
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33925
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33926
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberCreateInputs, localVarRequestOptions, configuration)
|
|
33927
|
+
|
|
33928
|
+
return {
|
|
33929
|
+
url: toPathString(localVarUrlObj),
|
|
33930
|
+
options: localVarRequestOptions,
|
|
33931
|
+
};
|
|
33932
|
+
},
|
|
33933
|
+
/**
|
|
33934
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
33935
|
+
* @summary Create a place membership type
|
|
33573
33936
|
* @param {string} placeId The place identifier
|
|
33937
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
33574
33938
|
* @param {*} [options] Override http request option.
|
|
33575
33939
|
* @throws {RequiredError}
|
|
33576
33940
|
*/
|
|
33577
|
-
|
|
33941
|
+
createPlaceMembershipType: async (placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33578
33942
|
// verify required parameter 'placeId' is not null or undefined
|
|
33579
|
-
assertParamExists('
|
|
33580
|
-
|
|
33943
|
+
assertParamExists('createPlaceMembershipType', 'placeId', placeId)
|
|
33944
|
+
// verify required parameter 'placeMembershipTypeCreateInputs' is not null or undefined
|
|
33945
|
+
assertParamExists('createPlaceMembershipType', 'placeMembershipTypeCreateInputs', placeMembershipTypeCreateInputs)
|
|
33946
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
33947
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33948
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33949
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33950
|
+
let baseOptions;
|
|
33951
|
+
if (configuration) {
|
|
33952
|
+
baseOptions = configuration.baseOptions;
|
|
33953
|
+
}
|
|
33954
|
+
|
|
33955
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
33956
|
+
const localVarHeaderParameter = {} as any;
|
|
33957
|
+
const localVarQueryParameter = {} as any;
|
|
33958
|
+
|
|
33959
|
+
// authentication ApiKeyAuth required
|
|
33960
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
33961
|
+
|
|
33962
|
+
// authentication OrganizationId required
|
|
33963
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
33964
|
+
|
|
33965
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
33966
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
33967
|
+
|
|
33968
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33969
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33970
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33971
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeCreateInputs, localVarRequestOptions, configuration)
|
|
33972
|
+
|
|
33973
|
+
return {
|
|
33974
|
+
url: toPathString(localVarUrlObj),
|
|
33975
|
+
options: localVarRequestOptions,
|
|
33976
|
+
};
|
|
33977
|
+
},
|
|
33978
|
+
/**
|
|
33979
|
+
* 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.
|
|
33980
|
+
* @summary Remove a member from a place membership
|
|
33981
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
33982
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
33983
|
+
* @param {*} [options] Override http request option.
|
|
33984
|
+
* @throws {RequiredError}
|
|
33985
|
+
*/
|
|
33986
|
+
deletePlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33987
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
33988
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
33989
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
33990
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId)
|
|
33991
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
33992
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
33993
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
33994
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33995
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33996
|
+
let baseOptions;
|
|
33997
|
+
if (configuration) {
|
|
33998
|
+
baseOptions = configuration.baseOptions;
|
|
33999
|
+
}
|
|
34000
|
+
|
|
34001
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
34002
|
+
const localVarHeaderParameter = {} as any;
|
|
34003
|
+
const localVarQueryParameter = {} as any;
|
|
34004
|
+
|
|
34005
|
+
// authentication ApiKeyAuth required
|
|
34006
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34007
|
+
|
|
34008
|
+
// authentication OrganizationId required
|
|
34009
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34010
|
+
|
|
34011
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34012
|
+
|
|
34013
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34014
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34015
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34016
|
+
|
|
34017
|
+
return {
|
|
34018
|
+
url: toPathString(localVarUrlObj),
|
|
34019
|
+
options: localVarRequestOptions,
|
|
34020
|
+
};
|
|
34021
|
+
},
|
|
34022
|
+
/**
|
|
34023
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34024
|
+
* @summary Delete a place membership type
|
|
34025
|
+
* @param {string} placeId The place identifier
|
|
34026
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34027
|
+
* @param {*} [options] Override http request option.
|
|
34028
|
+
* @throws {RequiredError}
|
|
34029
|
+
*/
|
|
34030
|
+
deletePlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34031
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34032
|
+
assertParamExists('deletePlaceMembershipType', 'placeId', placeId)
|
|
34033
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34034
|
+
assertParamExists('deletePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34035
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34036
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34037
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34038
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34039
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34040
|
+
let baseOptions;
|
|
34041
|
+
if (configuration) {
|
|
34042
|
+
baseOptions = configuration.baseOptions;
|
|
34043
|
+
}
|
|
34044
|
+
|
|
34045
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
34046
|
+
const localVarHeaderParameter = {} as any;
|
|
34047
|
+
const localVarQueryParameter = {} as any;
|
|
34048
|
+
|
|
34049
|
+
// authentication ApiKeyAuth required
|
|
34050
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34051
|
+
|
|
34052
|
+
// authentication OrganizationId required
|
|
34053
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34054
|
+
|
|
34055
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34056
|
+
|
|
34057
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34058
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34059
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34060
|
+
|
|
34061
|
+
return {
|
|
34062
|
+
url: toPathString(localVarUrlObj),
|
|
34063
|
+
options: localVarRequestOptions,
|
|
34064
|
+
};
|
|
34065
|
+
},
|
|
34066
|
+
/**
|
|
34067
|
+
* 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\".
|
|
34068
|
+
* @summary Get a place membership
|
|
34069
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34070
|
+
* @param {*} [options] Override http request option.
|
|
34071
|
+
* @throws {RequiredError}
|
|
34072
|
+
*/
|
|
34073
|
+
getPlaceMembership: async (placeMembershipId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34074
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34075
|
+
assertParamExists('getPlaceMembership', 'placeMembershipId', placeMembershipId)
|
|
34076
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
34077
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34078
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34079
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34080
|
+
let baseOptions;
|
|
34081
|
+
if (configuration) {
|
|
34082
|
+
baseOptions = configuration.baseOptions;
|
|
34083
|
+
}
|
|
34084
|
+
|
|
34085
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34086
|
+
const localVarHeaderParameter = {} as any;
|
|
34087
|
+
const localVarQueryParameter = {} as any;
|
|
34088
|
+
|
|
34089
|
+
// authentication ApiKeyAuth required
|
|
34090
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34091
|
+
|
|
34092
|
+
// authentication OrganizationId required
|
|
34093
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34094
|
+
|
|
34095
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34096
|
+
|
|
34097
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34098
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34099
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34100
|
+
|
|
34101
|
+
return {
|
|
34102
|
+
url: toPathString(localVarUrlObj),
|
|
34103
|
+
options: localVarRequestOptions,
|
|
34104
|
+
};
|
|
34105
|
+
},
|
|
34106
|
+
/**
|
|
34107
|
+
* 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\".
|
|
34108
|
+
* @summary List bookings that applied a place membership
|
|
34109
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34110
|
+
* @param {number} [page] Page number
|
|
34111
|
+
* @param {number} [pageSize] Number of items per page
|
|
34112
|
+
* @param {string} [orderBy] Field to order by
|
|
34113
|
+
* @param {string} [search] Search query
|
|
34114
|
+
* @param {*} [options] Override http request option.
|
|
34115
|
+
* @throws {RequiredError}
|
|
34116
|
+
*/
|
|
34117
|
+
getPlaceMembershipBookings: async (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34118
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34119
|
+
assertParamExists('getPlaceMembershipBookings', 'placeMembershipId', placeMembershipId)
|
|
34120
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/bookings`
|
|
34121
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34122
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34123
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34124
|
+
let baseOptions;
|
|
34125
|
+
if (configuration) {
|
|
34126
|
+
baseOptions = configuration.baseOptions;
|
|
34127
|
+
}
|
|
34128
|
+
|
|
34129
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34130
|
+
const localVarHeaderParameter = {} as any;
|
|
34131
|
+
const localVarQueryParameter = {} as any;
|
|
34132
|
+
|
|
34133
|
+
// authentication ApiKeyAuth required
|
|
34134
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34135
|
+
|
|
34136
|
+
// authentication OrganizationId required
|
|
34137
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34138
|
+
|
|
34139
|
+
if (page !== undefined) {
|
|
34140
|
+
localVarQueryParameter['page'] = page;
|
|
34141
|
+
}
|
|
34142
|
+
|
|
34143
|
+
if (pageSize !== undefined) {
|
|
34144
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34145
|
+
}
|
|
34146
|
+
|
|
34147
|
+
if (orderBy !== undefined) {
|
|
34148
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34149
|
+
}
|
|
34150
|
+
|
|
34151
|
+
if (search !== undefined) {
|
|
34152
|
+
localVarQueryParameter['search'] = search;
|
|
34153
|
+
}
|
|
34154
|
+
|
|
34155
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34156
|
+
|
|
34157
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34158
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34159
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34160
|
+
|
|
34161
|
+
return {
|
|
34162
|
+
url: toPathString(localVarUrlObj),
|
|
34163
|
+
options: localVarRequestOptions,
|
|
34164
|
+
};
|
|
34165
|
+
},
|
|
34166
|
+
/**
|
|
34167
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34168
|
+
* @summary List a place membership\'s members
|
|
34169
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34170
|
+
* @param {number} [page] Page number
|
|
34171
|
+
* @param {number} [pageSize] Number of items per page
|
|
34172
|
+
* @param {string} [orderBy] Field to order by
|
|
34173
|
+
* @param {string} [search] Search query
|
|
34174
|
+
* @param {*} [options] Override http request option.
|
|
34175
|
+
* @throws {RequiredError}
|
|
34176
|
+
*/
|
|
34177
|
+
getPlaceMembershipMembers: async (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34178
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34179
|
+
assertParamExists('getPlaceMembershipMembers', 'placeMembershipId', placeMembershipId)
|
|
34180
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
34181
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34182
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34183
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34184
|
+
let baseOptions;
|
|
34185
|
+
if (configuration) {
|
|
34186
|
+
baseOptions = configuration.baseOptions;
|
|
34187
|
+
}
|
|
34188
|
+
|
|
34189
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34190
|
+
const localVarHeaderParameter = {} as any;
|
|
34191
|
+
const localVarQueryParameter = {} as any;
|
|
34192
|
+
|
|
34193
|
+
// authentication ApiKeyAuth required
|
|
34194
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34195
|
+
|
|
34196
|
+
// authentication OrganizationId required
|
|
34197
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34198
|
+
|
|
34199
|
+
if (page !== undefined) {
|
|
34200
|
+
localVarQueryParameter['page'] = page;
|
|
34201
|
+
}
|
|
34202
|
+
|
|
34203
|
+
if (pageSize !== undefined) {
|
|
34204
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34205
|
+
}
|
|
34206
|
+
|
|
34207
|
+
if (orderBy !== undefined) {
|
|
34208
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34209
|
+
}
|
|
34210
|
+
|
|
34211
|
+
if (search !== undefined) {
|
|
34212
|
+
localVarQueryParameter['search'] = search;
|
|
34213
|
+
}
|
|
34214
|
+
|
|
34215
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34216
|
+
|
|
34217
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34218
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34219
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34220
|
+
|
|
34221
|
+
return {
|
|
34222
|
+
url: toPathString(localVarUrlObj),
|
|
34223
|
+
options: localVarRequestOptions,
|
|
34224
|
+
};
|
|
34225
|
+
},
|
|
34226
|
+
/**
|
|
34227
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34228
|
+
* @summary Get a place membership type
|
|
34229
|
+
* @param {string} placeId The place identifier
|
|
34230
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34231
|
+
* @param {*} [options] Override http request option.
|
|
34232
|
+
* @throws {RequiredError}
|
|
34233
|
+
*/
|
|
34234
|
+
getPlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34235
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34236
|
+
assertParamExists('getPlaceMembershipType', 'placeId', placeId)
|
|
34237
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34238
|
+
assertParamExists('getPlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34239
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34240
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34241
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34242
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34243
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34244
|
+
let baseOptions;
|
|
34245
|
+
if (configuration) {
|
|
34246
|
+
baseOptions = configuration.baseOptions;
|
|
34247
|
+
}
|
|
34248
|
+
|
|
34249
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34250
|
+
const localVarHeaderParameter = {} as any;
|
|
34251
|
+
const localVarQueryParameter = {} as any;
|
|
34252
|
+
|
|
34253
|
+
// authentication ApiKeyAuth required
|
|
34254
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34255
|
+
|
|
34256
|
+
// authentication OrganizationId required
|
|
34257
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34258
|
+
|
|
34259
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34260
|
+
|
|
34261
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34262
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34263
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34264
|
+
|
|
34265
|
+
return {
|
|
34266
|
+
url: toPathString(localVarUrlObj),
|
|
34267
|
+
options: localVarRequestOptions,
|
|
34268
|
+
};
|
|
34269
|
+
},
|
|
34270
|
+
/**
|
|
34271
|
+
* 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\".
|
|
34272
|
+
* @summary List a place\'s membership types
|
|
34273
|
+
* @param {string} placeId The place identifier
|
|
34274
|
+
* @param {boolean} [archived] Filter by archived
|
|
34275
|
+
* @param {number} [page] Page number
|
|
34276
|
+
* @param {number} [pageSize] Number of items per page
|
|
34277
|
+
* @param {string} [orderBy] Field to order by
|
|
34278
|
+
* @param {string} [search] Search query
|
|
34279
|
+
* @param {*} [options] Override http request option.
|
|
34280
|
+
* @throws {RequiredError}
|
|
34281
|
+
*/
|
|
34282
|
+
getPlaceMembershipTypes: async (placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34283
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34284
|
+
assertParamExists('getPlaceMembershipTypes', 'placeId', placeId)
|
|
34285
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
34286
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
34287
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34288
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34289
|
+
let baseOptions;
|
|
34290
|
+
if (configuration) {
|
|
34291
|
+
baseOptions = configuration.baseOptions;
|
|
34292
|
+
}
|
|
34293
|
+
|
|
34294
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34295
|
+
const localVarHeaderParameter = {} as any;
|
|
34296
|
+
const localVarQueryParameter = {} as any;
|
|
34297
|
+
|
|
34298
|
+
// authentication ApiKeyAuth required
|
|
34299
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34300
|
+
|
|
34301
|
+
// authentication OrganizationId required
|
|
34302
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34303
|
+
|
|
34304
|
+
if (archived !== undefined) {
|
|
34305
|
+
localVarQueryParameter['archived'] = archived;
|
|
34306
|
+
}
|
|
34307
|
+
|
|
34308
|
+
if (page !== undefined) {
|
|
34309
|
+
localVarQueryParameter['page'] = page;
|
|
34310
|
+
}
|
|
34311
|
+
|
|
34312
|
+
if (pageSize !== undefined) {
|
|
34313
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34314
|
+
}
|
|
34315
|
+
|
|
34316
|
+
if (orderBy !== undefined) {
|
|
34317
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34318
|
+
}
|
|
34319
|
+
|
|
34320
|
+
if (search !== undefined) {
|
|
34321
|
+
localVarQueryParameter['search'] = search;
|
|
34322
|
+
}
|
|
34323
|
+
|
|
34324
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34325
|
+
|
|
34326
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34327
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34328
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34329
|
+
|
|
34330
|
+
return {
|
|
34331
|
+
url: toPathString(localVarUrlObj),
|
|
34332
|
+
options: localVarRequestOptions,
|
|
34333
|
+
};
|
|
34334
|
+
},
|
|
34335
|
+
/**
|
|
34336
|
+
* 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\".
|
|
34337
|
+
* @summary List a place\'s memberships
|
|
34338
|
+
* @param {string} placeId The place identifier
|
|
34339
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
34340
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
34341
|
+
* @param {boolean} [active] Filter by active
|
|
34342
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
34343
|
+
* @param {boolean} [expired] Filter by expired
|
|
34344
|
+
* @param {number} [page] Page number
|
|
34345
|
+
* @param {number} [pageSize] Number of items per page
|
|
34346
|
+
* @param {string} [orderBy] Field to order by
|
|
34347
|
+
* @param {string} [search] Search query
|
|
34348
|
+
* @param {*} [options] Override http request option.
|
|
34349
|
+
* @throws {RequiredError}
|
|
34350
|
+
*/
|
|
34351
|
+
getPlaceMemberships: async (placeId: string, placeMembershipTypeId?: string, status?: PurchaseStatus, active?: boolean, upcoming?: boolean, expired?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34352
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34353
|
+
assertParamExists('getPlaceMemberships', 'placeId', placeId)
|
|
34354
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
34355
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
34356
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34357
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34358
|
+
let baseOptions;
|
|
34359
|
+
if (configuration) {
|
|
34360
|
+
baseOptions = configuration.baseOptions;
|
|
34361
|
+
}
|
|
34362
|
+
|
|
34363
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34364
|
+
const localVarHeaderParameter = {} as any;
|
|
34365
|
+
const localVarQueryParameter = {} as any;
|
|
34366
|
+
|
|
34367
|
+
// authentication ApiKeyAuth required
|
|
34368
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34369
|
+
|
|
34370
|
+
// authentication OrganizationId required
|
|
34371
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34372
|
+
|
|
34373
|
+
if (placeMembershipTypeId !== undefined) {
|
|
34374
|
+
localVarQueryParameter['placeMembershipTypeId'] = placeMembershipTypeId;
|
|
34375
|
+
}
|
|
34376
|
+
|
|
34377
|
+
if (status !== undefined) {
|
|
34378
|
+
localVarQueryParameter['status'] = status;
|
|
34379
|
+
}
|
|
34380
|
+
|
|
34381
|
+
if (active !== undefined) {
|
|
34382
|
+
localVarQueryParameter['active'] = active;
|
|
34383
|
+
}
|
|
34384
|
+
|
|
34385
|
+
if (upcoming !== undefined) {
|
|
34386
|
+
localVarQueryParameter['upcoming'] = upcoming;
|
|
34387
|
+
}
|
|
34388
|
+
|
|
34389
|
+
if (expired !== undefined) {
|
|
34390
|
+
localVarQueryParameter['expired'] = expired;
|
|
34391
|
+
}
|
|
34392
|
+
|
|
34393
|
+
if (page !== undefined) {
|
|
34394
|
+
localVarQueryParameter['page'] = page;
|
|
34395
|
+
}
|
|
34396
|
+
|
|
34397
|
+
if (pageSize !== undefined) {
|
|
34398
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34399
|
+
}
|
|
34400
|
+
|
|
34401
|
+
if (orderBy !== undefined) {
|
|
34402
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34403
|
+
}
|
|
34404
|
+
|
|
34405
|
+
if (search !== undefined) {
|
|
34406
|
+
localVarQueryParameter['search'] = search;
|
|
34407
|
+
}
|
|
34408
|
+
|
|
34409
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34410
|
+
|
|
34411
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34412
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34413
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34414
|
+
|
|
34415
|
+
return {
|
|
34416
|
+
url: toPathString(localVarUrlObj),
|
|
34417
|
+
options: localVarRequestOptions,
|
|
34418
|
+
};
|
|
34419
|
+
},
|
|
34420
|
+
/**
|
|
34421
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34422
|
+
* @summary Update a place membership
|
|
34423
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34424
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
34425
|
+
* @param {*} [options] Override http request option.
|
|
34426
|
+
* @throws {RequiredError}
|
|
34427
|
+
*/
|
|
34428
|
+
updatePlaceMembership: async (placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34429
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34430
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipId', placeMembershipId)
|
|
34431
|
+
// verify required parameter 'placeMembershipUpdateInputs' is not null or undefined
|
|
34432
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipUpdateInputs', placeMembershipUpdateInputs)
|
|
34433
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
34434
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34435
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34436
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34437
|
+
let baseOptions;
|
|
34438
|
+
if (configuration) {
|
|
34439
|
+
baseOptions = configuration.baseOptions;
|
|
34440
|
+
}
|
|
34441
|
+
|
|
34442
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34443
|
+
const localVarHeaderParameter = {} as any;
|
|
34444
|
+
const localVarQueryParameter = {} as any;
|
|
34445
|
+
|
|
34446
|
+
// authentication ApiKeyAuth required
|
|
34447
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34448
|
+
|
|
34449
|
+
// authentication OrganizationId required
|
|
34450
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34451
|
+
|
|
34452
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34453
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34454
|
+
|
|
34455
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34456
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34457
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34458
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipUpdateInputs, localVarRequestOptions, configuration)
|
|
34459
|
+
|
|
34460
|
+
return {
|
|
34461
|
+
url: toPathString(localVarUrlObj),
|
|
34462
|
+
options: localVarRequestOptions,
|
|
34463
|
+
};
|
|
34464
|
+
},
|
|
34465
|
+
/**
|
|
34466
|
+
* 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.
|
|
34467
|
+
* @summary Update a place membership member
|
|
34468
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34469
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34470
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
34471
|
+
* @param {*} [options] Override http request option.
|
|
34472
|
+
* @throws {RequiredError}
|
|
34473
|
+
*/
|
|
34474
|
+
updatePlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34475
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34476
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
34477
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
34478
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId)
|
|
34479
|
+
// verify required parameter 'placeMembershipMemberUpdateInputs' is not null or undefined
|
|
34480
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberUpdateInputs', placeMembershipMemberUpdateInputs)
|
|
34481
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
34482
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
34483
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
34484
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34485
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34486
|
+
let baseOptions;
|
|
34487
|
+
if (configuration) {
|
|
34488
|
+
baseOptions = configuration.baseOptions;
|
|
34489
|
+
}
|
|
34490
|
+
|
|
34491
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34492
|
+
const localVarHeaderParameter = {} as any;
|
|
34493
|
+
const localVarQueryParameter = {} as any;
|
|
34494
|
+
|
|
34495
|
+
// authentication ApiKeyAuth required
|
|
34496
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34497
|
+
|
|
34498
|
+
// authentication OrganizationId required
|
|
34499
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34500
|
+
|
|
34501
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34502
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34503
|
+
|
|
34504
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34505
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34506
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34507
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberUpdateInputs, localVarRequestOptions, configuration)
|
|
34508
|
+
|
|
34509
|
+
return {
|
|
34510
|
+
url: toPathString(localVarUrlObj),
|
|
34511
|
+
options: localVarRequestOptions,
|
|
34512
|
+
};
|
|
34513
|
+
},
|
|
34514
|
+
/**
|
|
34515
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34516
|
+
* @summary Update a place membership type
|
|
34517
|
+
* @param {string} placeId The place identifier
|
|
34518
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34519
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
34520
|
+
* @param {*} [options] Override http request option.
|
|
34521
|
+
* @throws {RequiredError}
|
|
34522
|
+
*/
|
|
34523
|
+
updatePlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34524
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34525
|
+
assertParamExists('updatePlaceMembershipType', 'placeId', placeId)
|
|
34526
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34527
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34528
|
+
// verify required parameter 'placeMembershipTypeUpdateInputs' is not null or undefined
|
|
34529
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeUpdateInputs', placeMembershipTypeUpdateInputs)
|
|
34530
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34531
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34532
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34533
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34534
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34535
|
+
let baseOptions;
|
|
34536
|
+
if (configuration) {
|
|
34537
|
+
baseOptions = configuration.baseOptions;
|
|
34538
|
+
}
|
|
34539
|
+
|
|
34540
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34541
|
+
const localVarHeaderParameter = {} as any;
|
|
34542
|
+
const localVarQueryParameter = {} as any;
|
|
34543
|
+
|
|
34544
|
+
// authentication ApiKeyAuth required
|
|
34545
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34546
|
+
|
|
34547
|
+
// authentication OrganizationId required
|
|
34548
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34549
|
+
|
|
34550
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34551
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34552
|
+
|
|
34553
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34554
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34555
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34556
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeUpdateInputs, localVarRequestOptions, configuration)
|
|
34557
|
+
|
|
34558
|
+
return {
|
|
34559
|
+
url: toPathString(localVarUrlObj),
|
|
34560
|
+
options: localVarRequestOptions,
|
|
34561
|
+
};
|
|
34562
|
+
},
|
|
34563
|
+
}
|
|
34564
|
+
};
|
|
34565
|
+
|
|
34566
|
+
/**
|
|
34567
|
+
* BookingsMembershipsApi - functional programming interface
|
|
34568
|
+
*/
|
|
34569
|
+
export const BookingsMembershipsApiFp = function(configuration?: Configuration) {
|
|
34570
|
+
const localVarAxiosParamCreator = BookingsMembershipsApiAxiosParamCreator(configuration)
|
|
34571
|
+
return {
|
|
34572
|
+
/**
|
|
34573
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
34574
|
+
* @summary Grant a place membership
|
|
34575
|
+
* @param {string} placeId The place identifier
|
|
34576
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
34577
|
+
* @param {*} [options] Override http request option.
|
|
34578
|
+
* @throws {RequiredError}
|
|
34579
|
+
*/
|
|
34580
|
+
async createPlaceMembership(placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34581
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembership(placeId, placeMembershipCreateInputs, options);
|
|
34582
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34583
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34584
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34585
|
+
},
|
|
34586
|
+
/**
|
|
34587
|
+
* 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.
|
|
34588
|
+
* @summary Add a member to a place membership
|
|
34589
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34590
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
34591
|
+
* @param {*} [options] Override http request option.
|
|
34592
|
+
* @throws {RequiredError}
|
|
34593
|
+
*/
|
|
34594
|
+
async createPlaceMembershipMember(placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>> {
|
|
34595
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembershipMember(placeMembershipId, placeMembershipMemberCreateInputs, options);
|
|
34596
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34597
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34598
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34599
|
+
},
|
|
34600
|
+
/**
|
|
34601
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
34602
|
+
* @summary Create a place membership type
|
|
34603
|
+
* @param {string} placeId The place identifier
|
|
34604
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
34605
|
+
* @param {*} [options] Override http request option.
|
|
34606
|
+
* @throws {RequiredError}
|
|
34607
|
+
*/
|
|
34608
|
+
async createPlaceMembershipType(placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34609
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembershipType(placeId, placeMembershipTypeCreateInputs, options);
|
|
34610
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34611
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34612
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34613
|
+
},
|
|
34614
|
+
/**
|
|
34615
|
+
* 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.
|
|
34616
|
+
* @summary Remove a member from a place membership
|
|
34617
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34618
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34619
|
+
* @param {*} [options] Override http request option.
|
|
34620
|
+
* @throws {RequiredError}
|
|
34621
|
+
*/
|
|
34622
|
+
async deletePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
34623
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, options);
|
|
34624
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34625
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34626
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34627
|
+
},
|
|
34628
|
+
/**
|
|
34629
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34630
|
+
* @summary Delete a place membership type
|
|
34631
|
+
* @param {string} placeId The place identifier
|
|
34632
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34633
|
+
* @param {*} [options] Override http request option.
|
|
34634
|
+
* @throws {RequiredError}
|
|
34635
|
+
*/
|
|
34636
|
+
async deletePlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
34637
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
34638
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34639
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34640
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34641
|
+
},
|
|
34642
|
+
/**
|
|
34643
|
+
* 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\".
|
|
34644
|
+
* @summary Get a place membership
|
|
34645
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34646
|
+
* @param {*} [options] Override http request option.
|
|
34647
|
+
* @throws {RequiredError}
|
|
34648
|
+
*/
|
|
34649
|
+
async getPlaceMembership(placeMembershipId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34650
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembership(placeMembershipId, options);
|
|
34651
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34652
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34653
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34654
|
+
},
|
|
34655
|
+
/**
|
|
34656
|
+
* 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\".
|
|
34657
|
+
* @summary List bookings that applied a place membership
|
|
34658
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34659
|
+
* @param {number} [page] Page number
|
|
34660
|
+
* @param {number} [pageSize] Number of items per page
|
|
34661
|
+
* @param {string} [orderBy] Field to order by
|
|
34662
|
+
* @param {string} [search] Search query
|
|
34663
|
+
* @param {*} [options] Override http request option.
|
|
34664
|
+
* @throws {RequiredError}
|
|
34665
|
+
*/
|
|
34666
|
+
async getPlaceMembershipBookings(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountBookings200Response>> {
|
|
34667
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipBookings(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
34668
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34669
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipBookings']?.[localVarOperationServerIndex]?.url;
|
|
34670
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34671
|
+
},
|
|
34672
|
+
/**
|
|
34673
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34674
|
+
* @summary List a place membership\'s members
|
|
34675
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34676
|
+
* @param {number} [page] Page number
|
|
34677
|
+
* @param {number} [pageSize] Number of items per page
|
|
34678
|
+
* @param {string} [orderBy] Field to order by
|
|
34679
|
+
* @param {string} [search] Search query
|
|
34680
|
+
* @param {*} [options] Override http request option.
|
|
34681
|
+
* @throws {RequiredError}
|
|
34682
|
+
*/
|
|
34683
|
+
async getPlaceMembershipMembers(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipMembers200Response>> {
|
|
34684
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipMembers(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
34685
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34686
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipMembers']?.[localVarOperationServerIndex]?.url;
|
|
34687
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34688
|
+
},
|
|
34689
|
+
/**
|
|
34690
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34691
|
+
* @summary Get a place membership type
|
|
34692
|
+
* @param {string} placeId The place identifier
|
|
34693
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34694
|
+
* @param {*} [options] Override http request option.
|
|
34695
|
+
* @throws {RequiredError}
|
|
34696
|
+
*/
|
|
34697
|
+
async getPlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34698
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
34699
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34700
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34701
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34702
|
+
},
|
|
34703
|
+
/**
|
|
34704
|
+
* 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\".
|
|
34705
|
+
* @summary List a place\'s membership types
|
|
34706
|
+
* @param {string} placeId The place identifier
|
|
34707
|
+
* @param {boolean} [archived] Filter by archived
|
|
34708
|
+
* @param {number} [page] Page number
|
|
34709
|
+
* @param {number} [pageSize] Number of items per page
|
|
34710
|
+
* @param {string} [orderBy] Field to order by
|
|
34711
|
+
* @param {string} [search] Search query
|
|
34712
|
+
* @param {*} [options] Override http request option.
|
|
34713
|
+
* @throws {RequiredError}
|
|
34714
|
+
*/
|
|
34715
|
+
async getPlaceMembershipTypes(placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypes200Response>> {
|
|
34716
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypes(placeId, archived, page, pageSize, orderBy, search, options);
|
|
34717
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34718
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipTypes']?.[localVarOperationServerIndex]?.url;
|
|
34719
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34720
|
+
},
|
|
34721
|
+
/**
|
|
34722
|
+
* 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\".
|
|
34723
|
+
* @summary List a place\'s memberships
|
|
34724
|
+
* @param {string} placeId The place identifier
|
|
34725
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
34726
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
34727
|
+
* @param {boolean} [active] Filter by active
|
|
34728
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
34729
|
+
* @param {boolean} [expired] Filter by expired
|
|
34730
|
+
* @param {number} [page] Page number
|
|
34731
|
+
* @param {number} [pageSize] Number of items per page
|
|
34732
|
+
* @param {string} [orderBy] Field to order by
|
|
34733
|
+
* @param {string} [search] Search query
|
|
34734
|
+
* @param {*} [options] Override http request option.
|
|
34735
|
+
* @throws {RequiredError}
|
|
34736
|
+
*/
|
|
34737
|
+
async 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>> {
|
|
34738
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMemberships(placeId, placeMembershipTypeId, status, active, upcoming, expired, page, pageSize, orderBy, search, options);
|
|
34739
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34740
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMemberships']?.[localVarOperationServerIndex]?.url;
|
|
34741
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34742
|
+
},
|
|
34743
|
+
/**
|
|
34744
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34745
|
+
* @summary Update a place membership
|
|
34746
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34747
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
34748
|
+
* @param {*} [options] Override http request option.
|
|
34749
|
+
* @throws {RequiredError}
|
|
34750
|
+
*/
|
|
34751
|
+
async updatePlaceMembership(placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34752
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembership(placeMembershipId, placeMembershipUpdateInputs, options);
|
|
34753
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34754
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34755
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34756
|
+
},
|
|
34757
|
+
/**
|
|
34758
|
+
* 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.
|
|
34759
|
+
* @summary Update a place membership member
|
|
34760
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34761
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34762
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
34763
|
+
* @param {*} [options] Override http request option.
|
|
34764
|
+
* @throws {RequiredError}
|
|
34765
|
+
*/
|
|
34766
|
+
async updatePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>> {
|
|
34767
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, placeMembershipMemberUpdateInputs, options);
|
|
34768
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34769
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34770
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34771
|
+
},
|
|
34772
|
+
/**
|
|
34773
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34774
|
+
* @summary Update a place membership type
|
|
34775
|
+
* @param {string} placeId The place identifier
|
|
34776
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34777
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
34778
|
+
* @param {*} [options] Override http request option.
|
|
34779
|
+
* @throws {RequiredError}
|
|
34780
|
+
*/
|
|
34781
|
+
async updatePlaceMembershipType(placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34782
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipType(placeId, placeMembershipTypeId, placeMembershipTypeUpdateInputs, options);
|
|
34783
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34784
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34785
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34786
|
+
},
|
|
34787
|
+
}
|
|
34788
|
+
};
|
|
34789
|
+
|
|
34790
|
+
/**
|
|
34791
|
+
* BookingsMembershipsApi - factory interface
|
|
34792
|
+
*/
|
|
34793
|
+
export const BookingsMembershipsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
34794
|
+
const localVarFp = BookingsMembershipsApiFp(configuration)
|
|
34795
|
+
return {
|
|
34796
|
+
/**
|
|
34797
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
34798
|
+
* @summary Grant a place membership
|
|
34799
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
34800
|
+
* @param {*} [options] Override http request option.
|
|
34801
|
+
* @throws {RequiredError}
|
|
34802
|
+
*/
|
|
34803
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34804
|
+
return localVarFp.createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(axios, basePath));
|
|
34805
|
+
},
|
|
34806
|
+
/**
|
|
34807
|
+
* 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.
|
|
34808
|
+
* @summary Add a member to a place membership
|
|
34809
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34810
|
+
* @param {*} [options] Override http request option.
|
|
34811
|
+
* @throws {RequiredError}
|
|
34812
|
+
*/
|
|
34813
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response> {
|
|
34814
|
+
return localVarFp.createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(axios, basePath));
|
|
34815
|
+
},
|
|
34816
|
+
/**
|
|
34817
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
34818
|
+
* @summary Create a place membership type
|
|
34819
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34820
|
+
* @param {*} [options] Override http request option.
|
|
34821
|
+
* @throws {RequiredError}
|
|
34822
|
+
*/
|
|
34823
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34824
|
+
return localVarFp.createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(axios, basePath));
|
|
34825
|
+
},
|
|
34826
|
+
/**
|
|
34827
|
+
* 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.
|
|
34828
|
+
* @summary Remove a member from a place membership
|
|
34829
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34830
|
+
* @param {*} [options] Override http request option.
|
|
34831
|
+
* @throws {RequiredError}
|
|
34832
|
+
*/
|
|
34833
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
34834
|
+
return localVarFp.deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(axios, basePath));
|
|
34835
|
+
},
|
|
34836
|
+
/**
|
|
34837
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34838
|
+
* @summary Delete a place membership type
|
|
34839
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34840
|
+
* @param {*} [options] Override http request option.
|
|
34841
|
+
* @throws {RequiredError}
|
|
34842
|
+
*/
|
|
34843
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
34844
|
+
return localVarFp.deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
34845
|
+
},
|
|
34846
|
+
/**
|
|
34847
|
+
* 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\".
|
|
34848
|
+
* @summary Get a place membership
|
|
34849
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
34850
|
+
* @param {*} [options] Override http request option.
|
|
34851
|
+
* @throws {RequiredError}
|
|
34852
|
+
*/
|
|
34853
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34854
|
+
return localVarFp.getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(axios, basePath));
|
|
34855
|
+
},
|
|
34856
|
+
/**
|
|
34857
|
+
* 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\".
|
|
34858
|
+
* @summary List bookings that applied a place membership
|
|
34859
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
34860
|
+
* @param {*} [options] Override http request option.
|
|
34861
|
+
* @throws {RequiredError}
|
|
34862
|
+
*/
|
|
34863
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountBookings200Response> {
|
|
34864
|
+
return localVarFp.getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34865
|
+
},
|
|
34866
|
+
/**
|
|
34867
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34868
|
+
* @summary List a place membership\'s members
|
|
34869
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
34870
|
+
* @param {*} [options] Override http request option.
|
|
34871
|
+
* @throws {RequiredError}
|
|
34872
|
+
*/
|
|
34873
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipMembers200Response> {
|
|
34874
|
+
return localVarFp.getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34875
|
+
},
|
|
34876
|
+
/**
|
|
34877
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34878
|
+
* @summary Get a place membership type
|
|
34879
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34880
|
+
* @param {*} [options] Override http request option.
|
|
34881
|
+
* @throws {RequiredError}
|
|
34882
|
+
*/
|
|
34883
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34884
|
+
return localVarFp.getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
34885
|
+
},
|
|
34886
|
+
/**
|
|
34887
|
+
* 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\".
|
|
34888
|
+
* @summary List a place\'s membership types
|
|
34889
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
34890
|
+
* @param {*} [options] Override http request option.
|
|
34891
|
+
* @throws {RequiredError}
|
|
34892
|
+
*/
|
|
34893
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypes200Response> {
|
|
34894
|
+
return localVarFp.getPlaceMembershipTypes(requestParameters.placeId, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34895
|
+
},
|
|
34896
|
+
/**
|
|
34897
|
+
* 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\".
|
|
34898
|
+
* @summary List a place\'s memberships
|
|
34899
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
34900
|
+
* @param {*} [options] Override http request option.
|
|
34901
|
+
* @throws {RequiredError}
|
|
34902
|
+
*/
|
|
34903
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMemberships200Response> {
|
|
34904
|
+
return localVarFp.getPlaceMemberships(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.status, requestParameters.active, requestParameters.upcoming, requestParameters.expired, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34905
|
+
},
|
|
34906
|
+
/**
|
|
34907
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34908
|
+
* @summary Update a place membership
|
|
34909
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
34910
|
+
* @param {*} [options] Override http request option.
|
|
34911
|
+
* @throws {RequiredError}
|
|
34912
|
+
*/
|
|
34913
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34914
|
+
return localVarFp.updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34915
|
+
},
|
|
34916
|
+
/**
|
|
34917
|
+
* 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.
|
|
34918
|
+
* @summary Update a place membership member
|
|
34919
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34920
|
+
* @param {*} [options] Override http request option.
|
|
34921
|
+
* @throws {RequiredError}
|
|
34922
|
+
*/
|
|
34923
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response> {
|
|
34924
|
+
return localVarFp.updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34925
|
+
},
|
|
34926
|
+
/**
|
|
34927
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34928
|
+
* @summary Update a place membership type
|
|
34929
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34930
|
+
* @param {*} [options] Override http request option.
|
|
34931
|
+
* @throws {RequiredError}
|
|
34932
|
+
*/
|
|
34933
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34934
|
+
return localVarFp.updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34935
|
+
},
|
|
34936
|
+
};
|
|
34937
|
+
};
|
|
34938
|
+
|
|
34939
|
+
/**
|
|
34940
|
+
* Request parameters for createPlaceMembership operation in BookingsMembershipsApi.
|
|
34941
|
+
*/
|
|
34942
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipRequest {
|
|
34943
|
+
/**
|
|
34944
|
+
* The place identifier
|
|
34945
|
+
*/
|
|
34946
|
+
readonly placeId: string
|
|
34947
|
+
|
|
34948
|
+
readonly placeMembershipCreateInputs: PlaceMembershipCreateInputs
|
|
34949
|
+
}
|
|
34950
|
+
|
|
34951
|
+
/**
|
|
34952
|
+
* Request parameters for createPlaceMembershipMember operation in BookingsMembershipsApi.
|
|
34953
|
+
*/
|
|
34954
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipMemberRequest {
|
|
34955
|
+
/**
|
|
34956
|
+
* The placeMembership identifier
|
|
34957
|
+
*/
|
|
34958
|
+
readonly placeMembershipId: string
|
|
34959
|
+
|
|
34960
|
+
readonly placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs
|
|
34961
|
+
}
|
|
34962
|
+
|
|
34963
|
+
/**
|
|
34964
|
+
* Request parameters for createPlaceMembershipType operation in BookingsMembershipsApi.
|
|
34965
|
+
*/
|
|
34966
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipTypeRequest {
|
|
34967
|
+
/**
|
|
34968
|
+
* The place identifier
|
|
34969
|
+
*/
|
|
34970
|
+
readonly placeId: string
|
|
34971
|
+
|
|
34972
|
+
readonly placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs
|
|
34973
|
+
}
|
|
34974
|
+
|
|
34975
|
+
/**
|
|
34976
|
+
* Request parameters for deletePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
34977
|
+
*/
|
|
34978
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipMemberRequest {
|
|
34979
|
+
/**
|
|
34980
|
+
* The placeMembership identifier
|
|
34981
|
+
*/
|
|
34982
|
+
readonly placeMembershipId: string
|
|
34983
|
+
|
|
34984
|
+
/**
|
|
34985
|
+
* The placeMembershipMember identifier
|
|
34986
|
+
*/
|
|
34987
|
+
readonly placeMembershipMemberId: string
|
|
34988
|
+
}
|
|
34989
|
+
|
|
34990
|
+
/**
|
|
34991
|
+
* Request parameters for deletePlaceMembershipType operation in BookingsMembershipsApi.
|
|
34992
|
+
*/
|
|
34993
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipTypeRequest {
|
|
34994
|
+
/**
|
|
34995
|
+
* The place identifier
|
|
34996
|
+
*/
|
|
34997
|
+
readonly placeId: string
|
|
34998
|
+
|
|
34999
|
+
/**
|
|
35000
|
+
* The placeMembershipType identifier
|
|
35001
|
+
*/
|
|
35002
|
+
readonly placeMembershipTypeId: string
|
|
35003
|
+
}
|
|
35004
|
+
|
|
35005
|
+
/**
|
|
35006
|
+
* Request parameters for getPlaceMembership operation in BookingsMembershipsApi.
|
|
35007
|
+
*/
|
|
35008
|
+
export interface BookingsMembershipsApiGetPlaceMembershipRequest {
|
|
35009
|
+
/**
|
|
35010
|
+
* The placeMembership identifier
|
|
35011
|
+
*/
|
|
35012
|
+
readonly placeMembershipId: string
|
|
35013
|
+
}
|
|
35014
|
+
|
|
35015
|
+
/**
|
|
35016
|
+
* Request parameters for getPlaceMembershipBookings operation in BookingsMembershipsApi.
|
|
35017
|
+
*/
|
|
35018
|
+
export interface BookingsMembershipsApiGetPlaceMembershipBookingsRequest {
|
|
35019
|
+
/**
|
|
35020
|
+
* The placeMembership identifier
|
|
35021
|
+
*/
|
|
35022
|
+
readonly placeMembershipId: string
|
|
35023
|
+
|
|
35024
|
+
/**
|
|
35025
|
+
* Page number
|
|
35026
|
+
*/
|
|
35027
|
+
readonly page?: number
|
|
35028
|
+
|
|
35029
|
+
/**
|
|
35030
|
+
* Number of items per page
|
|
35031
|
+
*/
|
|
35032
|
+
readonly pageSize?: number
|
|
35033
|
+
|
|
35034
|
+
/**
|
|
35035
|
+
* Field to order by
|
|
35036
|
+
*/
|
|
35037
|
+
readonly orderBy?: string
|
|
35038
|
+
|
|
35039
|
+
/**
|
|
35040
|
+
* Search query
|
|
35041
|
+
*/
|
|
35042
|
+
readonly search?: string
|
|
35043
|
+
}
|
|
35044
|
+
|
|
35045
|
+
/**
|
|
35046
|
+
* Request parameters for getPlaceMembershipMembers operation in BookingsMembershipsApi.
|
|
35047
|
+
*/
|
|
35048
|
+
export interface BookingsMembershipsApiGetPlaceMembershipMembersRequest {
|
|
35049
|
+
/**
|
|
35050
|
+
* The placeMembership identifier
|
|
35051
|
+
*/
|
|
35052
|
+
readonly placeMembershipId: string
|
|
35053
|
+
|
|
35054
|
+
/**
|
|
35055
|
+
* Page number
|
|
35056
|
+
*/
|
|
35057
|
+
readonly page?: number
|
|
35058
|
+
|
|
35059
|
+
/**
|
|
35060
|
+
* Number of items per page
|
|
35061
|
+
*/
|
|
35062
|
+
readonly pageSize?: number
|
|
35063
|
+
|
|
35064
|
+
/**
|
|
35065
|
+
* Field to order by
|
|
35066
|
+
*/
|
|
35067
|
+
readonly orderBy?: string
|
|
35068
|
+
|
|
35069
|
+
/**
|
|
35070
|
+
* Search query
|
|
35071
|
+
*/
|
|
35072
|
+
readonly search?: string
|
|
35073
|
+
}
|
|
35074
|
+
|
|
35075
|
+
/**
|
|
35076
|
+
* Request parameters for getPlaceMembershipType operation in BookingsMembershipsApi.
|
|
35077
|
+
*/
|
|
35078
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypeRequest {
|
|
35079
|
+
/**
|
|
35080
|
+
* The place identifier
|
|
35081
|
+
*/
|
|
35082
|
+
readonly placeId: string
|
|
35083
|
+
|
|
35084
|
+
/**
|
|
35085
|
+
* The placeMembershipType identifier
|
|
35086
|
+
*/
|
|
35087
|
+
readonly placeMembershipTypeId: string
|
|
35088
|
+
}
|
|
35089
|
+
|
|
35090
|
+
/**
|
|
35091
|
+
* Request parameters for getPlaceMembershipTypes operation in BookingsMembershipsApi.
|
|
35092
|
+
*/
|
|
35093
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypesRequest {
|
|
35094
|
+
/**
|
|
35095
|
+
* The place identifier
|
|
35096
|
+
*/
|
|
35097
|
+
readonly placeId: string
|
|
35098
|
+
|
|
35099
|
+
/**
|
|
35100
|
+
* Filter by archived
|
|
35101
|
+
*/
|
|
35102
|
+
readonly archived?: boolean
|
|
35103
|
+
|
|
35104
|
+
/**
|
|
35105
|
+
* Page number
|
|
35106
|
+
*/
|
|
35107
|
+
readonly page?: number
|
|
35108
|
+
|
|
35109
|
+
/**
|
|
35110
|
+
* Number of items per page
|
|
35111
|
+
*/
|
|
35112
|
+
readonly pageSize?: number
|
|
35113
|
+
|
|
35114
|
+
/**
|
|
35115
|
+
* Field to order by
|
|
35116
|
+
*/
|
|
35117
|
+
readonly orderBy?: string
|
|
35118
|
+
|
|
35119
|
+
/**
|
|
35120
|
+
* Search query
|
|
35121
|
+
*/
|
|
35122
|
+
readonly search?: string
|
|
35123
|
+
}
|
|
35124
|
+
|
|
35125
|
+
/**
|
|
35126
|
+
* Request parameters for getPlaceMemberships operation in BookingsMembershipsApi.
|
|
35127
|
+
*/
|
|
35128
|
+
export interface BookingsMembershipsApiGetPlaceMembershipsRequest {
|
|
35129
|
+
/**
|
|
35130
|
+
* The place identifier
|
|
35131
|
+
*/
|
|
35132
|
+
readonly placeId: string
|
|
35133
|
+
|
|
35134
|
+
/**
|
|
35135
|
+
* Filter by placeMembershipTypeId
|
|
35136
|
+
*/
|
|
35137
|
+
readonly placeMembershipTypeId?: string
|
|
35138
|
+
|
|
35139
|
+
/**
|
|
35140
|
+
* Filter by status
|
|
35141
|
+
*/
|
|
35142
|
+
readonly status?: PurchaseStatus
|
|
35143
|
+
|
|
35144
|
+
/**
|
|
35145
|
+
* Filter by active
|
|
35146
|
+
*/
|
|
35147
|
+
readonly active?: boolean
|
|
35148
|
+
|
|
35149
|
+
/**
|
|
35150
|
+
* Filter by upcoming
|
|
35151
|
+
*/
|
|
35152
|
+
readonly upcoming?: boolean
|
|
35153
|
+
|
|
35154
|
+
/**
|
|
35155
|
+
* Filter by expired
|
|
35156
|
+
*/
|
|
35157
|
+
readonly expired?: boolean
|
|
35158
|
+
|
|
35159
|
+
/**
|
|
35160
|
+
* Page number
|
|
35161
|
+
*/
|
|
35162
|
+
readonly page?: number
|
|
35163
|
+
|
|
35164
|
+
/**
|
|
35165
|
+
* Number of items per page
|
|
35166
|
+
*/
|
|
35167
|
+
readonly pageSize?: number
|
|
35168
|
+
|
|
35169
|
+
/**
|
|
35170
|
+
* Field to order by
|
|
35171
|
+
*/
|
|
35172
|
+
readonly orderBy?: string
|
|
35173
|
+
|
|
35174
|
+
/**
|
|
35175
|
+
* Search query
|
|
35176
|
+
*/
|
|
35177
|
+
readonly search?: string
|
|
35178
|
+
}
|
|
35179
|
+
|
|
35180
|
+
/**
|
|
35181
|
+
* Request parameters for updatePlaceMembership operation in BookingsMembershipsApi.
|
|
35182
|
+
*/
|
|
35183
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipRequest {
|
|
35184
|
+
/**
|
|
35185
|
+
* The placeMembership identifier
|
|
35186
|
+
*/
|
|
35187
|
+
readonly placeMembershipId: string
|
|
35188
|
+
|
|
35189
|
+
readonly placeMembershipUpdateInputs: PlaceMembershipUpdateInputs
|
|
35190
|
+
}
|
|
35191
|
+
|
|
35192
|
+
/**
|
|
35193
|
+
* Request parameters for updatePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
35194
|
+
*/
|
|
35195
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipMemberRequest {
|
|
35196
|
+
/**
|
|
35197
|
+
* The placeMembership identifier
|
|
35198
|
+
*/
|
|
35199
|
+
readonly placeMembershipId: string
|
|
35200
|
+
|
|
35201
|
+
/**
|
|
35202
|
+
* The placeMembershipMember identifier
|
|
35203
|
+
*/
|
|
35204
|
+
readonly placeMembershipMemberId: string
|
|
35205
|
+
|
|
35206
|
+
readonly placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs
|
|
35207
|
+
}
|
|
35208
|
+
|
|
35209
|
+
/**
|
|
35210
|
+
* Request parameters for updatePlaceMembershipType operation in BookingsMembershipsApi.
|
|
35211
|
+
*/
|
|
35212
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipTypeRequest {
|
|
35213
|
+
/**
|
|
35214
|
+
* The place identifier
|
|
35215
|
+
*/
|
|
35216
|
+
readonly placeId: string
|
|
35217
|
+
|
|
35218
|
+
/**
|
|
35219
|
+
* The placeMembershipType identifier
|
|
35220
|
+
*/
|
|
35221
|
+
readonly placeMembershipTypeId: string
|
|
35222
|
+
|
|
35223
|
+
readonly placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs
|
|
35224
|
+
}
|
|
35225
|
+
|
|
35226
|
+
/**
|
|
35227
|
+
* BookingsMembershipsApi - object-oriented interface
|
|
35228
|
+
*/
|
|
35229
|
+
export class BookingsMembershipsApi extends BaseAPI {
|
|
35230
|
+
/**
|
|
35231
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
35232
|
+
* @summary Grant a place membership
|
|
35233
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
35234
|
+
* @param {*} [options] Override http request option.
|
|
35235
|
+
* @throws {RequiredError}
|
|
35236
|
+
*/
|
|
35237
|
+
public createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35238
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35239
|
+
}
|
|
35240
|
+
|
|
35241
|
+
/**
|
|
35242
|
+
* 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.
|
|
35243
|
+
* @summary Add a member to a place membership
|
|
35244
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35245
|
+
* @param {*} [options] Override http request option.
|
|
35246
|
+
* @throws {RequiredError}
|
|
35247
|
+
*/
|
|
35248
|
+
public createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35249
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35250
|
+
}
|
|
35251
|
+
|
|
35252
|
+
/**
|
|
35253
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
35254
|
+
* @summary Create a place membership type
|
|
35255
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35256
|
+
* @param {*} [options] Override http request option.
|
|
35257
|
+
* @throws {RequiredError}
|
|
35258
|
+
*/
|
|
35259
|
+
public createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35260
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35261
|
+
}
|
|
35262
|
+
|
|
35263
|
+
/**
|
|
35264
|
+
* 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.
|
|
35265
|
+
* @summary Remove a member from a place membership
|
|
35266
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35267
|
+
* @param {*} [options] Override http request option.
|
|
35268
|
+
* @throws {RequiredError}
|
|
35269
|
+
*/
|
|
35270
|
+
public deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35271
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(this.axios, this.basePath));
|
|
35272
|
+
}
|
|
35273
|
+
|
|
35274
|
+
/**
|
|
35275
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
35276
|
+
* @summary Delete a place membership type
|
|
35277
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35278
|
+
* @param {*} [options] Override http request option.
|
|
35279
|
+
* @throws {RequiredError}
|
|
35280
|
+
*/
|
|
35281
|
+
public deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35282
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
35283
|
+
}
|
|
35284
|
+
|
|
35285
|
+
/**
|
|
35286
|
+
* 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\".
|
|
35287
|
+
* @summary Get a place membership
|
|
35288
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
35289
|
+
* @param {*} [options] Override http request option.
|
|
35290
|
+
* @throws {RequiredError}
|
|
35291
|
+
*/
|
|
35292
|
+
public getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35293
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(this.axios, this.basePath));
|
|
35294
|
+
}
|
|
35295
|
+
|
|
35296
|
+
/**
|
|
35297
|
+
* 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\".
|
|
35298
|
+
* @summary List bookings that applied a place membership
|
|
35299
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
35300
|
+
* @param {*} [options] Override http request option.
|
|
35301
|
+
* @throws {RequiredError}
|
|
35302
|
+
*/
|
|
35303
|
+
public getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig) {
|
|
35304
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35305
|
+
}
|
|
35306
|
+
|
|
35307
|
+
/**
|
|
35308
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
35309
|
+
* @summary List a place membership\'s members
|
|
35310
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
35311
|
+
* @param {*} [options] Override http request option.
|
|
35312
|
+
* @throws {RequiredError}
|
|
35313
|
+
*/
|
|
35314
|
+
public getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig) {
|
|
35315
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35316
|
+
}
|
|
35317
|
+
|
|
35318
|
+
/**
|
|
35319
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
35320
|
+
* @summary Get a place membership type
|
|
35321
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35322
|
+
* @param {*} [options] Override http request option.
|
|
35323
|
+
* @throws {RequiredError}
|
|
35324
|
+
*/
|
|
35325
|
+
public getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35326
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
35327
|
+
}
|
|
35328
|
+
|
|
35329
|
+
/**
|
|
35330
|
+
* 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\".
|
|
35331
|
+
* @summary List a place\'s membership types
|
|
35332
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
35333
|
+
* @param {*} [options] Override http request option.
|
|
35334
|
+
* @throws {RequiredError}
|
|
35335
|
+
*/
|
|
35336
|
+
public getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig) {
|
|
35337
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipTypes(requestParameters.placeId, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35338
|
+
}
|
|
35339
|
+
|
|
35340
|
+
/**
|
|
35341
|
+
* 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\".
|
|
35342
|
+
* @summary List a place\'s memberships
|
|
35343
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
35344
|
+
* @param {*} [options] Override http request option.
|
|
35345
|
+
* @throws {RequiredError}
|
|
35346
|
+
*/
|
|
35347
|
+
public getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig) {
|
|
35348
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMemberships(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.status, requestParameters.active, requestParameters.upcoming, requestParameters.expired, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35349
|
+
}
|
|
35350
|
+
|
|
35351
|
+
/**
|
|
35352
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
35353
|
+
* @summary Update a place membership
|
|
35354
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
35355
|
+
* @param {*} [options] Override http request option.
|
|
35356
|
+
* @throws {RequiredError}
|
|
35357
|
+
*/
|
|
35358
|
+
public updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35359
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35360
|
+
}
|
|
35361
|
+
|
|
35362
|
+
/**
|
|
35363
|
+
* 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.
|
|
35364
|
+
* @summary Update a place membership member
|
|
35365
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35366
|
+
* @param {*} [options] Override http request option.
|
|
35367
|
+
* @throws {RequiredError}
|
|
35368
|
+
*/
|
|
35369
|
+
public updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35370
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35371
|
+
}
|
|
35372
|
+
|
|
35373
|
+
/**
|
|
35374
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
35375
|
+
* @summary Update a place membership type
|
|
35376
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35377
|
+
* @param {*} [options] Override http request option.
|
|
35378
|
+
* @throws {RequiredError}
|
|
35379
|
+
*/
|
|
35380
|
+
public updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35381
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35382
|
+
}
|
|
35383
|
+
}
|
|
35384
|
+
|
|
35385
|
+
|
|
35386
|
+
|
|
35387
|
+
/**
|
|
35388
|
+
* BookingsMembershipsTranslationsApi - axios parameter creator
|
|
35389
|
+
*/
|
|
35390
|
+
export const BookingsMembershipsTranslationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35391
|
+
return {
|
|
35392
|
+
/**
|
|
35393
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35394
|
+
* @summary Delete a place membership type translation
|
|
35395
|
+
* @param {string} placeId The place identifier
|
|
35396
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35397
|
+
* @param {string} locale The locale identifier
|
|
35398
|
+
* @param {*} [options] Override http request option.
|
|
35399
|
+
* @throws {RequiredError}
|
|
35400
|
+
*/
|
|
35401
|
+
deletePlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35402
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35403
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35404
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35405
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35406
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35407
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'locale', locale)
|
|
35408
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35409
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35410
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35411
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35412
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35413
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35414
|
+
let baseOptions;
|
|
35415
|
+
if (configuration) {
|
|
35416
|
+
baseOptions = configuration.baseOptions;
|
|
35417
|
+
}
|
|
35418
|
+
|
|
35419
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
35420
|
+
const localVarHeaderParameter = {} as any;
|
|
35421
|
+
const localVarQueryParameter = {} as any;
|
|
35422
|
+
|
|
35423
|
+
// authentication ApiKeyAuth required
|
|
35424
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35425
|
+
|
|
35426
|
+
// authentication OrganizationId required
|
|
35427
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35428
|
+
|
|
35429
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35430
|
+
|
|
35431
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35432
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35433
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35434
|
+
|
|
35435
|
+
return {
|
|
35436
|
+
url: toPathString(localVarUrlObj),
|
|
35437
|
+
options: localVarRequestOptions,
|
|
35438
|
+
};
|
|
35439
|
+
},
|
|
35440
|
+
/**
|
|
35441
|
+
* 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\".
|
|
35442
|
+
* @summary Get a place membership type\'s translation
|
|
35443
|
+
* @param {string} placeId The place identifier
|
|
35444
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35445
|
+
* @param {string} locale The locale identifier
|
|
35446
|
+
* @param {*} [options] Override http request option.
|
|
35447
|
+
* @throws {RequiredError}
|
|
35448
|
+
*/
|
|
35449
|
+
getPlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35450
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35451
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35452
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35453
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35454
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35455
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'locale', locale)
|
|
35456
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35457
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35458
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35459
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35460
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35461
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35462
|
+
let baseOptions;
|
|
35463
|
+
if (configuration) {
|
|
35464
|
+
baseOptions = configuration.baseOptions;
|
|
35465
|
+
}
|
|
35466
|
+
|
|
35467
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35468
|
+
const localVarHeaderParameter = {} as any;
|
|
35469
|
+
const localVarQueryParameter = {} as any;
|
|
35470
|
+
|
|
35471
|
+
// authentication ApiKeyAuth required
|
|
35472
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35473
|
+
|
|
35474
|
+
// authentication OrganizationId required
|
|
35475
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35476
|
+
|
|
35477
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35478
|
+
|
|
35479
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35480
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35481
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35482
|
+
|
|
35483
|
+
return {
|
|
35484
|
+
url: toPathString(localVarUrlObj),
|
|
35485
|
+
options: localVarRequestOptions,
|
|
35486
|
+
};
|
|
35487
|
+
},
|
|
35488
|
+
/**
|
|
35489
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35490
|
+
* @summary List a place membership type\'s translations
|
|
35491
|
+
* @param {string} placeId The place identifier
|
|
35492
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35493
|
+
* @param {number} [page] Page number
|
|
35494
|
+
* @param {number} [pageSize] Number of items per page
|
|
35495
|
+
* @param {string} [orderBy] Field to order by
|
|
35496
|
+
* @param {string} [search] Search query
|
|
35497
|
+
* @param {*} [options] Override http request option.
|
|
35498
|
+
* @throws {RequiredError}
|
|
35499
|
+
*/
|
|
35500
|
+
getPlaceMembershipTypeTranslations: async (placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35501
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35502
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeId', placeId)
|
|
35503
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35504
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35505
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations`
|
|
35506
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35507
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
35508
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35509
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35510
|
+
let baseOptions;
|
|
35511
|
+
if (configuration) {
|
|
35512
|
+
baseOptions = configuration.baseOptions;
|
|
35513
|
+
}
|
|
35514
|
+
|
|
35515
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35516
|
+
const localVarHeaderParameter = {} as any;
|
|
35517
|
+
const localVarQueryParameter = {} as any;
|
|
35518
|
+
|
|
35519
|
+
// authentication ApiKeyAuth required
|
|
35520
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35521
|
+
|
|
35522
|
+
// authentication OrganizationId required
|
|
35523
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35524
|
+
|
|
35525
|
+
if (page !== undefined) {
|
|
35526
|
+
localVarQueryParameter['page'] = page;
|
|
35527
|
+
}
|
|
35528
|
+
|
|
35529
|
+
if (pageSize !== undefined) {
|
|
35530
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
35531
|
+
}
|
|
35532
|
+
|
|
35533
|
+
if (orderBy !== undefined) {
|
|
35534
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
35535
|
+
}
|
|
35536
|
+
|
|
35537
|
+
if (search !== undefined) {
|
|
35538
|
+
localVarQueryParameter['search'] = search;
|
|
35539
|
+
}
|
|
35540
|
+
|
|
35541
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35542
|
+
|
|
35543
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35544
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35545
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35546
|
+
|
|
35547
|
+
return {
|
|
35548
|
+
url: toPathString(localVarUrlObj),
|
|
35549
|
+
options: localVarRequestOptions,
|
|
35550
|
+
};
|
|
35551
|
+
},
|
|
35552
|
+
/**
|
|
35553
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35554
|
+
* @summary Update a place membership type\'s translation
|
|
35555
|
+
* @param {string} placeId The place identifier
|
|
35556
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35557
|
+
* @param {string} locale The locale identifier
|
|
35558
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
35559
|
+
* @param {*} [options] Override http request option.
|
|
35560
|
+
* @throws {RequiredError}
|
|
35561
|
+
*/
|
|
35562
|
+
updatePlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35563
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35564
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35565
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35566
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35567
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35568
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'locale', locale)
|
|
35569
|
+
// verify required parameter 'placeMembershipTypeTranslationUpdateInputs' is not null or undefined
|
|
35570
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeTranslationUpdateInputs', placeMembershipTypeTranslationUpdateInputs)
|
|
35571
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35572
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35573
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35574
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35575
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35576
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35577
|
+
let baseOptions;
|
|
35578
|
+
if (configuration) {
|
|
35579
|
+
baseOptions = configuration.baseOptions;
|
|
35580
|
+
}
|
|
35581
|
+
|
|
35582
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
35583
|
+
const localVarHeaderParameter = {} as any;
|
|
35584
|
+
const localVarQueryParameter = {} as any;
|
|
35585
|
+
|
|
35586
|
+
// authentication ApiKeyAuth required
|
|
35587
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35588
|
+
|
|
35589
|
+
// authentication OrganizationId required
|
|
35590
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35591
|
+
|
|
35592
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35593
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35594
|
+
|
|
35595
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35596
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35597
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35598
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeTranslationUpdateInputs, localVarRequestOptions, configuration)
|
|
35599
|
+
|
|
35600
|
+
return {
|
|
35601
|
+
url: toPathString(localVarUrlObj),
|
|
35602
|
+
options: localVarRequestOptions,
|
|
35603
|
+
};
|
|
35604
|
+
},
|
|
35605
|
+
}
|
|
35606
|
+
};
|
|
35607
|
+
|
|
35608
|
+
/**
|
|
35609
|
+
* BookingsMembershipsTranslationsApi - functional programming interface
|
|
35610
|
+
*/
|
|
35611
|
+
export const BookingsMembershipsTranslationsApiFp = function(configuration?: Configuration) {
|
|
35612
|
+
const localVarAxiosParamCreator = BookingsMembershipsTranslationsApiAxiosParamCreator(configuration)
|
|
35613
|
+
return {
|
|
35614
|
+
/**
|
|
35615
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35616
|
+
* @summary Delete a place membership type translation
|
|
35617
|
+
* @param {string} placeId The place identifier
|
|
35618
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35619
|
+
* @param {string} locale The locale identifier
|
|
35620
|
+
* @param {*} [options] Override http request option.
|
|
35621
|
+
* @throws {RequiredError}
|
|
35622
|
+
*/
|
|
35623
|
+
async deletePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
35624
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
35625
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35626
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.deletePlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35627
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35628
|
+
},
|
|
35629
|
+
/**
|
|
35630
|
+
* 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\".
|
|
35631
|
+
* @summary Get a place membership type\'s translation
|
|
35632
|
+
* @param {string} placeId The place identifier
|
|
35633
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35634
|
+
* @param {string} locale The locale identifier
|
|
35635
|
+
* @param {*} [options] Override http request option.
|
|
35636
|
+
* @throws {RequiredError}
|
|
35637
|
+
*/
|
|
35638
|
+
async getPlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslation200Response>> {
|
|
35639
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
35640
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35641
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35642
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35643
|
+
},
|
|
35644
|
+
/**
|
|
35645
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35646
|
+
* @summary List a place membership type\'s translations
|
|
35647
|
+
* @param {string} placeId The place identifier
|
|
35648
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35649
|
+
* @param {number} [page] Page number
|
|
35650
|
+
* @param {number} [pageSize] Number of items per page
|
|
35651
|
+
* @param {string} [orderBy] Field to order by
|
|
35652
|
+
* @param {string} [search] Search query
|
|
35653
|
+
* @param {*} [options] Override http request option.
|
|
35654
|
+
* @throws {RequiredError}
|
|
35655
|
+
*/
|
|
35656
|
+
async getPlaceMembershipTypeTranslations(placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslations200Response>> {
|
|
35657
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypeTranslations(placeId, placeMembershipTypeId, page, pageSize, orderBy, search, options);
|
|
35658
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35659
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslations']?.[localVarOperationServerIndex]?.url;
|
|
35660
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35661
|
+
},
|
|
35662
|
+
/**
|
|
35663
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35664
|
+
* @summary Update a place membership type\'s translation
|
|
35665
|
+
* @param {string} placeId The place identifier
|
|
35666
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35667
|
+
* @param {string} locale The locale identifier
|
|
35668
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
35669
|
+
* @param {*} [options] Override http request option.
|
|
35670
|
+
* @throws {RequiredError}
|
|
35671
|
+
*/
|
|
35672
|
+
async updatePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>> {
|
|
35673
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, placeMembershipTypeTranslationUpdateInputs, options);
|
|
35674
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35675
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.updatePlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35676
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35677
|
+
},
|
|
35678
|
+
}
|
|
35679
|
+
};
|
|
35680
|
+
|
|
35681
|
+
/**
|
|
35682
|
+
* BookingsMembershipsTranslationsApi - factory interface
|
|
35683
|
+
*/
|
|
35684
|
+
export const BookingsMembershipsTranslationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
35685
|
+
const localVarFp = BookingsMembershipsTranslationsApiFp(configuration)
|
|
35686
|
+
return {
|
|
35687
|
+
/**
|
|
35688
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35689
|
+
* @summary Delete a place membership type translation
|
|
35690
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35691
|
+
* @param {*} [options] Override http request option.
|
|
35692
|
+
* @throws {RequiredError}
|
|
35693
|
+
*/
|
|
35694
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
35695
|
+
return localVarFp.deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
35696
|
+
},
|
|
35697
|
+
/**
|
|
35698
|
+
* 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\".
|
|
35699
|
+
* @summary Get a place membership type\'s translation
|
|
35700
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35701
|
+
* @param {*} [options] Override http request option.
|
|
35702
|
+
* @throws {RequiredError}
|
|
35703
|
+
*/
|
|
35704
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslation200Response> {
|
|
35705
|
+
return localVarFp.getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
35706
|
+
},
|
|
35707
|
+
/**
|
|
35708
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35709
|
+
* @summary List a place membership type\'s translations
|
|
35710
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
35711
|
+
* @param {*} [options] Override http request option.
|
|
35712
|
+
* @throws {RequiredError}
|
|
35713
|
+
*/
|
|
35714
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslations200Response> {
|
|
35715
|
+
return localVarFp.getPlaceMembershipTypeTranslations(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
35716
|
+
},
|
|
35717
|
+
/**
|
|
35718
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35719
|
+
* @summary Update a place membership type\'s translation
|
|
35720
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35721
|
+
* @param {*} [options] Override http request option.
|
|
35722
|
+
* @throws {RequiredError}
|
|
35723
|
+
*/
|
|
35724
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response> {
|
|
35725
|
+
return localVarFp.updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(axios, basePath));
|
|
35726
|
+
},
|
|
35727
|
+
};
|
|
35728
|
+
};
|
|
35729
|
+
|
|
35730
|
+
/**
|
|
35731
|
+
* Request parameters for deletePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35732
|
+
*/
|
|
35733
|
+
export interface BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest {
|
|
35734
|
+
/**
|
|
35735
|
+
* The place identifier
|
|
35736
|
+
*/
|
|
35737
|
+
readonly placeId: string
|
|
35738
|
+
|
|
35739
|
+
/**
|
|
35740
|
+
* The placeMembershipType identifier
|
|
35741
|
+
*/
|
|
35742
|
+
readonly placeMembershipTypeId: string
|
|
35743
|
+
|
|
35744
|
+
/**
|
|
35745
|
+
* The locale identifier
|
|
35746
|
+
*/
|
|
35747
|
+
readonly locale: string
|
|
35748
|
+
}
|
|
35749
|
+
|
|
35750
|
+
/**
|
|
35751
|
+
* Request parameters for getPlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35752
|
+
*/
|
|
35753
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest {
|
|
35754
|
+
/**
|
|
35755
|
+
* The place identifier
|
|
35756
|
+
*/
|
|
35757
|
+
readonly placeId: string
|
|
35758
|
+
|
|
35759
|
+
/**
|
|
35760
|
+
* The placeMembershipType identifier
|
|
35761
|
+
*/
|
|
35762
|
+
readonly placeMembershipTypeId: string
|
|
35763
|
+
|
|
35764
|
+
/**
|
|
35765
|
+
* The locale identifier
|
|
35766
|
+
*/
|
|
35767
|
+
readonly locale: string
|
|
35768
|
+
}
|
|
35769
|
+
|
|
35770
|
+
/**
|
|
35771
|
+
* Request parameters for getPlaceMembershipTypeTranslations operation in BookingsMembershipsTranslationsApi.
|
|
35772
|
+
*/
|
|
35773
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest {
|
|
35774
|
+
/**
|
|
35775
|
+
* The place identifier
|
|
35776
|
+
*/
|
|
35777
|
+
readonly placeId: string
|
|
35778
|
+
|
|
35779
|
+
/**
|
|
35780
|
+
* The placeMembershipType identifier
|
|
35781
|
+
*/
|
|
35782
|
+
readonly placeMembershipTypeId: string
|
|
35783
|
+
|
|
35784
|
+
/**
|
|
35785
|
+
* Page number
|
|
35786
|
+
*/
|
|
35787
|
+
readonly page?: number
|
|
35788
|
+
|
|
35789
|
+
/**
|
|
35790
|
+
* Number of items per page
|
|
35791
|
+
*/
|
|
35792
|
+
readonly pageSize?: number
|
|
35793
|
+
|
|
35794
|
+
/**
|
|
35795
|
+
* Field to order by
|
|
35796
|
+
*/
|
|
35797
|
+
readonly orderBy?: string
|
|
35798
|
+
|
|
35799
|
+
/**
|
|
35800
|
+
* Search query
|
|
35801
|
+
*/
|
|
35802
|
+
readonly search?: string
|
|
35803
|
+
}
|
|
35804
|
+
|
|
35805
|
+
/**
|
|
35806
|
+
* Request parameters for updatePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35807
|
+
*/
|
|
35808
|
+
export interface BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest {
|
|
35809
|
+
/**
|
|
35810
|
+
* The place identifier
|
|
35811
|
+
*/
|
|
35812
|
+
readonly placeId: string
|
|
35813
|
+
|
|
35814
|
+
/**
|
|
35815
|
+
* The placeMembershipType identifier
|
|
35816
|
+
*/
|
|
35817
|
+
readonly placeMembershipTypeId: string
|
|
35818
|
+
|
|
35819
|
+
/**
|
|
35820
|
+
* The locale identifier
|
|
35821
|
+
*/
|
|
35822
|
+
readonly locale: string
|
|
35823
|
+
|
|
35824
|
+
readonly placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs
|
|
35825
|
+
}
|
|
35826
|
+
|
|
35827
|
+
/**
|
|
35828
|
+
* BookingsMembershipsTranslationsApi - object-oriented interface
|
|
35829
|
+
*/
|
|
35830
|
+
export class BookingsMembershipsTranslationsApi extends BaseAPI {
|
|
35831
|
+
/**
|
|
35832
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35833
|
+
* @summary Delete a place membership type translation
|
|
35834
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35835
|
+
* @param {*} [options] Override http request option.
|
|
35836
|
+
* @throws {RequiredError}
|
|
35837
|
+
*/
|
|
35838
|
+
public deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35839
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
35840
|
+
}
|
|
35841
|
+
|
|
35842
|
+
/**
|
|
35843
|
+
* 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\".
|
|
35844
|
+
* @summary Get a place membership type\'s translation
|
|
35845
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35846
|
+
* @param {*} [options] Override http request option.
|
|
35847
|
+
* @throws {RequiredError}
|
|
35848
|
+
*/
|
|
35849
|
+
public getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35850
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
35851
|
+
}
|
|
35852
|
+
|
|
35853
|
+
/**
|
|
35854
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35855
|
+
* @summary List a place membership type\'s translations
|
|
35856
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
35857
|
+
* @param {*} [options] Override http request option.
|
|
35858
|
+
* @throws {RequiredError}
|
|
35859
|
+
*/
|
|
35860
|
+
public getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig) {
|
|
35861
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).getPlaceMembershipTypeTranslations(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35862
|
+
}
|
|
35863
|
+
|
|
35864
|
+
/**
|
|
35865
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35866
|
+
* @summary Update a place membership type\'s translation
|
|
35867
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35868
|
+
* @param {*} [options] Override http request option.
|
|
35869
|
+
* @throws {RequiredError}
|
|
35870
|
+
*/
|
|
35871
|
+
public updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35872
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35873
|
+
}
|
|
35874
|
+
}
|
|
35875
|
+
|
|
35876
|
+
|
|
35877
|
+
|
|
35878
|
+
/**
|
|
35879
|
+
* BookingsPlacesApi - axios parameter creator
|
|
35880
|
+
*/
|
|
35881
|
+
export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35882
|
+
return {
|
|
35883
|
+
/**
|
|
35884
|
+
* Creates a new booking place (a bookable location such as a venue or facility) for the organization, requires the update bookings permission.
|
|
35885
|
+
* @summary Create a booking place
|
|
35886
|
+
* @param {BookingPlaceCreateInputs} bookingPlaceCreateInputs
|
|
35887
|
+
* @param {*} [options] Override http request option.
|
|
35888
|
+
* @throws {RequiredError}
|
|
35889
|
+
*/
|
|
35890
|
+
createBookingPlace: async (bookingPlaceCreateInputs: BookingPlaceCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35891
|
+
// verify required parameter 'bookingPlaceCreateInputs' is not null or undefined
|
|
35892
|
+
assertParamExists('createBookingPlace', 'bookingPlaceCreateInputs', bookingPlaceCreateInputs)
|
|
35893
|
+
const localVarPath = `/bookings/places`;
|
|
35894
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35895
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35896
|
+
let baseOptions;
|
|
35897
|
+
if (configuration) {
|
|
35898
|
+
baseOptions = configuration.baseOptions;
|
|
35899
|
+
}
|
|
35900
|
+
|
|
35901
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35902
|
+
const localVarHeaderParameter = {} as any;
|
|
35903
|
+
const localVarQueryParameter = {} as any;
|
|
35904
|
+
|
|
35905
|
+
// authentication ApiKeyAuth required
|
|
35906
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35907
|
+
|
|
35908
|
+
// authentication OrganizationId required
|
|
35909
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35910
|
+
|
|
35911
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35912
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35913
|
+
|
|
35914
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35915
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35916
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35917
|
+
localVarRequestOptions.data = serializeDataIfNeeded(bookingPlaceCreateInputs, localVarRequestOptions, configuration)
|
|
35918
|
+
|
|
35919
|
+
return {
|
|
35920
|
+
url: toPathString(localVarUrlObj),
|
|
35921
|
+
options: localVarRequestOptions,
|
|
35922
|
+
};
|
|
35923
|
+
},
|
|
35924
|
+
/**
|
|
35925
|
+
* Permanently deletes a booking place from the organization by its ID, requires the update bookings permission.
|
|
35926
|
+
* @summary Delete a booking place
|
|
35927
|
+
* @param {string} placeId The place identifier
|
|
35928
|
+
* @param {*} [options] Override http request option.
|
|
35929
|
+
* @throws {RequiredError}
|
|
35930
|
+
*/
|
|
35931
|
+
deleteBookingPlace: async (placeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35932
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35933
|
+
assertParamExists('deleteBookingPlace', 'placeId', placeId)
|
|
35934
|
+
const localVarPath = `/bookings/places/{placeId}`
|
|
33581
35935
|
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33582
35936
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33583
35937
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -111798,6 +114152,252 @@ export class EventsTranslationsApi extends BaseAPI {
|
|
|
111798
114152
|
|
|
111799
114153
|
|
|
111800
114154
|
|
|
114155
|
+
/**
|
|
114156
|
+
* ExportsApi - axios parameter creator
|
|
114157
|
+
*/
|
|
114158
|
+
export const ExportsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
114159
|
+
return {
|
|
114160
|
+
/**
|
|
114161
|
+
* 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.
|
|
114162
|
+
* @summary Get a single export
|
|
114163
|
+
* @param {string} exportId The export identifier
|
|
114164
|
+
* @param {*} [options] Override http request option.
|
|
114165
|
+
* @throws {RequiredError}
|
|
114166
|
+
*/
|
|
114167
|
+
getExport: async (exportId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
114168
|
+
// verify required parameter 'exportId' is not null or undefined
|
|
114169
|
+
assertParamExists('getExport', 'exportId', exportId)
|
|
114170
|
+
const localVarPath = `/exports/{exportId}`
|
|
114171
|
+
.replace('{exportId}', encodeURIComponent(String(exportId)));
|
|
114172
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
114173
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
114174
|
+
let baseOptions;
|
|
114175
|
+
if (configuration) {
|
|
114176
|
+
baseOptions = configuration.baseOptions;
|
|
114177
|
+
}
|
|
114178
|
+
|
|
114179
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
114180
|
+
const localVarHeaderParameter = {} as any;
|
|
114181
|
+
const localVarQueryParameter = {} as any;
|
|
114182
|
+
|
|
114183
|
+
// authentication ApiKeyAuth required
|
|
114184
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
114185
|
+
|
|
114186
|
+
// authentication OrganizationId required
|
|
114187
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
114188
|
+
|
|
114189
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
114190
|
+
|
|
114191
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
114192
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
114193
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
114194
|
+
|
|
114195
|
+
return {
|
|
114196
|
+
url: toPathString(localVarUrlObj),
|
|
114197
|
+
options: localVarRequestOptions,
|
|
114198
|
+
};
|
|
114199
|
+
},
|
|
114200
|
+
/**
|
|
114201
|
+
* 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.
|
|
114202
|
+
* @summary List data exports
|
|
114203
|
+
* @param {ExportStatus} [status] Filter by status
|
|
114204
|
+
* @param {number} [page] Page number
|
|
114205
|
+
* @param {number} [pageSize] Number of items per page
|
|
114206
|
+
* @param {string} [orderBy] Field to order by
|
|
114207
|
+
* @param {string} [search] Search query
|
|
114208
|
+
* @param {*} [options] Override http request option.
|
|
114209
|
+
* @throws {RequiredError}
|
|
114210
|
+
*/
|
|
114211
|
+
getExports: async (status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
114212
|
+
const localVarPath = `/exports`;
|
|
114213
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
114214
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
114215
|
+
let baseOptions;
|
|
114216
|
+
if (configuration) {
|
|
114217
|
+
baseOptions = configuration.baseOptions;
|
|
114218
|
+
}
|
|
114219
|
+
|
|
114220
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
114221
|
+
const localVarHeaderParameter = {} as any;
|
|
114222
|
+
const localVarQueryParameter = {} as any;
|
|
114223
|
+
|
|
114224
|
+
// authentication ApiKeyAuth required
|
|
114225
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
114226
|
+
|
|
114227
|
+
// authentication OrganizationId required
|
|
114228
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
114229
|
+
|
|
114230
|
+
if (status !== undefined) {
|
|
114231
|
+
localVarQueryParameter['status'] = status;
|
|
114232
|
+
}
|
|
114233
|
+
|
|
114234
|
+
if (page !== undefined) {
|
|
114235
|
+
localVarQueryParameter['page'] = page;
|
|
114236
|
+
}
|
|
114237
|
+
|
|
114238
|
+
if (pageSize !== undefined) {
|
|
114239
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
114240
|
+
}
|
|
114241
|
+
|
|
114242
|
+
if (orderBy !== undefined) {
|
|
114243
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
114244
|
+
}
|
|
114245
|
+
|
|
114246
|
+
if (search !== undefined) {
|
|
114247
|
+
localVarQueryParameter['search'] = search;
|
|
114248
|
+
}
|
|
114249
|
+
|
|
114250
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
114251
|
+
|
|
114252
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
114253
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
114254
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
114255
|
+
|
|
114256
|
+
return {
|
|
114257
|
+
url: toPathString(localVarUrlObj),
|
|
114258
|
+
options: localVarRequestOptions,
|
|
114259
|
+
};
|
|
114260
|
+
},
|
|
114261
|
+
}
|
|
114262
|
+
};
|
|
114263
|
+
|
|
114264
|
+
/**
|
|
114265
|
+
* ExportsApi - functional programming interface
|
|
114266
|
+
*/
|
|
114267
|
+
export const ExportsApiFp = function(configuration?: Configuration) {
|
|
114268
|
+
const localVarAxiosParamCreator = ExportsApiAxiosParamCreator(configuration)
|
|
114269
|
+
return {
|
|
114270
|
+
/**
|
|
114271
|
+
* 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.
|
|
114272
|
+
* @summary Get a single export
|
|
114273
|
+
* @param {string} exportId The export identifier
|
|
114274
|
+
* @param {*} [options] Override http request option.
|
|
114275
|
+
* @throws {RequiredError}
|
|
114276
|
+
*/
|
|
114277
|
+
async getExport(exportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExport200Response>> {
|
|
114278
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getExport(exportId, options);
|
|
114279
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
114280
|
+
const localVarOperationServerBasePath = operationServerMap['ExportsApi.getExport']?.[localVarOperationServerIndex]?.url;
|
|
114281
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
114282
|
+
},
|
|
114283
|
+
/**
|
|
114284
|
+
* 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.
|
|
114285
|
+
* @summary List data exports
|
|
114286
|
+
* @param {ExportStatus} [status] Filter by status
|
|
114287
|
+
* @param {number} [page] Page number
|
|
114288
|
+
* @param {number} [pageSize] Number of items per page
|
|
114289
|
+
* @param {string} [orderBy] Field to order by
|
|
114290
|
+
* @param {string} [search] Search query
|
|
114291
|
+
* @param {*} [options] Override http request option.
|
|
114292
|
+
* @throws {RequiredError}
|
|
114293
|
+
*/
|
|
114294
|
+
async getExports(status?: ExportStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetExports200Response>> {
|
|
114295
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getExports(status, page, pageSize, orderBy, search, options);
|
|
114296
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
114297
|
+
const localVarOperationServerBasePath = operationServerMap['ExportsApi.getExports']?.[localVarOperationServerIndex]?.url;
|
|
114298
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
114299
|
+
},
|
|
114300
|
+
}
|
|
114301
|
+
};
|
|
114302
|
+
|
|
114303
|
+
/**
|
|
114304
|
+
* ExportsApi - factory interface
|
|
114305
|
+
*/
|
|
114306
|
+
export const ExportsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
114307
|
+
const localVarFp = ExportsApiFp(configuration)
|
|
114308
|
+
return {
|
|
114309
|
+
/**
|
|
114310
|
+
* 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.
|
|
114311
|
+
* @summary Get a single export
|
|
114312
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
114313
|
+
* @param {*} [options] Override http request option.
|
|
114314
|
+
* @throws {RequiredError}
|
|
114315
|
+
*/
|
|
114316
|
+
getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetExport200Response> {
|
|
114317
|
+
return localVarFp.getExport(requestParameters.exportId, options).then((request) => request(axios, basePath));
|
|
114318
|
+
},
|
|
114319
|
+
/**
|
|
114320
|
+
* 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.
|
|
114321
|
+
* @summary List data exports
|
|
114322
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
114323
|
+
* @param {*} [options] Override http request option.
|
|
114324
|
+
* @throws {RequiredError}
|
|
114325
|
+
*/
|
|
114326
|
+
getExports(requestParameters: ExportsApiGetExportsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetExports200Response> {
|
|
114327
|
+
return localVarFp.getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
114328
|
+
},
|
|
114329
|
+
};
|
|
114330
|
+
};
|
|
114331
|
+
|
|
114332
|
+
/**
|
|
114333
|
+
* Request parameters for getExport operation in ExportsApi.
|
|
114334
|
+
*/
|
|
114335
|
+
export interface ExportsApiGetExportRequest {
|
|
114336
|
+
/**
|
|
114337
|
+
* The export identifier
|
|
114338
|
+
*/
|
|
114339
|
+
readonly exportId: string
|
|
114340
|
+
}
|
|
114341
|
+
|
|
114342
|
+
/**
|
|
114343
|
+
* Request parameters for getExports operation in ExportsApi.
|
|
114344
|
+
*/
|
|
114345
|
+
export interface ExportsApiGetExportsRequest {
|
|
114346
|
+
/**
|
|
114347
|
+
* Filter by status
|
|
114348
|
+
*/
|
|
114349
|
+
readonly status?: ExportStatus
|
|
114350
|
+
|
|
114351
|
+
/**
|
|
114352
|
+
* Page number
|
|
114353
|
+
*/
|
|
114354
|
+
readonly page?: number
|
|
114355
|
+
|
|
114356
|
+
/**
|
|
114357
|
+
* Number of items per page
|
|
114358
|
+
*/
|
|
114359
|
+
readonly pageSize?: number
|
|
114360
|
+
|
|
114361
|
+
/**
|
|
114362
|
+
* Field to order by
|
|
114363
|
+
*/
|
|
114364
|
+
readonly orderBy?: string
|
|
114365
|
+
|
|
114366
|
+
/**
|
|
114367
|
+
* Search query
|
|
114368
|
+
*/
|
|
114369
|
+
readonly search?: string
|
|
114370
|
+
}
|
|
114371
|
+
|
|
114372
|
+
/**
|
|
114373
|
+
* ExportsApi - object-oriented interface
|
|
114374
|
+
*/
|
|
114375
|
+
export class ExportsApi extends BaseAPI {
|
|
114376
|
+
/**
|
|
114377
|
+
* 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.
|
|
114378
|
+
* @summary Get a single export
|
|
114379
|
+
* @param {ExportsApiGetExportRequest} requestParameters Request parameters.
|
|
114380
|
+
* @param {*} [options] Override http request option.
|
|
114381
|
+
* @throws {RequiredError}
|
|
114382
|
+
*/
|
|
114383
|
+
public getExport(requestParameters: ExportsApiGetExportRequest, options?: RawAxiosRequestConfig) {
|
|
114384
|
+
return ExportsApiFp(this.configuration).getExport(requestParameters.exportId, options).then((request) => request(this.axios, this.basePath));
|
|
114385
|
+
}
|
|
114386
|
+
|
|
114387
|
+
/**
|
|
114388
|
+
* 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.
|
|
114389
|
+
* @summary List data exports
|
|
114390
|
+
* @param {ExportsApiGetExportsRequest} requestParameters Request parameters.
|
|
114391
|
+
* @param {*} [options] Override http request option.
|
|
114392
|
+
* @throws {RequiredError}
|
|
114393
|
+
*/
|
|
114394
|
+
public getExports(requestParameters: ExportsApiGetExportsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
114395
|
+
return ExportsApiFp(this.configuration).getExports(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
114396
|
+
}
|
|
114397
|
+
}
|
|
114398
|
+
|
|
114399
|
+
|
|
114400
|
+
|
|
111801
114401
|
/**
|
|
111802
114402
|
* FilesApi - axios parameter creator
|
|
111803
114403
|
*/
|