@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/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.5.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1247,6 +1247,8 @@ export interface BaseBooking {
|
|
|
1247
1247
|
'duration': number;
|
|
1248
1248
|
'checkedIn': string | null;
|
|
1249
1249
|
'status': PurchaseStatus;
|
|
1250
|
+
'placeMembershipId': string | null;
|
|
1251
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
1250
1252
|
'account': BaseAccount;
|
|
1251
1253
|
'space': BaseBookingSpace;
|
|
1252
1254
|
}
|
|
@@ -1262,6 +1264,11 @@ export interface BaseBookingPlace {
|
|
|
1262
1264
|
'paymentIntegrationId': string | null;
|
|
1263
1265
|
'paymentIntegration': BasePaymentIntegration | null;
|
|
1264
1266
|
}
|
|
1267
|
+
export interface BaseBookingPlaceMembership {
|
|
1268
|
+
'id': string;
|
|
1269
|
+
'expiresAt': string | null;
|
|
1270
|
+
'placeMembershipType': BasePassAttributeAttribute;
|
|
1271
|
+
}
|
|
1265
1272
|
export interface BaseBookingQuestionResponse {
|
|
1266
1273
|
'id': string;
|
|
1267
1274
|
'value': string;
|
|
@@ -1285,6 +1292,7 @@ export interface BaseBookingSpace {
|
|
|
1285
1292
|
'bookingLimitPerAccount': number | null;
|
|
1286
1293
|
'slotDuration': number;
|
|
1287
1294
|
'price': number;
|
|
1295
|
+
'membershipPrice': number | null;
|
|
1288
1296
|
'description': string | null;
|
|
1289
1297
|
'image': BaseImage | null;
|
|
1290
1298
|
'start': string | null;
|
|
@@ -2333,10 +2341,10 @@ export interface BasePayment {
|
|
|
2333
2341
|
'passId': string | null;
|
|
2334
2342
|
'sessionId': string | null;
|
|
2335
2343
|
'spaceId': string | null;
|
|
2336
|
-
'membershipId': string | null;
|
|
2337
2344
|
'couponId': string | null;
|
|
2338
2345
|
'invoiceId': string | null;
|
|
2339
2346
|
'seriesId': string | null;
|
|
2347
|
+
'placeMembershipTypeId': string | null;
|
|
2340
2348
|
'taxIntegrationCompanyCode': string | null;
|
|
2341
2349
|
'taxIntegrationCustomerId': string | null;
|
|
2342
2350
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -2369,6 +2377,8 @@ export interface BasePaymentIntent {
|
|
|
2369
2377
|
'couponId': string | null;
|
|
2370
2378
|
'invoiceId': string | null;
|
|
2371
2379
|
'seriesId': string | null;
|
|
2380
|
+
'placeMembershipTypeId': string | null;
|
|
2381
|
+
'placeMembershipId': string | null;
|
|
2372
2382
|
'address1': string | null;
|
|
2373
2383
|
'address2': string | null;
|
|
2374
2384
|
'city': string | null;
|
|
@@ -2420,6 +2430,7 @@ export interface BasePaymentIntentLineItem {
|
|
|
2420
2430
|
'bookingId': string | null;
|
|
2421
2431
|
'couponId': string | null;
|
|
2422
2432
|
'seriesRegistrationId': string | null;
|
|
2433
|
+
'placeMembershipId': string | null;
|
|
2423
2434
|
'createdAt': string;
|
|
2424
2435
|
}
|
|
2425
2436
|
export interface BasePaymentIntentTaxIntegration {
|
|
@@ -2450,6 +2461,29 @@ export interface BasePaymentLineItem {
|
|
|
2450
2461
|
'reservationId': string | null;
|
|
2451
2462
|
'accessId': string | null;
|
|
2452
2463
|
'bookingId': string | null;
|
|
2464
|
+
'placeMembershipId': string | null;
|
|
2465
|
+
}
|
|
2466
|
+
export interface BasePlaceMembership {
|
|
2467
|
+
'id': string;
|
|
2468
|
+
'status': PurchaseStatus;
|
|
2469
|
+
'startsAt': string | null;
|
|
2470
|
+
'expiresAt': string | null;
|
|
2471
|
+
'account': BaseAccount;
|
|
2472
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
2473
|
+
'createdAt': string;
|
|
2474
|
+
}
|
|
2475
|
+
export interface BasePlaceMembershipType {
|
|
2476
|
+
'id': string;
|
|
2477
|
+
'slug': string;
|
|
2478
|
+
'name': string;
|
|
2479
|
+
'description': string | null;
|
|
2480
|
+
'image': BaseImage | null;
|
|
2481
|
+
'price': number;
|
|
2482
|
+
'termDays': number;
|
|
2483
|
+
'maxMembers': number;
|
|
2484
|
+
'sortOrder': number;
|
|
2485
|
+
'visible': boolean;
|
|
2486
|
+
'archived': boolean;
|
|
2453
2487
|
}
|
|
2454
2488
|
export interface BasePreset {
|
|
2455
2489
|
'id': string;
|
|
@@ -2747,8 +2781,11 @@ export interface BaseStreamInput {
|
|
|
2747
2781
|
export interface BaseStreamSession {
|
|
2748
2782
|
'id': string;
|
|
2749
2783
|
'organizationId': string;
|
|
2750
|
-
'streamId': string;
|
|
2751
|
-
'
|
|
2784
|
+
'streamId': string | null;
|
|
2785
|
+
'name': string | null;
|
|
2786
|
+
'eventId': string | null;
|
|
2787
|
+
'eventSessionId': string | null;
|
|
2788
|
+
'status': StreamSessionStatus;
|
|
2752
2789
|
'startedAt': string | null;
|
|
2753
2790
|
'endedAt': string | null;
|
|
2754
2791
|
'createdAt': string;
|
|
@@ -3118,6 +3155,8 @@ export interface Booking {
|
|
|
3118
3155
|
'duration': number;
|
|
3119
3156
|
'checkedIn': string | null;
|
|
3120
3157
|
'status': PurchaseStatus;
|
|
3158
|
+
'placeMembershipId': string | null;
|
|
3159
|
+
'placeMembership': BaseBookingPlaceMembership | null;
|
|
3121
3160
|
'account': BaseAccount;
|
|
3122
3161
|
'space': BaseBookingSpace;
|
|
3123
3162
|
'lineItem': PaymentLineItem | null;
|
|
@@ -3226,6 +3265,7 @@ export interface BookingSpace {
|
|
|
3226
3265
|
'bookingLimitPerAccount': number | null;
|
|
3227
3266
|
'slotDuration': number;
|
|
3228
3267
|
'price': number;
|
|
3268
|
+
'membershipPrice': number | null;
|
|
3229
3269
|
'description': string | null;
|
|
3230
3270
|
'image': BaseImage | null;
|
|
3231
3271
|
'start': string | null;
|
|
@@ -3301,6 +3341,7 @@ export interface BookingSpaceCreateInputs {
|
|
|
3301
3341
|
'bookingLimitPerAccount'?: number | null;
|
|
3302
3342
|
'slotDuration': number;
|
|
3303
3343
|
'price'?: number;
|
|
3344
|
+
'membershipPrice'?: number | null;
|
|
3304
3345
|
'description'?: string | null;
|
|
3305
3346
|
'imageId'?: string | null;
|
|
3306
3347
|
'start'?: string | null;
|
|
@@ -3490,6 +3531,7 @@ export interface BookingSpaceUpdateInputs {
|
|
|
3490
3531
|
'supply'?: number;
|
|
3491
3532
|
'bookingLimitPerAccount'?: number | null;
|
|
3492
3533
|
'price'?: number;
|
|
3534
|
+
'membershipPrice'?: number | null;
|
|
3493
3535
|
'description'?: string | null;
|
|
3494
3536
|
'imageId'?: string | null;
|
|
3495
3537
|
'start'?: string | null;
|
|
@@ -4539,6 +4581,22 @@ export interface CreateOrganizationTeamMember200Response {
|
|
|
4539
4581
|
export declare enum CreateOrganizationTeamMember200ResponseStatusEnum {
|
|
4540
4582
|
Ok = "ok"
|
|
4541
4583
|
}
|
|
4584
|
+
export interface CreatePlaceMembershipMember200Response {
|
|
4585
|
+
'status': CreatePlaceMembershipMember200ResponseStatusEnum;
|
|
4586
|
+
'message': string;
|
|
4587
|
+
'data': PlaceMembershipMember;
|
|
4588
|
+
}
|
|
4589
|
+
export declare enum CreatePlaceMembershipMember200ResponseStatusEnum {
|
|
4590
|
+
Ok = "ok"
|
|
4591
|
+
}
|
|
4592
|
+
export interface CreatePlaceMembershipType200Response {
|
|
4593
|
+
'status': CreatePlaceMembershipType200ResponseStatusEnum;
|
|
4594
|
+
'message': string;
|
|
4595
|
+
'data': PlaceMembershipType;
|
|
4596
|
+
}
|
|
4597
|
+
export declare enum CreatePlaceMembershipType200ResponseStatusEnum {
|
|
4598
|
+
Ok = "ok"
|
|
4599
|
+
}
|
|
4542
4600
|
export interface CreatePreset200Response {
|
|
4543
4601
|
'status': CreatePreset200ResponseStatusEnum;
|
|
4544
4602
|
'message': string;
|
|
@@ -7233,6 +7291,15 @@ export interface GetAllAccountMerges200Response {
|
|
|
7233
7291
|
export declare enum GetAllAccountMerges200ResponseStatusEnum {
|
|
7234
7292
|
Ok = "ok"
|
|
7235
7293
|
}
|
|
7294
|
+
export interface GetAllStreamSessions200Response {
|
|
7295
|
+
'status': GetAllStreamSessions200ResponseStatusEnum;
|
|
7296
|
+
'message': string;
|
|
7297
|
+
'data': Array<StreamSession>;
|
|
7298
|
+
'count'?: number;
|
|
7299
|
+
}
|
|
7300
|
+
export declare enum GetAllStreamSessions200ResponseStatusEnum {
|
|
7301
|
+
Ok = "ok"
|
|
7302
|
+
}
|
|
7236
7303
|
export interface GetAnnouncementAudienceAccounts200Response {
|
|
7237
7304
|
'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
|
|
7238
7305
|
'message': string;
|
|
@@ -9356,6 +9423,58 @@ export interface GetPaymentTaxMetadata200Response {
|
|
|
9356
9423
|
export declare enum GetPaymentTaxMetadata200ResponseStatusEnum {
|
|
9357
9424
|
Ok = "ok"
|
|
9358
9425
|
}
|
|
9426
|
+
export interface GetPlaceMembership200Response {
|
|
9427
|
+
'status': GetPlaceMembership200ResponseStatusEnum;
|
|
9428
|
+
'message': string;
|
|
9429
|
+
'data': PlaceMembership;
|
|
9430
|
+
}
|
|
9431
|
+
export declare enum GetPlaceMembership200ResponseStatusEnum {
|
|
9432
|
+
Ok = "ok"
|
|
9433
|
+
}
|
|
9434
|
+
export interface GetPlaceMembershipMembers200Response {
|
|
9435
|
+
'status': GetPlaceMembershipMembers200ResponseStatusEnum;
|
|
9436
|
+
'message': string;
|
|
9437
|
+
'data': Array<PlaceMembershipMember>;
|
|
9438
|
+
'count'?: number;
|
|
9439
|
+
}
|
|
9440
|
+
export declare enum GetPlaceMembershipMembers200ResponseStatusEnum {
|
|
9441
|
+
Ok = "ok"
|
|
9442
|
+
}
|
|
9443
|
+
export interface GetPlaceMembershipTypeTranslation200Response {
|
|
9444
|
+
'status': GetPlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
9445
|
+
'message': string;
|
|
9446
|
+
'data': PlaceMembershipTypeTranslation | null;
|
|
9447
|
+
}
|
|
9448
|
+
export declare enum GetPlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
9449
|
+
Ok = "ok"
|
|
9450
|
+
}
|
|
9451
|
+
export interface GetPlaceMembershipTypeTranslations200Response {
|
|
9452
|
+
'status': GetPlaceMembershipTypeTranslations200ResponseStatusEnum;
|
|
9453
|
+
'message': string;
|
|
9454
|
+
'data': Array<PlaceMembershipTypeTranslation>;
|
|
9455
|
+
'count'?: number;
|
|
9456
|
+
}
|
|
9457
|
+
export declare enum GetPlaceMembershipTypeTranslations200ResponseStatusEnum {
|
|
9458
|
+
Ok = "ok"
|
|
9459
|
+
}
|
|
9460
|
+
export interface GetPlaceMembershipTypes200Response {
|
|
9461
|
+
'status': GetPlaceMembershipTypes200ResponseStatusEnum;
|
|
9462
|
+
'message': string;
|
|
9463
|
+
'data': Array<PlaceMembershipType>;
|
|
9464
|
+
'count'?: number;
|
|
9465
|
+
}
|
|
9466
|
+
export declare enum GetPlaceMembershipTypes200ResponseStatusEnum {
|
|
9467
|
+
Ok = "ok"
|
|
9468
|
+
}
|
|
9469
|
+
export interface GetPlaceMemberships200Response {
|
|
9470
|
+
'status': GetPlaceMemberships200ResponseStatusEnum;
|
|
9471
|
+
'message': string;
|
|
9472
|
+
'data': Array<PlaceMembership>;
|
|
9473
|
+
'count'?: number;
|
|
9474
|
+
}
|
|
9475
|
+
export declare enum GetPlaceMemberships200ResponseStatusEnum {
|
|
9476
|
+
Ok = "ok"
|
|
9477
|
+
}
|
|
9359
9478
|
export interface GetPreferences200Response {
|
|
9360
9479
|
'status': GetPreferences200ResponseStatusEnum;
|
|
9361
9480
|
'message': string;
|
|
@@ -9553,38 +9672,29 @@ export interface GetStreamInputs200Response {
|
|
|
9553
9672
|
export declare enum GetStreamInputs200ResponseStatusEnum {
|
|
9554
9673
|
Ok = "ok"
|
|
9555
9674
|
}
|
|
9556
|
-
export interface
|
|
9557
|
-
'status':
|
|
9675
|
+
export interface GetStreamSessionById200Response {
|
|
9676
|
+
'status': GetStreamSessionById200ResponseStatusEnum;
|
|
9558
9677
|
'message': string;
|
|
9559
9678
|
'data': StreamSession;
|
|
9560
9679
|
}
|
|
9561
|
-
export declare enum
|
|
9680
|
+
export declare enum GetStreamSessionById200ResponseStatusEnum {
|
|
9562
9681
|
Ok = "ok"
|
|
9563
9682
|
}
|
|
9564
|
-
export interface
|
|
9565
|
-
'status':
|
|
9683
|
+
export interface GetStreamSessionByIdChat200Response {
|
|
9684
|
+
'status': GetStreamSessionByIdChat200ResponseStatusEnum;
|
|
9566
9685
|
'message': string;
|
|
9567
9686
|
'data': Array<StreamSessionChatMessage>;
|
|
9568
9687
|
}
|
|
9569
|
-
export declare enum
|
|
9688
|
+
export declare enum GetStreamSessionByIdChat200ResponseStatusEnum {
|
|
9570
9689
|
Ok = "ok"
|
|
9571
9690
|
}
|
|
9572
|
-
export interface
|
|
9573
|
-
'status':
|
|
9691
|
+
export interface GetStreamSessionByIdSubscriptions200Response {
|
|
9692
|
+
'status': GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
|
|
9574
9693
|
'message': string;
|
|
9575
9694
|
'data': Array<StreamSessionSubscription>;
|
|
9576
9695
|
'count'?: number;
|
|
9577
9696
|
}
|
|
9578
|
-
export declare enum
|
|
9579
|
-
Ok = "ok"
|
|
9580
|
-
}
|
|
9581
|
-
export interface GetStreamSessions200Response {
|
|
9582
|
-
'status': GetStreamSessions200ResponseStatusEnum;
|
|
9583
|
-
'message': string;
|
|
9584
|
-
'data': Array<StreamSession>;
|
|
9585
|
-
'count'?: number;
|
|
9586
|
-
}
|
|
9587
|
-
export declare enum GetStreamSessions200ResponseStatusEnum {
|
|
9697
|
+
export declare enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
|
|
9588
9698
|
Ok = "ok"
|
|
9589
9699
|
}
|
|
9590
9700
|
export interface GetStreamVideos200Response {
|
|
@@ -11832,10 +11942,10 @@ export interface Payment {
|
|
|
11832
11942
|
'passId': string | null;
|
|
11833
11943
|
'sessionId': string | null;
|
|
11834
11944
|
'spaceId': string | null;
|
|
11835
|
-
'membershipId': string | null;
|
|
11836
11945
|
'couponId': string | null;
|
|
11837
11946
|
'invoiceId': string | null;
|
|
11838
11947
|
'seriesId': string | null;
|
|
11948
|
+
'placeMembershipTypeId': string | null;
|
|
11839
11949
|
'taxIntegrationCompanyCode': string | null;
|
|
11840
11950
|
'taxIntegrationCustomerId': string | null;
|
|
11841
11951
|
'taxIntegrationEntityUseCode': string | null;
|
|
@@ -11867,6 +11977,7 @@ export interface Payment {
|
|
|
11867
11977
|
'coupon': BaseCoupon | null;
|
|
11868
11978
|
'invoice': BaseInvoice | null;
|
|
11869
11979
|
'series': BaseSeries | null;
|
|
11980
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
11870
11981
|
'exchangeTarget': BaseEventPassTypeExchangeTarget | null;
|
|
11871
11982
|
'metadata'?: object;
|
|
11872
11983
|
}
|
|
@@ -11909,6 +12020,8 @@ export interface PaymentIntent {
|
|
|
11909
12020
|
'couponId': string | null;
|
|
11910
12021
|
'invoiceId': string | null;
|
|
11911
12022
|
'seriesId': string | null;
|
|
12023
|
+
'placeMembershipTypeId': string | null;
|
|
12024
|
+
'placeMembershipId': string | null;
|
|
11912
12025
|
'address1': string | null;
|
|
11913
12026
|
'address2': string | null;
|
|
11914
12027
|
'city': string | null;
|
|
@@ -11942,6 +12055,7 @@ export interface PaymentIntent {
|
|
|
11942
12055
|
'space': BaseBookingSpace | null;
|
|
11943
12056
|
'invoice': BaseInvoice | null;
|
|
11944
12057
|
'series': BaseSeries | null;
|
|
12058
|
+
'placeMembershipType': BasePlaceMembershipType | null;
|
|
11945
12059
|
}
|
|
11946
12060
|
export declare enum PaymentIntentSource {
|
|
11947
12061
|
Registration = "registration",
|
|
@@ -11952,7 +12066,8 @@ export declare enum PaymentIntentSource {
|
|
|
11952
12066
|
Coupon = "coupon",
|
|
11953
12067
|
Session = "session",
|
|
11954
12068
|
Booking = "booking",
|
|
11955
|
-
Series = "series"
|
|
12069
|
+
Series = "series",
|
|
12070
|
+
PlaceMembership = "placeMembership"
|
|
11956
12071
|
}
|
|
11957
12072
|
export interface PaymentLineItem {
|
|
11958
12073
|
'id': string;
|
|
@@ -11978,12 +12093,14 @@ export interface PaymentLineItem {
|
|
|
11978
12093
|
'reservationId': string | null;
|
|
11979
12094
|
'accessId': string | null;
|
|
11980
12095
|
'bookingId': string | null;
|
|
12096
|
+
'placeMembershipId': string | null;
|
|
11981
12097
|
'pass': BaseEventPass | null;
|
|
11982
12098
|
'package': BaseEventPackage | null;
|
|
11983
12099
|
'passAddOn': BasePassAddOn | null;
|
|
11984
12100
|
'reservation': BaseEventRoomTypeReservation | null;
|
|
11985
12101
|
'access': BaseEventSessionAccess | null;
|
|
11986
12102
|
'booking': BaseBooking | null;
|
|
12103
|
+
'placeMembership': BasePlaceMembership | null;
|
|
11987
12104
|
'coupon': BaseCoupon | null;
|
|
11988
12105
|
'seriesRegistration': BaseSeriesRegistration | null;
|
|
11989
12106
|
'payment': BasePayment;
|
|
@@ -11999,6 +12116,7 @@ export declare enum PaymentLineItemType {
|
|
|
11999
12116
|
Booking = "booking",
|
|
12000
12117
|
Coupon = "coupon",
|
|
12001
12118
|
Series = "series",
|
|
12119
|
+
PlaceMembership = "placeMembership",
|
|
12002
12120
|
Refund = "refund"
|
|
12003
12121
|
}
|
|
12004
12122
|
export declare enum PaymentType {
|
|
@@ -12015,6 +12133,117 @@ export interface PaypalActivationFormParams {
|
|
|
12015
12133
|
'currencyCode': string;
|
|
12016
12134
|
'name': string;
|
|
12017
12135
|
}
|
|
12136
|
+
export interface PlaceMembership {
|
|
12137
|
+
'id': string;
|
|
12138
|
+
'status': PurchaseStatus;
|
|
12139
|
+
'startsAt': string | null;
|
|
12140
|
+
'expiresAt': string | null;
|
|
12141
|
+
'account': BaseAccount;
|
|
12142
|
+
'placeMembershipType': BasePlaceMembershipType;
|
|
12143
|
+
'createdAt': string;
|
|
12144
|
+
'lineItem': PaymentLineItem | null;
|
|
12145
|
+
'members': Array<PlaceMembershipMember>;
|
|
12146
|
+
'_count': PlaceMembershipAllOfCount;
|
|
12147
|
+
}
|
|
12148
|
+
export interface PlaceMembershipAllOfCount {
|
|
12149
|
+
'bookings': number;
|
|
12150
|
+
}
|
|
12151
|
+
export interface PlaceMembershipCreateInputs {
|
|
12152
|
+
'accountId': string;
|
|
12153
|
+
'placeMembershipTypeId': string;
|
|
12154
|
+
'startsAt'?: string | null;
|
|
12155
|
+
'expiresAt'?: string | null;
|
|
12156
|
+
}
|
|
12157
|
+
export interface PlaceMembershipMember {
|
|
12158
|
+
'id': string;
|
|
12159
|
+
'name': string;
|
|
12160
|
+
'image': BaseImage | null;
|
|
12161
|
+
'createdAt': string;
|
|
12162
|
+
'updatedAt': string;
|
|
12163
|
+
}
|
|
12164
|
+
export interface PlaceMembershipMemberCreateInputs {
|
|
12165
|
+
'name': string;
|
|
12166
|
+
'imageId'?: string | null;
|
|
12167
|
+
}
|
|
12168
|
+
export interface PlaceMembershipMemberUpdateInputs {
|
|
12169
|
+
'name'?: string;
|
|
12170
|
+
'imageId'?: string | null;
|
|
12171
|
+
}
|
|
12172
|
+
export interface PlaceMembershipType {
|
|
12173
|
+
'id': string;
|
|
12174
|
+
'slug': string;
|
|
12175
|
+
'name': string;
|
|
12176
|
+
'description': string | null;
|
|
12177
|
+
'image': BaseImage | null;
|
|
12178
|
+
'price': number;
|
|
12179
|
+
'termDays': number;
|
|
12180
|
+
'maxMembers': number;
|
|
12181
|
+
'sortOrder': number;
|
|
12182
|
+
'visible': boolean;
|
|
12183
|
+
'archived': boolean;
|
|
12184
|
+
'taxCode': string | null;
|
|
12185
|
+
'taxIncluded': boolean;
|
|
12186
|
+
'taxLocation': TaxLocationType;
|
|
12187
|
+
'paymentIntegrationId': string | null;
|
|
12188
|
+
'paymentIntegration': BasePaymentIntegration | null;
|
|
12189
|
+
'entityId': string | null;
|
|
12190
|
+
'entity': BaseOrganizationEntity | null;
|
|
12191
|
+
'placeId': string;
|
|
12192
|
+
'createdAt': string;
|
|
12193
|
+
'updatedAt': string;
|
|
12194
|
+
}
|
|
12195
|
+
export interface PlaceMembershipTypeCreateInputs {
|
|
12196
|
+
'name': string;
|
|
12197
|
+
'description'?: string | null;
|
|
12198
|
+
'imageId'?: string | null;
|
|
12199
|
+
'price'?: number;
|
|
12200
|
+
'termDays': number;
|
|
12201
|
+
'maxMembers'?: number;
|
|
12202
|
+
'sortOrder'?: number | null;
|
|
12203
|
+
'visible'?: boolean;
|
|
12204
|
+
'taxCode'?: string | null;
|
|
12205
|
+
'taxIncluded'?: boolean;
|
|
12206
|
+
'taxLocation'?: TaxLocationType;
|
|
12207
|
+
'paymentIntegrationId'?: string | null;
|
|
12208
|
+
'entityId'?: string | null;
|
|
12209
|
+
}
|
|
12210
|
+
export interface PlaceMembershipTypeTranslation {
|
|
12211
|
+
'id': number;
|
|
12212
|
+
'locale': string;
|
|
12213
|
+
'name': string | null;
|
|
12214
|
+
'description': string | null;
|
|
12215
|
+
'createdAt': string;
|
|
12216
|
+
'updatedAt': string;
|
|
12217
|
+
}
|
|
12218
|
+
export interface PlaceMembershipTypeTranslationUpdateInputs {
|
|
12219
|
+
'name'?: string | null;
|
|
12220
|
+
'description'?: string | null;
|
|
12221
|
+
}
|
|
12222
|
+
export interface PlaceMembershipTypeUpdateInputs {
|
|
12223
|
+
'name'?: string;
|
|
12224
|
+
'description'?: string | null;
|
|
12225
|
+
'imageId'?: string | null;
|
|
12226
|
+
'price'?: number;
|
|
12227
|
+
'termDays'?: number;
|
|
12228
|
+
'maxMembers'?: number;
|
|
12229
|
+
'sortOrder'?: number | null;
|
|
12230
|
+
'visible'?: boolean;
|
|
12231
|
+
'archived'?: boolean;
|
|
12232
|
+
'taxCode'?: string | null;
|
|
12233
|
+
'taxIncluded'?: boolean;
|
|
12234
|
+
'taxLocation'?: TaxLocationType;
|
|
12235
|
+
'paymentIntegrationId'?: string | null;
|
|
12236
|
+
'entityId'?: string | null;
|
|
12237
|
+
}
|
|
12238
|
+
export interface PlaceMembershipUpdateInputs {
|
|
12239
|
+
'status'?: PlaceMembershipUpdateInputsStatusEnum;
|
|
12240
|
+
'startsAt'?: string;
|
|
12241
|
+
'expiresAt'?: string;
|
|
12242
|
+
}
|
|
12243
|
+
export declare enum PlaceMembershipUpdateInputsStatusEnum {
|
|
12244
|
+
Ready = "ready",
|
|
12245
|
+
Canceled = "canceled"
|
|
12246
|
+
}
|
|
12018
12247
|
export interface Preset {
|
|
12019
12248
|
'id': string;
|
|
12020
12249
|
'name': string;
|
|
@@ -13212,13 +13441,18 @@ export interface StreamOutputCreateInputs {
|
|
|
13212
13441
|
export interface StreamSession {
|
|
13213
13442
|
'id': string;
|
|
13214
13443
|
'organizationId': string;
|
|
13215
|
-
'streamId': string;
|
|
13216
|
-
'
|
|
13444
|
+
'streamId': string | null;
|
|
13445
|
+
'name': string | null;
|
|
13446
|
+
'eventId': string | null;
|
|
13447
|
+
'eventSessionId': string | null;
|
|
13448
|
+
'status': StreamSessionStatus;
|
|
13217
13449
|
'startedAt': string | null;
|
|
13218
13450
|
'endedAt': string | null;
|
|
13219
13451
|
'createdAt': string;
|
|
13220
13452
|
'updatedAt': string;
|
|
13221
|
-
'stream': BaseStreamInput;
|
|
13453
|
+
'stream': BaseStreamInput | null;
|
|
13454
|
+
'event': BaseEvent | null;
|
|
13455
|
+
'eventSession': BaseEventSession | null;
|
|
13222
13456
|
'organization': BaseOrganization;
|
|
13223
13457
|
}
|
|
13224
13458
|
export interface StreamSessionChatMessage {
|
|
@@ -13231,6 +13465,10 @@ export interface StreamSessionChatMessage {
|
|
|
13231
13465
|
'message': string;
|
|
13232
13466
|
'timestamp': number;
|
|
13233
13467
|
}
|
|
13468
|
+
export declare enum StreamSessionStatus {
|
|
13469
|
+
Active = "ACTIVE",
|
|
13470
|
+
Ended = "ENDED"
|
|
13471
|
+
}
|
|
13234
13472
|
export interface StreamSessionSubscription {
|
|
13235
13473
|
'id': string;
|
|
13236
13474
|
'organizationId': string;
|
|
@@ -13242,6 +13480,11 @@ export interface StreamSessionSubscription {
|
|
|
13242
13480
|
'connection': BaseWebSocketConnection;
|
|
13243
13481
|
'streamSession': BaseStreamSession;
|
|
13244
13482
|
}
|
|
13483
|
+
export interface StreamSessionUpdateInputs {
|
|
13484
|
+
'name'?: string | null;
|
|
13485
|
+
'eventId'?: string | null;
|
|
13486
|
+
'eventSessionId'?: string | null;
|
|
13487
|
+
}
|
|
13245
13488
|
export interface StripeActivationFormParams {
|
|
13246
13489
|
'clientPublicKey': string;
|
|
13247
13490
|
'clientSecret': string;
|
|
@@ -14229,6 +14472,14 @@ export interface UpdateOrganizationIntegrationsRequest {
|
|
|
14229
14472
|
'ghostAdminKey'?: string;
|
|
14230
14473
|
'ghostContentKey'?: string;
|
|
14231
14474
|
}
|
|
14475
|
+
export interface UpdatePlaceMembershipTypeTranslation200Response {
|
|
14476
|
+
'status': UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
14477
|
+
'message': string;
|
|
14478
|
+
'data': PlaceMembershipTypeTranslation;
|
|
14479
|
+
}
|
|
14480
|
+
export declare enum UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum {
|
|
14481
|
+
Ok = "ok"
|
|
14482
|
+
}
|
|
14232
14483
|
export interface UpdateSelf200Response {
|
|
14233
14484
|
'status': UpdateSelf200ResponseStatusEnum;
|
|
14234
14485
|
'message': string;
|
|
@@ -23168,6 +23419,1033 @@ export declare class BookingsBlackoutsApi extends BaseAPI {
|
|
|
23168
23419
|
*/
|
|
23169
23420
|
updateBookingSpaceBlackout(requestParameters: BookingsBlackoutsApiUpdateBookingSpaceBlackoutRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingSpaceBlackout200Response, any, {}, any>>;
|
|
23170
23421
|
}
|
|
23422
|
+
/**
|
|
23423
|
+
* BookingsMembershipsApi - axios parameter creator
|
|
23424
|
+
*/
|
|
23425
|
+
export declare const BookingsMembershipsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23426
|
+
/**
|
|
23427
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23428
|
+
* @summary Grant a place membership
|
|
23429
|
+
* @param {string} placeId The place identifier
|
|
23430
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
23431
|
+
* @param {*} [options] Override http request option.
|
|
23432
|
+
* @throws {RequiredError}
|
|
23433
|
+
*/
|
|
23434
|
+
createPlaceMembership: (placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23435
|
+
/**
|
|
23436
|
+
* 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.
|
|
23437
|
+
* @summary Add a member to a place membership
|
|
23438
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23439
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
23440
|
+
* @param {*} [options] Override http request option.
|
|
23441
|
+
* @throws {RequiredError}
|
|
23442
|
+
*/
|
|
23443
|
+
createPlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23444
|
+
/**
|
|
23445
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23446
|
+
* @summary Create a place membership type
|
|
23447
|
+
* @param {string} placeId The place identifier
|
|
23448
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
23449
|
+
* @param {*} [options] Override http request option.
|
|
23450
|
+
* @throws {RequiredError}
|
|
23451
|
+
*/
|
|
23452
|
+
createPlaceMembershipType: (placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23453
|
+
/**
|
|
23454
|
+
* 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.
|
|
23455
|
+
* @summary Remove a member from a place membership
|
|
23456
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23457
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23458
|
+
* @param {*} [options] Override http request option.
|
|
23459
|
+
* @throws {RequiredError}
|
|
23460
|
+
*/
|
|
23461
|
+
deletePlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23462
|
+
/**
|
|
23463
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23464
|
+
* @summary Delete a place membership type
|
|
23465
|
+
* @param {string} placeId The place identifier
|
|
23466
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23467
|
+
* @param {*} [options] Override http request option.
|
|
23468
|
+
* @throws {RequiredError}
|
|
23469
|
+
*/
|
|
23470
|
+
deletePlaceMembershipType: (placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23471
|
+
/**
|
|
23472
|
+
* 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\".
|
|
23473
|
+
* @summary Get a place membership
|
|
23474
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23475
|
+
* @param {*} [options] Override http request option.
|
|
23476
|
+
* @throws {RequiredError}
|
|
23477
|
+
*/
|
|
23478
|
+
getPlaceMembership: (placeMembershipId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23479
|
+
/**
|
|
23480
|
+
* 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\".
|
|
23481
|
+
* @summary List bookings that applied a place membership
|
|
23482
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23483
|
+
* @param {number} [page] Page number
|
|
23484
|
+
* @param {number} [pageSize] Number of items per page
|
|
23485
|
+
* @param {string} [orderBy] Field to order by
|
|
23486
|
+
* @param {string} [search] Search query
|
|
23487
|
+
* @param {*} [options] Override http request option.
|
|
23488
|
+
* @throws {RequiredError}
|
|
23489
|
+
*/
|
|
23490
|
+
getPlaceMembershipBookings: (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23491
|
+
/**
|
|
23492
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23493
|
+
* @summary List a place membership\'s members
|
|
23494
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23495
|
+
* @param {number} [page] Page number
|
|
23496
|
+
* @param {number} [pageSize] Number of items per page
|
|
23497
|
+
* @param {string} [orderBy] Field to order by
|
|
23498
|
+
* @param {string} [search] Search query
|
|
23499
|
+
* @param {*} [options] Override http request option.
|
|
23500
|
+
* @throws {RequiredError}
|
|
23501
|
+
*/
|
|
23502
|
+
getPlaceMembershipMembers: (placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23503
|
+
/**
|
|
23504
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23505
|
+
* @summary Get a place membership type
|
|
23506
|
+
* @param {string} placeId The place identifier
|
|
23507
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23508
|
+
* @param {*} [options] Override http request option.
|
|
23509
|
+
* @throws {RequiredError}
|
|
23510
|
+
*/
|
|
23511
|
+
getPlaceMembershipType: (placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23512
|
+
/**
|
|
23513
|
+
* 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\".
|
|
23514
|
+
* @summary List a place\'s membership types
|
|
23515
|
+
* @param {string} placeId The place identifier
|
|
23516
|
+
* @param {boolean} [archived] Filter by archived
|
|
23517
|
+
* @param {number} [page] Page number
|
|
23518
|
+
* @param {number} [pageSize] Number of items per page
|
|
23519
|
+
* @param {string} [orderBy] Field to order by
|
|
23520
|
+
* @param {string} [search] Search query
|
|
23521
|
+
* @param {*} [options] Override http request option.
|
|
23522
|
+
* @throws {RequiredError}
|
|
23523
|
+
*/
|
|
23524
|
+
getPlaceMembershipTypes: (placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23525
|
+
/**
|
|
23526
|
+
* 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\".
|
|
23527
|
+
* @summary List a place\'s memberships
|
|
23528
|
+
* @param {string} placeId The place identifier
|
|
23529
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
23530
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
23531
|
+
* @param {boolean} [active] Filter by active
|
|
23532
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
23533
|
+
* @param {boolean} [expired] Filter by expired
|
|
23534
|
+
* @param {number} [page] Page number
|
|
23535
|
+
* @param {number} [pageSize] Number of items per page
|
|
23536
|
+
* @param {string} [orderBy] Field to order by
|
|
23537
|
+
* @param {string} [search] Search query
|
|
23538
|
+
* @param {*} [options] Override http request option.
|
|
23539
|
+
* @throws {RequiredError}
|
|
23540
|
+
*/
|
|
23541
|
+
getPlaceMemberships: (placeId: string, placeMembershipTypeId?: string, status?: PurchaseStatus, active?: boolean, upcoming?: boolean, expired?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23542
|
+
/**
|
|
23543
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23544
|
+
* @summary Update a place membership
|
|
23545
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23546
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
23547
|
+
* @param {*} [options] Override http request option.
|
|
23548
|
+
* @throws {RequiredError}
|
|
23549
|
+
*/
|
|
23550
|
+
updatePlaceMembership: (placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23551
|
+
/**
|
|
23552
|
+
* 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.
|
|
23553
|
+
* @summary Update a place membership member
|
|
23554
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23555
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23556
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
23557
|
+
* @param {*} [options] Override http request option.
|
|
23558
|
+
* @throws {RequiredError}
|
|
23559
|
+
*/
|
|
23560
|
+
updatePlaceMembershipMember: (placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23561
|
+
/**
|
|
23562
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23563
|
+
* @summary Update a place membership type
|
|
23564
|
+
* @param {string} placeId The place identifier
|
|
23565
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23566
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
23567
|
+
* @param {*} [options] Override http request option.
|
|
23568
|
+
* @throws {RequiredError}
|
|
23569
|
+
*/
|
|
23570
|
+
updatePlaceMembershipType: (placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23571
|
+
};
|
|
23572
|
+
/**
|
|
23573
|
+
* BookingsMembershipsApi - functional programming interface
|
|
23574
|
+
*/
|
|
23575
|
+
export declare const BookingsMembershipsApiFp: (configuration?: Configuration) => {
|
|
23576
|
+
/**
|
|
23577
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23578
|
+
* @summary Grant a place membership
|
|
23579
|
+
* @param {string} placeId The place identifier
|
|
23580
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
23581
|
+
* @param {*} [options] Override http request option.
|
|
23582
|
+
* @throws {RequiredError}
|
|
23583
|
+
*/
|
|
23584
|
+
createPlaceMembership(placeId: string, placeMembershipCreateInputs: PlaceMembershipCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23585
|
+
/**
|
|
23586
|
+
* 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.
|
|
23587
|
+
* @summary Add a member to a place membership
|
|
23588
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23589
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
23590
|
+
* @param {*} [options] Override http request option.
|
|
23591
|
+
* @throws {RequiredError}
|
|
23592
|
+
*/
|
|
23593
|
+
createPlaceMembershipMember(placeMembershipId: string, placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>>;
|
|
23594
|
+
/**
|
|
23595
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23596
|
+
* @summary Create a place membership type
|
|
23597
|
+
* @param {string} placeId The place identifier
|
|
23598
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
23599
|
+
* @param {*} [options] Override http request option.
|
|
23600
|
+
* @throws {RequiredError}
|
|
23601
|
+
*/
|
|
23602
|
+
createPlaceMembershipType(placeId: string, placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23603
|
+
/**
|
|
23604
|
+
* 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.
|
|
23605
|
+
* @summary Remove a member from a place membership
|
|
23606
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23607
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23608
|
+
* @param {*} [options] Override http request option.
|
|
23609
|
+
* @throws {RequiredError}
|
|
23610
|
+
*/
|
|
23611
|
+
deletePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
23612
|
+
/**
|
|
23613
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23614
|
+
* @summary Delete a place membership type
|
|
23615
|
+
* @param {string} placeId The place identifier
|
|
23616
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23617
|
+
* @param {*} [options] Override http request option.
|
|
23618
|
+
* @throws {RequiredError}
|
|
23619
|
+
*/
|
|
23620
|
+
deletePlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
23621
|
+
/**
|
|
23622
|
+
* 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\".
|
|
23623
|
+
* @summary Get a place membership
|
|
23624
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23625
|
+
* @param {*} [options] Override http request option.
|
|
23626
|
+
* @throws {RequiredError}
|
|
23627
|
+
*/
|
|
23628
|
+
getPlaceMembership(placeMembershipId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23629
|
+
/**
|
|
23630
|
+
* 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\".
|
|
23631
|
+
* @summary List bookings that applied a place membership
|
|
23632
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23633
|
+
* @param {number} [page] Page number
|
|
23634
|
+
* @param {number} [pageSize] Number of items per page
|
|
23635
|
+
* @param {string} [orderBy] Field to order by
|
|
23636
|
+
* @param {string} [search] Search query
|
|
23637
|
+
* @param {*} [options] Override http request option.
|
|
23638
|
+
* @throws {RequiredError}
|
|
23639
|
+
*/
|
|
23640
|
+
getPlaceMembershipBookings(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountBookings200Response>>;
|
|
23641
|
+
/**
|
|
23642
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23643
|
+
* @summary List a place membership\'s members
|
|
23644
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23645
|
+
* @param {number} [page] Page number
|
|
23646
|
+
* @param {number} [pageSize] Number of items per page
|
|
23647
|
+
* @param {string} [orderBy] Field to order by
|
|
23648
|
+
* @param {string} [search] Search query
|
|
23649
|
+
* @param {*} [options] Override http request option.
|
|
23650
|
+
* @throws {RequiredError}
|
|
23651
|
+
*/
|
|
23652
|
+
getPlaceMembershipMembers(placeMembershipId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipMembers200Response>>;
|
|
23653
|
+
/**
|
|
23654
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23655
|
+
* @summary Get a place membership type
|
|
23656
|
+
* @param {string} placeId The place identifier
|
|
23657
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23658
|
+
* @param {*} [options] Override http request option.
|
|
23659
|
+
* @throws {RequiredError}
|
|
23660
|
+
*/
|
|
23661
|
+
getPlaceMembershipType(placeId: string, placeMembershipTypeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23662
|
+
/**
|
|
23663
|
+
* 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\".
|
|
23664
|
+
* @summary List a place\'s membership types
|
|
23665
|
+
* @param {string} placeId The place identifier
|
|
23666
|
+
* @param {boolean} [archived] Filter by archived
|
|
23667
|
+
* @param {number} [page] Page number
|
|
23668
|
+
* @param {number} [pageSize] Number of items per page
|
|
23669
|
+
* @param {string} [orderBy] Field to order by
|
|
23670
|
+
* @param {string} [search] Search query
|
|
23671
|
+
* @param {*} [options] Override http request option.
|
|
23672
|
+
* @throws {RequiredError}
|
|
23673
|
+
*/
|
|
23674
|
+
getPlaceMembershipTypes(placeId: string, archived?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypes200Response>>;
|
|
23675
|
+
/**
|
|
23676
|
+
* 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\".
|
|
23677
|
+
* @summary List a place\'s memberships
|
|
23678
|
+
* @param {string} placeId The place identifier
|
|
23679
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
23680
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
23681
|
+
* @param {boolean} [active] Filter by active
|
|
23682
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
23683
|
+
* @param {boolean} [expired] Filter by expired
|
|
23684
|
+
* @param {number} [page] Page number
|
|
23685
|
+
* @param {number} [pageSize] Number of items per page
|
|
23686
|
+
* @param {string} [orderBy] Field to order by
|
|
23687
|
+
* @param {string} [search] Search query
|
|
23688
|
+
* @param {*} [options] Override http request option.
|
|
23689
|
+
* @throws {RequiredError}
|
|
23690
|
+
*/
|
|
23691
|
+
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>>;
|
|
23692
|
+
/**
|
|
23693
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23694
|
+
* @summary Update a place membership
|
|
23695
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23696
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
23697
|
+
* @param {*} [options] Override http request option.
|
|
23698
|
+
* @throws {RequiredError}
|
|
23699
|
+
*/
|
|
23700
|
+
updatePlaceMembership(placeMembershipId: string, placeMembershipUpdateInputs: PlaceMembershipUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembership200Response>>;
|
|
23701
|
+
/**
|
|
23702
|
+
* 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.
|
|
23703
|
+
* @summary Update a place membership member
|
|
23704
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
23705
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
23706
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
23707
|
+
* @param {*} [options] Override http request option.
|
|
23708
|
+
* @throws {RequiredError}
|
|
23709
|
+
*/
|
|
23710
|
+
updatePlaceMembershipMember(placeMembershipId: string, placeMembershipMemberId: string, placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipMember200Response>>;
|
|
23711
|
+
/**
|
|
23712
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23713
|
+
* @summary Update a place membership type
|
|
23714
|
+
* @param {string} placeId The place identifier
|
|
23715
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
23716
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
23717
|
+
* @param {*} [options] Override http request option.
|
|
23718
|
+
* @throws {RequiredError}
|
|
23719
|
+
*/
|
|
23720
|
+
updatePlaceMembershipType(placeId: string, placeMembershipTypeId: string, placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePlaceMembershipType200Response>>;
|
|
23721
|
+
};
|
|
23722
|
+
/**
|
|
23723
|
+
* BookingsMembershipsApi - factory interface
|
|
23724
|
+
*/
|
|
23725
|
+
export declare const BookingsMembershipsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23726
|
+
/**
|
|
23727
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
23728
|
+
* @summary Grant a place membership
|
|
23729
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
23730
|
+
* @param {*} [options] Override http request option.
|
|
23731
|
+
* @throws {RequiredError}
|
|
23732
|
+
*/
|
|
23733
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23734
|
+
/**
|
|
23735
|
+
* 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.
|
|
23736
|
+
* @summary Add a member to a place membership
|
|
23737
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23738
|
+
* @param {*} [options] Override http request option.
|
|
23739
|
+
* @throws {RequiredError}
|
|
23740
|
+
*/
|
|
23741
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response>;
|
|
23742
|
+
/**
|
|
23743
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
23744
|
+
* @summary Create a place membership type
|
|
23745
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23746
|
+
* @param {*} [options] Override http request option.
|
|
23747
|
+
* @throws {RequiredError}
|
|
23748
|
+
*/
|
|
23749
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23750
|
+
/**
|
|
23751
|
+
* 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.
|
|
23752
|
+
* @summary Remove a member from a place membership
|
|
23753
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23754
|
+
* @param {*} [options] Override http request option.
|
|
23755
|
+
* @throws {RequiredError}
|
|
23756
|
+
*/
|
|
23757
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
23758
|
+
/**
|
|
23759
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
23760
|
+
* @summary Delete a place membership type
|
|
23761
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23762
|
+
* @param {*} [options] Override http request option.
|
|
23763
|
+
* @throws {RequiredError}
|
|
23764
|
+
*/
|
|
23765
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
23766
|
+
/**
|
|
23767
|
+
* 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\".
|
|
23768
|
+
* @summary Get a place membership
|
|
23769
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
23770
|
+
* @param {*} [options] Override http request option.
|
|
23771
|
+
* @throws {RequiredError}
|
|
23772
|
+
*/
|
|
23773
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23774
|
+
/**
|
|
23775
|
+
* 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\".
|
|
23776
|
+
* @summary List bookings that applied a place membership
|
|
23777
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
23778
|
+
* @param {*} [options] Override http request option.
|
|
23779
|
+
* @throws {RequiredError}
|
|
23780
|
+
*/
|
|
23781
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountBookings200Response>;
|
|
23782
|
+
/**
|
|
23783
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
23784
|
+
* @summary List a place membership\'s members
|
|
23785
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
23786
|
+
* @param {*} [options] Override http request option.
|
|
23787
|
+
* @throws {RequiredError}
|
|
23788
|
+
*/
|
|
23789
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipMembers200Response>;
|
|
23790
|
+
/**
|
|
23791
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
23792
|
+
* @summary Get a place membership type
|
|
23793
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23794
|
+
* @param {*} [options] Override http request option.
|
|
23795
|
+
* @throws {RequiredError}
|
|
23796
|
+
*/
|
|
23797
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23798
|
+
/**
|
|
23799
|
+
* 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\".
|
|
23800
|
+
* @summary List a place\'s membership types
|
|
23801
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
23802
|
+
* @param {*} [options] Override http request option.
|
|
23803
|
+
* @throws {RequiredError}
|
|
23804
|
+
*/
|
|
23805
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypes200Response>;
|
|
23806
|
+
/**
|
|
23807
|
+
* 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\".
|
|
23808
|
+
* @summary List a place\'s memberships
|
|
23809
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
23810
|
+
* @param {*} [options] Override http request option.
|
|
23811
|
+
* @throws {RequiredError}
|
|
23812
|
+
*/
|
|
23813
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMemberships200Response>;
|
|
23814
|
+
/**
|
|
23815
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
23816
|
+
* @summary Update a place membership
|
|
23817
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
23818
|
+
* @param {*} [options] Override http request option.
|
|
23819
|
+
* @throws {RequiredError}
|
|
23820
|
+
*/
|
|
23821
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembership200Response>;
|
|
23822
|
+
/**
|
|
23823
|
+
* 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.
|
|
23824
|
+
* @summary Update a place membership member
|
|
23825
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
23826
|
+
* @param {*} [options] Override http request option.
|
|
23827
|
+
* @throws {RequiredError}
|
|
23828
|
+
*/
|
|
23829
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipMember200Response>;
|
|
23830
|
+
/**
|
|
23831
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
23832
|
+
* @summary Update a place membership type
|
|
23833
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
23834
|
+
* @param {*} [options] Override http request option.
|
|
23835
|
+
* @throws {RequiredError}
|
|
23836
|
+
*/
|
|
23837
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreatePlaceMembershipType200Response>;
|
|
23838
|
+
};
|
|
23839
|
+
/**
|
|
23840
|
+
* Request parameters for createPlaceMembership operation in BookingsMembershipsApi.
|
|
23841
|
+
*/
|
|
23842
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipRequest {
|
|
23843
|
+
/**
|
|
23844
|
+
* The place identifier
|
|
23845
|
+
*/
|
|
23846
|
+
readonly placeId: string;
|
|
23847
|
+
readonly placeMembershipCreateInputs: PlaceMembershipCreateInputs;
|
|
23848
|
+
}
|
|
23849
|
+
/**
|
|
23850
|
+
* Request parameters for createPlaceMembershipMember operation in BookingsMembershipsApi.
|
|
23851
|
+
*/
|
|
23852
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipMemberRequest {
|
|
23853
|
+
/**
|
|
23854
|
+
* The placeMembership identifier
|
|
23855
|
+
*/
|
|
23856
|
+
readonly placeMembershipId: string;
|
|
23857
|
+
readonly placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs;
|
|
23858
|
+
}
|
|
23859
|
+
/**
|
|
23860
|
+
* Request parameters for createPlaceMembershipType operation in BookingsMembershipsApi.
|
|
23861
|
+
*/
|
|
23862
|
+
export interface BookingsMembershipsApiCreatePlaceMembershipTypeRequest {
|
|
23863
|
+
/**
|
|
23864
|
+
* The place identifier
|
|
23865
|
+
*/
|
|
23866
|
+
readonly placeId: string;
|
|
23867
|
+
readonly placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs;
|
|
23868
|
+
}
|
|
23869
|
+
/**
|
|
23870
|
+
* Request parameters for deletePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
23871
|
+
*/
|
|
23872
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipMemberRequest {
|
|
23873
|
+
/**
|
|
23874
|
+
* The placeMembership identifier
|
|
23875
|
+
*/
|
|
23876
|
+
readonly placeMembershipId: string;
|
|
23877
|
+
/**
|
|
23878
|
+
* The placeMembershipMember identifier
|
|
23879
|
+
*/
|
|
23880
|
+
readonly placeMembershipMemberId: string;
|
|
23881
|
+
}
|
|
23882
|
+
/**
|
|
23883
|
+
* Request parameters for deletePlaceMembershipType operation in BookingsMembershipsApi.
|
|
23884
|
+
*/
|
|
23885
|
+
export interface BookingsMembershipsApiDeletePlaceMembershipTypeRequest {
|
|
23886
|
+
/**
|
|
23887
|
+
* The place identifier
|
|
23888
|
+
*/
|
|
23889
|
+
readonly placeId: string;
|
|
23890
|
+
/**
|
|
23891
|
+
* The placeMembershipType identifier
|
|
23892
|
+
*/
|
|
23893
|
+
readonly placeMembershipTypeId: string;
|
|
23894
|
+
}
|
|
23895
|
+
/**
|
|
23896
|
+
* Request parameters for getPlaceMembership operation in BookingsMembershipsApi.
|
|
23897
|
+
*/
|
|
23898
|
+
export interface BookingsMembershipsApiGetPlaceMembershipRequest {
|
|
23899
|
+
/**
|
|
23900
|
+
* The placeMembership identifier
|
|
23901
|
+
*/
|
|
23902
|
+
readonly placeMembershipId: string;
|
|
23903
|
+
}
|
|
23904
|
+
/**
|
|
23905
|
+
* Request parameters for getPlaceMembershipBookings operation in BookingsMembershipsApi.
|
|
23906
|
+
*/
|
|
23907
|
+
export interface BookingsMembershipsApiGetPlaceMembershipBookingsRequest {
|
|
23908
|
+
/**
|
|
23909
|
+
* The placeMembership identifier
|
|
23910
|
+
*/
|
|
23911
|
+
readonly placeMembershipId: string;
|
|
23912
|
+
/**
|
|
23913
|
+
* Page number
|
|
23914
|
+
*/
|
|
23915
|
+
readonly page?: number;
|
|
23916
|
+
/**
|
|
23917
|
+
* Number of items per page
|
|
23918
|
+
*/
|
|
23919
|
+
readonly pageSize?: number;
|
|
23920
|
+
/**
|
|
23921
|
+
* Field to order by
|
|
23922
|
+
*/
|
|
23923
|
+
readonly orderBy?: string;
|
|
23924
|
+
/**
|
|
23925
|
+
* Search query
|
|
23926
|
+
*/
|
|
23927
|
+
readonly search?: string;
|
|
23928
|
+
}
|
|
23929
|
+
/**
|
|
23930
|
+
* Request parameters for getPlaceMembershipMembers operation in BookingsMembershipsApi.
|
|
23931
|
+
*/
|
|
23932
|
+
export interface BookingsMembershipsApiGetPlaceMembershipMembersRequest {
|
|
23933
|
+
/**
|
|
23934
|
+
* The placeMembership identifier
|
|
23935
|
+
*/
|
|
23936
|
+
readonly placeMembershipId: string;
|
|
23937
|
+
/**
|
|
23938
|
+
* Page number
|
|
23939
|
+
*/
|
|
23940
|
+
readonly page?: number;
|
|
23941
|
+
/**
|
|
23942
|
+
* Number of items per page
|
|
23943
|
+
*/
|
|
23944
|
+
readonly pageSize?: number;
|
|
23945
|
+
/**
|
|
23946
|
+
* Field to order by
|
|
23947
|
+
*/
|
|
23948
|
+
readonly orderBy?: string;
|
|
23949
|
+
/**
|
|
23950
|
+
* Search query
|
|
23951
|
+
*/
|
|
23952
|
+
readonly search?: string;
|
|
23953
|
+
}
|
|
23954
|
+
/**
|
|
23955
|
+
* Request parameters for getPlaceMembershipType operation in BookingsMembershipsApi.
|
|
23956
|
+
*/
|
|
23957
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypeRequest {
|
|
23958
|
+
/**
|
|
23959
|
+
* The place identifier
|
|
23960
|
+
*/
|
|
23961
|
+
readonly placeId: string;
|
|
23962
|
+
/**
|
|
23963
|
+
* The placeMembershipType identifier
|
|
23964
|
+
*/
|
|
23965
|
+
readonly placeMembershipTypeId: string;
|
|
23966
|
+
}
|
|
23967
|
+
/**
|
|
23968
|
+
* Request parameters for getPlaceMembershipTypes operation in BookingsMembershipsApi.
|
|
23969
|
+
*/
|
|
23970
|
+
export interface BookingsMembershipsApiGetPlaceMembershipTypesRequest {
|
|
23971
|
+
/**
|
|
23972
|
+
* The place identifier
|
|
23973
|
+
*/
|
|
23974
|
+
readonly placeId: string;
|
|
23975
|
+
/**
|
|
23976
|
+
* Filter by archived
|
|
23977
|
+
*/
|
|
23978
|
+
readonly archived?: boolean;
|
|
23979
|
+
/**
|
|
23980
|
+
* Page number
|
|
23981
|
+
*/
|
|
23982
|
+
readonly page?: number;
|
|
23983
|
+
/**
|
|
23984
|
+
* Number of items per page
|
|
23985
|
+
*/
|
|
23986
|
+
readonly pageSize?: number;
|
|
23987
|
+
/**
|
|
23988
|
+
* Field to order by
|
|
23989
|
+
*/
|
|
23990
|
+
readonly orderBy?: string;
|
|
23991
|
+
/**
|
|
23992
|
+
* Search query
|
|
23993
|
+
*/
|
|
23994
|
+
readonly search?: string;
|
|
23995
|
+
}
|
|
23996
|
+
/**
|
|
23997
|
+
* Request parameters for getPlaceMemberships operation in BookingsMembershipsApi.
|
|
23998
|
+
*/
|
|
23999
|
+
export interface BookingsMembershipsApiGetPlaceMembershipsRequest {
|
|
24000
|
+
/**
|
|
24001
|
+
* The place identifier
|
|
24002
|
+
*/
|
|
24003
|
+
readonly placeId: string;
|
|
24004
|
+
/**
|
|
24005
|
+
* Filter by placeMembershipTypeId
|
|
24006
|
+
*/
|
|
24007
|
+
readonly placeMembershipTypeId?: string;
|
|
24008
|
+
/**
|
|
24009
|
+
* Filter by status
|
|
24010
|
+
*/
|
|
24011
|
+
readonly status?: PurchaseStatus;
|
|
24012
|
+
/**
|
|
24013
|
+
* Filter by active
|
|
24014
|
+
*/
|
|
24015
|
+
readonly active?: boolean;
|
|
24016
|
+
/**
|
|
24017
|
+
* Filter by upcoming
|
|
24018
|
+
*/
|
|
24019
|
+
readonly upcoming?: boolean;
|
|
24020
|
+
/**
|
|
24021
|
+
* Filter by expired
|
|
24022
|
+
*/
|
|
24023
|
+
readonly expired?: boolean;
|
|
24024
|
+
/**
|
|
24025
|
+
* Page number
|
|
24026
|
+
*/
|
|
24027
|
+
readonly page?: number;
|
|
24028
|
+
/**
|
|
24029
|
+
* Number of items per page
|
|
24030
|
+
*/
|
|
24031
|
+
readonly pageSize?: number;
|
|
24032
|
+
/**
|
|
24033
|
+
* Field to order by
|
|
24034
|
+
*/
|
|
24035
|
+
readonly orderBy?: string;
|
|
24036
|
+
/**
|
|
24037
|
+
* Search query
|
|
24038
|
+
*/
|
|
24039
|
+
readonly search?: string;
|
|
24040
|
+
}
|
|
24041
|
+
/**
|
|
24042
|
+
* Request parameters for updatePlaceMembership operation in BookingsMembershipsApi.
|
|
24043
|
+
*/
|
|
24044
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipRequest {
|
|
24045
|
+
/**
|
|
24046
|
+
* The placeMembership identifier
|
|
24047
|
+
*/
|
|
24048
|
+
readonly placeMembershipId: string;
|
|
24049
|
+
readonly placeMembershipUpdateInputs: PlaceMembershipUpdateInputs;
|
|
24050
|
+
}
|
|
24051
|
+
/**
|
|
24052
|
+
* Request parameters for updatePlaceMembershipMember operation in BookingsMembershipsApi.
|
|
24053
|
+
*/
|
|
24054
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipMemberRequest {
|
|
24055
|
+
/**
|
|
24056
|
+
* The placeMembership identifier
|
|
24057
|
+
*/
|
|
24058
|
+
readonly placeMembershipId: string;
|
|
24059
|
+
/**
|
|
24060
|
+
* The placeMembershipMember identifier
|
|
24061
|
+
*/
|
|
24062
|
+
readonly placeMembershipMemberId: string;
|
|
24063
|
+
readonly placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs;
|
|
24064
|
+
}
|
|
24065
|
+
/**
|
|
24066
|
+
* Request parameters for updatePlaceMembershipType operation in BookingsMembershipsApi.
|
|
24067
|
+
*/
|
|
24068
|
+
export interface BookingsMembershipsApiUpdatePlaceMembershipTypeRequest {
|
|
24069
|
+
/**
|
|
24070
|
+
* The place identifier
|
|
24071
|
+
*/
|
|
24072
|
+
readonly placeId: string;
|
|
24073
|
+
/**
|
|
24074
|
+
* The placeMembershipType identifier
|
|
24075
|
+
*/
|
|
24076
|
+
readonly placeMembershipTypeId: string;
|
|
24077
|
+
readonly placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs;
|
|
24078
|
+
}
|
|
24079
|
+
/**
|
|
24080
|
+
* BookingsMembershipsApi - object-oriented interface
|
|
24081
|
+
*/
|
|
24082
|
+
export declare class BookingsMembershipsApi extends BaseAPI {
|
|
24083
|
+
/**
|
|
24084
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
24085
|
+
* @summary Grant a place membership
|
|
24086
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
24087
|
+
* @param {*} [options] Override http request option.
|
|
24088
|
+
* @throws {RequiredError}
|
|
24089
|
+
*/
|
|
24090
|
+
createPlaceMembership(requestParameters: BookingsMembershipsApiCreatePlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24091
|
+
/**
|
|
24092
|
+
* 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.
|
|
24093
|
+
* @summary Add a member to a place membership
|
|
24094
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24095
|
+
* @param {*} [options] Override http request option.
|
|
24096
|
+
* @throws {RequiredError}
|
|
24097
|
+
*/
|
|
24098
|
+
createPlaceMembershipMember(requestParameters: BookingsMembershipsApiCreatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipMember200Response, any, {}, any>>;
|
|
24099
|
+
/**
|
|
24100
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
24101
|
+
* @summary Create a place membership type
|
|
24102
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24103
|
+
* @param {*} [options] Override http request option.
|
|
24104
|
+
* @throws {RequiredError}
|
|
24105
|
+
*/
|
|
24106
|
+
createPlaceMembershipType(requestParameters: BookingsMembershipsApiCreatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24107
|
+
/**
|
|
24108
|
+
* 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.
|
|
24109
|
+
* @summary Remove a member from a place membership
|
|
24110
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24111
|
+
* @param {*} [options] Override http request option.
|
|
24112
|
+
* @throws {RequiredError}
|
|
24113
|
+
*/
|
|
24114
|
+
deletePlaceMembershipMember(requestParameters: BookingsMembershipsApiDeletePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24115
|
+
/**
|
|
24116
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
24117
|
+
* @summary Delete a place membership type
|
|
24118
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24119
|
+
* @param {*} [options] Override http request option.
|
|
24120
|
+
* @throws {RequiredError}
|
|
24121
|
+
*/
|
|
24122
|
+
deletePlaceMembershipType(requestParameters: BookingsMembershipsApiDeletePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24123
|
+
/**
|
|
24124
|
+
* 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\".
|
|
24125
|
+
* @summary Get a place membership
|
|
24126
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
24127
|
+
* @param {*} [options] Override http request option.
|
|
24128
|
+
* @throws {RequiredError}
|
|
24129
|
+
*/
|
|
24130
|
+
getPlaceMembership(requestParameters: BookingsMembershipsApiGetPlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24131
|
+
/**
|
|
24132
|
+
* 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\".
|
|
24133
|
+
* @summary List bookings that applied a place membership
|
|
24134
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
24135
|
+
* @param {*} [options] Override http request option.
|
|
24136
|
+
* @throws {RequiredError}
|
|
24137
|
+
*/
|
|
24138
|
+
getPlaceMembershipBookings(requestParameters: BookingsMembershipsApiGetPlaceMembershipBookingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountBookings200Response, any, {}, any>>;
|
|
24139
|
+
/**
|
|
24140
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
24141
|
+
* @summary List a place membership\'s members
|
|
24142
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
24143
|
+
* @param {*} [options] Override http request option.
|
|
24144
|
+
* @throws {RequiredError}
|
|
24145
|
+
*/
|
|
24146
|
+
getPlaceMembershipMembers(requestParameters: BookingsMembershipsApiGetPlaceMembershipMembersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipMembers200Response, any, {}, any>>;
|
|
24147
|
+
/**
|
|
24148
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
24149
|
+
* @summary Get a place membership type
|
|
24150
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24151
|
+
* @param {*} [options] Override http request option.
|
|
24152
|
+
* @throws {RequiredError}
|
|
24153
|
+
*/
|
|
24154
|
+
getPlaceMembershipType(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24155
|
+
/**
|
|
24156
|
+
* 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\".
|
|
24157
|
+
* @summary List a place\'s membership types
|
|
24158
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
24159
|
+
* @param {*} [options] Override http request option.
|
|
24160
|
+
* @throws {RequiredError}
|
|
24161
|
+
*/
|
|
24162
|
+
getPlaceMembershipTypes(requestParameters: BookingsMembershipsApiGetPlaceMembershipTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypes200Response, any, {}, any>>;
|
|
24163
|
+
/**
|
|
24164
|
+
* 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\".
|
|
24165
|
+
* @summary List a place\'s memberships
|
|
24166
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
24167
|
+
* @param {*} [options] Override http request option.
|
|
24168
|
+
* @throws {RequiredError}
|
|
24169
|
+
*/
|
|
24170
|
+
getPlaceMemberships(requestParameters: BookingsMembershipsApiGetPlaceMembershipsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMemberships200Response, any, {}, any>>;
|
|
24171
|
+
/**
|
|
24172
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
24173
|
+
* @summary Update a place membership
|
|
24174
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
24175
|
+
* @param {*} [options] Override http request option.
|
|
24176
|
+
* @throws {RequiredError}
|
|
24177
|
+
*/
|
|
24178
|
+
updatePlaceMembership(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembership200Response, any, {}, any>>;
|
|
24179
|
+
/**
|
|
24180
|
+
* 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.
|
|
24181
|
+
* @summary Update a place membership member
|
|
24182
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
24183
|
+
* @param {*} [options] Override http request option.
|
|
24184
|
+
* @throws {RequiredError}
|
|
24185
|
+
*/
|
|
24186
|
+
updatePlaceMembershipMember(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipMember200Response, any, {}, any>>;
|
|
24187
|
+
/**
|
|
24188
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
24189
|
+
* @summary Update a place membership type
|
|
24190
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
24191
|
+
* @param {*} [options] Override http request option.
|
|
24192
|
+
* @throws {RequiredError}
|
|
24193
|
+
*/
|
|
24194
|
+
updatePlaceMembershipType(requestParameters: BookingsMembershipsApiUpdatePlaceMembershipTypeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePlaceMembershipType200Response, any, {}, any>>;
|
|
24195
|
+
}
|
|
24196
|
+
/**
|
|
24197
|
+
* BookingsMembershipsTranslationsApi - axios parameter creator
|
|
24198
|
+
*/
|
|
24199
|
+
export declare const BookingsMembershipsTranslationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24200
|
+
/**
|
|
24201
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24202
|
+
* @summary Delete a place membership type translation
|
|
24203
|
+
* @param {string} placeId The place identifier
|
|
24204
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24205
|
+
* @param {string} locale The locale identifier
|
|
24206
|
+
* @param {*} [options] Override http request option.
|
|
24207
|
+
* @throws {RequiredError}
|
|
24208
|
+
*/
|
|
24209
|
+
deletePlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24210
|
+
/**
|
|
24211
|
+
* 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\".
|
|
24212
|
+
* @summary Get a place membership type\'s translation
|
|
24213
|
+
* @param {string} placeId The place identifier
|
|
24214
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24215
|
+
* @param {string} locale The locale identifier
|
|
24216
|
+
* @param {*} [options] Override http request option.
|
|
24217
|
+
* @throws {RequiredError}
|
|
24218
|
+
*/
|
|
24219
|
+
getPlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24220
|
+
/**
|
|
24221
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24222
|
+
* @summary List a place membership type\'s translations
|
|
24223
|
+
* @param {string} placeId The place identifier
|
|
24224
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24225
|
+
* @param {number} [page] Page number
|
|
24226
|
+
* @param {number} [pageSize] Number of items per page
|
|
24227
|
+
* @param {string} [orderBy] Field to order by
|
|
24228
|
+
* @param {string} [search] Search query
|
|
24229
|
+
* @param {*} [options] Override http request option.
|
|
24230
|
+
* @throws {RequiredError}
|
|
24231
|
+
*/
|
|
24232
|
+
getPlaceMembershipTypeTranslations: (placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24233
|
+
/**
|
|
24234
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24235
|
+
* @summary Update a place membership type\'s translation
|
|
24236
|
+
* @param {string} placeId The place identifier
|
|
24237
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24238
|
+
* @param {string} locale The locale identifier
|
|
24239
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
24240
|
+
* @param {*} [options] Override http request option.
|
|
24241
|
+
* @throws {RequiredError}
|
|
24242
|
+
*/
|
|
24243
|
+
updatePlaceMembershipTypeTranslation: (placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24244
|
+
};
|
|
24245
|
+
/**
|
|
24246
|
+
* BookingsMembershipsTranslationsApi - functional programming interface
|
|
24247
|
+
*/
|
|
24248
|
+
export declare const BookingsMembershipsTranslationsApiFp: (configuration?: Configuration) => {
|
|
24249
|
+
/**
|
|
24250
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24251
|
+
* @summary Delete a place membership type translation
|
|
24252
|
+
* @param {string} placeId The place identifier
|
|
24253
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24254
|
+
* @param {string} locale The locale identifier
|
|
24255
|
+
* @param {*} [options] Override http request option.
|
|
24256
|
+
* @throws {RequiredError}
|
|
24257
|
+
*/
|
|
24258
|
+
deletePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
24259
|
+
/**
|
|
24260
|
+
* 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\".
|
|
24261
|
+
* @summary Get a place membership type\'s translation
|
|
24262
|
+
* @param {string} placeId The place identifier
|
|
24263
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24264
|
+
* @param {string} locale The locale identifier
|
|
24265
|
+
* @param {*} [options] Override http request option.
|
|
24266
|
+
* @throws {RequiredError}
|
|
24267
|
+
*/
|
|
24268
|
+
getPlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslation200Response>>;
|
|
24269
|
+
/**
|
|
24270
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24271
|
+
* @summary List a place membership type\'s translations
|
|
24272
|
+
* @param {string} placeId The place identifier
|
|
24273
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24274
|
+
* @param {number} [page] Page number
|
|
24275
|
+
* @param {number} [pageSize] Number of items per page
|
|
24276
|
+
* @param {string} [orderBy] Field to order by
|
|
24277
|
+
* @param {string} [search] Search query
|
|
24278
|
+
* @param {*} [options] Override http request option.
|
|
24279
|
+
* @throws {RequiredError}
|
|
24280
|
+
*/
|
|
24281
|
+
getPlaceMembershipTypeTranslations(placeId: string, placeMembershipTypeId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPlaceMembershipTypeTranslations200Response>>;
|
|
24282
|
+
/**
|
|
24283
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24284
|
+
* @summary Update a place membership type\'s translation
|
|
24285
|
+
* @param {string} placeId The place identifier
|
|
24286
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
24287
|
+
* @param {string} locale The locale identifier
|
|
24288
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
24289
|
+
* @param {*} [options] Override http request option.
|
|
24290
|
+
* @throws {RequiredError}
|
|
24291
|
+
*/
|
|
24292
|
+
updatePlaceMembershipTypeTranslation(placeId: string, placeMembershipTypeId: string, locale: string, placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>>;
|
|
24293
|
+
};
|
|
24294
|
+
/**
|
|
24295
|
+
* BookingsMembershipsTranslationsApi - factory interface
|
|
24296
|
+
*/
|
|
24297
|
+
export declare const BookingsMembershipsTranslationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24298
|
+
/**
|
|
24299
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24300
|
+
* @summary Delete a place membership type translation
|
|
24301
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24302
|
+
* @param {*} [options] Override http request option.
|
|
24303
|
+
* @throws {RequiredError}
|
|
24304
|
+
*/
|
|
24305
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
24306
|
+
/**
|
|
24307
|
+
* 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\".
|
|
24308
|
+
* @summary Get a place membership type\'s translation
|
|
24309
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24310
|
+
* @param {*} [options] Override http request option.
|
|
24311
|
+
* @throws {RequiredError}
|
|
24312
|
+
*/
|
|
24313
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslation200Response>;
|
|
24314
|
+
/**
|
|
24315
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24316
|
+
* @summary List a place membership type\'s translations
|
|
24317
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
24318
|
+
* @param {*} [options] Override http request option.
|
|
24319
|
+
* @throws {RequiredError}
|
|
24320
|
+
*/
|
|
24321
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPlaceMembershipTypeTranslations200Response>;
|
|
24322
|
+
/**
|
|
24323
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24324
|
+
* @summary Update a place membership type\'s translation
|
|
24325
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24326
|
+
* @param {*} [options] Override http request option.
|
|
24327
|
+
* @throws {RequiredError}
|
|
24328
|
+
*/
|
|
24329
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdatePlaceMembershipTypeTranslation200Response>;
|
|
24330
|
+
};
|
|
24331
|
+
/**
|
|
24332
|
+
* Request parameters for deletePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24333
|
+
*/
|
|
24334
|
+
export interface BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest {
|
|
24335
|
+
/**
|
|
24336
|
+
* The place identifier
|
|
24337
|
+
*/
|
|
24338
|
+
readonly placeId: string;
|
|
24339
|
+
/**
|
|
24340
|
+
* The placeMembershipType identifier
|
|
24341
|
+
*/
|
|
24342
|
+
readonly placeMembershipTypeId: string;
|
|
24343
|
+
/**
|
|
24344
|
+
* The locale identifier
|
|
24345
|
+
*/
|
|
24346
|
+
readonly locale: string;
|
|
24347
|
+
}
|
|
24348
|
+
/**
|
|
24349
|
+
* Request parameters for getPlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24350
|
+
*/
|
|
24351
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest {
|
|
24352
|
+
/**
|
|
24353
|
+
* The place identifier
|
|
24354
|
+
*/
|
|
24355
|
+
readonly placeId: string;
|
|
24356
|
+
/**
|
|
24357
|
+
* The placeMembershipType identifier
|
|
24358
|
+
*/
|
|
24359
|
+
readonly placeMembershipTypeId: string;
|
|
24360
|
+
/**
|
|
24361
|
+
* The locale identifier
|
|
24362
|
+
*/
|
|
24363
|
+
readonly locale: string;
|
|
24364
|
+
}
|
|
24365
|
+
/**
|
|
24366
|
+
* Request parameters for getPlaceMembershipTypeTranslations operation in BookingsMembershipsTranslationsApi.
|
|
24367
|
+
*/
|
|
24368
|
+
export interface BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest {
|
|
24369
|
+
/**
|
|
24370
|
+
* The place identifier
|
|
24371
|
+
*/
|
|
24372
|
+
readonly placeId: string;
|
|
24373
|
+
/**
|
|
24374
|
+
* The placeMembershipType identifier
|
|
24375
|
+
*/
|
|
24376
|
+
readonly placeMembershipTypeId: string;
|
|
24377
|
+
/**
|
|
24378
|
+
* Page number
|
|
24379
|
+
*/
|
|
24380
|
+
readonly page?: number;
|
|
24381
|
+
/**
|
|
24382
|
+
* Number of items per page
|
|
24383
|
+
*/
|
|
24384
|
+
readonly pageSize?: number;
|
|
24385
|
+
/**
|
|
24386
|
+
* Field to order by
|
|
24387
|
+
*/
|
|
24388
|
+
readonly orderBy?: string;
|
|
24389
|
+
/**
|
|
24390
|
+
* Search query
|
|
24391
|
+
*/
|
|
24392
|
+
readonly search?: string;
|
|
24393
|
+
}
|
|
24394
|
+
/**
|
|
24395
|
+
* Request parameters for updatePlaceMembershipTypeTranslation operation in BookingsMembershipsTranslationsApi.
|
|
24396
|
+
*/
|
|
24397
|
+
export interface BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest {
|
|
24398
|
+
/**
|
|
24399
|
+
* The place identifier
|
|
24400
|
+
*/
|
|
24401
|
+
readonly placeId: string;
|
|
24402
|
+
/**
|
|
24403
|
+
* The placeMembershipType identifier
|
|
24404
|
+
*/
|
|
24405
|
+
readonly placeMembershipTypeId: string;
|
|
24406
|
+
/**
|
|
24407
|
+
* The locale identifier
|
|
24408
|
+
*/
|
|
24409
|
+
readonly locale: string;
|
|
24410
|
+
readonly placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs;
|
|
24411
|
+
}
|
|
24412
|
+
/**
|
|
24413
|
+
* BookingsMembershipsTranslationsApi - object-oriented interface
|
|
24414
|
+
*/
|
|
24415
|
+
export declare class BookingsMembershipsTranslationsApi extends BaseAPI {
|
|
24416
|
+
/**
|
|
24417
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
24418
|
+
* @summary Delete a place membership type translation
|
|
24419
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24420
|
+
* @param {*} [options] Override http request option.
|
|
24421
|
+
* @throws {RequiredError}
|
|
24422
|
+
*/
|
|
24423
|
+
deletePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
24424
|
+
/**
|
|
24425
|
+
* 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\".
|
|
24426
|
+
* @summary Get a place membership type\'s translation
|
|
24427
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24428
|
+
* @param {*} [options] Override http request option.
|
|
24429
|
+
* @throws {RequiredError}
|
|
24430
|
+
*/
|
|
24431
|
+
getPlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypeTranslation200Response, any, {}, any>>;
|
|
24432
|
+
/**
|
|
24433
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
24434
|
+
* @summary List a place membership type\'s translations
|
|
24435
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
24436
|
+
* @param {*} [options] Override http request option.
|
|
24437
|
+
* @throws {RequiredError}
|
|
24438
|
+
*/
|
|
24439
|
+
getPlaceMembershipTypeTranslations(requestParameters: BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPlaceMembershipTypeTranslations200Response, any, {}, any>>;
|
|
24440
|
+
/**
|
|
24441
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
24442
|
+
* @summary Update a place membership type\'s translation
|
|
24443
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
24444
|
+
* @param {*} [options] Override http request option.
|
|
24445
|
+
* @throws {RequiredError}
|
|
24446
|
+
*/
|
|
24447
|
+
updatePlaceMembershipTypeTranslation(requestParameters: BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePlaceMembershipTypeTranslation200Response, any, {}, any>>;
|
|
24448
|
+
}
|
|
23171
24449
|
/**
|
|
23172
24450
|
* BookingsPlacesApi - axios parameter creator
|
|
23173
24451
|
*/
|
|
@@ -81140,7 +82418,7 @@ export declare const StreamsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
81140
82418
|
*/
|
|
81141
82419
|
createStreamInput: (streamInputCreateInputs: StreamInputCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81142
82420
|
/**
|
|
81143
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
82421
|
+
* 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.
|
|
81144
82422
|
* @summary Delete a stream input
|
|
81145
82423
|
* @param {string} streamId The stream identifier
|
|
81146
82424
|
* @param {*} [options] Override http request option.
|
|
@@ -81214,7 +82492,7 @@ export declare const StreamsApiFp: (configuration?: Configuration) => {
|
|
|
81214
82492
|
*/
|
|
81215
82493
|
createStreamInput(streamInputCreateInputs: StreamInputCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamInput200Response>>;
|
|
81216
82494
|
/**
|
|
81217
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
82495
|
+
* 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.
|
|
81218
82496
|
* @summary Delete a stream input
|
|
81219
82497
|
* @param {string} streamId The stream identifier
|
|
81220
82498
|
* @param {*} [options] Override http request option.
|
|
@@ -81288,7 +82566,7 @@ export declare const StreamsApiFactory: (configuration?: Configuration, basePath
|
|
|
81288
82566
|
*/
|
|
81289
82567
|
createStreamInput(requestParameters: StreamsApiCreateStreamInputRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamInput200Response>;
|
|
81290
82568
|
/**
|
|
81291
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
82569
|
+
* 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.
|
|
81292
82570
|
* @summary Delete a stream input
|
|
81293
82571
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
81294
82572
|
* @param {*} [options] Override http request option.
|
|
@@ -81455,7 +82733,7 @@ export declare class StreamsApi extends BaseAPI {
|
|
|
81455
82733
|
*/
|
|
81456
82734
|
createStreamInput(requestParameters: StreamsApiCreateStreamInputRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamInput200Response, any, {}, any>>;
|
|
81457
82735
|
/**
|
|
81458
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
82736
|
+
* 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.
|
|
81459
82737
|
* @summary Delete a stream input
|
|
81460
82738
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
81461
82739
|
* @param {*} [options] Override http request option.
|
|
@@ -81798,6 +83076,29 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
81798
83076
|
* @throws {RequiredError}
|
|
81799
83077
|
*/
|
|
81800
83078
|
exportStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83079
|
+
/**
|
|
83080
|
+
* 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.
|
|
83081
|
+
* @summary Request an export of a stream session by session id
|
|
83082
|
+
* @param {string} sessionId The session identifier
|
|
83083
|
+
* @param {*} [options] Override http request option.
|
|
83084
|
+
* @throws {RequiredError}
|
|
83085
|
+
*/
|
|
83086
|
+
exportStreamSessionById: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83087
|
+
/**
|
|
83088
|
+
* 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.
|
|
83089
|
+
* @summary List stream sessions across all stream inputs
|
|
83090
|
+
* @param {string} [streamId] Filter by streamId
|
|
83091
|
+
* @param {string} [eventId] Filter by eventId
|
|
83092
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
83093
|
+
* @param {string} [status] Filter by status
|
|
83094
|
+
* @param {number} [page] Page number
|
|
83095
|
+
* @param {number} [pageSize] Number of items per page
|
|
83096
|
+
* @param {string} [orderBy] Field to order by
|
|
83097
|
+
* @param {string} [search] Search query
|
|
83098
|
+
* @param {*} [options] Override http request option.
|
|
83099
|
+
* @throws {RequiredError}
|
|
83100
|
+
*/
|
|
83101
|
+
getAllStreamSessions: (streamId?: string, eventId?: string, eventSessionId?: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81801
83102
|
/**
|
|
81802
83103
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
81803
83104
|
* @summary Get a single stream session
|
|
@@ -81807,6 +83108,35 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
81807
83108
|
* @throws {RequiredError}
|
|
81808
83109
|
*/
|
|
81809
83110
|
getStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83111
|
+
/**
|
|
83112
|
+
* 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.
|
|
83113
|
+
* @summary Get a stream session by id
|
|
83114
|
+
* @param {string} sessionId The session identifier
|
|
83115
|
+
* @param {*} [options] Override http request option.
|
|
83116
|
+
* @throws {RequiredError}
|
|
83117
|
+
*/
|
|
83118
|
+
getStreamSessionById: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83119
|
+
/**
|
|
83120
|
+
* 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.
|
|
83121
|
+
* @summary List a stream session\'s chat messages by session id
|
|
83122
|
+
* @param {string} sessionId The session identifier
|
|
83123
|
+
* @param {*} [options] Override http request option.
|
|
83124
|
+
* @throws {RequiredError}
|
|
83125
|
+
*/
|
|
83126
|
+
getStreamSessionByIdChat: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83127
|
+
/**
|
|
83128
|
+
* 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.
|
|
83129
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
83130
|
+
* @param {string} sessionId The session identifier
|
|
83131
|
+
* @param {boolean} [active] Filter by active
|
|
83132
|
+
* @param {number} [page] Page number
|
|
83133
|
+
* @param {number} [pageSize] Number of items per page
|
|
83134
|
+
* @param {string} [orderBy] Field to order by
|
|
83135
|
+
* @param {string} [search] Search query
|
|
83136
|
+
* @param {*} [options] Override http request option.
|
|
83137
|
+
* @throws {RequiredError}
|
|
83138
|
+
*/
|
|
83139
|
+
getStreamSessionByIdSubscriptions: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81810
83140
|
/**
|
|
81811
83141
|
* 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.
|
|
81812
83142
|
* @summary List a stream session\'s chat messages
|
|
@@ -81843,6 +83173,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
81843
83173
|
* @throws {RequiredError}
|
|
81844
83174
|
*/
|
|
81845
83175
|
getStreamSessions: (streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83176
|
+
/**
|
|
83177
|
+
* 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.
|
|
83178
|
+
* @summary Update a stream session
|
|
83179
|
+
* @param {string} sessionId The session identifier
|
|
83180
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
83181
|
+
* @param {*} [options] Override http request option.
|
|
83182
|
+
* @throws {RequiredError}
|
|
83183
|
+
*/
|
|
83184
|
+
updateStreamSession: (sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81846
83185
|
};
|
|
81847
83186
|
/**
|
|
81848
83187
|
* StreamsSessionsApi - functional programming interface
|
|
@@ -81866,6 +83205,29 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
81866
83205
|
* @throws {RequiredError}
|
|
81867
83206
|
*/
|
|
81868
83207
|
exportStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83208
|
+
/**
|
|
83209
|
+
* 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.
|
|
83210
|
+
* @summary Request an export of a stream session by session id
|
|
83211
|
+
* @param {string} sessionId The session identifier
|
|
83212
|
+
* @param {*} [options] Override http request option.
|
|
83213
|
+
* @throws {RequiredError}
|
|
83214
|
+
*/
|
|
83215
|
+
exportStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83216
|
+
/**
|
|
83217
|
+
* 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.
|
|
83218
|
+
* @summary List stream sessions across all stream inputs
|
|
83219
|
+
* @param {string} [streamId] Filter by streamId
|
|
83220
|
+
* @param {string} [eventId] Filter by eventId
|
|
83221
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
83222
|
+
* @param {string} [status] Filter by status
|
|
83223
|
+
* @param {number} [page] Page number
|
|
83224
|
+
* @param {number} [pageSize] Number of items per page
|
|
83225
|
+
* @param {string} [orderBy] Field to order by
|
|
83226
|
+
* @param {string} [search] Search query
|
|
83227
|
+
* @param {*} [options] Override http request option.
|
|
83228
|
+
* @throws {RequiredError}
|
|
83229
|
+
*/
|
|
83230
|
+
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>>;
|
|
81869
83231
|
/**
|
|
81870
83232
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
81871
83233
|
* @summary Get a single stream session
|
|
@@ -81874,7 +83236,36 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
81874
83236
|
* @param {*} [options] Override http request option.
|
|
81875
83237
|
* @throws {RequiredError}
|
|
81876
83238
|
*/
|
|
81877
|
-
getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
83239
|
+
getStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
83240
|
+
/**
|
|
83241
|
+
* 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.
|
|
83242
|
+
* @summary Get a stream session by id
|
|
83243
|
+
* @param {string} sessionId The session identifier
|
|
83244
|
+
* @param {*} [options] Override http request option.
|
|
83245
|
+
* @throws {RequiredError}
|
|
83246
|
+
*/
|
|
83247
|
+
getStreamSessionById(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
83248
|
+
/**
|
|
83249
|
+
* 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.
|
|
83250
|
+
* @summary List a stream session\'s chat messages by session id
|
|
83251
|
+
* @param {string} sessionId The session identifier
|
|
83252
|
+
* @param {*} [options] Override http request option.
|
|
83253
|
+
* @throws {RequiredError}
|
|
83254
|
+
*/
|
|
83255
|
+
getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
|
|
83256
|
+
/**
|
|
83257
|
+
* 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.
|
|
83258
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
83259
|
+
* @param {string} sessionId The session identifier
|
|
83260
|
+
* @param {boolean} [active] Filter by active
|
|
83261
|
+
* @param {number} [page] Page number
|
|
83262
|
+
* @param {number} [pageSize] Number of items per page
|
|
83263
|
+
* @param {string} [orderBy] Field to order by
|
|
83264
|
+
* @param {string} [search] Search query
|
|
83265
|
+
* @param {*} [options] Override http request option.
|
|
83266
|
+
* @throws {RequiredError}
|
|
83267
|
+
*/
|
|
83268
|
+
getStreamSessionByIdSubscriptions(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
81878
83269
|
/**
|
|
81879
83270
|
* 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.
|
|
81880
83271
|
* @summary List a stream session\'s chat messages
|
|
@@ -81883,7 +83274,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
81883
83274
|
* @param {*} [options] Override http request option.
|
|
81884
83275
|
* @throws {RequiredError}
|
|
81885
83276
|
*/
|
|
81886
|
-
getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
83277
|
+
getStreamSessionChat(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
|
|
81887
83278
|
/**
|
|
81888
83279
|
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
81889
83280
|
* @summary List a stream session\'s viewer connections
|
|
@@ -81897,7 +83288,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
81897
83288
|
* @param {*} [options] Override http request option.
|
|
81898
83289
|
* @throws {RequiredError}
|
|
81899
83290
|
*/
|
|
81900
|
-
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
83291
|
+
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
81901
83292
|
/**
|
|
81902
83293
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
81903
83294
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -81910,7 +83301,16 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
81910
83301
|
* @param {*} [options] Override http request option.
|
|
81911
83302
|
* @throws {RequiredError}
|
|
81912
83303
|
*/
|
|
81913
|
-
getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
83304
|
+
getStreamSessions(streamId: string, status?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllStreamSessions200Response>>;
|
|
83305
|
+
/**
|
|
83306
|
+
* 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.
|
|
83307
|
+
* @summary Update a stream session
|
|
83308
|
+
* @param {string} sessionId The session identifier
|
|
83309
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
83310
|
+
* @param {*} [options] Override http request option.
|
|
83311
|
+
* @throws {RequiredError}
|
|
83312
|
+
*/
|
|
83313
|
+
updateStreamSession(sessionId: string, streamSessionUpdateInputs: StreamSessionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionById200Response>>;
|
|
81914
83314
|
};
|
|
81915
83315
|
/**
|
|
81916
83316
|
* StreamsSessionsApi - factory interface
|
|
@@ -81932,6 +83332,22 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
81932
83332
|
* @throws {RequiredError}
|
|
81933
83333
|
*/
|
|
81934
83334
|
exportStreamSession(requestParameters: StreamsSessionsApiExportStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83335
|
+
/**
|
|
83336
|
+
* 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.
|
|
83337
|
+
* @summary Request an export of a stream session by session id
|
|
83338
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
83339
|
+
* @param {*} [options] Override http request option.
|
|
83340
|
+
* @throws {RequiredError}
|
|
83341
|
+
*/
|
|
83342
|
+
exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83343
|
+
/**
|
|
83344
|
+
* 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.
|
|
83345
|
+
* @summary List stream sessions across all stream inputs
|
|
83346
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
83347
|
+
* @param {*} [options] Override http request option.
|
|
83348
|
+
* @throws {RequiredError}
|
|
83349
|
+
*/
|
|
83350
|
+
getAllStreamSessions(requestParameters?: StreamsSessionsApiGetAllStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
|
|
81935
83351
|
/**
|
|
81936
83352
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
81937
83353
|
* @summary Get a single stream session
|
|
@@ -81939,7 +83355,31 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
81939
83355
|
* @param {*} [options] Override http request option.
|
|
81940
83356
|
* @throws {RequiredError}
|
|
81941
83357
|
*/
|
|
81942
|
-
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
83358
|
+
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
83359
|
+
/**
|
|
83360
|
+
* 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.
|
|
83361
|
+
* @summary Get a stream session by id
|
|
83362
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
83363
|
+
* @param {*} [options] Override http request option.
|
|
83364
|
+
* @throws {RequiredError}
|
|
83365
|
+
*/
|
|
83366
|
+
getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
83367
|
+
/**
|
|
83368
|
+
* 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.
|
|
83369
|
+
* @summary List a stream session\'s chat messages by session id
|
|
83370
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
83371
|
+
* @param {*} [options] Override http request option.
|
|
83372
|
+
* @throws {RequiredError}
|
|
83373
|
+
*/
|
|
83374
|
+
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
|
|
83375
|
+
/**
|
|
83376
|
+
* 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.
|
|
83377
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
83378
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83379
|
+
* @param {*} [options] Override http request option.
|
|
83380
|
+
* @throws {RequiredError}
|
|
83381
|
+
*/
|
|
83382
|
+
getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
81943
83383
|
/**
|
|
81944
83384
|
* 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.
|
|
81945
83385
|
* @summary List a stream session\'s chat messages
|
|
@@ -81947,7 +83387,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
81947
83387
|
* @param {*} [options] Override http request option.
|
|
81948
83388
|
* @throws {RequiredError}
|
|
81949
83389
|
*/
|
|
81950
|
-
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
83390
|
+
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
|
|
81951
83391
|
/**
|
|
81952
83392
|
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
81953
83393
|
* @summary List a stream session\'s viewer connections
|
|
@@ -81955,7 +83395,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
81955
83395
|
* @param {*} [options] Override http request option.
|
|
81956
83396
|
* @throws {RequiredError}
|
|
81957
83397
|
*/
|
|
81958
|
-
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
83398
|
+
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
81959
83399
|
/**
|
|
81960
83400
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
81961
83401
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -81963,7 +83403,15 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
81963
83403
|
* @param {*} [options] Override http request option.
|
|
81964
83404
|
* @throws {RequiredError}
|
|
81965
83405
|
*/
|
|
81966
|
-
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
83406
|
+
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllStreamSessions200Response>;
|
|
83407
|
+
/**
|
|
83408
|
+
* 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.
|
|
83409
|
+
* @summary Update a stream session
|
|
83410
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
83411
|
+
* @param {*} [options] Override http request option.
|
|
83412
|
+
* @throws {RequiredError}
|
|
83413
|
+
*/
|
|
83414
|
+
updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionById200Response>;
|
|
81967
83415
|
};
|
|
81968
83416
|
/**
|
|
81969
83417
|
* Request parameters for closeStreamSession operation in StreamsSessionsApi.
|
|
@@ -81991,6 +83439,52 @@ export interface StreamsSessionsApiExportStreamSessionRequest {
|
|
|
81991
83439
|
*/
|
|
81992
83440
|
readonly sessionId: string;
|
|
81993
83441
|
}
|
|
83442
|
+
/**
|
|
83443
|
+
* Request parameters for exportStreamSessionById operation in StreamsSessionsApi.
|
|
83444
|
+
*/
|
|
83445
|
+
export interface StreamsSessionsApiExportStreamSessionByIdRequest {
|
|
83446
|
+
/**
|
|
83447
|
+
* The session identifier
|
|
83448
|
+
*/
|
|
83449
|
+
readonly sessionId: string;
|
|
83450
|
+
}
|
|
83451
|
+
/**
|
|
83452
|
+
* Request parameters for getAllStreamSessions operation in StreamsSessionsApi.
|
|
83453
|
+
*/
|
|
83454
|
+
export interface StreamsSessionsApiGetAllStreamSessionsRequest {
|
|
83455
|
+
/**
|
|
83456
|
+
* Filter by streamId
|
|
83457
|
+
*/
|
|
83458
|
+
readonly streamId?: string;
|
|
83459
|
+
/**
|
|
83460
|
+
* Filter by eventId
|
|
83461
|
+
*/
|
|
83462
|
+
readonly eventId?: string;
|
|
83463
|
+
/**
|
|
83464
|
+
* Filter by eventSessionId
|
|
83465
|
+
*/
|
|
83466
|
+
readonly eventSessionId?: string;
|
|
83467
|
+
/**
|
|
83468
|
+
* Filter by status
|
|
83469
|
+
*/
|
|
83470
|
+
readonly status?: string;
|
|
83471
|
+
/**
|
|
83472
|
+
* Page number
|
|
83473
|
+
*/
|
|
83474
|
+
readonly page?: number;
|
|
83475
|
+
/**
|
|
83476
|
+
* Number of items per page
|
|
83477
|
+
*/
|
|
83478
|
+
readonly pageSize?: number;
|
|
83479
|
+
/**
|
|
83480
|
+
* Field to order by
|
|
83481
|
+
*/
|
|
83482
|
+
readonly orderBy?: string;
|
|
83483
|
+
/**
|
|
83484
|
+
* Search query
|
|
83485
|
+
*/
|
|
83486
|
+
readonly search?: string;
|
|
83487
|
+
}
|
|
81994
83488
|
/**
|
|
81995
83489
|
* Request parameters for getStreamSession operation in StreamsSessionsApi.
|
|
81996
83490
|
*/
|
|
@@ -82004,6 +83498,53 @@ export interface StreamsSessionsApiGetStreamSessionRequest {
|
|
|
82004
83498
|
*/
|
|
82005
83499
|
readonly sessionId: string;
|
|
82006
83500
|
}
|
|
83501
|
+
/**
|
|
83502
|
+
* Request parameters for getStreamSessionById operation in StreamsSessionsApi.
|
|
83503
|
+
*/
|
|
83504
|
+
export interface StreamsSessionsApiGetStreamSessionByIdRequest {
|
|
83505
|
+
/**
|
|
83506
|
+
* The session identifier
|
|
83507
|
+
*/
|
|
83508
|
+
readonly sessionId: string;
|
|
83509
|
+
}
|
|
83510
|
+
/**
|
|
83511
|
+
* Request parameters for getStreamSessionByIdChat operation in StreamsSessionsApi.
|
|
83512
|
+
*/
|
|
83513
|
+
export interface StreamsSessionsApiGetStreamSessionByIdChatRequest {
|
|
83514
|
+
/**
|
|
83515
|
+
* The session identifier
|
|
83516
|
+
*/
|
|
83517
|
+
readonly sessionId: string;
|
|
83518
|
+
}
|
|
83519
|
+
/**
|
|
83520
|
+
* Request parameters for getStreamSessionByIdSubscriptions operation in StreamsSessionsApi.
|
|
83521
|
+
*/
|
|
83522
|
+
export interface StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest {
|
|
83523
|
+
/**
|
|
83524
|
+
* The session identifier
|
|
83525
|
+
*/
|
|
83526
|
+
readonly sessionId: string;
|
|
83527
|
+
/**
|
|
83528
|
+
* Filter by active
|
|
83529
|
+
*/
|
|
83530
|
+
readonly active?: boolean;
|
|
83531
|
+
/**
|
|
83532
|
+
* Page number
|
|
83533
|
+
*/
|
|
83534
|
+
readonly page?: number;
|
|
83535
|
+
/**
|
|
83536
|
+
* Number of items per page
|
|
83537
|
+
*/
|
|
83538
|
+
readonly pageSize?: number;
|
|
83539
|
+
/**
|
|
83540
|
+
* Field to order by
|
|
83541
|
+
*/
|
|
83542
|
+
readonly orderBy?: string;
|
|
83543
|
+
/**
|
|
83544
|
+
* Search query
|
|
83545
|
+
*/
|
|
83546
|
+
readonly search?: string;
|
|
83547
|
+
}
|
|
82007
83548
|
/**
|
|
82008
83549
|
* Request parameters for getStreamSessionChat operation in StreamsSessionsApi.
|
|
82009
83550
|
*/
|
|
@@ -82079,6 +83620,16 @@ export interface StreamsSessionsApiGetStreamSessionsRequest {
|
|
|
82079
83620
|
*/
|
|
82080
83621
|
readonly search?: string;
|
|
82081
83622
|
}
|
|
83623
|
+
/**
|
|
83624
|
+
* Request parameters for updateStreamSession operation in StreamsSessionsApi.
|
|
83625
|
+
*/
|
|
83626
|
+
export interface StreamsSessionsApiUpdateStreamSessionRequest {
|
|
83627
|
+
/**
|
|
83628
|
+
* The session identifier
|
|
83629
|
+
*/
|
|
83630
|
+
readonly sessionId: string;
|
|
83631
|
+
readonly streamSessionUpdateInputs: StreamSessionUpdateInputs;
|
|
83632
|
+
}
|
|
82082
83633
|
/**
|
|
82083
83634
|
* StreamsSessionsApi - object-oriented interface
|
|
82084
83635
|
*/
|
|
@@ -82099,6 +83650,22 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
82099
83650
|
* @throws {RequiredError}
|
|
82100
83651
|
*/
|
|
82101
83652
|
exportStreamSession(requestParameters: StreamsSessionsApiExportStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83653
|
+
/**
|
|
83654
|
+
* 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.
|
|
83655
|
+
* @summary Request an export of a stream session by session id
|
|
83656
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
83657
|
+
* @param {*} [options] Override http request option.
|
|
83658
|
+
* @throws {RequiredError}
|
|
83659
|
+
*/
|
|
83660
|
+
exportStreamSessionById(requestParameters: StreamsSessionsApiExportStreamSessionByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83661
|
+
/**
|
|
83662
|
+
* 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.
|
|
83663
|
+
* @summary List stream sessions across all stream inputs
|
|
83664
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
83665
|
+
* @param {*} [options] Override http request option.
|
|
83666
|
+
* @throws {RequiredError}
|
|
83667
|
+
*/
|
|
83668
|
+
getAllStreamSessions(requestParameters?: StreamsSessionsApiGetAllStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
|
|
82102
83669
|
/**
|
|
82103
83670
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
82104
83671
|
* @summary Get a single stream session
|
|
@@ -82106,7 +83673,31 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
82106
83673
|
* @param {*} [options] Override http request option.
|
|
82107
83674
|
* @throws {RequiredError}
|
|
82108
83675
|
*/
|
|
82109
|
-
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
83676
|
+
getStreamSession(requestParameters: StreamsSessionsApiGetStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
83677
|
+
/**
|
|
83678
|
+
* 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.
|
|
83679
|
+
* @summary Get a stream session by id
|
|
83680
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
83681
|
+
* @param {*} [options] Override http request option.
|
|
83682
|
+
* @throws {RequiredError}
|
|
83683
|
+
*/
|
|
83684
|
+
getStreamSessionById(requestParameters: StreamsSessionsApiGetStreamSessionByIdRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
83685
|
+
/**
|
|
83686
|
+
* 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.
|
|
83687
|
+
* @summary List a stream session\'s chat messages by session id
|
|
83688
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
83689
|
+
* @param {*} [options] Override http request option.
|
|
83690
|
+
* @throws {RequiredError}
|
|
83691
|
+
*/
|
|
83692
|
+
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
|
|
83693
|
+
/**
|
|
83694
|
+
* 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.
|
|
83695
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
83696
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83697
|
+
* @param {*} [options] Override http request option.
|
|
83698
|
+
* @throws {RequiredError}
|
|
83699
|
+
*/
|
|
83700
|
+
getStreamSessionByIdSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
82110
83701
|
/**
|
|
82111
83702
|
* 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.
|
|
82112
83703
|
* @summary List a stream session\'s chat messages
|
|
@@ -82114,7 +83705,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
82114
83705
|
* @param {*} [options] Override http request option.
|
|
82115
83706
|
* @throws {RequiredError}
|
|
82116
83707
|
*/
|
|
82117
|
-
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
83708
|
+
getStreamSessionChat(requestParameters: StreamsSessionsApiGetStreamSessionChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
|
|
82118
83709
|
/**
|
|
82119
83710
|
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, each with its connection details, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
82120
83711
|
* @summary List a stream session\'s viewer connections
|
|
@@ -82122,7 +83713,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
82122
83713
|
* @param {*} [options] Override http request option.
|
|
82123
83714
|
* @throws {RequiredError}
|
|
82124
83715
|
*/
|
|
82125
|
-
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
83716
|
+
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
82126
83717
|
/**
|
|
82127
83718
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
82128
83719
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -82130,7 +83721,15 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
82130
83721
|
* @param {*} [options] Override http request option.
|
|
82131
83722
|
* @throws {RequiredError}
|
|
82132
83723
|
*/
|
|
82133
|
-
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
83724
|
+
getStreamSessions(requestParameters: StreamsSessionsApiGetStreamSessionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllStreamSessions200Response, any, {}, any>>;
|
|
83725
|
+
/**
|
|
83726
|
+
* 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.
|
|
83727
|
+
* @summary Update a stream session
|
|
83728
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
83729
|
+
* @param {*} [options] Override http request option.
|
|
83730
|
+
* @throws {RequiredError}
|
|
83731
|
+
*/
|
|
83732
|
+
updateStreamSession(requestParameters: StreamsSessionsApiUpdateStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionById200Response, any, {}, any>>;
|
|
82134
83733
|
}
|
|
82135
83734
|
/**
|
|
82136
83735
|
* SupportApi - axios parameter creator
|