@connectedxm/admin-sdk 13.3.0 → 13.5.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 +32 -4
- package/AdminApi.ts +6 -0
- package/README.md +2 -2
- package/api.ts +3029 -56
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +3 -1
- package/dist/AdminApi.js +2 -0
- package/dist/api.d.ts +1642 -43
- package/dist/api.js +2139 -49
- 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 +3 -1
- package/dist/esm/AdminApi.js +3 -1
- package/dist/esm/api.d.ts +1642 -43
- package/dist/esm/api.js +2103 -21
- 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/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/BaseStreamSession.md +7 -1
- 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/{GetStreamSessions200Response.md → GetAllStreamSessions200Response.md} +3 -3
- 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/{GetStreamSession200Response.md → GetStreamSessionById200Response.md} +3 -3
- package/docs/{GetStreamSessionChat200Response.md → GetStreamSessionByIdChat200Response.md} +3 -3
- package/docs/{GetStreamSessionSubscriptions200Response.md → GetStreamSessionByIdSubscriptions200Response.md} +3 -3
- 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/StreamSession.md +11 -1
- package/docs/StreamSessionStatus.md +10 -0
- package/docs/StreamSessionUpdateInputs.md +24 -0
- package/docs/StreamsApi.md +1 -1
- package/docs/StreamsSessionsApi.md +360 -8
- 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.5.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;
|
|
@@ -2533,10 +2541,10 @@ export interface BasePayment {
|
|
|
2533
2541
|
'passId': string | null;
|
|
2534
2542
|
'sessionId': string | null;
|
|
2535
2543
|
'spaceId': string | null;
|
|
2536
|
-
'membershipId': string | null;
|
|
2537
2544
|
'couponId': string | null;
|
|
2538
2545
|
'invoiceId': string | null;
|
|
2539
2546
|
'seriesId': string | null;
|
|
2547
|
+
'placeMembershipTypeId': string | null;
|
|
2540
2548
|
'taxIntegrationCompanyCode': string | null;
|
|
2541
2549
|
'taxIntegrationCustomerId': string | null;
|
|
2542
2550
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -2573,6 +2581,8 @@ export interface BasePaymentIntent {
|
|
|
2573
2581
|
'couponId': string | null;
|
|
2574
2582
|
'invoiceId': string | null;
|
|
2575
2583
|
'seriesId': string | null;
|
|
2584
|
+
'placeMembershipTypeId': string | null;
|
|
2585
|
+
'placeMembershipId': string | null;
|
|
2576
2586
|
'address1': string | null;
|
|
2577
2587
|
'address2': string | null;
|
|
2578
2588
|
'city': string | null;
|
|
@@ -2628,6 +2638,7 @@ export interface BasePaymentIntentLineItem {
|
|
|
2628
2638
|
'bookingId': string | null;
|
|
2629
2639
|
'couponId': string | null;
|
|
2630
2640
|
'seriesRegistrationId': string | null;
|
|
2641
|
+
'placeMembershipId': string | null;
|
|
2631
2642
|
'createdAt': string;
|
|
2632
2643
|
}
|
|
2633
2644
|
|
|
@@ -2660,9 +2671,34 @@ export interface BasePaymentLineItem {
|
|
|
2660
2671
|
'reservationId': string | null;
|
|
2661
2672
|
'accessId': string | null;
|
|
2662
2673
|
'bookingId': string | null;
|
|
2674
|
+
'placeMembershipId': string | null;
|
|
2675
|
+
}
|
|
2676
|
+
|
|
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;
|
|
2663
2686
|
}
|
|
2664
2687
|
|
|
2665
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
|
+
}
|
|
2666
2702
|
export interface BasePreset {
|
|
2667
2703
|
'id': string;
|
|
2668
2704
|
'name': string;
|
|
@@ -2974,13 +3010,18 @@ export interface BaseStreamInput {
|
|
|
2974
3010
|
export interface BaseStreamSession {
|
|
2975
3011
|
'id': string;
|
|
2976
3012
|
'organizationId': string;
|
|
2977
|
-
'streamId': string;
|
|
2978
|
-
'
|
|
3013
|
+
'streamId': string | null;
|
|
3014
|
+
'name': string | null;
|
|
3015
|
+
'eventId': string | null;
|
|
3016
|
+
'eventSessionId': string | null;
|
|
3017
|
+
'status': StreamSessionStatus;
|
|
2979
3018
|
'startedAt': string | null;
|
|
2980
3019
|
'endedAt': string | null;
|
|
2981
3020
|
'createdAt': string;
|
|
2982
3021
|
'updatedAt': string;
|
|
2983
3022
|
}
|
|
3023
|
+
|
|
3024
|
+
|
|
2984
3025
|
export interface BaseStreamSessionSubscription {
|
|
2985
3026
|
'id': string;
|
|
2986
3027
|
'organizationId': string;
|
|
@@ -3364,6 +3405,8 @@ export interface Booking {
|
|
|
3364
3405
|
'duration': number;
|
|
3365
3406
|
'checkedIn': string | null;
|
|
3366
3407
|
'status': PurchaseStatus;
|
|
3408
|
+
'placeMembershipId': string | null;
|
|
3409
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
3367
3410
|
'account': BaseAccount;
|
|
3368
3411
|
'space': BaseBookingSpace;
|
|
3369
3412
|
'lineItem': PaymentLineItem | null;
|
|
@@ -3476,6 +3519,7 @@ export interface BookingSpace {
|
|
|
3476
3519
|
'bookingLimitPerAccount': number | null;
|
|
3477
3520
|
'slotDuration': number;
|
|
3478
3521
|
'price': number;
|
|
3522
|
+
'membershipPrice': number | null;
|
|
3479
3523
|
'description': string | null;
|
|
3480
3524
|
'image': BaseImage | null;
|
|
3481
3525
|
'start': string | null;
|
|
@@ -3555,6 +3599,7 @@ export interface BookingSpaceCreateInputs {
|
|
|
3555
3599
|
'bookingLimitPerAccount'?: number | null;
|
|
3556
3600
|
'slotDuration': number;
|
|
3557
3601
|
'price'?: number;
|
|
3602
|
+
'membershipPrice'?: number | null;
|
|
3558
3603
|
'description'?: string | null;
|
|
3559
3604
|
'imageId'?: string | null;
|
|
3560
3605
|
'start'?: string | null;
|
|
@@ -3756,6 +3801,7 @@ export interface BookingSpaceUpdateInputs {
|
|
|
3756
3801
|
'supply'?: number;
|
|
3757
3802
|
'bookingLimitPerAccount'?: number | null;
|
|
3758
3803
|
'price'?: number;
|
|
3804
|
+
'membershipPrice'?: number | null;
|
|
3759
3805
|
'description'?: string | null;
|
|
3760
3806
|
'imageId'?: string | null;
|
|
3761
3807
|
'start'?: string | null;
|
|
@@ -4980,6 +5026,26 @@ export enum CreateOrganizationTeamMember200ResponseStatusEnum {
|
|
|
4980
5026
|
Ok = 'ok'
|
|
4981
5027
|
}
|
|
4982
5028
|
|
|
5029
|
+
export interface CreatePlaceMembershipMember200Response {
|
|
5030
|
+
'status': CreatePlaceMembershipMember200ResponseStatusEnum;
|
|
5031
|
+
'message': string;
|
|
5032
|
+
'data': PlaceMembershipMember;
|
|
5033
|
+
}
|
|
5034
|
+
|
|
5035
|
+
export enum CreatePlaceMembershipMember200ResponseStatusEnum {
|
|
5036
|
+
Ok = 'ok'
|
|
5037
|
+
}
|
|
5038
|
+
|
|
5039
|
+
export interface CreatePlaceMembershipType200Response {
|
|
5040
|
+
'status': CreatePlaceMembershipType200ResponseStatusEnum;
|
|
5041
|
+
'message': string;
|
|
5042
|
+
'data': PlaceMembershipType;
|
|
5043
|
+
}
|
|
5044
|
+
|
|
5045
|
+
export enum CreatePlaceMembershipType200ResponseStatusEnum {
|
|
5046
|
+
Ok = 'ok'
|
|
5047
|
+
}
|
|
5048
|
+
|
|
4983
5049
|
export interface CreatePreset200Response {
|
|
4984
5050
|
'status': CreatePreset200ResponseStatusEnum;
|
|
4985
5051
|
'message': string;
|
|
@@ -7928,6 +7994,17 @@ export enum GetAllAccountMerges200ResponseStatusEnum {
|
|
|
7928
7994
|
Ok = 'ok'
|
|
7929
7995
|
}
|
|
7930
7996
|
|
|
7997
|
+
export interface GetAllStreamSessions200Response {
|
|
7998
|
+
'status': GetAllStreamSessions200ResponseStatusEnum;
|
|
7999
|
+
'message': string;
|
|
8000
|
+
'data': Array<StreamSession>;
|
|
8001
|
+
'count'?: number;
|
|
8002
|
+
}
|
|
8003
|
+
|
|
8004
|
+
export enum GetAllStreamSessions200ResponseStatusEnum {
|
|
8005
|
+
Ok = 'ok'
|
|
8006
|
+
}
|
|
8007
|
+
|
|
7931
8008
|
export interface GetAnnouncementAudienceAccounts200Response {
|
|
7932
8009
|
'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
|
|
7933
8010
|
'message': string;
|
|
@@ -10539,6 +10616,70 @@ export enum GetPaymentTaxMetadata200ResponseStatusEnum {
|
|
|
10539
10616
|
Ok = 'ok'
|
|
10540
10617
|
}
|
|
10541
10618
|
|
|
10619
|
+
export interface GetPlaceMembership200Response {
|
|
10620
|
+
'status': GetPlaceMembership200ResponseStatusEnum;
|
|
10621
|
+
'message': string;
|
|
10622
|
+
'data': PlaceMembership;
|
|
10623
|
+
}
|
|
10624
|
+
|
|
10625
|
+
export enum GetPlaceMembership200ResponseStatusEnum {
|
|
10626
|
+
Ok = 'ok'
|
|
10627
|
+
}
|
|
10628
|
+
|
|
10629
|
+
export interface GetPlaceMembershipMembers200Response {
|
|
10630
|
+
'status': GetPlaceMembershipMembers200ResponseStatusEnum;
|
|
10631
|
+
'message': string;
|
|
10632
|
+
'data': Array<PlaceMembershipMember>;
|
|
10633
|
+
'count'?: number;
|
|
10634
|
+
}
|
|
10635
|
+
|
|
10636
|
+
export enum GetPlaceMembershipMembers200ResponseStatusEnum {
|
|
10637
|
+
Ok = 'ok'
|
|
10638
|
+
}
|
|
10639
|
+
|
|
10640
|
+
export interface GetPlaceMembershipTypeTranslation200Response {
|
|
10641
|
+
'status': GetPlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
10642
|
+
'message': string;
|
|
10643
|
+
'data': PlaceMembershipTypeTranslation | null;
|
|
10644
|
+
}
|
|
10645
|
+
|
|
10646
|
+
export enum GetPlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
10647
|
+
Ok = 'ok'
|
|
10648
|
+
}
|
|
10649
|
+
|
|
10650
|
+
export interface GetPlaceMembershipTypeTranslations200Response {
|
|
10651
|
+
'status': GetPlaceMembershipTypeTranslations200ResponseStatusEnum;
|
|
10652
|
+
'message': string;
|
|
10653
|
+
'data': Array<PlaceMembershipTypeTranslation>;
|
|
10654
|
+
'count'?: number;
|
|
10655
|
+
}
|
|
10656
|
+
|
|
10657
|
+
export enum GetPlaceMembershipTypeTranslations200ResponseStatusEnum {
|
|
10658
|
+
Ok = 'ok'
|
|
10659
|
+
}
|
|
10660
|
+
|
|
10661
|
+
export interface GetPlaceMembershipTypes200Response {
|
|
10662
|
+
'status': GetPlaceMembershipTypes200ResponseStatusEnum;
|
|
10663
|
+
'message': string;
|
|
10664
|
+
'data': Array<PlaceMembershipType>;
|
|
10665
|
+
'count'?: number;
|
|
10666
|
+
}
|
|
10667
|
+
|
|
10668
|
+
export enum GetPlaceMembershipTypes200ResponseStatusEnum {
|
|
10669
|
+
Ok = 'ok'
|
|
10670
|
+
}
|
|
10671
|
+
|
|
10672
|
+
export interface GetPlaceMemberships200Response {
|
|
10673
|
+
'status': GetPlaceMemberships200ResponseStatusEnum;
|
|
10674
|
+
'message': string;
|
|
10675
|
+
'data': Array<PlaceMembership>;
|
|
10676
|
+
'count'?: number;
|
|
10677
|
+
}
|
|
10678
|
+
|
|
10679
|
+
export enum GetPlaceMemberships200ResponseStatusEnum {
|
|
10680
|
+
Ok = 'ok'
|
|
10681
|
+
}
|
|
10682
|
+
|
|
10542
10683
|
export interface GetPreferences200Response {
|
|
10543
10684
|
'status': GetPreferences200ResponseStatusEnum;
|
|
10544
10685
|
'message': string;
|
|
@@ -10782,45 +10923,34 @@ export enum GetStreamInputs200ResponseStatusEnum {
|
|
|
10782
10923
|
Ok = 'ok'
|
|
10783
10924
|
}
|
|
10784
10925
|
|
|
10785
|
-
export interface
|
|
10786
|
-
'status':
|
|
10926
|
+
export interface GetStreamSessionById200Response {
|
|
10927
|
+
'status': GetStreamSessionById200ResponseStatusEnum;
|
|
10787
10928
|
'message': string;
|
|
10788
10929
|
'data': StreamSession;
|
|
10789
10930
|
}
|
|
10790
10931
|
|
|
10791
|
-
export enum
|
|
10932
|
+
export enum GetStreamSessionById200ResponseStatusEnum {
|
|
10792
10933
|
Ok = 'ok'
|
|
10793
10934
|
}
|
|
10794
10935
|
|
|
10795
|
-
export interface
|
|
10796
|
-
'status':
|
|
10936
|
+
export interface GetStreamSessionByIdChat200Response {
|
|
10937
|
+
'status': GetStreamSessionByIdChat200ResponseStatusEnum;
|
|
10797
10938
|
'message': string;
|
|
10798
10939
|
'data': Array<StreamSessionChatMessage>;
|
|
10799
10940
|
}
|
|
10800
10941
|
|
|
10801
|
-
export enum
|
|
10942
|
+
export enum GetStreamSessionByIdChat200ResponseStatusEnum {
|
|
10802
10943
|
Ok = 'ok'
|
|
10803
10944
|
}
|
|
10804
10945
|
|
|
10805
|
-
export interface
|
|
10806
|
-
'status':
|
|
10946
|
+
export interface GetStreamSessionByIdSubscriptions200Response {
|
|
10947
|
+
'status': GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
|
|
10807
10948
|
'message': string;
|
|
10808
10949
|
'data': Array<StreamSessionSubscription>;
|
|
10809
10950
|
'count'?: number;
|
|
10810
10951
|
}
|
|
10811
10952
|
|
|
10812
|
-
export enum
|
|
10813
|
-
Ok = 'ok'
|
|
10814
|
-
}
|
|
10815
|
-
|
|
10816
|
-
export interface GetStreamSessions200Response {
|
|
10817
|
-
'status': GetStreamSessions200ResponseStatusEnum;
|
|
10818
|
-
'message': string;
|
|
10819
|
-
'data': Array<StreamSession>;
|
|
10820
|
-
'count'?: number;
|
|
10821
|
-
}
|
|
10822
|
-
|
|
10823
|
-
export enum GetStreamSessions200ResponseStatusEnum {
|
|
10953
|
+
export enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
|
|
10824
10954
|
Ok = 'ok'
|
|
10825
10955
|
}
|
|
10826
10956
|
|
|
@@ -13333,10 +13463,10 @@ export interface Payment {
|
|
|
13333
13463
|
'passId': string | null;
|
|
13334
13464
|
'sessionId': string | null;
|
|
13335
13465
|
'spaceId': string | null;
|
|
13336
|
-
'membershipId': string | null;
|
|
13337
13466
|
'couponId': string | null;
|
|
13338
13467
|
'invoiceId': string | null;
|
|
13339
13468
|
'seriesId': string | null;
|
|
13469
|
+
'placeMembershipTypeId': string | null;
|
|
13340
13470
|
'taxIntegrationCompanyCode': string | null;
|
|
13341
13471
|
'taxIntegrationCustomerId': string | null;
|
|
13342
13472
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -13368,6 +13498,7 @@ export interface Payment {
|
|
|
13368
13498
|
'coupon': BaseCoupon | null;
|
|
13369
13499
|
'invoice': BaseInvoice | null;
|
|
13370
13500
|
'series': BaseSeries | null;
|
|
13501
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
13371
13502
|
'exchangeTarget': BaseEventPassTypeExchangeTarget | null;
|
|
13372
13503
|
'metadata'?: object;
|
|
13373
13504
|
}
|
|
@@ -13419,6 +13550,8 @@ export interface PaymentIntent {
|
|
|
13419
13550
|
'couponId': string | null;
|
|
13420
13551
|
'invoiceId': string | null;
|
|
13421
13552
|
'seriesId': string | null;
|
|
13553
|
+
'placeMembershipTypeId': string | null;
|
|
13554
|
+
'placeMembershipId': string | null;
|
|
13422
13555
|
'address1': string | null;
|
|
13423
13556
|
'address2': string | null;
|
|
13424
13557
|
'city': string | null;
|
|
@@ -13452,6 +13585,7 @@ export interface PaymentIntent {
|
|
|
13452
13585
|
'space': BaseBookingSpace | null;
|
|
13453
13586
|
'invoice': BaseInvoice | null;
|
|
13454
13587
|
'series': BaseSeries | null;
|
|
13588
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
13455
13589
|
}
|
|
13456
13590
|
|
|
13457
13591
|
|
|
@@ -13465,7 +13599,8 @@ export enum PaymentIntentSource {
|
|
|
13465
13599
|
Coupon = 'coupon',
|
|
13466
13600
|
Session = 'session',
|
|
13467
13601
|
Booking = 'booking',
|
|
13468
|
-
Series = 'series'
|
|
13602
|
+
Series = 'series',
|
|
13603
|
+
PlaceMembership = 'placeMembership'
|
|
13469
13604
|
}
|
|
13470
13605
|
|
|
13471
13606
|
|
|
@@ -13493,12 +13628,14 @@ export interface PaymentLineItem {
|
|
|
13493
13628
|
'reservationId': string | null;
|
|
13494
13629
|
'accessId': string | null;
|
|
13495
13630
|
'bookingId': string | null;
|
|
13631
|
+
'placeMembershipId': string | null;
|
|
13496
13632
|
'pass': BaseEventPass | null;
|
|
13497
13633
|
'package': BaseEventPackage | null;
|
|
13498
13634
|
'passAddOn': BasePassAddOn | null;
|
|
13499
13635
|
'reservation': BaseEventRoomTypeReservation | null;
|
|
13500
13636
|
'access': BaseEventSessionAccess | null;
|
|
13501
13637
|
'booking': BaseBooking | null;
|
|
13638
|
+
'placeMembership': BasePlaceMembership | null;
|
|
13502
13639
|
'coupon': BaseCoupon | null;
|
|
13503
13640
|
'seriesRegistration': BaseSeriesRegistration | null;
|
|
13504
13641
|
'payment': BasePayment;
|
|
@@ -13517,6 +13654,7 @@ export enum PaymentLineItemType {
|
|
|
13517
13654
|
Booking = 'booking',
|
|
13518
13655
|
Coupon = 'coupon',
|
|
13519
13656
|
Series = 'series',
|
|
13657
|
+
PlaceMembership = 'placeMembership',
|
|
13520
13658
|
Refund = 'refund'
|
|
13521
13659
|
}
|
|
13522
13660
|
|
|
@@ -13538,6 +13676,127 @@ export interface PaypalActivationFormParams {
|
|
|
13538
13676
|
'currencyCode': string;
|
|
13539
13677
|
'name': string;
|
|
13540
13678
|
}
|
|
13679
|
+
export interface PlaceMembership {
|
|
13680
|
+
'id': string;
|
|
13681
|
+
'status': PurchaseStatus;
|
|
13682
|
+
'startsAt': string | null;
|
|
13683
|
+
'expiresAt': string | null;
|
|
13684
|
+
'account': BaseAccount;
|
|
13685
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
13686
|
+
'createdAt': string;
|
|
13687
|
+
'lineItem': PaymentLineItem | null;
|
|
13688
|
+
'members': Array<PlaceMembershipMember>;
|
|
13689
|
+
'_count': PlaceMembershipAllOfCount;
|
|
13690
|
+
}
|
|
13691
|
+
|
|
13692
|
+
|
|
13693
|
+
export interface PlaceMembershipAllOfCount {
|
|
13694
|
+
'bookings': number;
|
|
13695
|
+
}
|
|
13696
|
+
export interface PlaceMembershipCreateInputs {
|
|
13697
|
+
'accountId': string;
|
|
13698
|
+
'placeMembershipTypeId': string;
|
|
13699
|
+
'startsAt'?: string | null;
|
|
13700
|
+
'expiresAt'?: string | null;
|
|
13701
|
+
}
|
|
13702
|
+
export interface PlaceMembershipMember {
|
|
13703
|
+
'id': string;
|
|
13704
|
+
'name': string;
|
|
13705
|
+
'image': BaseImage | null;
|
|
13706
|
+
'createdAt': string;
|
|
13707
|
+
'updatedAt': string;
|
|
13708
|
+
}
|
|
13709
|
+
export interface PlaceMembershipMemberCreateInputs {
|
|
13710
|
+
'name': string;
|
|
13711
|
+
'imageId'?: string | null;
|
|
13712
|
+
}
|
|
13713
|
+
export interface PlaceMembershipMemberUpdateInputs {
|
|
13714
|
+
'name'?: string;
|
|
13715
|
+
'imageId'?: string | null;
|
|
13716
|
+
}
|
|
13717
|
+
export interface PlaceMembershipType {
|
|
13718
|
+
'id': string;
|
|
13719
|
+
'slug': string;
|
|
13720
|
+
'name': string;
|
|
13721
|
+
'description': string | null;
|
|
13722
|
+
'image': BaseImage | null;
|
|
13723
|
+
'price': number;
|
|
13724
|
+
'termDays': number;
|
|
13725
|
+
'maxMembers': number;
|
|
13726
|
+
'sortOrder': number;
|
|
13727
|
+
'visible': boolean;
|
|
13728
|
+
'archived': boolean;
|
|
13729
|
+
'taxCode': string | null;
|
|
13730
|
+
'taxIncluded': boolean;
|
|
13731
|
+
'taxLocation': TaxLocationType;
|
|
13732
|
+
'paymentIntegrationId': string | null;
|
|
13733
|
+
'paymentIntegration': BasePaymentIntegration | null;
|
|
13734
|
+
'entityId': string | null;
|
|
13735
|
+
'entity': BaseOrganizationEntity | null;
|
|
13736
|
+
'placeId': string;
|
|
13737
|
+
'createdAt': string;
|
|
13738
|
+
'updatedAt': string;
|
|
13739
|
+
}
|
|
13740
|
+
|
|
13741
|
+
|
|
13742
|
+
export interface PlaceMembershipTypeCreateInputs {
|
|
13743
|
+
'name': string;
|
|
13744
|
+
'description'?: string | null;
|
|
13745
|
+
'imageId'?: string | null;
|
|
13746
|
+
'price'?: number;
|
|
13747
|
+
'termDays': number;
|
|
13748
|
+
'maxMembers'?: number;
|
|
13749
|
+
'sortOrder'?: number | null;
|
|
13750
|
+
'visible'?: boolean;
|
|
13751
|
+
'taxCode'?: string | null;
|
|
13752
|
+
'taxIncluded'?: boolean;
|
|
13753
|
+
'taxLocation'?: TaxLocationType;
|
|
13754
|
+
'paymentIntegrationId'?: string | null;
|
|
13755
|
+
'entityId'?: string | null;
|
|
13756
|
+
}
|
|
13757
|
+
|
|
13758
|
+
|
|
13759
|
+
export interface PlaceMembershipTypeTranslation {
|
|
13760
|
+
'id': number;
|
|
13761
|
+
'locale': string;
|
|
13762
|
+
'name': string | null;
|
|
13763
|
+
'description': string | null;
|
|
13764
|
+
'createdAt': string;
|
|
13765
|
+
'updatedAt': string;
|
|
13766
|
+
}
|
|
13767
|
+
export interface PlaceMembershipTypeTranslationUpdateInputs {
|
|
13768
|
+
'name'?: string | null;
|
|
13769
|
+
'description'?: string | null;
|
|
13770
|
+
}
|
|
13771
|
+
export interface PlaceMembershipTypeUpdateInputs {
|
|
13772
|
+
'name'?: string;
|
|
13773
|
+
'description'?: string | null;
|
|
13774
|
+
'imageId'?: string | null;
|
|
13775
|
+
'price'?: number;
|
|
13776
|
+
'termDays'?: number;
|
|
13777
|
+
'maxMembers'?: number;
|
|
13778
|
+
'sortOrder'?: number | null;
|
|
13779
|
+
'visible'?: boolean;
|
|
13780
|
+
'archived'?: boolean;
|
|
13781
|
+
'taxCode'?: string | null;
|
|
13782
|
+
'taxIncluded'?: boolean;
|
|
13783
|
+
'taxLocation'?: TaxLocationType;
|
|
13784
|
+
'paymentIntegrationId'?: string | null;
|
|
13785
|
+
'entityId'?: string | null;
|
|
13786
|
+
}
|
|
13787
|
+
|
|
13788
|
+
|
|
13789
|
+
export interface PlaceMembershipUpdateInputs {
|
|
13790
|
+
'status'?: PlaceMembershipUpdateInputsStatusEnum;
|
|
13791
|
+
'startsAt'?: string;
|
|
13792
|
+
'expiresAt'?: string;
|
|
13793
|
+
}
|
|
13794
|
+
|
|
13795
|
+
export enum PlaceMembershipUpdateInputsStatusEnum {
|
|
13796
|
+
Ready = 'ready',
|
|
13797
|
+
Canceled = 'canceled'
|
|
13798
|
+
}
|
|
13799
|
+
|
|
13541
13800
|
export interface Preset {
|
|
13542
13801
|
'id': string;
|
|
13543
13802
|
'name': string;
|
|
@@ -14845,15 +15104,22 @@ export interface StreamOutputCreateInputs {
|
|
|
14845
15104
|
export interface StreamSession {
|
|
14846
15105
|
'id': string;
|
|
14847
15106
|
'organizationId': string;
|
|
14848
|
-
'streamId': string;
|
|
14849
|
-
'
|
|
15107
|
+
'streamId': string | null;
|
|
15108
|
+
'name': string | null;
|
|
15109
|
+
'eventId': string | null;
|
|
15110
|
+
'eventSessionId': string | null;
|
|
15111
|
+
'status': StreamSessionStatus;
|
|
14850
15112
|
'startedAt': string | null;
|
|
14851
15113
|
'endedAt': string | null;
|
|
14852
15114
|
'createdAt': string;
|
|
14853
15115
|
'updatedAt': string;
|
|
14854
|
-
'stream': BaseStreamInput;
|
|
15116
|
+
'stream': BaseStreamInput | null;
|
|
15117
|
+
'event': BaseEvent | null;
|
|
15118
|
+
'eventSession': BaseEventSession | null;
|
|
14855
15119
|
'organization': BaseOrganization;
|
|
14856
15120
|
}
|
|
15121
|
+
|
|
15122
|
+
|
|
14857
15123
|
export interface StreamSessionChatMessage {
|
|
14858
15124
|
'messageId': string;
|
|
14859
15125
|
'streamId': string;
|
|
@@ -14864,6 +15130,13 @@ export interface StreamSessionChatMessage {
|
|
|
14864
15130
|
'message': string;
|
|
14865
15131
|
'timestamp': number;
|
|
14866
15132
|
}
|
|
15133
|
+
|
|
15134
|
+
export enum StreamSessionStatus {
|
|
15135
|
+
Active = 'ACTIVE',
|
|
15136
|
+
Ended = 'ENDED'
|
|
15137
|
+
}
|
|
15138
|
+
|
|
15139
|
+
|
|
14867
15140
|
export interface StreamSessionSubscription {
|
|
14868
15141
|
'id': string;
|
|
14869
15142
|
'organizationId': string;
|
|
@@ -14875,6 +15148,11 @@ export interface StreamSessionSubscription {
|
|
|
14875
15148
|
'connection': BaseWebSocketConnection;
|
|
14876
15149
|
'streamSession': BaseStreamSession;
|
|
14877
15150
|
}
|
|
15151
|
+
export interface StreamSessionUpdateInputs {
|
|
15152
|
+
'name'?: string | null;
|
|
15153
|
+
'eventId'?: string | null;
|
|
15154
|
+
'eventSessionId'?: string | null;
|
|
15155
|
+
}
|
|
14878
15156
|
export interface StripeActivationFormParams {
|
|
14879
15157
|
'clientPublicKey': string;
|
|
14880
15158
|
'clientSecret': string;
|
|
@@ -15967,6 +16245,16 @@ export interface UpdateOrganizationIntegrationsRequest {
|
|
|
15967
16245
|
'ghostAdminKey'?: string;
|
|
15968
16246
|
'ghostContentKey'?: string;
|
|
15969
16247
|
}
|
|
16248
|
+
export interface UpdatePlaceMembershipTypeTranslation200Response {
|
|
16249
|
+
'status': UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
16250
|
+
'message': string;
|
|
16251
|
+
'data': PlaceMembershipTypeTranslation;
|
|
16252
|
+
}
|
|
16253
|
+
|
|
16254
|
+
export enum UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
16255
|
+
Ok = 'ok'
|
|
16256
|
+
}
|
|
16257
|
+
|
|
15970
16258
|
export interface UpdateSelf200Response {
|
|
15971
16259
|
'status': UpdateSelf200ResponseStatusEnum;
|
|
15972
16260
|
'message': string;
|
|
@@ -33572,21 +33860,25 @@ export class BookingsBlackoutsApi extends BaseAPI {
|
|
|
33572
33860
|
|
|
33573
33861
|
|
|
33574
33862
|
/**
|
|
33575
|
-
*
|
|
33863
|
+
* BookingsMembershipsApi - axios parameter creator
|
|
33576
33864
|
*/
|
|
33577
|
-
export const
|
|
33865
|
+
export const BookingsMembershipsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
33578
33866
|
return {
|
|
33579
33867
|
/**
|
|
33580
|
-
* Creates a
|
|
33581
|
-
* @summary
|
|
33582
|
-
* @param {
|
|
33868
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
33869
|
+
* @summary Grant a place membership
|
|
33870
|
+
* @param {string} placeId The place identifier
|
|
33871
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
33583
33872
|
* @param {*} [options] Override http request option.
|
|
33584
33873
|
* @throws {RequiredError}
|
|
33585
33874
|
*/
|
|
33586
|
-
|
|
33587
|
-
// verify required parameter '
|
|
33588
|
-
assertParamExists('
|
|
33589
|
-
|
|
33875
|
+
createPlaceMembership: async (placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33876
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
33877
|
+
assertParamExists('createPlaceMembership', 'placeId', placeId)
|
|
33878
|
+
// verify required parameter 'placeMembershipCreateInputs' is not null or undefined
|
|
33879
|
+
assertParamExists('createPlaceMembership', 'placeMembershipCreateInputs', placeMembershipCreateInputs)
|
|
33880
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
33881
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33590
33882
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33591
33883
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33592
33884
|
let baseOptions;
|
|
@@ -33610,7 +33902,7 @@ export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
33610
33902
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33611
33903
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33612
33904
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33613
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
33905
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipCreateInputs, localVarRequestOptions, configuration)
|
|
33614
33906
|
|
|
33615
33907
|
return {
|
|
33616
33908
|
url: toPathString(localVarUrlObj),
|
|
@@ -33618,16 +33910,2052 @@ export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Conf
|
|
|
33618
33910
|
};
|
|
33619
33911
|
},
|
|
33620
33912
|
/**
|
|
33621
|
-
*
|
|
33622
|
-
* @summary
|
|
33913
|
+
* 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.
|
|
33914
|
+
* @summary Add a member to a place membership
|
|
33915
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
33916
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
33917
|
+
* @param {*} [options] Override http request option.
|
|
33918
|
+
* @throws {RequiredError}
|
|
33919
|
+
*/
|
|
33920
|
+
createPlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33921
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
33922
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
33923
|
+
// verify required parameter 'placeMembershipMemberCreateInputs' is not null or undefined
|
|
33924
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipMemberCreateInputs', placeMembershipMemberCreateInputs)
|
|
33925
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
33926
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
33927
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33928
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33929
|
+
let baseOptions;
|
|
33930
|
+
if (configuration) {
|
|
33931
|
+
baseOptions = configuration.baseOptions;
|
|
33932
|
+
}
|
|
33933
|
+
|
|
33934
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
33935
|
+
const localVarHeaderParameter = {} as any;
|
|
33936
|
+
const localVarQueryParameter = {} as any;
|
|
33937
|
+
|
|
33938
|
+
// authentication ApiKeyAuth required
|
|
33939
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
33940
|
+
|
|
33941
|
+
// authentication OrganizationId required
|
|
33942
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
33943
|
+
|
|
33944
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
33945
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
33946
|
+
|
|
33947
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33948
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33949
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33950
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberCreateInputs, localVarRequestOptions, configuration)
|
|
33951
|
+
|
|
33952
|
+
return {
|
|
33953
|
+
url: toPathString(localVarUrlObj),
|
|
33954
|
+
options: localVarRequestOptions,
|
|
33955
|
+
};
|
|
33956
|
+
},
|
|
33957
|
+
/**
|
|
33958
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
33959
|
+
* @summary Create a place membership type
|
|
33623
33960
|
* @param {string} placeId The place identifier
|
|
33961
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
33624
33962
|
* @param {*} [options] Override http request option.
|
|
33625
33963
|
* @throws {RequiredError}
|
|
33626
33964
|
*/
|
|
33627
|
-
|
|
33965
|
+
createPlaceMembershipType: async (placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33628
33966
|
// verify required parameter 'placeId' is not null or undefined
|
|
33629
|
-
assertParamExists('
|
|
33630
|
-
|
|
33967
|
+
assertParamExists('createPlaceMembershipType', 'placeId', placeId)
|
|
33968
|
+
// verify required parameter 'placeMembershipTypeCreateInputs' is not null or undefined
|
|
33969
|
+
assertParamExists('createPlaceMembershipType', 'placeMembershipTypeCreateInputs', placeMembershipTypeCreateInputs)
|
|
33970
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
33971
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33972
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33973
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
33974
|
+
let baseOptions;
|
|
33975
|
+
if (configuration) {
|
|
33976
|
+
baseOptions = configuration.baseOptions;
|
|
33977
|
+
}
|
|
33978
|
+
|
|
33979
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
33980
|
+
const localVarHeaderParameter = {} as any;
|
|
33981
|
+
const localVarQueryParameter = {} as any;
|
|
33982
|
+
|
|
33983
|
+
// authentication ApiKeyAuth required
|
|
33984
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
33985
|
+
|
|
33986
|
+
// authentication OrganizationId required
|
|
33987
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
33988
|
+
|
|
33989
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
33990
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
33991
|
+
|
|
33992
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33993
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33994
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33995
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeCreateInputs, localVarRequestOptions, configuration)
|
|
33996
|
+
|
|
33997
|
+
return {
|
|
33998
|
+
url: toPathString(localVarUrlObj),
|
|
33999
|
+
options: localVarRequestOptions,
|
|
34000
|
+
};
|
|
34001
|
+
},
|
|
34002
|
+
/**
|
|
34003
|
+
* 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.
|
|
34004
|
+
* @summary Remove a member from a place membership
|
|
34005
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34006
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34007
|
+
* @param {*} [options] Override http request option.
|
|
34008
|
+
* @throws {RequiredError}
|
|
34009
|
+
*/
|
|
34010
|
+
deletePlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34011
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34012
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
34013
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
34014
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId)
|
|
34015
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
34016
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
34017
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
34018
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34019
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34020
|
+
let baseOptions;
|
|
34021
|
+
if (configuration) {
|
|
34022
|
+
baseOptions = configuration.baseOptions;
|
|
34023
|
+
}
|
|
34024
|
+
|
|
34025
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
34026
|
+
const localVarHeaderParameter = {} as any;
|
|
34027
|
+
const localVarQueryParameter = {} as any;
|
|
34028
|
+
|
|
34029
|
+
// authentication ApiKeyAuth required
|
|
34030
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34031
|
+
|
|
34032
|
+
// authentication OrganizationId required
|
|
34033
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34034
|
+
|
|
34035
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34036
|
+
|
|
34037
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34038
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34039
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34040
|
+
|
|
34041
|
+
return {
|
|
34042
|
+
url: toPathString(localVarUrlObj),
|
|
34043
|
+
options: localVarRequestOptions,
|
|
34044
|
+
};
|
|
34045
|
+
},
|
|
34046
|
+
/**
|
|
34047
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34048
|
+
* @summary Delete a place membership type
|
|
34049
|
+
* @param {string} placeId The place identifier
|
|
34050
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34051
|
+
* @param {*} [options] Override http request option.
|
|
34052
|
+
* @throws {RequiredError}
|
|
34053
|
+
*/
|
|
34054
|
+
deletePlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34055
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34056
|
+
assertParamExists('deletePlaceMembershipType', 'placeId', placeId)
|
|
34057
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34058
|
+
assertParamExists('deletePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34059
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34060
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34061
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34062
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34063
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34064
|
+
let baseOptions;
|
|
34065
|
+
if (configuration) {
|
|
34066
|
+
baseOptions = configuration.baseOptions;
|
|
34067
|
+
}
|
|
34068
|
+
|
|
34069
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
34070
|
+
const localVarHeaderParameter = {} as any;
|
|
34071
|
+
const localVarQueryParameter = {} as any;
|
|
34072
|
+
|
|
34073
|
+
// authentication ApiKeyAuth required
|
|
34074
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34075
|
+
|
|
34076
|
+
// authentication OrganizationId required
|
|
34077
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34078
|
+
|
|
34079
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34080
|
+
|
|
34081
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34082
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34083
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34084
|
+
|
|
34085
|
+
return {
|
|
34086
|
+
url: toPathString(localVarUrlObj),
|
|
34087
|
+
options: localVarRequestOptions,
|
|
34088
|
+
};
|
|
34089
|
+
},
|
|
34090
|
+
/**
|
|
34091
|
+
* 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\".
|
|
34092
|
+
* @summary Get a place membership
|
|
34093
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34094
|
+
* @param {*} [options] Override http request option.
|
|
34095
|
+
* @throws {RequiredError}
|
|
34096
|
+
*/
|
|
34097
|
+
getPlaceMembership: async (placeMembershipId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34098
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34099
|
+
assertParamExists('getPlaceMembership', 'placeMembershipId', placeMembershipId)
|
|
34100
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
34101
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34102
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34103
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34104
|
+
let baseOptions;
|
|
34105
|
+
if (configuration) {
|
|
34106
|
+
baseOptions = configuration.baseOptions;
|
|
34107
|
+
}
|
|
34108
|
+
|
|
34109
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34110
|
+
const localVarHeaderParameter = {} as any;
|
|
34111
|
+
const localVarQueryParameter = {} as any;
|
|
34112
|
+
|
|
34113
|
+
// authentication ApiKeyAuth required
|
|
34114
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34115
|
+
|
|
34116
|
+
// authentication OrganizationId required
|
|
34117
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34118
|
+
|
|
34119
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34120
|
+
|
|
34121
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34122
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34123
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34124
|
+
|
|
34125
|
+
return {
|
|
34126
|
+
url: toPathString(localVarUrlObj),
|
|
34127
|
+
options: localVarRequestOptions,
|
|
34128
|
+
};
|
|
34129
|
+
},
|
|
34130
|
+
/**
|
|
34131
|
+
* 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\".
|
|
34132
|
+
* @summary List bookings that applied a place membership
|
|
34133
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34134
|
+
* @param {number} [page] Page number
|
|
34135
|
+
* @param {number} [pageSize] Number of items per page
|
|
34136
|
+
* @param {string} [orderBy] Field to order by
|
|
34137
|
+
* @param {string} [search] Search query
|
|
34138
|
+
* @param {*} [options] Override http request option.
|
|
34139
|
+
* @throws {RequiredError}
|
|
34140
|
+
*/
|
|
34141
|
+
getPlaceMembershipBookings: async (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34142
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34143
|
+
assertParamExists('getPlaceMembershipBookings', 'placeMembershipId', placeMembershipId)
|
|
34144
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/bookings`
|
|
34145
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34146
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34147
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34148
|
+
let baseOptions;
|
|
34149
|
+
if (configuration) {
|
|
34150
|
+
baseOptions = configuration.baseOptions;
|
|
34151
|
+
}
|
|
34152
|
+
|
|
34153
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34154
|
+
const localVarHeaderParameter = {} as any;
|
|
34155
|
+
const localVarQueryParameter = {} as any;
|
|
34156
|
+
|
|
34157
|
+
// authentication ApiKeyAuth required
|
|
34158
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34159
|
+
|
|
34160
|
+
// authentication OrganizationId required
|
|
34161
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34162
|
+
|
|
34163
|
+
if (page !== undefined) {
|
|
34164
|
+
localVarQueryParameter['page'] = page;
|
|
34165
|
+
}
|
|
34166
|
+
|
|
34167
|
+
if (pageSize !== undefined) {
|
|
34168
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34169
|
+
}
|
|
34170
|
+
|
|
34171
|
+
if (orderBy !== undefined) {
|
|
34172
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34173
|
+
}
|
|
34174
|
+
|
|
34175
|
+
if (search !== undefined) {
|
|
34176
|
+
localVarQueryParameter['search'] = search;
|
|
34177
|
+
}
|
|
34178
|
+
|
|
34179
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34180
|
+
|
|
34181
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34182
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34183
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34184
|
+
|
|
34185
|
+
return {
|
|
34186
|
+
url: toPathString(localVarUrlObj),
|
|
34187
|
+
options: localVarRequestOptions,
|
|
34188
|
+
};
|
|
34189
|
+
},
|
|
34190
|
+
/**
|
|
34191
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34192
|
+
* @summary List a place membership\'s members
|
|
34193
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34194
|
+
* @param {number} [page] Page number
|
|
34195
|
+
* @param {number} [pageSize] Number of items per page
|
|
34196
|
+
* @param {string} [orderBy] Field to order by
|
|
34197
|
+
* @param {string} [search] Search query
|
|
34198
|
+
* @param {*} [options] Override http request option.
|
|
34199
|
+
* @throws {RequiredError}
|
|
34200
|
+
*/
|
|
34201
|
+
getPlaceMembershipMembers: async (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34202
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34203
|
+
assertParamExists('getPlaceMembershipMembers', 'placeMembershipId', placeMembershipId)
|
|
34204
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
34205
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34206
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34207
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34208
|
+
let baseOptions;
|
|
34209
|
+
if (configuration) {
|
|
34210
|
+
baseOptions = configuration.baseOptions;
|
|
34211
|
+
}
|
|
34212
|
+
|
|
34213
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34214
|
+
const localVarHeaderParameter = {} as any;
|
|
34215
|
+
const localVarQueryParameter = {} as any;
|
|
34216
|
+
|
|
34217
|
+
// authentication ApiKeyAuth required
|
|
34218
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34219
|
+
|
|
34220
|
+
// authentication OrganizationId required
|
|
34221
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34222
|
+
|
|
34223
|
+
if (page !== undefined) {
|
|
34224
|
+
localVarQueryParameter['page'] = page;
|
|
34225
|
+
}
|
|
34226
|
+
|
|
34227
|
+
if (pageSize !== undefined) {
|
|
34228
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34229
|
+
}
|
|
34230
|
+
|
|
34231
|
+
if (orderBy !== undefined) {
|
|
34232
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34233
|
+
}
|
|
34234
|
+
|
|
34235
|
+
if (search !== undefined) {
|
|
34236
|
+
localVarQueryParameter['search'] = search;
|
|
34237
|
+
}
|
|
34238
|
+
|
|
34239
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34240
|
+
|
|
34241
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34242
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34243
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34244
|
+
|
|
34245
|
+
return {
|
|
34246
|
+
url: toPathString(localVarUrlObj),
|
|
34247
|
+
options: localVarRequestOptions,
|
|
34248
|
+
};
|
|
34249
|
+
},
|
|
34250
|
+
/**
|
|
34251
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34252
|
+
* @summary Get a place membership type
|
|
34253
|
+
* @param {string} placeId The place identifier
|
|
34254
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34255
|
+
* @param {*} [options] Override http request option.
|
|
34256
|
+
* @throws {RequiredError}
|
|
34257
|
+
*/
|
|
34258
|
+
getPlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34259
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34260
|
+
assertParamExists('getPlaceMembershipType', 'placeId', placeId)
|
|
34261
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34262
|
+
assertParamExists('getPlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34263
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34264
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34265
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34266
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34267
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34268
|
+
let baseOptions;
|
|
34269
|
+
if (configuration) {
|
|
34270
|
+
baseOptions = configuration.baseOptions;
|
|
34271
|
+
}
|
|
34272
|
+
|
|
34273
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34274
|
+
const localVarHeaderParameter = {} as any;
|
|
34275
|
+
const localVarQueryParameter = {} as any;
|
|
34276
|
+
|
|
34277
|
+
// authentication ApiKeyAuth required
|
|
34278
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34279
|
+
|
|
34280
|
+
// authentication OrganizationId required
|
|
34281
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34282
|
+
|
|
34283
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34284
|
+
|
|
34285
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34286
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34287
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34288
|
+
|
|
34289
|
+
return {
|
|
34290
|
+
url: toPathString(localVarUrlObj),
|
|
34291
|
+
options: localVarRequestOptions,
|
|
34292
|
+
};
|
|
34293
|
+
},
|
|
34294
|
+
/**
|
|
34295
|
+
* 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\".
|
|
34296
|
+
* @summary List a place\'s membership types
|
|
34297
|
+
* @param {string} placeId The place identifier
|
|
34298
|
+
* @param {boolean} [archived] Filter by archived
|
|
34299
|
+
* @param {number} [page] Page number
|
|
34300
|
+
* @param {number} [pageSize] Number of items per page
|
|
34301
|
+
* @param {string} [orderBy] Field to order by
|
|
34302
|
+
* @param {string} [search] Search query
|
|
34303
|
+
* @param {*} [options] Override http request option.
|
|
34304
|
+
* @throws {RequiredError}
|
|
34305
|
+
*/
|
|
34306
|
+
getPlaceMembershipTypes: async (placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34307
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34308
|
+
assertParamExists('getPlaceMembershipTypes', 'placeId', placeId)
|
|
34309
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
34310
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
34311
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34312
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34313
|
+
let baseOptions;
|
|
34314
|
+
if (configuration) {
|
|
34315
|
+
baseOptions = configuration.baseOptions;
|
|
34316
|
+
}
|
|
34317
|
+
|
|
34318
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34319
|
+
const localVarHeaderParameter = {} as any;
|
|
34320
|
+
const localVarQueryParameter = {} as any;
|
|
34321
|
+
|
|
34322
|
+
// authentication ApiKeyAuth required
|
|
34323
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34324
|
+
|
|
34325
|
+
// authentication OrganizationId required
|
|
34326
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34327
|
+
|
|
34328
|
+
if (archived !== undefined) {
|
|
34329
|
+
localVarQueryParameter['archived'] = archived;
|
|
34330
|
+
}
|
|
34331
|
+
|
|
34332
|
+
if (page !== undefined) {
|
|
34333
|
+
localVarQueryParameter['page'] = page;
|
|
34334
|
+
}
|
|
34335
|
+
|
|
34336
|
+
if (pageSize !== undefined) {
|
|
34337
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34338
|
+
}
|
|
34339
|
+
|
|
34340
|
+
if (orderBy !== undefined) {
|
|
34341
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34342
|
+
}
|
|
34343
|
+
|
|
34344
|
+
if (search !== undefined) {
|
|
34345
|
+
localVarQueryParameter['search'] = search;
|
|
34346
|
+
}
|
|
34347
|
+
|
|
34348
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34349
|
+
|
|
34350
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34351
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34352
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34353
|
+
|
|
34354
|
+
return {
|
|
34355
|
+
url: toPathString(localVarUrlObj),
|
|
34356
|
+
options: localVarRequestOptions,
|
|
34357
|
+
};
|
|
34358
|
+
},
|
|
34359
|
+
/**
|
|
34360
|
+
* 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\".
|
|
34361
|
+
* @summary List a place\'s memberships
|
|
34362
|
+
* @param {string} placeId The place identifier
|
|
34363
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
34364
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
34365
|
+
* @param {boolean} [active] Filter by active
|
|
34366
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
34367
|
+
* @param {boolean} [expired] Filter by expired
|
|
34368
|
+
* @param {number} [page] Page number
|
|
34369
|
+
* @param {number} [pageSize] Number of items per page
|
|
34370
|
+
* @param {string} [orderBy] Field to order by
|
|
34371
|
+
* @param {string} [search] Search query
|
|
34372
|
+
* @param {*} [options] Override http request option.
|
|
34373
|
+
* @throws {RequiredError}
|
|
34374
|
+
*/
|
|
34375
|
+
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> => {
|
|
34376
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34377
|
+
assertParamExists('getPlaceMemberships', 'placeId', placeId)
|
|
34378
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
34379
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
34380
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34381
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34382
|
+
let baseOptions;
|
|
34383
|
+
if (configuration) {
|
|
34384
|
+
baseOptions = configuration.baseOptions;
|
|
34385
|
+
}
|
|
34386
|
+
|
|
34387
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
34388
|
+
const localVarHeaderParameter = {} as any;
|
|
34389
|
+
const localVarQueryParameter = {} as any;
|
|
34390
|
+
|
|
34391
|
+
// authentication ApiKeyAuth required
|
|
34392
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34393
|
+
|
|
34394
|
+
// authentication OrganizationId required
|
|
34395
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34396
|
+
|
|
34397
|
+
if (placeMembershipTypeId !== undefined) {
|
|
34398
|
+
localVarQueryParameter['placeMembershipTypeId'] = placeMembershipTypeId;
|
|
34399
|
+
}
|
|
34400
|
+
|
|
34401
|
+
if (status !== undefined) {
|
|
34402
|
+
localVarQueryParameter['status'] = status;
|
|
34403
|
+
}
|
|
34404
|
+
|
|
34405
|
+
if (active !== undefined) {
|
|
34406
|
+
localVarQueryParameter['active'] = active;
|
|
34407
|
+
}
|
|
34408
|
+
|
|
34409
|
+
if (upcoming !== undefined) {
|
|
34410
|
+
localVarQueryParameter['upcoming'] = upcoming;
|
|
34411
|
+
}
|
|
34412
|
+
|
|
34413
|
+
if (expired !== undefined) {
|
|
34414
|
+
localVarQueryParameter['expired'] = expired;
|
|
34415
|
+
}
|
|
34416
|
+
|
|
34417
|
+
if (page !== undefined) {
|
|
34418
|
+
localVarQueryParameter['page'] = page;
|
|
34419
|
+
}
|
|
34420
|
+
|
|
34421
|
+
if (pageSize !== undefined) {
|
|
34422
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
34423
|
+
}
|
|
34424
|
+
|
|
34425
|
+
if (orderBy !== undefined) {
|
|
34426
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
34427
|
+
}
|
|
34428
|
+
|
|
34429
|
+
if (search !== undefined) {
|
|
34430
|
+
localVarQueryParameter['search'] = search;
|
|
34431
|
+
}
|
|
34432
|
+
|
|
34433
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34434
|
+
|
|
34435
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34436
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34437
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34438
|
+
|
|
34439
|
+
return {
|
|
34440
|
+
url: toPathString(localVarUrlObj),
|
|
34441
|
+
options: localVarRequestOptions,
|
|
34442
|
+
};
|
|
34443
|
+
},
|
|
34444
|
+
/**
|
|
34445
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34446
|
+
* @summary Update a place membership
|
|
34447
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34448
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
34449
|
+
* @param {*} [options] Override http request option.
|
|
34450
|
+
* @throws {RequiredError}
|
|
34451
|
+
*/
|
|
34452
|
+
updatePlaceMembership: async (placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34453
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34454
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipId', placeMembershipId)
|
|
34455
|
+
// verify required parameter 'placeMembershipUpdateInputs' is not null or undefined
|
|
34456
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipUpdateInputs', placeMembershipUpdateInputs)
|
|
34457
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
34458
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
34459
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34460
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34461
|
+
let baseOptions;
|
|
34462
|
+
if (configuration) {
|
|
34463
|
+
baseOptions = configuration.baseOptions;
|
|
34464
|
+
}
|
|
34465
|
+
|
|
34466
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34467
|
+
const localVarHeaderParameter = {} as any;
|
|
34468
|
+
const localVarQueryParameter = {} as any;
|
|
34469
|
+
|
|
34470
|
+
// authentication ApiKeyAuth required
|
|
34471
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34472
|
+
|
|
34473
|
+
// authentication OrganizationId required
|
|
34474
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34475
|
+
|
|
34476
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34477
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34478
|
+
|
|
34479
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34480
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34481
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34482
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipUpdateInputs, localVarRequestOptions, configuration)
|
|
34483
|
+
|
|
34484
|
+
return {
|
|
34485
|
+
url: toPathString(localVarUrlObj),
|
|
34486
|
+
options: localVarRequestOptions,
|
|
34487
|
+
};
|
|
34488
|
+
},
|
|
34489
|
+
/**
|
|
34490
|
+
* 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.
|
|
34491
|
+
* @summary Update a place membership member
|
|
34492
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34493
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34494
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
34495
|
+
* @param {*} [options] Override http request option.
|
|
34496
|
+
* @throws {RequiredError}
|
|
34497
|
+
*/
|
|
34498
|
+
updatePlaceMembershipMember: async (placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34499
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
34500
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipId', placeMembershipId)
|
|
34501
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
34502
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId)
|
|
34503
|
+
// verify required parameter 'placeMembershipMemberUpdateInputs' is not null or undefined
|
|
34504
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberUpdateInputs', placeMembershipMemberUpdateInputs)
|
|
34505
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
34506
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
34507
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
34508
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34509
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34510
|
+
let baseOptions;
|
|
34511
|
+
if (configuration) {
|
|
34512
|
+
baseOptions = configuration.baseOptions;
|
|
34513
|
+
}
|
|
34514
|
+
|
|
34515
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34516
|
+
const localVarHeaderParameter = {} as any;
|
|
34517
|
+
const localVarQueryParameter = {} as any;
|
|
34518
|
+
|
|
34519
|
+
// authentication ApiKeyAuth required
|
|
34520
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34521
|
+
|
|
34522
|
+
// authentication OrganizationId required
|
|
34523
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34524
|
+
|
|
34525
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34526
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34527
|
+
|
|
34528
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34529
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34530
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34531
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberUpdateInputs, localVarRequestOptions, configuration)
|
|
34532
|
+
|
|
34533
|
+
return {
|
|
34534
|
+
url: toPathString(localVarUrlObj),
|
|
34535
|
+
options: localVarRequestOptions,
|
|
34536
|
+
};
|
|
34537
|
+
},
|
|
34538
|
+
/**
|
|
34539
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34540
|
+
* @summary Update a place membership type
|
|
34541
|
+
* @param {string} placeId The place identifier
|
|
34542
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34543
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
34544
|
+
* @param {*} [options] Override http request option.
|
|
34545
|
+
* @throws {RequiredError}
|
|
34546
|
+
*/
|
|
34547
|
+
updatePlaceMembershipType: async (placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34548
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
34549
|
+
assertParamExists('updatePlaceMembershipType', 'placeId', placeId)
|
|
34550
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
34551
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
34552
|
+
// verify required parameter 'placeMembershipTypeUpdateInputs' is not null or undefined
|
|
34553
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeUpdateInputs', placeMembershipTypeUpdateInputs)
|
|
34554
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
34555
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
34556
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
34557
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34558
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
34559
|
+
let baseOptions;
|
|
34560
|
+
if (configuration) {
|
|
34561
|
+
baseOptions = configuration.baseOptions;
|
|
34562
|
+
}
|
|
34563
|
+
|
|
34564
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
34565
|
+
const localVarHeaderParameter = {} as any;
|
|
34566
|
+
const localVarQueryParameter = {} as any;
|
|
34567
|
+
|
|
34568
|
+
// authentication ApiKeyAuth required
|
|
34569
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
34570
|
+
|
|
34571
|
+
// authentication OrganizationId required
|
|
34572
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
34573
|
+
|
|
34574
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
34575
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
34576
|
+
|
|
34577
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
34578
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
34579
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
34580
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeUpdateInputs, localVarRequestOptions, configuration)
|
|
34581
|
+
|
|
34582
|
+
return {
|
|
34583
|
+
url: toPathString(localVarUrlObj),
|
|
34584
|
+
options: localVarRequestOptions,
|
|
34585
|
+
};
|
|
34586
|
+
},
|
|
34587
|
+
}
|
|
34588
|
+
};
|
|
34589
|
+
|
|
34590
|
+
/**
|
|
34591
|
+
* BookingsMembershipsApi - functional programming interface
|
|
34592
|
+
*/
|
|
34593
|
+
export const BookingsMembershipsApiFp = function(configuration?: Configuration) {
|
|
34594
|
+
const localVarAxiosParamCreator = BookingsMembershipsApiAxiosParamCreator(configuration)
|
|
34595
|
+
return {
|
|
34596
|
+
/**
|
|
34597
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
34598
|
+
* @summary Grant a place membership
|
|
34599
|
+
* @param {string} placeId The place identifier
|
|
34600
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
34601
|
+
* @param {*} [options] Override http request option.
|
|
34602
|
+
* @throws {RequiredError}
|
|
34603
|
+
*/
|
|
34604
|
+
async createPlaceMembership(placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34605
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembership(placeId, placeMembershipCreateInputs, options);
|
|
34606
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34607
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34608
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34609
|
+
},
|
|
34610
|
+
/**
|
|
34611
|
+
* 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.
|
|
34612
|
+
* @summary Add a member to a place membership
|
|
34613
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34614
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
34615
|
+
* @param {*} [options] Override http request option.
|
|
34616
|
+
* @throws {RequiredError}
|
|
34617
|
+
*/
|
|
34618
|
+
async createPlaceMembershipMember(placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>> {
|
|
34619
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembershipMember(placeMembershipId, placeMembershipMemberCreateInputs, options);
|
|
34620
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34621
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34622
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34623
|
+
},
|
|
34624
|
+
/**
|
|
34625
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
34626
|
+
* @summary Create a place membership type
|
|
34627
|
+
* @param {string} placeId The place identifier
|
|
34628
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
34629
|
+
* @param {*} [options] Override http request option.
|
|
34630
|
+
* @throws {RequiredError}
|
|
34631
|
+
*/
|
|
34632
|
+
async createPlaceMembershipType(placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34633
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createPlaceMembershipType(placeId, placeMembershipTypeCreateInputs, options);
|
|
34634
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34635
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.createPlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34636
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34637
|
+
},
|
|
34638
|
+
/**
|
|
34639
|
+
* 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.
|
|
34640
|
+
* @summary Remove a member from a place membership
|
|
34641
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34642
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34643
|
+
* @param {*} [options] Override http request option.
|
|
34644
|
+
* @throws {RequiredError}
|
|
34645
|
+
*/
|
|
34646
|
+
async deletePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
34647
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, options);
|
|
34648
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34649
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34650
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34651
|
+
},
|
|
34652
|
+
/**
|
|
34653
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34654
|
+
* @summary Delete a place membership type
|
|
34655
|
+
* @param {string} placeId The place identifier
|
|
34656
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34657
|
+
* @param {*} [options] Override http request option.
|
|
34658
|
+
* @throws {RequiredError}
|
|
34659
|
+
*/
|
|
34660
|
+
async deletePlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
34661
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
34662
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34663
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34664
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34665
|
+
},
|
|
34666
|
+
/**
|
|
34667
|
+
* 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\".
|
|
34668
|
+
* @summary Get a place membership
|
|
34669
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34670
|
+
* @param {*} [options] Override http request option.
|
|
34671
|
+
* @throws {RequiredError}
|
|
34672
|
+
*/
|
|
34673
|
+
async getPlaceMembership(placeMembershipId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34674
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembership(placeMembershipId, options);
|
|
34675
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34676
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34677
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34678
|
+
},
|
|
34679
|
+
/**
|
|
34680
|
+
* 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\".
|
|
34681
|
+
* @summary List bookings that applied a place membership
|
|
34682
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34683
|
+
* @param {number} [page] Page number
|
|
34684
|
+
* @param {number} [pageSize] Number of items per page
|
|
34685
|
+
* @param {string} [orderBy] Field to order by
|
|
34686
|
+
* @param {string} [search] Search query
|
|
34687
|
+
* @param {*} [options] Override http request option.
|
|
34688
|
+
* @throws {RequiredError}
|
|
34689
|
+
*/
|
|
34690
|
+
async getPlaceMembershipBookings(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountBookings200Response>> {
|
|
34691
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipBookings(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
34692
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34693
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipBookings']?.[localVarOperationServerIndex]?.url;
|
|
34694
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34695
|
+
},
|
|
34696
|
+
/**
|
|
34697
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34698
|
+
* @summary List a place membership\'s members
|
|
34699
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34700
|
+
* @param {number} [page] Page number
|
|
34701
|
+
* @param {number} [pageSize] Number of items per page
|
|
34702
|
+
* @param {string} [orderBy] Field to order by
|
|
34703
|
+
* @param {string} [search] Search query
|
|
34704
|
+
* @param {*} [options] Override http request option.
|
|
34705
|
+
* @throws {RequiredError}
|
|
34706
|
+
*/
|
|
34707
|
+
async getPlaceMembershipMembers(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipMembers200Response>> {
|
|
34708
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipMembers(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
34709
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34710
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipMembers']?.[localVarOperationServerIndex]?.url;
|
|
34711
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34712
|
+
},
|
|
34713
|
+
/**
|
|
34714
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34715
|
+
* @summary Get a place membership type
|
|
34716
|
+
* @param {string} placeId The place identifier
|
|
34717
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34718
|
+
* @param {*} [options] Override http request option.
|
|
34719
|
+
* @throws {RequiredError}
|
|
34720
|
+
*/
|
|
34721
|
+
async getPlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34722
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
34723
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34724
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34725
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34726
|
+
},
|
|
34727
|
+
/**
|
|
34728
|
+
* 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\".
|
|
34729
|
+
* @summary List a place\'s membership types
|
|
34730
|
+
* @param {string} placeId The place identifier
|
|
34731
|
+
* @param {boolean} [archived] Filter by archived
|
|
34732
|
+
* @param {number} [page] Page number
|
|
34733
|
+
* @param {number} [pageSize] Number of items per page
|
|
34734
|
+
* @param {string} [orderBy] Field to order by
|
|
34735
|
+
* @param {string} [search] Search query
|
|
34736
|
+
* @param {*} [options] Override http request option.
|
|
34737
|
+
* @throws {RequiredError}
|
|
34738
|
+
*/
|
|
34739
|
+
async getPlaceMembershipTypes(placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypes200Response>> {
|
|
34740
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypes(placeId, archived, page, pageSize, orderBy, search, options);
|
|
34741
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34742
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMembershipTypes']?.[localVarOperationServerIndex]?.url;
|
|
34743
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34744
|
+
},
|
|
34745
|
+
/**
|
|
34746
|
+
* 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\".
|
|
34747
|
+
* @summary List a place\'s memberships
|
|
34748
|
+
* @param {string} placeId The place identifier
|
|
34749
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
34750
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
34751
|
+
* @param {boolean} [active] Filter by active
|
|
34752
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
34753
|
+
* @param {boolean} [expired] Filter by expired
|
|
34754
|
+
* @param {number} [page] Page number
|
|
34755
|
+
* @param {number} [pageSize] Number of items per page
|
|
34756
|
+
* @param {string} [orderBy] Field to order by
|
|
34757
|
+
* @param {string} [search] Search query
|
|
34758
|
+
* @param {*} [options] Override http request option.
|
|
34759
|
+
* @throws {RequiredError}
|
|
34760
|
+
*/
|
|
34761
|
+
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>> {
|
|
34762
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMemberships(placeId, placeMembershipTypeId, status, active, upcoming, expired, page, pageSize, orderBy, search, options);
|
|
34763
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34764
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.getPlaceMemberships']?.[localVarOperationServerIndex]?.url;
|
|
34765
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34766
|
+
},
|
|
34767
|
+
/**
|
|
34768
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34769
|
+
* @summary Update a place membership
|
|
34770
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34771
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
34772
|
+
* @param {*} [options] Override http request option.
|
|
34773
|
+
* @throws {RequiredError}
|
|
34774
|
+
*/
|
|
34775
|
+
async updatePlaceMembership(placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>> {
|
|
34776
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembership(placeMembershipId, placeMembershipUpdateInputs, options);
|
|
34777
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34778
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembership']?.[localVarOperationServerIndex]?.url;
|
|
34779
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34780
|
+
},
|
|
34781
|
+
/**
|
|
34782
|
+
* 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.
|
|
34783
|
+
* @summary Update a place membership member
|
|
34784
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
34785
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
34786
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
34787
|
+
* @param {*} [options] Override http request option.
|
|
34788
|
+
* @throws {RequiredError}
|
|
34789
|
+
*/
|
|
34790
|
+
async updatePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>> {
|
|
34791
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, placeMembershipMemberUpdateInputs, options);
|
|
34792
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34793
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipMember']?.[localVarOperationServerIndex]?.url;
|
|
34794
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34795
|
+
},
|
|
34796
|
+
/**
|
|
34797
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34798
|
+
* @summary Update a place membership type
|
|
34799
|
+
* @param {string} placeId The place identifier
|
|
34800
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
34801
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
34802
|
+
* @param {*} [options] Override http request option.
|
|
34803
|
+
* @throws {RequiredError}
|
|
34804
|
+
*/
|
|
34805
|
+
async updatePlaceMembershipType(placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>> {
|
|
34806
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipType(placeId, placeMembershipTypeId, placeMembershipTypeUpdateInputs, options);
|
|
34807
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34808
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipType']?.[localVarOperationServerIndex]?.url;
|
|
34809
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
34810
|
+
},
|
|
34811
|
+
}
|
|
34812
|
+
};
|
|
34813
|
+
|
|
34814
|
+
/**
|
|
34815
|
+
* BookingsMembershipsApi - factory interface
|
|
34816
|
+
*/
|
|
34817
|
+
export const BookingsMembershipsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
34818
|
+
const localVarFp = BookingsMembershipsApiFp(configuration)
|
|
34819
|
+
return {
|
|
34820
|
+
/**
|
|
34821
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
34822
|
+
* @summary Grant a place membership
|
|
34823
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
34824
|
+
* @param {*} [options] Override http request option.
|
|
34825
|
+
* @throws {RequiredError}
|
|
34826
|
+
*/
|
|
34827
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34828
|
+
return localVarFp.createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(axios, basePath));
|
|
34829
|
+
},
|
|
34830
|
+
/**
|
|
34831
|
+
* 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.
|
|
34832
|
+
* @summary Add a member to a place membership
|
|
34833
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34834
|
+
* @param {*} [options] Override http request option.
|
|
34835
|
+
* @throws {RequiredError}
|
|
34836
|
+
*/
|
|
34837
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response> {
|
|
34838
|
+
return localVarFp.createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(axios, basePath));
|
|
34839
|
+
},
|
|
34840
|
+
/**
|
|
34841
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
34842
|
+
* @summary Create a place membership type
|
|
34843
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34844
|
+
* @param {*} [options] Override http request option.
|
|
34845
|
+
* @throws {RequiredError}
|
|
34846
|
+
*/
|
|
34847
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34848
|
+
return localVarFp.createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(axios, basePath));
|
|
34849
|
+
},
|
|
34850
|
+
/**
|
|
34851
|
+
* 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.
|
|
34852
|
+
* @summary Remove a member from a place membership
|
|
34853
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34854
|
+
* @param {*} [options] Override http request option.
|
|
34855
|
+
* @throws {RequiredError}
|
|
34856
|
+
*/
|
|
34857
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
34858
|
+
return localVarFp.deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(axios, basePath));
|
|
34859
|
+
},
|
|
34860
|
+
/**
|
|
34861
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
34862
|
+
* @summary Delete a place membership type
|
|
34863
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34864
|
+
* @param {*} [options] Override http request option.
|
|
34865
|
+
* @throws {RequiredError}
|
|
34866
|
+
*/
|
|
34867
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
34868
|
+
return localVarFp.deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
34869
|
+
},
|
|
34870
|
+
/**
|
|
34871
|
+
* 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\".
|
|
34872
|
+
* @summary Get a place membership
|
|
34873
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
34874
|
+
* @param {*} [options] Override http request option.
|
|
34875
|
+
* @throws {RequiredError}
|
|
34876
|
+
*/
|
|
34877
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34878
|
+
return localVarFp.getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(axios, basePath));
|
|
34879
|
+
},
|
|
34880
|
+
/**
|
|
34881
|
+
* 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\".
|
|
34882
|
+
* @summary List bookings that applied a place membership
|
|
34883
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
34884
|
+
* @param {*} [options] Override http request option.
|
|
34885
|
+
* @throws {RequiredError}
|
|
34886
|
+
*/
|
|
34887
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountBookings200Response> {
|
|
34888
|
+
return localVarFp.getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34889
|
+
},
|
|
34890
|
+
/**
|
|
34891
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
34892
|
+
* @summary List a place membership\'s members
|
|
34893
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
34894
|
+
* @param {*} [options] Override http request option.
|
|
34895
|
+
* @throws {RequiredError}
|
|
34896
|
+
*/
|
|
34897
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipMembers200Response> {
|
|
34898
|
+
return localVarFp.getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34899
|
+
},
|
|
34900
|
+
/**
|
|
34901
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
34902
|
+
* @summary Get a place membership type
|
|
34903
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34904
|
+
* @param {*} [options] Override http request option.
|
|
34905
|
+
* @throws {RequiredError}
|
|
34906
|
+
*/
|
|
34907
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34908
|
+
return localVarFp.getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
34909
|
+
},
|
|
34910
|
+
/**
|
|
34911
|
+
* 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\".
|
|
34912
|
+
* @summary List a place\'s membership types
|
|
34913
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
34914
|
+
* @param {*} [options] Override http request option.
|
|
34915
|
+
* @throws {RequiredError}
|
|
34916
|
+
*/
|
|
34917
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypes200Response> {
|
|
34918
|
+
return localVarFp.getPlaceMembershipTypes(requestParameters.placeId, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
34919
|
+
},
|
|
34920
|
+
/**
|
|
34921
|
+
* 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\".
|
|
34922
|
+
* @summary List a place\'s memberships
|
|
34923
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
34924
|
+
* @param {*} [options] Override http request option.
|
|
34925
|
+
* @throws {RequiredError}
|
|
34926
|
+
*/
|
|
34927
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMemberships200Response> {
|
|
34928
|
+
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));
|
|
34929
|
+
},
|
|
34930
|
+
/**
|
|
34931
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
34932
|
+
* @summary Update a place membership
|
|
34933
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
34934
|
+
* @param {*} [options] Override http request option.
|
|
34935
|
+
* @throws {RequiredError}
|
|
34936
|
+
*/
|
|
34937
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response> {
|
|
34938
|
+
return localVarFp.updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34939
|
+
},
|
|
34940
|
+
/**
|
|
34941
|
+
* 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.
|
|
34942
|
+
* @summary Update a place membership member
|
|
34943
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
34944
|
+
* @param {*} [options] Override http request option.
|
|
34945
|
+
* @throws {RequiredError}
|
|
34946
|
+
*/
|
|
34947
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response> {
|
|
34948
|
+
return localVarFp.updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34949
|
+
},
|
|
34950
|
+
/**
|
|
34951
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
34952
|
+
* @summary Update a place membership type
|
|
34953
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
34954
|
+
* @param {*} [options] Override http request option.
|
|
34955
|
+
* @throws {RequiredError}
|
|
34956
|
+
*/
|
|
34957
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response> {
|
|
34958
|
+
return localVarFp.updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(axios, basePath));
|
|
34959
|
+
},
|
|
34960
|
+
};
|
|
34961
|
+
};
|
|
34962
|
+
|
|
34963
|
+
/**
|
|
34964
|
+
* Request parameters for createPlaceMembership operation in BookingsMembershipsApi.
|
|
34965
|
+
*/
|
|
34966
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipRequest {
|
|
34967
|
+
/**
|
|
34968
|
+
* The place identifier
|
|
34969
|
+
*/
|
|
34970
|
+
readonly placeId: string
|
|
34971
|
+
|
|
34972
|
+
readonly placeMembershipCreateInputs: PlaceMembershipCreateInputs
|
|
34973
|
+
}
|
|
34974
|
+
|
|
34975
|
+
/**
|
|
34976
|
+
* Request parameters for createPlaceMembershipMember operation in BookingsMembershipsApi.
|
|
34977
|
+
*/
|
|
34978
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipMemberRequest {
|
|
34979
|
+
/**
|
|
34980
|
+
* The placeMembership identifier
|
|
34981
|
+
*/
|
|
34982
|
+
readonly placeMembershipId: string
|
|
34983
|
+
|
|
34984
|
+
readonly placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs
|
|
34985
|
+
}
|
|
34986
|
+
|
|
34987
|
+
/**
|
|
34988
|
+
* Request parameters for createPlaceMembershipType operation in BookingsMembershipsApi.
|
|
34989
|
+
*/
|
|
34990
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipTypeRequest {
|
|
34991
|
+
/**
|
|
34992
|
+
* The place identifier
|
|
34993
|
+
*/
|
|
34994
|
+
readonly placeId: string
|
|
34995
|
+
|
|
34996
|
+
readonly placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs
|
|
34997
|
+
}
|
|
34998
|
+
|
|
34999
|
+
/**
|
|
35000
|
+
* Request parameters for deletePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
35001
|
+
*/
|
|
35002
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipMemberRequest {
|
|
35003
|
+
/**
|
|
35004
|
+
* The placeMembership identifier
|
|
35005
|
+
*/
|
|
35006
|
+
readonly placeMembershipId: string
|
|
35007
|
+
|
|
35008
|
+
/**
|
|
35009
|
+
* The placeMembershipMember identifier
|
|
35010
|
+
*/
|
|
35011
|
+
readonly placeMembershipMemberId: string
|
|
35012
|
+
}
|
|
35013
|
+
|
|
35014
|
+
/**
|
|
35015
|
+
* Request parameters for deletePlaceMembershipType operation in BookingsMembershipsApi.
|
|
35016
|
+
*/
|
|
35017
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipTypeRequest {
|
|
35018
|
+
/**
|
|
35019
|
+
* The place identifier
|
|
35020
|
+
*/
|
|
35021
|
+
readonly placeId: string
|
|
35022
|
+
|
|
35023
|
+
/**
|
|
35024
|
+
* The placeMembershipType identifier
|
|
35025
|
+
*/
|
|
35026
|
+
readonly placeMembershipTypeId: string
|
|
35027
|
+
}
|
|
35028
|
+
|
|
35029
|
+
/**
|
|
35030
|
+
* Request parameters for getPlaceMembership operation in BookingsMembershipsApi.
|
|
35031
|
+
*/
|
|
35032
|
+
export interface BookingsMembershipsApiGetPlaceMembershipRequest {
|
|
35033
|
+
/**
|
|
35034
|
+
* The placeMembership identifier
|
|
35035
|
+
*/
|
|
35036
|
+
readonly placeMembershipId: string
|
|
35037
|
+
}
|
|
35038
|
+
|
|
35039
|
+
/**
|
|
35040
|
+
* Request parameters for getPlaceMembershipBookings operation in BookingsMembershipsApi.
|
|
35041
|
+
*/
|
|
35042
|
+
export interface BookingsMembershipsApiGetPlaceMembershipBookingsRequest {
|
|
35043
|
+
/**
|
|
35044
|
+
* The placeMembership identifier
|
|
35045
|
+
*/
|
|
35046
|
+
readonly placeMembershipId: string
|
|
35047
|
+
|
|
35048
|
+
/**
|
|
35049
|
+
* Page number
|
|
35050
|
+
*/
|
|
35051
|
+
readonly page?: number
|
|
35052
|
+
|
|
35053
|
+
/**
|
|
35054
|
+
* Number of items per page
|
|
35055
|
+
*/
|
|
35056
|
+
readonly pageSize?: number
|
|
35057
|
+
|
|
35058
|
+
/**
|
|
35059
|
+
* Field to order by
|
|
35060
|
+
*/
|
|
35061
|
+
readonly orderBy?: string
|
|
35062
|
+
|
|
35063
|
+
/**
|
|
35064
|
+
* Search query
|
|
35065
|
+
*/
|
|
35066
|
+
readonly search?: string
|
|
35067
|
+
}
|
|
35068
|
+
|
|
35069
|
+
/**
|
|
35070
|
+
* Request parameters for getPlaceMembershipMembers operation in BookingsMembershipsApi.
|
|
35071
|
+
*/
|
|
35072
|
+
export interface BookingsMembershipsApiGetPlaceMembershipMembersRequest {
|
|
35073
|
+
/**
|
|
35074
|
+
* The placeMembership identifier
|
|
35075
|
+
*/
|
|
35076
|
+
readonly placeMembershipId: string
|
|
35077
|
+
|
|
35078
|
+
/**
|
|
35079
|
+
* Page number
|
|
35080
|
+
*/
|
|
35081
|
+
readonly page?: number
|
|
35082
|
+
|
|
35083
|
+
/**
|
|
35084
|
+
* Number of items per page
|
|
35085
|
+
*/
|
|
35086
|
+
readonly pageSize?: number
|
|
35087
|
+
|
|
35088
|
+
/**
|
|
35089
|
+
* Field to order by
|
|
35090
|
+
*/
|
|
35091
|
+
readonly orderBy?: string
|
|
35092
|
+
|
|
35093
|
+
/**
|
|
35094
|
+
* Search query
|
|
35095
|
+
*/
|
|
35096
|
+
readonly search?: string
|
|
35097
|
+
}
|
|
35098
|
+
|
|
35099
|
+
/**
|
|
35100
|
+
* Request parameters for getPlaceMembershipType operation in BookingsMembershipsApi.
|
|
35101
|
+
*/
|
|
35102
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypeRequest {
|
|
35103
|
+
/**
|
|
35104
|
+
* The place identifier
|
|
35105
|
+
*/
|
|
35106
|
+
readonly placeId: string
|
|
35107
|
+
|
|
35108
|
+
/**
|
|
35109
|
+
* The placeMembershipType identifier
|
|
35110
|
+
*/
|
|
35111
|
+
readonly placeMembershipTypeId: string
|
|
35112
|
+
}
|
|
35113
|
+
|
|
35114
|
+
/**
|
|
35115
|
+
* Request parameters for getPlaceMembershipTypes operation in BookingsMembershipsApi.
|
|
35116
|
+
*/
|
|
35117
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypesRequest {
|
|
35118
|
+
/**
|
|
35119
|
+
* The place identifier
|
|
35120
|
+
*/
|
|
35121
|
+
readonly placeId: string
|
|
35122
|
+
|
|
35123
|
+
/**
|
|
35124
|
+
* Filter by archived
|
|
35125
|
+
*/
|
|
35126
|
+
readonly archived?: boolean
|
|
35127
|
+
|
|
35128
|
+
/**
|
|
35129
|
+
* Page number
|
|
35130
|
+
*/
|
|
35131
|
+
readonly page?: number
|
|
35132
|
+
|
|
35133
|
+
/**
|
|
35134
|
+
* Number of items per page
|
|
35135
|
+
*/
|
|
35136
|
+
readonly pageSize?: number
|
|
35137
|
+
|
|
35138
|
+
/**
|
|
35139
|
+
* Field to order by
|
|
35140
|
+
*/
|
|
35141
|
+
readonly orderBy?: string
|
|
35142
|
+
|
|
35143
|
+
/**
|
|
35144
|
+
* Search query
|
|
35145
|
+
*/
|
|
35146
|
+
readonly search?: string
|
|
35147
|
+
}
|
|
35148
|
+
|
|
35149
|
+
/**
|
|
35150
|
+
* Request parameters for getPlaceMemberships operation in BookingsMembershipsApi.
|
|
35151
|
+
*/
|
|
35152
|
+
export interface BookingsMembershipsApiGetPlaceMembershipsRequest {
|
|
35153
|
+
/**
|
|
35154
|
+
* The place identifier
|
|
35155
|
+
*/
|
|
35156
|
+
readonly placeId: string
|
|
35157
|
+
|
|
35158
|
+
/**
|
|
35159
|
+
* Filter by placeMembershipTypeId
|
|
35160
|
+
*/
|
|
35161
|
+
readonly placeMembershipTypeId?: string
|
|
35162
|
+
|
|
35163
|
+
/**
|
|
35164
|
+
* Filter by status
|
|
35165
|
+
*/
|
|
35166
|
+
readonly status?: PurchaseStatus
|
|
35167
|
+
|
|
35168
|
+
/**
|
|
35169
|
+
* Filter by active
|
|
35170
|
+
*/
|
|
35171
|
+
readonly active?: boolean
|
|
35172
|
+
|
|
35173
|
+
/**
|
|
35174
|
+
* Filter by upcoming
|
|
35175
|
+
*/
|
|
35176
|
+
readonly upcoming?: boolean
|
|
35177
|
+
|
|
35178
|
+
/**
|
|
35179
|
+
* Filter by expired
|
|
35180
|
+
*/
|
|
35181
|
+
readonly expired?: boolean
|
|
35182
|
+
|
|
35183
|
+
/**
|
|
35184
|
+
* Page number
|
|
35185
|
+
*/
|
|
35186
|
+
readonly page?: number
|
|
35187
|
+
|
|
35188
|
+
/**
|
|
35189
|
+
* Number of items per page
|
|
35190
|
+
*/
|
|
35191
|
+
readonly pageSize?: number
|
|
35192
|
+
|
|
35193
|
+
/**
|
|
35194
|
+
* Field to order by
|
|
35195
|
+
*/
|
|
35196
|
+
readonly orderBy?: string
|
|
35197
|
+
|
|
35198
|
+
/**
|
|
35199
|
+
* Search query
|
|
35200
|
+
*/
|
|
35201
|
+
readonly search?: string
|
|
35202
|
+
}
|
|
35203
|
+
|
|
35204
|
+
/**
|
|
35205
|
+
* Request parameters for updatePlaceMembership operation in BookingsMembershipsApi.
|
|
35206
|
+
*/
|
|
35207
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipRequest {
|
|
35208
|
+
/**
|
|
35209
|
+
* The placeMembership identifier
|
|
35210
|
+
*/
|
|
35211
|
+
readonly placeMembershipId: string
|
|
35212
|
+
|
|
35213
|
+
readonly placeMembershipUpdateInputs: PlaceMembershipUpdateInputs
|
|
35214
|
+
}
|
|
35215
|
+
|
|
35216
|
+
/**
|
|
35217
|
+
* Request parameters for updatePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
35218
|
+
*/
|
|
35219
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipMemberRequest {
|
|
35220
|
+
/**
|
|
35221
|
+
* The placeMembership identifier
|
|
35222
|
+
*/
|
|
35223
|
+
readonly placeMembershipId: string
|
|
35224
|
+
|
|
35225
|
+
/**
|
|
35226
|
+
* The placeMembershipMember identifier
|
|
35227
|
+
*/
|
|
35228
|
+
readonly placeMembershipMemberId: string
|
|
35229
|
+
|
|
35230
|
+
readonly placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs
|
|
35231
|
+
}
|
|
35232
|
+
|
|
35233
|
+
/**
|
|
35234
|
+
* Request parameters for updatePlaceMembershipType operation in BookingsMembershipsApi.
|
|
35235
|
+
*/
|
|
35236
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipTypeRequest {
|
|
35237
|
+
/**
|
|
35238
|
+
* The place identifier
|
|
35239
|
+
*/
|
|
35240
|
+
readonly placeId: string
|
|
35241
|
+
|
|
35242
|
+
/**
|
|
35243
|
+
* The placeMembershipType identifier
|
|
35244
|
+
*/
|
|
35245
|
+
readonly placeMembershipTypeId: string
|
|
35246
|
+
|
|
35247
|
+
readonly placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs
|
|
35248
|
+
}
|
|
35249
|
+
|
|
35250
|
+
/**
|
|
35251
|
+
* BookingsMembershipsApi - object-oriented interface
|
|
35252
|
+
*/
|
|
35253
|
+
export class BookingsMembershipsApi extends BaseAPI {
|
|
35254
|
+
/**
|
|
35255
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
35256
|
+
* @summary Grant a place membership
|
|
35257
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
35258
|
+
* @param {*} [options] Override http request option.
|
|
35259
|
+
* @throws {RequiredError}
|
|
35260
|
+
*/
|
|
35261
|
+
public createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35262
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35263
|
+
}
|
|
35264
|
+
|
|
35265
|
+
/**
|
|
35266
|
+
* 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.
|
|
35267
|
+
* @summary Add a member to a place membership
|
|
35268
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35269
|
+
* @param {*} [options] Override http request option.
|
|
35270
|
+
* @throws {RequiredError}
|
|
35271
|
+
*/
|
|
35272
|
+
public createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35273
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35274
|
+
}
|
|
35275
|
+
|
|
35276
|
+
/**
|
|
35277
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
35278
|
+
* @summary Create a place membership type
|
|
35279
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35280
|
+
* @param {*} [options] Override http request option.
|
|
35281
|
+
* @throws {RequiredError}
|
|
35282
|
+
*/
|
|
35283
|
+
public createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35284
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35285
|
+
}
|
|
35286
|
+
|
|
35287
|
+
/**
|
|
35288
|
+
* 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.
|
|
35289
|
+
* @summary Remove a member from a place membership
|
|
35290
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35291
|
+
* @param {*} [options] Override http request option.
|
|
35292
|
+
* @throws {RequiredError}
|
|
35293
|
+
*/
|
|
35294
|
+
public deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35295
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(this.axios, this.basePath));
|
|
35296
|
+
}
|
|
35297
|
+
|
|
35298
|
+
/**
|
|
35299
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
35300
|
+
* @summary Delete a place membership type
|
|
35301
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35302
|
+
* @param {*} [options] Override http request option.
|
|
35303
|
+
* @throws {RequiredError}
|
|
35304
|
+
*/
|
|
35305
|
+
public deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35306
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
35307
|
+
}
|
|
35308
|
+
|
|
35309
|
+
/**
|
|
35310
|
+
* 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\".
|
|
35311
|
+
* @summary Get a place membership
|
|
35312
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
35313
|
+
* @param {*} [options] Override http request option.
|
|
35314
|
+
* @throws {RequiredError}
|
|
35315
|
+
*/
|
|
35316
|
+
public getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35317
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(this.axios, this.basePath));
|
|
35318
|
+
}
|
|
35319
|
+
|
|
35320
|
+
/**
|
|
35321
|
+
* 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\".
|
|
35322
|
+
* @summary List bookings that applied a place membership
|
|
35323
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
35324
|
+
* @param {*} [options] Override http request option.
|
|
35325
|
+
* @throws {RequiredError}
|
|
35326
|
+
*/
|
|
35327
|
+
public getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig) {
|
|
35328
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35329
|
+
}
|
|
35330
|
+
|
|
35331
|
+
/**
|
|
35332
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
35333
|
+
* @summary List a place membership\'s members
|
|
35334
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
35335
|
+
* @param {*} [options] Override http request option.
|
|
35336
|
+
* @throws {RequiredError}
|
|
35337
|
+
*/
|
|
35338
|
+
public getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig) {
|
|
35339
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
35340
|
+
}
|
|
35341
|
+
|
|
35342
|
+
/**
|
|
35343
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
35344
|
+
* @summary Get a place membership type
|
|
35345
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35346
|
+
* @param {*} [options] Override http request option.
|
|
35347
|
+
* @throws {RequiredError}
|
|
35348
|
+
*/
|
|
35349
|
+
public getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35350
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
35351
|
+
}
|
|
35352
|
+
|
|
35353
|
+
/**
|
|
35354
|
+
* 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\".
|
|
35355
|
+
* @summary List a place\'s membership types
|
|
35356
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
35357
|
+
* @param {*} [options] Override http request option.
|
|
35358
|
+
* @throws {RequiredError}
|
|
35359
|
+
*/
|
|
35360
|
+
public getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig) {
|
|
35361
|
+
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));
|
|
35362
|
+
}
|
|
35363
|
+
|
|
35364
|
+
/**
|
|
35365
|
+
* 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\".
|
|
35366
|
+
* @summary List a place\'s memberships
|
|
35367
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
35368
|
+
* @param {*} [options] Override http request option.
|
|
35369
|
+
* @throws {RequiredError}
|
|
35370
|
+
*/
|
|
35371
|
+
public getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig) {
|
|
35372
|
+
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));
|
|
35373
|
+
}
|
|
35374
|
+
|
|
35375
|
+
/**
|
|
35376
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
35377
|
+
* @summary Update a place membership
|
|
35378
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
35379
|
+
* @param {*} [options] Override http request option.
|
|
35380
|
+
* @throws {RequiredError}
|
|
35381
|
+
*/
|
|
35382
|
+
public updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig) {
|
|
35383
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35384
|
+
}
|
|
35385
|
+
|
|
35386
|
+
/**
|
|
35387
|
+
* 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.
|
|
35388
|
+
* @summary Update a place membership member
|
|
35389
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
35390
|
+
* @param {*} [options] Override http request option.
|
|
35391
|
+
* @throws {RequiredError}
|
|
35392
|
+
*/
|
|
35393
|
+
public updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig) {
|
|
35394
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35395
|
+
}
|
|
35396
|
+
|
|
35397
|
+
/**
|
|
35398
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
35399
|
+
* @summary Update a place membership type
|
|
35400
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
35401
|
+
* @param {*} [options] Override http request option.
|
|
35402
|
+
* @throws {RequiredError}
|
|
35403
|
+
*/
|
|
35404
|
+
public updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig) {
|
|
35405
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35406
|
+
}
|
|
35407
|
+
}
|
|
35408
|
+
|
|
35409
|
+
|
|
35410
|
+
|
|
35411
|
+
/**
|
|
35412
|
+
* BookingsMembershipsTranslationsApi - axios parameter creator
|
|
35413
|
+
*/
|
|
35414
|
+
export const BookingsMembershipsTranslationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35415
|
+
return {
|
|
35416
|
+
/**
|
|
35417
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35418
|
+
* @summary Delete a place membership type translation
|
|
35419
|
+
* @param {string} placeId The place identifier
|
|
35420
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35421
|
+
* @param {string} locale The locale identifier
|
|
35422
|
+
* @param {*} [options] Override http request option.
|
|
35423
|
+
* @throws {RequiredError}
|
|
35424
|
+
*/
|
|
35425
|
+
deletePlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35426
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35427
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35428
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35429
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35430
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35431
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'locale', locale)
|
|
35432
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35433
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35434
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35435
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35436
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35437
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35438
|
+
let baseOptions;
|
|
35439
|
+
if (configuration) {
|
|
35440
|
+
baseOptions = configuration.baseOptions;
|
|
35441
|
+
}
|
|
35442
|
+
|
|
35443
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
35444
|
+
const localVarHeaderParameter = {} as any;
|
|
35445
|
+
const localVarQueryParameter = {} as any;
|
|
35446
|
+
|
|
35447
|
+
// authentication ApiKeyAuth required
|
|
35448
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35449
|
+
|
|
35450
|
+
// authentication OrganizationId required
|
|
35451
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35452
|
+
|
|
35453
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35454
|
+
|
|
35455
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35456
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35457
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35458
|
+
|
|
35459
|
+
return {
|
|
35460
|
+
url: toPathString(localVarUrlObj),
|
|
35461
|
+
options: localVarRequestOptions,
|
|
35462
|
+
};
|
|
35463
|
+
},
|
|
35464
|
+
/**
|
|
35465
|
+
* 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\".
|
|
35466
|
+
* @summary Get a place membership type\'s translation
|
|
35467
|
+
* @param {string} placeId The place identifier
|
|
35468
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35469
|
+
* @param {string} locale The locale identifier
|
|
35470
|
+
* @param {*} [options] Override http request option.
|
|
35471
|
+
* @throws {RequiredError}
|
|
35472
|
+
*/
|
|
35473
|
+
getPlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35474
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35475
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35476
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35477
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35478
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35479
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'locale', locale)
|
|
35480
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35481
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35482
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35483
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35484
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35485
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35486
|
+
let baseOptions;
|
|
35487
|
+
if (configuration) {
|
|
35488
|
+
baseOptions = configuration.baseOptions;
|
|
35489
|
+
}
|
|
35490
|
+
|
|
35491
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35492
|
+
const localVarHeaderParameter = {} as any;
|
|
35493
|
+
const localVarQueryParameter = {} as any;
|
|
35494
|
+
|
|
35495
|
+
// authentication ApiKeyAuth required
|
|
35496
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35497
|
+
|
|
35498
|
+
// authentication OrganizationId required
|
|
35499
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35500
|
+
|
|
35501
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35502
|
+
|
|
35503
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35504
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35505
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35506
|
+
|
|
35507
|
+
return {
|
|
35508
|
+
url: toPathString(localVarUrlObj),
|
|
35509
|
+
options: localVarRequestOptions,
|
|
35510
|
+
};
|
|
35511
|
+
},
|
|
35512
|
+
/**
|
|
35513
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35514
|
+
* @summary List a place membership type\'s translations
|
|
35515
|
+
* @param {string} placeId The place identifier
|
|
35516
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35517
|
+
* @param {number} [page] Page number
|
|
35518
|
+
* @param {number} [pageSize] Number of items per page
|
|
35519
|
+
* @param {string} [orderBy] Field to order by
|
|
35520
|
+
* @param {string} [search] Search query
|
|
35521
|
+
* @param {*} [options] Override http request option.
|
|
35522
|
+
* @throws {RequiredError}
|
|
35523
|
+
*/
|
|
35524
|
+
getPlaceMembershipTypeTranslations: async (placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35525
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35526
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeId', placeId)
|
|
35527
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35528
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35529
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations`
|
|
35530
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35531
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
35532
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35533
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35534
|
+
let baseOptions;
|
|
35535
|
+
if (configuration) {
|
|
35536
|
+
baseOptions = configuration.baseOptions;
|
|
35537
|
+
}
|
|
35538
|
+
|
|
35539
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35540
|
+
const localVarHeaderParameter = {} as any;
|
|
35541
|
+
const localVarQueryParameter = {} as any;
|
|
35542
|
+
|
|
35543
|
+
// authentication ApiKeyAuth required
|
|
35544
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35545
|
+
|
|
35546
|
+
// authentication OrganizationId required
|
|
35547
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35548
|
+
|
|
35549
|
+
if (page !== undefined) {
|
|
35550
|
+
localVarQueryParameter['page'] = page;
|
|
35551
|
+
}
|
|
35552
|
+
|
|
35553
|
+
if (pageSize !== undefined) {
|
|
35554
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
35555
|
+
}
|
|
35556
|
+
|
|
35557
|
+
if (orderBy !== undefined) {
|
|
35558
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
35559
|
+
}
|
|
35560
|
+
|
|
35561
|
+
if (search !== undefined) {
|
|
35562
|
+
localVarQueryParameter['search'] = search;
|
|
35563
|
+
}
|
|
35564
|
+
|
|
35565
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35566
|
+
|
|
35567
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35568
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35569
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35570
|
+
|
|
35571
|
+
return {
|
|
35572
|
+
url: toPathString(localVarUrlObj),
|
|
35573
|
+
options: localVarRequestOptions,
|
|
35574
|
+
};
|
|
35575
|
+
},
|
|
35576
|
+
/**
|
|
35577
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35578
|
+
* @summary Update a place membership type\'s translation
|
|
35579
|
+
* @param {string} placeId The place identifier
|
|
35580
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35581
|
+
* @param {string} locale The locale identifier
|
|
35582
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
35583
|
+
* @param {*} [options] Override http request option.
|
|
35584
|
+
* @throws {RequiredError}
|
|
35585
|
+
*/
|
|
35586
|
+
updatePlaceMembershipTypeTranslation: async (placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35587
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35588
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeId', placeId)
|
|
35589
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
35590
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId)
|
|
35591
|
+
// verify required parameter 'locale' is not null or undefined
|
|
35592
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'locale', locale)
|
|
35593
|
+
// verify required parameter 'placeMembershipTypeTranslationUpdateInputs' is not null or undefined
|
|
35594
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeTranslationUpdateInputs', placeMembershipTypeTranslationUpdateInputs)
|
|
35595
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
35596
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
35597
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
35598
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
35599
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35600
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35601
|
+
let baseOptions;
|
|
35602
|
+
if (configuration) {
|
|
35603
|
+
baseOptions = configuration.baseOptions;
|
|
35604
|
+
}
|
|
35605
|
+
|
|
35606
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
35607
|
+
const localVarHeaderParameter = {} as any;
|
|
35608
|
+
const localVarQueryParameter = {} as any;
|
|
35609
|
+
|
|
35610
|
+
// authentication ApiKeyAuth required
|
|
35611
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35612
|
+
|
|
35613
|
+
// authentication OrganizationId required
|
|
35614
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35615
|
+
|
|
35616
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35617
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35618
|
+
|
|
35619
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35620
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35621
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35622
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeTranslationUpdateInputs, localVarRequestOptions, configuration)
|
|
35623
|
+
|
|
35624
|
+
return {
|
|
35625
|
+
url: toPathString(localVarUrlObj),
|
|
35626
|
+
options: localVarRequestOptions,
|
|
35627
|
+
};
|
|
35628
|
+
},
|
|
35629
|
+
}
|
|
35630
|
+
};
|
|
35631
|
+
|
|
35632
|
+
/**
|
|
35633
|
+
* BookingsMembershipsTranslationsApi - functional programming interface
|
|
35634
|
+
*/
|
|
35635
|
+
export const BookingsMembershipsTranslationsApiFp = function(configuration?: Configuration) {
|
|
35636
|
+
const localVarAxiosParamCreator = BookingsMembershipsTranslationsApiAxiosParamCreator(configuration)
|
|
35637
|
+
return {
|
|
35638
|
+
/**
|
|
35639
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35640
|
+
* @summary Delete a place membership type translation
|
|
35641
|
+
* @param {string} placeId The place identifier
|
|
35642
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35643
|
+
* @param {string} locale The locale identifier
|
|
35644
|
+
* @param {*} [options] Override http request option.
|
|
35645
|
+
* @throws {RequiredError}
|
|
35646
|
+
*/
|
|
35647
|
+
async deletePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
35648
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deletePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
35649
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35650
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.deletePlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35651
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35652
|
+
},
|
|
35653
|
+
/**
|
|
35654
|
+
* 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\".
|
|
35655
|
+
* @summary Get a place membership type\'s translation
|
|
35656
|
+
* @param {string} placeId The place identifier
|
|
35657
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35658
|
+
* @param {string} locale The locale identifier
|
|
35659
|
+
* @param {*} [options] Override http request option.
|
|
35660
|
+
* @throws {RequiredError}
|
|
35661
|
+
*/
|
|
35662
|
+
async getPlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslation200Response>> {
|
|
35663
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
35664
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35665
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35666
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35667
|
+
},
|
|
35668
|
+
/**
|
|
35669
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35670
|
+
* @summary List a place membership type\'s translations
|
|
35671
|
+
* @param {string} placeId The place identifier
|
|
35672
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35673
|
+
* @param {number} [page] Page number
|
|
35674
|
+
* @param {number} [pageSize] Number of items per page
|
|
35675
|
+
* @param {string} [orderBy] Field to order by
|
|
35676
|
+
* @param {string} [search] Search query
|
|
35677
|
+
* @param {*} [options] Override http request option.
|
|
35678
|
+
* @throws {RequiredError}
|
|
35679
|
+
*/
|
|
35680
|
+
async getPlaceMembershipTypeTranslations(placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslations200Response>> {
|
|
35681
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlaceMembershipTypeTranslations(placeId, placeMembershipTypeId, page, pageSize, orderBy, search, options);
|
|
35682
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35683
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslations']?.[localVarOperationServerIndex]?.url;
|
|
35684
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35685
|
+
},
|
|
35686
|
+
/**
|
|
35687
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35688
|
+
* @summary Update a place membership type\'s translation
|
|
35689
|
+
* @param {string} placeId The place identifier
|
|
35690
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
35691
|
+
* @param {string} locale The locale identifier
|
|
35692
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
35693
|
+
* @param {*} [options] Override http request option.
|
|
35694
|
+
* @throws {RequiredError}
|
|
35695
|
+
*/
|
|
35696
|
+
async updatePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>> {
|
|
35697
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, placeMembershipTypeTranslationUpdateInputs, options);
|
|
35698
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
35699
|
+
const localVarOperationServerBasePath = operationServerMap['BookingsMembershipsTranslationsApi.updatePlaceMembershipTypeTranslation']?.[localVarOperationServerIndex]?.url;
|
|
35700
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
35701
|
+
},
|
|
35702
|
+
}
|
|
35703
|
+
};
|
|
35704
|
+
|
|
35705
|
+
/**
|
|
35706
|
+
* BookingsMembershipsTranslationsApi - factory interface
|
|
35707
|
+
*/
|
|
35708
|
+
export const BookingsMembershipsTranslationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
35709
|
+
const localVarFp = BookingsMembershipsTranslationsApiFp(configuration)
|
|
35710
|
+
return {
|
|
35711
|
+
/**
|
|
35712
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35713
|
+
* @summary Delete a place membership type translation
|
|
35714
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35715
|
+
* @param {*} [options] Override http request option.
|
|
35716
|
+
* @throws {RequiredError}
|
|
35717
|
+
*/
|
|
35718
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
35719
|
+
return localVarFp.deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
35720
|
+
},
|
|
35721
|
+
/**
|
|
35722
|
+
* 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\".
|
|
35723
|
+
* @summary Get a place membership type\'s translation
|
|
35724
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35725
|
+
* @param {*} [options] Override http request option.
|
|
35726
|
+
* @throws {RequiredError}
|
|
35727
|
+
*/
|
|
35728
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslation200Response> {
|
|
35729
|
+
return localVarFp.getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
35730
|
+
},
|
|
35731
|
+
/**
|
|
35732
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35733
|
+
* @summary List a place membership type\'s translations
|
|
35734
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
35735
|
+
* @param {*} [options] Override http request option.
|
|
35736
|
+
* @throws {RequiredError}
|
|
35737
|
+
*/
|
|
35738
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslations200Response> {
|
|
35739
|
+
return localVarFp.getPlaceMembershipTypeTranslations(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
35740
|
+
},
|
|
35741
|
+
/**
|
|
35742
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35743
|
+
* @summary Update a place membership type\'s translation
|
|
35744
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35745
|
+
* @param {*} [options] Override http request option.
|
|
35746
|
+
* @throws {RequiredError}
|
|
35747
|
+
*/
|
|
35748
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response> {
|
|
35749
|
+
return localVarFp.updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(axios, basePath));
|
|
35750
|
+
},
|
|
35751
|
+
};
|
|
35752
|
+
};
|
|
35753
|
+
|
|
35754
|
+
/**
|
|
35755
|
+
* Request parameters for deletePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35756
|
+
*/
|
|
35757
|
+
export interface BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest {
|
|
35758
|
+
/**
|
|
35759
|
+
* The place identifier
|
|
35760
|
+
*/
|
|
35761
|
+
readonly placeId: string
|
|
35762
|
+
|
|
35763
|
+
/**
|
|
35764
|
+
* The placeMembershipType identifier
|
|
35765
|
+
*/
|
|
35766
|
+
readonly placeMembershipTypeId: string
|
|
35767
|
+
|
|
35768
|
+
/**
|
|
35769
|
+
* The locale identifier
|
|
35770
|
+
*/
|
|
35771
|
+
readonly locale: string
|
|
35772
|
+
}
|
|
35773
|
+
|
|
35774
|
+
/**
|
|
35775
|
+
* Request parameters for getPlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35776
|
+
*/
|
|
35777
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest {
|
|
35778
|
+
/**
|
|
35779
|
+
* The place identifier
|
|
35780
|
+
*/
|
|
35781
|
+
readonly placeId: string
|
|
35782
|
+
|
|
35783
|
+
/**
|
|
35784
|
+
* The placeMembershipType identifier
|
|
35785
|
+
*/
|
|
35786
|
+
readonly placeMembershipTypeId: string
|
|
35787
|
+
|
|
35788
|
+
/**
|
|
35789
|
+
* The locale identifier
|
|
35790
|
+
*/
|
|
35791
|
+
readonly locale: string
|
|
35792
|
+
}
|
|
35793
|
+
|
|
35794
|
+
/**
|
|
35795
|
+
* Request parameters for getPlaceMembershipTypeTranslations operation in BookingsMembershipsTranslationsApi.
|
|
35796
|
+
*/
|
|
35797
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest {
|
|
35798
|
+
/**
|
|
35799
|
+
* The place identifier
|
|
35800
|
+
*/
|
|
35801
|
+
readonly placeId: string
|
|
35802
|
+
|
|
35803
|
+
/**
|
|
35804
|
+
* The placeMembershipType identifier
|
|
35805
|
+
*/
|
|
35806
|
+
readonly placeMembershipTypeId: string
|
|
35807
|
+
|
|
35808
|
+
/**
|
|
35809
|
+
* Page number
|
|
35810
|
+
*/
|
|
35811
|
+
readonly page?: number
|
|
35812
|
+
|
|
35813
|
+
/**
|
|
35814
|
+
* Number of items per page
|
|
35815
|
+
*/
|
|
35816
|
+
readonly pageSize?: number
|
|
35817
|
+
|
|
35818
|
+
/**
|
|
35819
|
+
* Field to order by
|
|
35820
|
+
*/
|
|
35821
|
+
readonly orderBy?: string
|
|
35822
|
+
|
|
35823
|
+
/**
|
|
35824
|
+
* Search query
|
|
35825
|
+
*/
|
|
35826
|
+
readonly search?: string
|
|
35827
|
+
}
|
|
35828
|
+
|
|
35829
|
+
/**
|
|
35830
|
+
* Request parameters for updatePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
35831
|
+
*/
|
|
35832
|
+
export interface BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest {
|
|
35833
|
+
/**
|
|
35834
|
+
* The place identifier
|
|
35835
|
+
*/
|
|
35836
|
+
readonly placeId: string
|
|
35837
|
+
|
|
35838
|
+
/**
|
|
35839
|
+
* The placeMembershipType identifier
|
|
35840
|
+
*/
|
|
35841
|
+
readonly placeMembershipTypeId: string
|
|
35842
|
+
|
|
35843
|
+
/**
|
|
35844
|
+
* The locale identifier
|
|
35845
|
+
*/
|
|
35846
|
+
readonly locale: string
|
|
35847
|
+
|
|
35848
|
+
readonly placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs
|
|
35849
|
+
}
|
|
35850
|
+
|
|
35851
|
+
/**
|
|
35852
|
+
* BookingsMembershipsTranslationsApi - object-oriented interface
|
|
35853
|
+
*/
|
|
35854
|
+
export class BookingsMembershipsTranslationsApi extends BaseAPI {
|
|
35855
|
+
/**
|
|
35856
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
35857
|
+
* @summary Delete a place membership type translation
|
|
35858
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35859
|
+
* @param {*} [options] Override http request option.
|
|
35860
|
+
* @throws {RequiredError}
|
|
35861
|
+
*/
|
|
35862
|
+
public deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35863
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
35864
|
+
}
|
|
35865
|
+
|
|
35866
|
+
/**
|
|
35867
|
+
* 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\".
|
|
35868
|
+
* @summary Get a place membership type\'s translation
|
|
35869
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35870
|
+
* @param {*} [options] Override http request option.
|
|
35871
|
+
* @throws {RequiredError}
|
|
35872
|
+
*/
|
|
35873
|
+
public getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35874
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
35875
|
+
}
|
|
35876
|
+
|
|
35877
|
+
/**
|
|
35878
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
35879
|
+
* @summary List a place membership type\'s translations
|
|
35880
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
35881
|
+
* @param {*} [options] Override http request option.
|
|
35882
|
+
* @throws {RequiredError}
|
|
35883
|
+
*/
|
|
35884
|
+
public getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig) {
|
|
35885
|
+
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));
|
|
35886
|
+
}
|
|
35887
|
+
|
|
35888
|
+
/**
|
|
35889
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
35890
|
+
* @summary Update a place membership type\'s translation
|
|
35891
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
35892
|
+
* @param {*} [options] Override http request option.
|
|
35893
|
+
* @throws {RequiredError}
|
|
35894
|
+
*/
|
|
35895
|
+
public updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig) {
|
|
35896
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
35897
|
+
}
|
|
35898
|
+
}
|
|
35899
|
+
|
|
35900
|
+
|
|
35901
|
+
|
|
35902
|
+
/**
|
|
35903
|
+
* BookingsPlacesApi - axios parameter creator
|
|
35904
|
+
*/
|
|
35905
|
+
export const BookingsPlacesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
35906
|
+
return {
|
|
35907
|
+
/**
|
|
35908
|
+
* Creates a new booking place (a bookable location such as a venue or facility) for the organization, requires the update bookings permission.
|
|
35909
|
+
* @summary Create a booking place
|
|
35910
|
+
* @param {BookingPlaceCreateInputs} bookingPlaceCreateInputs
|
|
35911
|
+
* @param {*} [options] Override http request option.
|
|
35912
|
+
* @throws {RequiredError}
|
|
35913
|
+
*/
|
|
35914
|
+
createBookingPlace: async (bookingPlaceCreateInputs: BookingPlaceCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35915
|
+
// verify required parameter 'bookingPlaceCreateInputs' is not null or undefined
|
|
35916
|
+
assertParamExists('createBookingPlace', 'bookingPlaceCreateInputs', bookingPlaceCreateInputs)
|
|
35917
|
+
const localVarPath = `/bookings/places`;
|
|
35918
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35919
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35920
|
+
let baseOptions;
|
|
35921
|
+
if (configuration) {
|
|
35922
|
+
baseOptions = configuration.baseOptions;
|
|
35923
|
+
}
|
|
35924
|
+
|
|
35925
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
35926
|
+
const localVarHeaderParameter = {} as any;
|
|
35927
|
+
const localVarQueryParameter = {} as any;
|
|
35928
|
+
|
|
35929
|
+
// authentication ApiKeyAuth required
|
|
35930
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
35931
|
+
|
|
35932
|
+
// authentication OrganizationId required
|
|
35933
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
35934
|
+
|
|
35935
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
35936
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
35937
|
+
|
|
35938
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35939
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35940
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35941
|
+
localVarRequestOptions.data = serializeDataIfNeeded(bookingPlaceCreateInputs, localVarRequestOptions, configuration)
|
|
35942
|
+
|
|
35943
|
+
return {
|
|
35944
|
+
url: toPathString(localVarUrlObj),
|
|
35945
|
+
options: localVarRequestOptions,
|
|
35946
|
+
};
|
|
35947
|
+
},
|
|
35948
|
+
/**
|
|
35949
|
+
* Permanently deletes a booking place from the organization by its ID, requires the update bookings permission.
|
|
35950
|
+
* @summary Delete a booking place
|
|
35951
|
+
* @param {string} placeId The place identifier
|
|
35952
|
+
* @param {*} [options] Override http request option.
|
|
35953
|
+
* @throws {RequiredError}
|
|
35954
|
+
*/
|
|
35955
|
+
deleteBookingPlace: async (placeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35956
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
35957
|
+
assertParamExists('deleteBookingPlace', 'placeId', placeId)
|
|
35958
|
+
const localVarPath = `/bookings/places/{placeId}`
|
|
33631
35959
|
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
33632
35960
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
33633
35961
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -148251,7 +150579,7 @@ export const StreamsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
148251
150579
|
};
|
|
148252
150580
|
},
|
|
148253
150581
|
/**
|
|
148254
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
150582
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
148255
150583
|
* @summary Delete a stream input
|
|
148256
150584
|
* @param {string} streamId The stream identifier
|
|
148257
150585
|
* @param {*} [options] Override http request option.
|
|
@@ -148579,7 +150907,7 @@ export const StreamsApiFp = function(configuration?: Configuration) {
|
|
|
148579
150907
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
148580
150908
|
},
|
|
148581
150909
|
/**
|
|
148582
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
150910
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
148583
150911
|
* @summary Delete a stream input
|
|
148584
150912
|
* @param {string} streamId The stream identifier
|
|
148585
150913
|
* @param {*} [options] Override http request option.
|
|
@@ -148689,7 +151017,7 @@ export const StreamsApiFactory = function (configuration?: Configuration, basePa
|
|
|
148689
151017
|
return localVarFp.createStreamInput(requestParameters.streamInputCreateInputs, options).then((request) => request(axios, basePath));
|
|
148690
151018
|
},
|
|
148691
151019
|
/**
|
|
148692
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
151020
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
148693
151021
|
* @summary Delete a stream input
|
|
148694
151022
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
148695
151023
|
* @param {*} [options] Override http request option.
|
|
@@ -148893,7 +151221,7 @@ export class StreamsApi extends BaseAPI {
|
|
|
148893
151221
|
}
|
|
148894
151222
|
|
|
148895
151223
|
/**
|
|
148896
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
151224
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
148897
151225
|
* @summary Delete a stream input
|
|
148898
151226
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
148899
151227
|
* @param {*} [options] Override http request option.
|
|
@@ -149597,6 +151925,122 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
149597
151925
|
options: localVarRequestOptions,
|
|
149598
151926
|
};
|
|
149599
151927
|
},
|
|
151928
|
+
/**
|
|
151929
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
151930
|
+
* @summary Request an export of a stream session by session id
|
|
151931
|
+
* @param {string} sessionId The session identifier
|
|
151932
|
+
* @param {*} [options] Override http request option.
|
|
151933
|
+
* @throws {RequiredError}
|
|
151934
|
+
*/
|
|
151935
|
+
exportStreamSessionById: async (sessionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
151936
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
151937
|
+
assertParamExists('exportStreamSessionById', 'sessionId', sessionId)
|
|
151938
|
+
const localVarPath = `/streams/sessions/{sessionId}/export`
|
|
151939
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
151940
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151941
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
151942
|
+
let baseOptions;
|
|
151943
|
+
if (configuration) {
|
|
151944
|
+
baseOptions = configuration.baseOptions;
|
|
151945
|
+
}
|
|
151946
|
+
|
|
151947
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
151948
|
+
const localVarHeaderParameter = {} as any;
|
|
151949
|
+
const localVarQueryParameter = {} as any;
|
|
151950
|
+
|
|
151951
|
+
// authentication ApiKeyAuth required
|
|
151952
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
151953
|
+
|
|
151954
|
+
// authentication OrganizationId required
|
|
151955
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
151956
|
+
|
|
151957
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
151958
|
+
|
|
151959
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
151960
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
151961
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
151962
|
+
|
|
151963
|
+
return {
|
|
151964
|
+
url: toPathString(localVarUrlObj),
|
|
151965
|
+
options: localVarRequestOptions,
|
|
151966
|
+
};
|
|
151967
|
+
},
|
|
151968
|
+
/**
|
|
151969
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
151970
|
+
* @summary List stream sessions across all stream inputs
|
|
151971
|
+
* @param {string} [streamId] Filter by streamId
|
|
151972
|
+
* @param {string} [eventId] Filter by eventId
|
|
151973
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
151974
|
+
* @param {string} [status] Filter by status
|
|
151975
|
+
* @param {number} [page] Page number
|
|
151976
|
+
* @param {number} [pageSize] Number of items per page
|
|
151977
|
+
* @param {string} [orderBy] Field to order by
|
|
151978
|
+
* @param {string} [search] Search query
|
|
151979
|
+
* @param {*} [options] Override http request option.
|
|
151980
|
+
* @throws {RequiredError}
|
|
151981
|
+
*/
|
|
151982
|
+
getAllStreamSessions: async (streamId?: string, eventId?: string, eventSessionId?: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
151983
|
+
const localVarPath = `/streams/sessions`;
|
|
151984
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151985
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
151986
|
+
let baseOptions;
|
|
151987
|
+
if (configuration) {
|
|
151988
|
+
baseOptions = configuration.baseOptions;
|
|
151989
|
+
}
|
|
151990
|
+
|
|
151991
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
151992
|
+
const localVarHeaderParameter = {} as any;
|
|
151993
|
+
const localVarQueryParameter = {} as any;
|
|
151994
|
+
|
|
151995
|
+
// authentication ApiKeyAuth required
|
|
151996
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
151997
|
+
|
|
151998
|
+
// authentication OrganizationId required
|
|
151999
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152000
|
+
|
|
152001
|
+
if (streamId !== undefined) {
|
|
152002
|
+
localVarQueryParameter['streamId'] = streamId;
|
|
152003
|
+
}
|
|
152004
|
+
|
|
152005
|
+
if (eventId !== undefined) {
|
|
152006
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
152007
|
+
}
|
|
152008
|
+
|
|
152009
|
+
if (eventSessionId !== undefined) {
|
|
152010
|
+
localVarQueryParameter['eventSessionId'] = eventSessionId;
|
|
152011
|
+
}
|
|
152012
|
+
|
|
152013
|
+
if (status !== undefined) {
|
|
152014
|
+
localVarQueryParameter['status'] = status;
|
|
152015
|
+
}
|
|
152016
|
+
|
|
152017
|
+
if (page !== undefined) {
|
|
152018
|
+
localVarQueryParameter['page'] = page;
|
|
152019
|
+
}
|
|
152020
|
+
|
|
152021
|
+
if (pageSize !== undefined) {
|
|
152022
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
152023
|
+
}
|
|
152024
|
+
|
|
152025
|
+
if (orderBy !== undefined) {
|
|
152026
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
152027
|
+
}
|
|
152028
|
+
|
|
152029
|
+
if (search !== undefined) {
|
|
152030
|
+
localVarQueryParameter['search'] = search;
|
|
152031
|
+
}
|
|
152032
|
+
|
|
152033
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152034
|
+
|
|
152035
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152036
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152037
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152038
|
+
|
|
152039
|
+
return {
|
|
152040
|
+
url: toPathString(localVarUrlObj),
|
|
152041
|
+
options: localVarRequestOptions,
|
|
152042
|
+
};
|
|
152043
|
+
},
|
|
149600
152044
|
/**
|
|
149601
152045
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
149602
152046
|
* @summary Get a single stream session
|
|
@@ -149641,6 +152085,151 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
149641
152085
|
options: localVarRequestOptions,
|
|
149642
152086
|
};
|
|
149643
152087
|
},
|
|
152088
|
+
/**
|
|
152089
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
152090
|
+
* @summary Get a stream session by id
|
|
152091
|
+
* @param {string} sessionId The session identifier
|
|
152092
|
+
* @param {*} [options] Override http request option.
|
|
152093
|
+
* @throws {RequiredError}
|
|
152094
|
+
*/
|
|
152095
|
+
getStreamSessionById: async (sessionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152096
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152097
|
+
assertParamExists('getStreamSessionById', 'sessionId', sessionId)
|
|
152098
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
152099
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152100
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152101
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152102
|
+
let baseOptions;
|
|
152103
|
+
if (configuration) {
|
|
152104
|
+
baseOptions = configuration.baseOptions;
|
|
152105
|
+
}
|
|
152106
|
+
|
|
152107
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
152108
|
+
const localVarHeaderParameter = {} as any;
|
|
152109
|
+
const localVarQueryParameter = {} as any;
|
|
152110
|
+
|
|
152111
|
+
// authentication ApiKeyAuth required
|
|
152112
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152113
|
+
|
|
152114
|
+
// authentication OrganizationId required
|
|
152115
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152116
|
+
|
|
152117
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152118
|
+
|
|
152119
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152120
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152121
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152122
|
+
|
|
152123
|
+
return {
|
|
152124
|
+
url: toPathString(localVarUrlObj),
|
|
152125
|
+
options: localVarRequestOptions,
|
|
152126
|
+
};
|
|
152127
|
+
},
|
|
152128
|
+
/**
|
|
152129
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
152130
|
+
* @summary List a stream session\'s chat messages by session id
|
|
152131
|
+
* @param {string} sessionId The session identifier
|
|
152132
|
+
* @param {*} [options] Override http request option.
|
|
152133
|
+
* @throws {RequiredError}
|
|
152134
|
+
*/
|
|
152135
|
+
getStreamSessionByIdChat: async (sessionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152136
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152137
|
+
assertParamExists('getStreamSessionByIdChat', 'sessionId', sessionId)
|
|
152138
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat`
|
|
152139
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152140
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152141
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152142
|
+
let baseOptions;
|
|
152143
|
+
if (configuration) {
|
|
152144
|
+
baseOptions = configuration.baseOptions;
|
|
152145
|
+
}
|
|
152146
|
+
|
|
152147
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
152148
|
+
const localVarHeaderParameter = {} as any;
|
|
152149
|
+
const localVarQueryParameter = {} as any;
|
|
152150
|
+
|
|
152151
|
+
// authentication ApiKeyAuth required
|
|
152152
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152153
|
+
|
|
152154
|
+
// authentication OrganizationId required
|
|
152155
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152156
|
+
|
|
152157
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152158
|
+
|
|
152159
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152160
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152161
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152162
|
+
|
|
152163
|
+
return {
|
|
152164
|
+
url: toPathString(localVarUrlObj),
|
|
152165
|
+
options: localVarRequestOptions,
|
|
152166
|
+
};
|
|
152167
|
+
},
|
|
152168
|
+
/**
|
|
152169
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
152170
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
152171
|
+
* @param {string} sessionId The session identifier
|
|
152172
|
+
* @param {boolean} [active] Filter by active
|
|
152173
|
+
* @param {number} [page] Page number
|
|
152174
|
+
* @param {number} [pageSize] Number of items per page
|
|
152175
|
+
* @param {string} [orderBy] Field to order by
|
|
152176
|
+
* @param {string} [search] Search query
|
|
152177
|
+
* @param {*} [options] Override http request option.
|
|
152178
|
+
* @throws {RequiredError}
|
|
152179
|
+
*/
|
|
152180
|
+
getStreamSessionByIdSubscriptions: async (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152181
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152182
|
+
assertParamExists('getStreamSessionByIdSubscriptions', 'sessionId', sessionId)
|
|
152183
|
+
const localVarPath = `/streams/sessions/{sessionId}/subscriptions`
|
|
152184
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152185
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152186
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152187
|
+
let baseOptions;
|
|
152188
|
+
if (configuration) {
|
|
152189
|
+
baseOptions = configuration.baseOptions;
|
|
152190
|
+
}
|
|
152191
|
+
|
|
152192
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
152193
|
+
const localVarHeaderParameter = {} as any;
|
|
152194
|
+
const localVarQueryParameter = {} as any;
|
|
152195
|
+
|
|
152196
|
+
// authentication ApiKeyAuth required
|
|
152197
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152198
|
+
|
|
152199
|
+
// authentication OrganizationId required
|
|
152200
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152201
|
+
|
|
152202
|
+
if (active !== undefined) {
|
|
152203
|
+
localVarQueryParameter['active'] = active;
|
|
152204
|
+
}
|
|
152205
|
+
|
|
152206
|
+
if (page !== undefined) {
|
|
152207
|
+
localVarQueryParameter['page'] = page;
|
|
152208
|
+
}
|
|
152209
|
+
|
|
152210
|
+
if (pageSize !== undefined) {
|
|
152211
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
152212
|
+
}
|
|
152213
|
+
|
|
152214
|
+
if (orderBy !== undefined) {
|
|
152215
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
152216
|
+
}
|
|
152217
|
+
|
|
152218
|
+
if (search !== undefined) {
|
|
152219
|
+
localVarQueryParameter['search'] = search;
|
|
152220
|
+
}
|
|
152221
|
+
|
|
152222
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152223
|
+
|
|
152224
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152225
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152226
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152227
|
+
|
|
152228
|
+
return {
|
|
152229
|
+
url: toPathString(localVarUrlObj),
|
|
152230
|
+
options: localVarRequestOptions,
|
|
152231
|
+
};
|
|
152232
|
+
},
|
|
149644
152233
|
/**
|
|
149645
152234
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
149646
152235
|
* @summary List a stream session\'s chat messages
|
|
@@ -149814,6 +152403,51 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
149814
152403
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
149815
152404
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
149816
152405
|
|
|
152406
|
+
return {
|
|
152407
|
+
url: toPathString(localVarUrlObj),
|
|
152408
|
+
options: localVarRequestOptions,
|
|
152409
|
+
};
|
|
152410
|
+
},
|
|
152411
|
+
/**
|
|
152412
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
152413
|
+
* @summary Update a stream session
|
|
152414
|
+
* @param {string} sessionId The session identifier
|
|
152415
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
152416
|
+
* @param {*} [options] Override http request option.
|
|
152417
|
+
* @throws {RequiredError}
|
|
152418
|
+
*/
|
|
152419
|
+
updateStreamSession: async (sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152420
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152421
|
+
assertParamExists('updateStreamSession', 'sessionId', sessionId)
|
|
152422
|
+
// verify required parameter 'streamSessionUpdateInputs' is not null or undefined
|
|
152423
|
+
assertParamExists('updateStreamSession', 'streamSessionUpdateInputs', streamSessionUpdateInputs)
|
|
152424
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
152425
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152426
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152427
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152428
|
+
let baseOptions;
|
|
152429
|
+
if (configuration) {
|
|
152430
|
+
baseOptions = configuration.baseOptions;
|
|
152431
|
+
}
|
|
152432
|
+
|
|
152433
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
152434
|
+
const localVarHeaderParameter = {} as any;
|
|
152435
|
+
const localVarQueryParameter = {} as any;
|
|
152436
|
+
|
|
152437
|
+
// authentication ApiKeyAuth required
|
|
152438
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152439
|
+
|
|
152440
|
+
// authentication OrganizationId required
|
|
152441
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152442
|
+
|
|
152443
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
152444
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152445
|
+
|
|
152446
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152447
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152448
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152449
|
+
localVarRequestOptions.data = serializeDataIfNeeded(streamSessionUpdateInputs, localVarRequestOptions, configuration)
|
|
152450
|
+
|
|
149817
152451
|
return {
|
|
149818
152452
|
url: toPathString(localVarUrlObj),
|
|
149819
152453
|
options: localVarRequestOptions,
|
|
@@ -149856,6 +152490,39 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
149856
152490
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.exportStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
149857
152491
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
149858
152492
|
},
|
|
152493
|
+
/**
|
|
152494
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
152495
|
+
* @summary Request an export of a stream session by session id
|
|
152496
|
+
* @param {string} sessionId The session identifier
|
|
152497
|
+
* @param {*} [options] Override http request option.
|
|
152498
|
+
* @throws {RequiredError}
|
|
152499
|
+
*/
|
|
152500
|
+
async exportStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
152501
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportStreamSessionById(sessionId, options);
|
|
152502
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152503
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.exportStreamSessionById']?.[localVarOperationServerIndex]?.url;
|
|
152504
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152505
|
+
},
|
|
152506
|
+
/**
|
|
152507
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
152508
|
+
* @summary List stream sessions across all stream inputs
|
|
152509
|
+
* @param {string} [streamId] Filter by streamId
|
|
152510
|
+
* @param {string} [eventId] Filter by eventId
|
|
152511
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
152512
|
+
* @param {string} [status] Filter by status
|
|
152513
|
+
* @param {number} [page] Page number
|
|
152514
|
+
* @param {number} [pageSize] Number of items per page
|
|
152515
|
+
* @param {string} [orderBy] Field to order by
|
|
152516
|
+
* @param {string} [search] Search query
|
|
152517
|
+
* @param {*} [options] Override http request option.
|
|
152518
|
+
* @throws {RequiredError}
|
|
152519
|
+
*/
|
|
152520
|
+
async getAllStreamSessions(streamId?: string, eventId?: string, eventSessionId?: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>> {
|
|
152521
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllStreamSessions(streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options);
|
|
152522
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152523
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getAllStreamSessions']?.[localVarOperationServerIndex]?.url;
|
|
152524
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152525
|
+
},
|
|
149859
152526
|
/**
|
|
149860
152527
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
149861
152528
|
* @summary Get a single stream session
|
|
@@ -149864,12 +152531,56 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
149864
152531
|
* @param {*} [options] Override http request option.
|
|
149865
152532
|
* @throws {RequiredError}
|
|
149866
152533
|
*/
|
|
149867
|
-
async getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
152534
|
+
async getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>> {
|
|
149868
152535
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSession(streamId, sessionId, options);
|
|
149869
152536
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
149870
152537
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
149871
152538
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
149872
152539
|
},
|
|
152540
|
+
/**
|
|
152541
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
152542
|
+
* @summary Get a stream session by id
|
|
152543
|
+
* @param {string} sessionId The session identifier
|
|
152544
|
+
* @param {*} [options] Override http request option.
|
|
152545
|
+
* @throws {RequiredError}
|
|
152546
|
+
*/
|
|
152547
|
+
async getStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>> {
|
|
152548
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionById(sessionId, options);
|
|
152549
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152550
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionById']?.[localVarOperationServerIndex]?.url;
|
|
152551
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152552
|
+
},
|
|
152553
|
+
/**
|
|
152554
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
152555
|
+
* @summary List a stream session\'s chat messages by session id
|
|
152556
|
+
* @param {string} sessionId The session identifier
|
|
152557
|
+
* @param {*} [options] Override http request option.
|
|
152558
|
+
* @throws {RequiredError}
|
|
152559
|
+
*/
|
|
152560
|
+
async getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>> {
|
|
152561
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionByIdChat(sessionId, options);
|
|
152562
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152563
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionByIdChat']?.[localVarOperationServerIndex]?.url;
|
|
152564
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152565
|
+
},
|
|
152566
|
+
/**
|
|
152567
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
152568
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
152569
|
+
* @param {string} sessionId The session identifier
|
|
152570
|
+
* @param {boolean} [active] Filter by active
|
|
152571
|
+
* @param {number} [page] Page number
|
|
152572
|
+
* @param {number} [pageSize] Number of items per page
|
|
152573
|
+
* @param {string} [orderBy] Field to order by
|
|
152574
|
+
* @param {string} [search] Search query
|
|
152575
|
+
* @param {*} [options] Override http request option.
|
|
152576
|
+
* @throws {RequiredError}
|
|
152577
|
+
*/
|
|
152578
|
+
async getStreamSessionByIdSubscriptions(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>> {
|
|
152579
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionByIdSubscriptions(sessionId, active, page, pageSize, orderBy, search, options);
|
|
152580
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152581
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionByIdSubscriptions']?.[localVarOperationServerIndex]?.url;
|
|
152582
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152583
|
+
},
|
|
149873
152584
|
/**
|
|
149874
152585
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
149875
152586
|
* @summary List a stream session\'s chat messages
|
|
@@ -149878,7 +152589,7 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
149878
152589
|
* @param {*} [options] Override http request option.
|
|
149879
152590
|
* @throws {RequiredError}
|
|
149880
152591
|
*/
|
|
149881
|
-
async getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
152592
|
+
async getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>> {
|
|
149882
152593
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionChat(streamId, sessionId, options);
|
|
149883
152594
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
149884
152595
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionChat']?.[localVarOperationServerIndex]?.url;
|
|
@@ -149897,7 +152608,7 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
149897
152608
|
* @param {*} [options] Override http request option.
|
|
149898
152609
|
* @throws {RequiredError}
|
|
149899
152610
|
*/
|
|
149900
|
-
async getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
152611
|
+
async getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>> {
|
|
149901
152612
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionSubscriptions(streamId, sessionId, active, page, pageSize, orderBy, search, options);
|
|
149902
152613
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
149903
152614
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionSubscriptions']?.[localVarOperationServerIndex]?.url;
|
|
@@ -149915,12 +152626,26 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
149915
152626
|
* @param {*} [options] Override http request option.
|
|
149916
152627
|
* @throws {RequiredError}
|
|
149917
152628
|
*/
|
|
149918
|
-
async getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
152629
|
+
async getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>> {
|
|
149919
152630
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessions(streamId, status, page, pageSize, orderBy, search, options);
|
|
149920
152631
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
149921
152632
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessions']?.[localVarOperationServerIndex]?.url;
|
|
149922
152633
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
149923
152634
|
},
|
|
152635
|
+
/**
|
|
152636
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
152637
|
+
* @summary Update a stream session
|
|
152638
|
+
* @param {string} sessionId The session identifier
|
|
152639
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
152640
|
+
* @param {*} [options] Override http request option.
|
|
152641
|
+
* @throws {RequiredError}
|
|
152642
|
+
*/
|
|
152643
|
+
async updateStreamSession(sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>> {
|
|
152644
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamSession(sessionId, streamSessionUpdateInputs, options);
|
|
152645
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152646
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.updateStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
152647
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152648
|
+
},
|
|
149924
152649
|
}
|
|
149925
152650
|
};
|
|
149926
152651
|
|
|
@@ -149950,6 +152675,26 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
149950
152675
|
exportStreamSession(requestParameters: StreamsSessionsApiExportStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
149951
152676
|
return localVarFp.exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
149952
152677
|
},
|
|
152678
|
+
/**
|
|
152679
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
152680
|
+
* @summary Request an export of a stream session by session id
|
|
152681
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
152682
|
+
* @param {*} [options] Override http request option.
|
|
152683
|
+
* @throws {RequiredError}
|
|
152684
|
+
*/
|
|
152685
|
+
exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
152686
|
+
return localVarFp.exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
152687
|
+
},
|
|
152688
|
+
/**
|
|
152689
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
152690
|
+
* @summary List stream sessions across all stream inputs
|
|
152691
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
152692
|
+
* @param {*} [options] Override http request option.
|
|
152693
|
+
* @throws {RequiredError}
|
|
152694
|
+
*/
|
|
152695
|
+
getAllStreamSessions(requestParameters: StreamsSessionsApiGetAllStreamSessionsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response> {
|
|
152696
|
+
return localVarFp.getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152697
|
+
},
|
|
149953
152698
|
/**
|
|
149954
152699
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
149955
152700
|
* @summary Get a single stream session
|
|
@@ -149957,9 +152702,39 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
149957
152702
|
* @param {*} [options] Override http request option.
|
|
149958
152703
|
* @throws {RequiredError}
|
|
149959
152704
|
*/
|
|
149960
|
-
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
152705
|
+
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response> {
|
|
149961
152706
|
return localVarFp.getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
149962
152707
|
},
|
|
152708
|
+
/**
|
|
152709
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
152710
|
+
* @summary Get a stream session by id
|
|
152711
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
152712
|
+
* @param {*} [options] Override http request option.
|
|
152713
|
+
* @throws {RequiredError}
|
|
152714
|
+
*/
|
|
152715
|
+
getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response> {
|
|
152716
|
+
return localVarFp.getStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
152717
|
+
},
|
|
152718
|
+
/**
|
|
152719
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
152720
|
+
* @summary List a stream session\'s chat messages by session id
|
|
152721
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
152722
|
+
* @param {*} [options] Override http request option.
|
|
152723
|
+
* @throws {RequiredError}
|
|
152724
|
+
*/
|
|
152725
|
+
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response> {
|
|
152726
|
+
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
152727
|
+
},
|
|
152728
|
+
/**
|
|
152729
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
152730
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
152731
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
152732
|
+
* @param {*} [options] Override http request option.
|
|
152733
|
+
* @throws {RequiredError}
|
|
152734
|
+
*/
|
|
152735
|
+
getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response> {
|
|
152736
|
+
return localVarFp.getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152737
|
+
},
|
|
149963
152738
|
/**
|
|
149964
152739
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
149965
152740
|
* @summary List a stream session\'s chat messages
|
|
@@ -149967,7 +152742,7 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
149967
152742
|
* @param {*} [options] Override http request option.
|
|
149968
152743
|
* @throws {RequiredError}
|
|
149969
152744
|
*/
|
|
149970
|
-
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
152745
|
+
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response> {
|
|
149971
152746
|
return localVarFp.getStreamSessionChat(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
149972
152747
|
},
|
|
149973
152748
|
/**
|
|
@@ -149977,7 +152752,7 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
149977
152752
|
* @param {*} [options] Override http request option.
|
|
149978
152753
|
* @throws {RequiredError}
|
|
149979
152754
|
*/
|
|
149980
|
-
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
152755
|
+
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response> {
|
|
149981
152756
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
149982
152757
|
},
|
|
149983
152758
|
/**
|
|
@@ -149987,9 +152762,19 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
149987
152762
|
* @param {*} [options] Override http request option.
|
|
149988
152763
|
* @throws {RequiredError}
|
|
149989
152764
|
*/
|
|
149990
|
-
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
152765
|
+
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response> {
|
|
149991
152766
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
149992
152767
|
},
|
|
152768
|
+
/**
|
|
152769
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
152770
|
+
* @summary Update a stream session
|
|
152771
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
152772
|
+
* @param {*} [options] Override http request option.
|
|
152773
|
+
* @throws {RequiredError}
|
|
152774
|
+
*/
|
|
152775
|
+
updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response> {
|
|
152776
|
+
return localVarFp.updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(axios, basePath));
|
|
152777
|
+
},
|
|
149993
152778
|
};
|
|
149994
152779
|
};
|
|
149995
152780
|
|
|
@@ -150023,6 +152808,61 @@ export interface StreamsSessionsApiExportStreamSessionRequest {
|
|
|
150023
152808
|
readonly sessionId: string
|
|
150024
152809
|
}
|
|
150025
152810
|
|
|
152811
|
+
/**
|
|
152812
|
+
* Request parameters for exportStreamSessionById operation in StreamsSessionsApi.
|
|
152813
|
+
*/
|
|
152814
|
+
export interface StreamsSessionsApiExportStreamSessionByIdRequest {
|
|
152815
|
+
/**
|
|
152816
|
+
* The session identifier
|
|
152817
|
+
*/
|
|
152818
|
+
readonly sessionId: string
|
|
152819
|
+
}
|
|
152820
|
+
|
|
152821
|
+
/**
|
|
152822
|
+
* Request parameters for getAllStreamSessions operation in StreamsSessionsApi.
|
|
152823
|
+
*/
|
|
152824
|
+
export interface StreamsSessionsApiGetAllStreamSessionsRequest {
|
|
152825
|
+
/**
|
|
152826
|
+
* Filter by streamId
|
|
152827
|
+
*/
|
|
152828
|
+
readonly streamId?: string
|
|
152829
|
+
|
|
152830
|
+
/**
|
|
152831
|
+
* Filter by eventId
|
|
152832
|
+
*/
|
|
152833
|
+
readonly eventId?: string
|
|
152834
|
+
|
|
152835
|
+
/**
|
|
152836
|
+
* Filter by eventSessionId
|
|
152837
|
+
*/
|
|
152838
|
+
readonly eventSessionId?: string
|
|
152839
|
+
|
|
152840
|
+
/**
|
|
152841
|
+
* Filter by status
|
|
152842
|
+
*/
|
|
152843
|
+
readonly status?: string
|
|
152844
|
+
|
|
152845
|
+
/**
|
|
152846
|
+
* Page number
|
|
152847
|
+
*/
|
|
152848
|
+
readonly page?: number
|
|
152849
|
+
|
|
152850
|
+
/**
|
|
152851
|
+
* Number of items per page
|
|
152852
|
+
*/
|
|
152853
|
+
readonly pageSize?: number
|
|
152854
|
+
|
|
152855
|
+
/**
|
|
152856
|
+
* Field to order by
|
|
152857
|
+
*/
|
|
152858
|
+
readonly orderBy?: string
|
|
152859
|
+
|
|
152860
|
+
/**
|
|
152861
|
+
* Search query
|
|
152862
|
+
*/
|
|
152863
|
+
readonly search?: string
|
|
152864
|
+
}
|
|
152865
|
+
|
|
150026
152866
|
/**
|
|
150027
152867
|
* Request parameters for getStreamSession operation in StreamsSessionsApi.
|
|
150028
152868
|
*/
|
|
@@ -150038,6 +152878,61 @@ export interface StreamsSessionsApiGetStreamSessionRequest {
|
|
|
150038
152878
|
readonly sessionId: string
|
|
150039
152879
|
}
|
|
150040
152880
|
|
|
152881
|
+
/**
|
|
152882
|
+
* Request parameters for getStreamSessionById operation in StreamsSessionsApi.
|
|
152883
|
+
*/
|
|
152884
|
+
export interface StreamsSessionsApiGetStreamSessionByIdRequest {
|
|
152885
|
+
/**
|
|
152886
|
+
* The session identifier
|
|
152887
|
+
*/
|
|
152888
|
+
readonly sessionId: string
|
|
152889
|
+
}
|
|
152890
|
+
|
|
152891
|
+
/**
|
|
152892
|
+
* Request parameters for getStreamSessionByIdChat operation in StreamsSessionsApi.
|
|
152893
|
+
*/
|
|
152894
|
+
export interface StreamsSessionsApiGetStreamSessionByIdChatRequest {
|
|
152895
|
+
/**
|
|
152896
|
+
* The session identifier
|
|
152897
|
+
*/
|
|
152898
|
+
readonly sessionId: string
|
|
152899
|
+
}
|
|
152900
|
+
|
|
152901
|
+
/**
|
|
152902
|
+
* Request parameters for getStreamSessionByIdSubscriptions operation in StreamsSessionsApi.
|
|
152903
|
+
*/
|
|
152904
|
+
export interface StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest {
|
|
152905
|
+
/**
|
|
152906
|
+
* The session identifier
|
|
152907
|
+
*/
|
|
152908
|
+
readonly sessionId: string
|
|
152909
|
+
|
|
152910
|
+
/**
|
|
152911
|
+
* Filter by active
|
|
152912
|
+
*/
|
|
152913
|
+
readonly active?: boolean
|
|
152914
|
+
|
|
152915
|
+
/**
|
|
152916
|
+
* Page number
|
|
152917
|
+
*/
|
|
152918
|
+
readonly page?: number
|
|
152919
|
+
|
|
152920
|
+
/**
|
|
152921
|
+
* Number of items per page
|
|
152922
|
+
*/
|
|
152923
|
+
readonly pageSize?: number
|
|
152924
|
+
|
|
152925
|
+
/**
|
|
152926
|
+
* Field to order by
|
|
152927
|
+
*/
|
|
152928
|
+
readonly orderBy?: string
|
|
152929
|
+
|
|
152930
|
+
/**
|
|
152931
|
+
* Search query
|
|
152932
|
+
*/
|
|
152933
|
+
readonly search?: string
|
|
152934
|
+
}
|
|
152935
|
+
|
|
150041
152936
|
/**
|
|
150042
152937
|
* Request parameters for getStreamSessionChat operation in StreamsSessionsApi.
|
|
150043
152938
|
*/
|
|
@@ -150128,6 +153023,18 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
150128
153023
|
readonly search?: string
|
|
150129
153024
|
}
|
|
150130
153025
|
|
|
153026
|
+
/**
|
|
153027
|
+
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
153028
|
+
*/
|
|
153029
|
+
export interface StreamsSessionsApiUpdateStreamSessionRequest {
|
|
153030
|
+
/**
|
|
153031
|
+
* The session identifier
|
|
153032
|
+
*/
|
|
153033
|
+
readonly sessionId: string
|
|
153034
|
+
|
|
153035
|
+
readonly streamSessionUpdateInputs: StreamSessionUpdateInputs
|
|
153036
|
+
}
|
|
153037
|
+
|
|
150131
153038
|
/**
|
|
150132
153039
|
* StreamsSessionsApi - object-oriented interface
|
|
150133
153040
|
*/
|
|
@@ -150154,6 +153061,28 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
150154
153061
|
return StreamsSessionsApiFp(this.configuration).exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
150155
153062
|
}
|
|
150156
153063
|
|
|
153064
|
+
/**
|
|
153065
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
153066
|
+
* @summary Request an export of a stream session by session id
|
|
153067
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
153068
|
+
* @param {*} [options] Override http request option.
|
|
153069
|
+
* @throws {RequiredError}
|
|
153070
|
+
*/
|
|
153071
|
+
public exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig) {
|
|
153072
|
+
return StreamsSessionsApiFp(this.configuration).exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153073
|
+
}
|
|
153074
|
+
|
|
153075
|
+
/**
|
|
153076
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
153077
|
+
* @summary List stream sessions across all stream inputs
|
|
153078
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
153079
|
+
* @param {*} [options] Override http request option.
|
|
153080
|
+
* @throws {RequiredError}
|
|
153081
|
+
*/
|
|
153082
|
+
public getAllStreamSessions(requestParameters: StreamsSessionsApiGetAllStreamSessionsRequest = {}, options?: RawAxiosRequestConfig) {
|
|
153083
|
+
return StreamsSessionsApiFp(this.configuration).getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153084
|
+
}
|
|
153085
|
+
|
|
150157
153086
|
/**
|
|
150158
153087
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
150159
153088
|
* @summary Get a single stream session
|
|
@@ -150165,6 +153094,39 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
150165
153094
|
return StreamsSessionsApiFp(this.configuration).getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
150166
153095
|
}
|
|
150167
153096
|
|
|
153097
|
+
/**
|
|
153098
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
153099
|
+
* @summary Get a stream session by id
|
|
153100
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
153101
|
+
* @param {*} [options] Override http request option.
|
|
153102
|
+
* @throws {RequiredError}
|
|
153103
|
+
*/
|
|
153104
|
+
public getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig) {
|
|
153105
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153106
|
+
}
|
|
153107
|
+
|
|
153108
|
+
/**
|
|
153109
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
153110
|
+
* @summary List a stream session\'s chat messages by session id
|
|
153111
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
153112
|
+
* @param {*} [options] Override http request option.
|
|
153113
|
+
* @throws {RequiredError}
|
|
153114
|
+
*/
|
|
153115
|
+
public getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig) {
|
|
153116
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153117
|
+
}
|
|
153118
|
+
|
|
153119
|
+
/**
|
|
153120
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
153121
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
153122
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
153123
|
+
* @param {*} [options] Override http request option.
|
|
153124
|
+
* @throws {RequiredError}
|
|
153125
|
+
*/
|
|
153126
|
+
public getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig) {
|
|
153127
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153128
|
+
}
|
|
153129
|
+
|
|
150168
153130
|
/**
|
|
150169
153131
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
150170
153132
|
* @summary List a stream session\'s chat messages
|
|
@@ -150197,6 +153159,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
150197
153159
|
public getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig) {
|
|
150198
153160
|
return StreamsSessionsApiFp(this.configuration).getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
150199
153161
|
}
|
|
153162
|
+
|
|
153163
|
+
/**
|
|
153164
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
153165
|
+
* @summary Update a stream session
|
|
153166
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
153167
|
+
* @param {*} [options] Override http request option.
|
|
153168
|
+
* @throws {RequiredError}
|
|
153169
|
+
*/
|
|
153170
|
+
public updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig) {
|
|
153171
|
+
return StreamsSessionsApiFp(this.configuration).updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
153172
|
+
}
|
|
150200
153173
|
}
|
|
150201
153174
|
|
|
150202
153175
|
|