@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.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.5.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -539,6 +539,14 @@ export var CreateOrganizationTeamMember200ResponseStatusEnum;
|
|
|
539
539
|
(function (CreateOrganizationTeamMember200ResponseStatusEnum) {
|
|
540
540
|
CreateOrganizationTeamMember200ResponseStatusEnum["Ok"] = "ok";
|
|
541
541
|
})(CreateOrganizationTeamMember200ResponseStatusEnum || (CreateOrganizationTeamMember200ResponseStatusEnum = {}));
|
|
542
|
+
export var CreatePlaceMembershipMember200ResponseStatusEnum;
|
|
543
|
+
(function (CreatePlaceMembershipMember200ResponseStatusEnum) {
|
|
544
|
+
CreatePlaceMembershipMember200ResponseStatusEnum["Ok"] = "ok";
|
|
545
|
+
})(CreatePlaceMembershipMember200ResponseStatusEnum || (CreatePlaceMembershipMember200ResponseStatusEnum = {}));
|
|
546
|
+
export var CreatePlaceMembershipType200ResponseStatusEnum;
|
|
547
|
+
(function (CreatePlaceMembershipType200ResponseStatusEnum) {
|
|
548
|
+
CreatePlaceMembershipType200ResponseStatusEnum["Ok"] = "ok";
|
|
549
|
+
})(CreatePlaceMembershipType200ResponseStatusEnum || (CreatePlaceMembershipType200ResponseStatusEnum = {}));
|
|
542
550
|
export var CreatePreset200ResponseStatusEnum;
|
|
543
551
|
(function (CreatePreset200ResponseStatusEnum) {
|
|
544
552
|
CreatePreset200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -886,6 +894,10 @@ export var GetAllAccountMerges200ResponseStatusEnum;
|
|
|
886
894
|
(function (GetAllAccountMerges200ResponseStatusEnum) {
|
|
887
895
|
GetAllAccountMerges200ResponseStatusEnum["Ok"] = "ok";
|
|
888
896
|
})(GetAllAccountMerges200ResponseStatusEnum || (GetAllAccountMerges200ResponseStatusEnum = {}));
|
|
897
|
+
export var GetAllStreamSessions200ResponseStatusEnum;
|
|
898
|
+
(function (GetAllStreamSessions200ResponseStatusEnum) {
|
|
899
|
+
GetAllStreamSessions200ResponseStatusEnum["Ok"] = "ok";
|
|
900
|
+
})(GetAllStreamSessions200ResponseStatusEnum || (GetAllStreamSessions200ResponseStatusEnum = {}));
|
|
889
901
|
export var GetAnnouncementAudienceAccounts200ResponseStatusEnum;
|
|
890
902
|
(function (GetAnnouncementAudienceAccounts200ResponseStatusEnum) {
|
|
891
903
|
GetAnnouncementAudienceAccounts200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1870,6 +1882,30 @@ export var GetPaymentTaxMetadata200ResponseStatusEnum;
|
|
|
1870
1882
|
(function (GetPaymentTaxMetadata200ResponseStatusEnum) {
|
|
1871
1883
|
GetPaymentTaxMetadata200ResponseStatusEnum["Ok"] = "ok";
|
|
1872
1884
|
})(GetPaymentTaxMetadata200ResponseStatusEnum || (GetPaymentTaxMetadata200ResponseStatusEnum = {}));
|
|
1885
|
+
export var GetPlaceMembership200ResponseStatusEnum;
|
|
1886
|
+
(function (GetPlaceMembership200ResponseStatusEnum) {
|
|
1887
|
+
GetPlaceMembership200ResponseStatusEnum["Ok"] = "ok";
|
|
1888
|
+
})(GetPlaceMembership200ResponseStatusEnum || (GetPlaceMembership200ResponseStatusEnum = {}));
|
|
1889
|
+
export var GetPlaceMembershipMembers200ResponseStatusEnum;
|
|
1890
|
+
(function (GetPlaceMembershipMembers200ResponseStatusEnum) {
|
|
1891
|
+
GetPlaceMembershipMembers200ResponseStatusEnum["Ok"] = "ok";
|
|
1892
|
+
})(GetPlaceMembershipMembers200ResponseStatusEnum || (GetPlaceMembershipMembers200ResponseStatusEnum = {}));
|
|
1893
|
+
export var GetPlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
1894
|
+
(function (GetPlaceMembershipTypeTranslation200ResponseStatusEnum) {
|
|
1895
|
+
GetPlaceMembershipTypeTranslation200ResponseStatusEnum["Ok"] = "ok";
|
|
1896
|
+
})(GetPlaceMembershipTypeTranslation200ResponseStatusEnum || (GetPlaceMembershipTypeTranslation200ResponseStatusEnum = {}));
|
|
1897
|
+
export var GetPlaceMembershipTypeTranslations200ResponseStatusEnum;
|
|
1898
|
+
(function (GetPlaceMembershipTypeTranslations200ResponseStatusEnum) {
|
|
1899
|
+
GetPlaceMembershipTypeTranslations200ResponseStatusEnum["Ok"] = "ok";
|
|
1900
|
+
})(GetPlaceMembershipTypeTranslations200ResponseStatusEnum || (GetPlaceMembershipTypeTranslations200ResponseStatusEnum = {}));
|
|
1901
|
+
export var GetPlaceMembershipTypes200ResponseStatusEnum;
|
|
1902
|
+
(function (GetPlaceMembershipTypes200ResponseStatusEnum) {
|
|
1903
|
+
GetPlaceMembershipTypes200ResponseStatusEnum["Ok"] = "ok";
|
|
1904
|
+
})(GetPlaceMembershipTypes200ResponseStatusEnum || (GetPlaceMembershipTypes200ResponseStatusEnum = {}));
|
|
1905
|
+
export var GetPlaceMemberships200ResponseStatusEnum;
|
|
1906
|
+
(function (GetPlaceMemberships200ResponseStatusEnum) {
|
|
1907
|
+
GetPlaceMemberships200ResponseStatusEnum["Ok"] = "ok";
|
|
1908
|
+
})(GetPlaceMemberships200ResponseStatusEnum || (GetPlaceMemberships200ResponseStatusEnum = {}));
|
|
1873
1909
|
export var GetPreferences200ResponseStatusEnum;
|
|
1874
1910
|
(function (GetPreferences200ResponseStatusEnum) {
|
|
1875
1911
|
GetPreferences200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1962,22 +1998,18 @@ export var GetStreamInputs200ResponseStatusEnum;
|
|
|
1962
1998
|
(function (GetStreamInputs200ResponseStatusEnum) {
|
|
1963
1999
|
GetStreamInputs200ResponseStatusEnum["Ok"] = "ok";
|
|
1964
2000
|
})(GetStreamInputs200ResponseStatusEnum || (GetStreamInputs200ResponseStatusEnum = {}));
|
|
1965
|
-
export var
|
|
1966
|
-
(function (
|
|
1967
|
-
|
|
1968
|
-
})(
|
|
1969
|
-
export var
|
|
1970
|
-
(function (
|
|
1971
|
-
|
|
1972
|
-
})(
|
|
1973
|
-
export var
|
|
1974
|
-
(function (
|
|
1975
|
-
|
|
1976
|
-
})(
|
|
1977
|
-
export var GetStreamSessions200ResponseStatusEnum;
|
|
1978
|
-
(function (GetStreamSessions200ResponseStatusEnum) {
|
|
1979
|
-
GetStreamSessions200ResponseStatusEnum["Ok"] = "ok";
|
|
1980
|
-
})(GetStreamSessions200ResponseStatusEnum || (GetStreamSessions200ResponseStatusEnum = {}));
|
|
2001
|
+
export var GetStreamSessionById200ResponseStatusEnum;
|
|
2002
|
+
(function (GetStreamSessionById200ResponseStatusEnum) {
|
|
2003
|
+
GetStreamSessionById200ResponseStatusEnum["Ok"] = "ok";
|
|
2004
|
+
})(GetStreamSessionById200ResponseStatusEnum || (GetStreamSessionById200ResponseStatusEnum = {}));
|
|
2005
|
+
export var GetStreamSessionByIdChat200ResponseStatusEnum;
|
|
2006
|
+
(function (GetStreamSessionByIdChat200ResponseStatusEnum) {
|
|
2007
|
+
GetStreamSessionByIdChat200ResponseStatusEnum["Ok"] = "ok";
|
|
2008
|
+
})(GetStreamSessionByIdChat200ResponseStatusEnum || (GetStreamSessionByIdChat200ResponseStatusEnum = {}));
|
|
2009
|
+
export var GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
|
|
2010
|
+
(function (GetStreamSessionByIdSubscriptions200ResponseStatusEnum) {
|
|
2011
|
+
GetStreamSessionByIdSubscriptions200ResponseStatusEnum["Ok"] = "ok";
|
|
2012
|
+
})(GetStreamSessionByIdSubscriptions200ResponseStatusEnum || (GetStreamSessionByIdSubscriptions200ResponseStatusEnum = {}));
|
|
1981
2013
|
export var GetStreamVideos200ResponseStatusEnum;
|
|
1982
2014
|
(function (GetStreamVideos200ResponseStatusEnum) {
|
|
1983
2015
|
GetStreamVideos200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2528,6 +2560,7 @@ export var PaymentIntentSource;
|
|
|
2528
2560
|
PaymentIntentSource["Session"] = "session";
|
|
2529
2561
|
PaymentIntentSource["Booking"] = "booking";
|
|
2530
2562
|
PaymentIntentSource["Series"] = "series";
|
|
2563
|
+
PaymentIntentSource["PlaceMembership"] = "placeMembership";
|
|
2531
2564
|
})(PaymentIntentSource || (PaymentIntentSource = {}));
|
|
2532
2565
|
export var PaymentLineItemType;
|
|
2533
2566
|
(function (PaymentLineItemType) {
|
|
@@ -2541,6 +2574,7 @@ export var PaymentLineItemType;
|
|
|
2541
2574
|
PaymentLineItemType["Booking"] = "booking";
|
|
2542
2575
|
PaymentLineItemType["Coupon"] = "coupon";
|
|
2543
2576
|
PaymentLineItemType["Series"] = "series";
|
|
2577
|
+
PaymentLineItemType["PlaceMembership"] = "placeMembership";
|
|
2544
2578
|
PaymentLineItemType["Refund"] = "refund";
|
|
2545
2579
|
})(PaymentLineItemType || (PaymentLineItemType = {}));
|
|
2546
2580
|
export var PaymentType;
|
|
@@ -2548,6 +2582,11 @@ export var PaymentType;
|
|
|
2548
2582
|
PaymentType["Charge"] = "charge";
|
|
2549
2583
|
PaymentType["Refund"] = "refund";
|
|
2550
2584
|
})(PaymentType || (PaymentType = {}));
|
|
2585
|
+
export var PlaceMembershipUpdateInputsStatusEnum;
|
|
2586
|
+
(function (PlaceMembershipUpdateInputsStatusEnum) {
|
|
2587
|
+
PlaceMembershipUpdateInputsStatusEnum["Ready"] = "ready";
|
|
2588
|
+
PlaceMembershipUpdateInputsStatusEnum["Canceled"] = "canceled";
|
|
2589
|
+
})(PlaceMembershipUpdateInputsStatusEnum || (PlaceMembershipUpdateInputsStatusEnum = {}));
|
|
2551
2590
|
export var PurchaseStatus;
|
|
2552
2591
|
(function (PurchaseStatus) {
|
|
2553
2592
|
PurchaseStatus["Draft"] = "draft";
|
|
@@ -2777,6 +2816,11 @@ export var StreamInputDetailsRecordingModeEnum;
|
|
|
2777
2816
|
StreamInputDetailsRecordingModeEnum["Automatic"] = "automatic";
|
|
2778
2817
|
StreamInputDetailsRecordingModeEnum["Off"] = "off";
|
|
2779
2818
|
})(StreamInputDetailsRecordingModeEnum || (StreamInputDetailsRecordingModeEnum = {}));
|
|
2819
|
+
export var StreamSessionStatus;
|
|
2820
|
+
(function (StreamSessionStatus) {
|
|
2821
|
+
StreamSessionStatus["Active"] = "ACTIVE";
|
|
2822
|
+
StreamSessionStatus["Ended"] = "ENDED";
|
|
2823
|
+
})(StreamSessionStatus || (StreamSessionStatus = {}));
|
|
2780
2824
|
export var SupportTicketActivitySource;
|
|
2781
2825
|
(function (SupportTicketActivitySource) {
|
|
2782
2826
|
SupportTicketActivitySource["System"] = "SYSTEM";
|
|
@@ -3003,6 +3047,10 @@ export var UpdateOrganizationDomain200ResponseStatusEnum;
|
|
|
3003
3047
|
(function (UpdateOrganizationDomain200ResponseStatusEnum) {
|
|
3004
3048
|
UpdateOrganizationDomain200ResponseStatusEnum["Ok"] = "ok";
|
|
3005
3049
|
})(UpdateOrganizationDomain200ResponseStatusEnum || (UpdateOrganizationDomain200ResponseStatusEnum = {}));
|
|
3050
|
+
export var UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum;
|
|
3051
|
+
(function (UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum) {
|
|
3052
|
+
UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum["Ok"] = "ok";
|
|
3053
|
+
})(UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum || (UpdatePlaceMembershipTypeTranslation200ResponseStatusEnum = {}));
|
|
3006
3054
|
export var UpdateSelf200ResponseStatusEnum;
|
|
3007
3055
|
(function (UpdateSelf200ResponseStatusEnum) {
|
|
3008
3056
|
UpdateSelf200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -16397,6 +16445,1554 @@ export class BookingsBlackoutsApi extends BaseAPI {
|
|
|
16397
16445
|
return BookingsBlackoutsApiFp(this.configuration).updateBookingSpaceBlackout(requestParameters.spaceId, requestParameters.blackoutId, requestParameters.bookingSpaceBlackoutUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
16398
16446
|
}
|
|
16399
16447
|
}
|
|
16448
|
+
/**
|
|
16449
|
+
* BookingsMembershipsApi - axios parameter creator
|
|
16450
|
+
*/
|
|
16451
|
+
export const BookingsMembershipsApiAxiosParamCreator = function (configuration) {
|
|
16452
|
+
return {
|
|
16453
|
+
/**
|
|
16454
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
16455
|
+
* @summary Grant a place membership
|
|
16456
|
+
* @param {string} placeId The place identifier
|
|
16457
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
16458
|
+
* @param {*} [options] Override http request option.
|
|
16459
|
+
* @throws {RequiredError}
|
|
16460
|
+
*/
|
|
16461
|
+
createPlaceMembership: (placeId_1, placeMembershipCreateInputs_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipCreateInputs_1, ...args_1], void 0, function* (placeId, placeMembershipCreateInputs, options = {}) {
|
|
16462
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16463
|
+
assertParamExists('createPlaceMembership', 'placeId', placeId);
|
|
16464
|
+
// verify required parameter 'placeMembershipCreateInputs' is not null or undefined
|
|
16465
|
+
assertParamExists('createPlaceMembership', 'placeMembershipCreateInputs', placeMembershipCreateInputs);
|
|
16466
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
16467
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
16468
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16469
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16470
|
+
let baseOptions;
|
|
16471
|
+
if (configuration) {
|
|
16472
|
+
baseOptions = configuration.baseOptions;
|
|
16473
|
+
}
|
|
16474
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
16475
|
+
const localVarHeaderParameter = {};
|
|
16476
|
+
const localVarQueryParameter = {};
|
|
16477
|
+
// authentication ApiKeyAuth required
|
|
16478
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16479
|
+
// authentication OrganizationId required
|
|
16480
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16481
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16482
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16483
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16484
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16485
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16486
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipCreateInputs, localVarRequestOptions, configuration);
|
|
16487
|
+
return {
|
|
16488
|
+
url: toPathString(localVarUrlObj),
|
|
16489
|
+
options: localVarRequestOptions,
|
|
16490
|
+
};
|
|
16491
|
+
}),
|
|
16492
|
+
/**
|
|
16493
|
+
* 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.
|
|
16494
|
+
* @summary Add a member to a place membership
|
|
16495
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16496
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
16497
|
+
* @param {*} [options] Override http request option.
|
|
16498
|
+
* @throws {RequiredError}
|
|
16499
|
+
*/
|
|
16500
|
+
createPlaceMembershipMember: (placeMembershipId_1, placeMembershipMemberCreateInputs_1, ...args_1) => __awaiter(this, [placeMembershipId_1, placeMembershipMemberCreateInputs_1, ...args_1], void 0, function* (placeMembershipId, placeMembershipMemberCreateInputs, options = {}) {
|
|
16501
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16502
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipId', placeMembershipId);
|
|
16503
|
+
// verify required parameter 'placeMembershipMemberCreateInputs' is not null or undefined
|
|
16504
|
+
assertParamExists('createPlaceMembershipMember', 'placeMembershipMemberCreateInputs', placeMembershipMemberCreateInputs);
|
|
16505
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
16506
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
16507
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16508
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16509
|
+
let baseOptions;
|
|
16510
|
+
if (configuration) {
|
|
16511
|
+
baseOptions = configuration.baseOptions;
|
|
16512
|
+
}
|
|
16513
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
16514
|
+
const localVarHeaderParameter = {};
|
|
16515
|
+
const localVarQueryParameter = {};
|
|
16516
|
+
// authentication ApiKeyAuth required
|
|
16517
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16518
|
+
// authentication OrganizationId required
|
|
16519
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16520
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16521
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16522
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16523
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16524
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16525
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberCreateInputs, localVarRequestOptions, configuration);
|
|
16526
|
+
return {
|
|
16527
|
+
url: toPathString(localVarUrlObj),
|
|
16528
|
+
options: localVarRequestOptions,
|
|
16529
|
+
};
|
|
16530
|
+
}),
|
|
16531
|
+
/**
|
|
16532
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
16533
|
+
* @summary Create a place membership type
|
|
16534
|
+
* @param {string} placeId The place identifier
|
|
16535
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
16536
|
+
* @param {*} [options] Override http request option.
|
|
16537
|
+
* @throws {RequiredError}
|
|
16538
|
+
*/
|
|
16539
|
+
createPlaceMembershipType: (placeId_1, placeMembershipTypeCreateInputs_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeCreateInputs_1, ...args_1], void 0, function* (placeId, placeMembershipTypeCreateInputs, options = {}) {
|
|
16540
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16541
|
+
assertParamExists('createPlaceMembershipType', 'placeId', placeId);
|
|
16542
|
+
// verify required parameter 'placeMembershipTypeCreateInputs' is not null or undefined
|
|
16543
|
+
assertParamExists('createPlaceMembershipType', 'placeMembershipTypeCreateInputs', placeMembershipTypeCreateInputs);
|
|
16544
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
16545
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
16546
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16547
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16548
|
+
let baseOptions;
|
|
16549
|
+
if (configuration) {
|
|
16550
|
+
baseOptions = configuration.baseOptions;
|
|
16551
|
+
}
|
|
16552
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
16553
|
+
const localVarHeaderParameter = {};
|
|
16554
|
+
const localVarQueryParameter = {};
|
|
16555
|
+
// authentication ApiKeyAuth required
|
|
16556
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16557
|
+
// authentication OrganizationId required
|
|
16558
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16559
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16560
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16561
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16562
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16563
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16564
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeCreateInputs, localVarRequestOptions, configuration);
|
|
16565
|
+
return {
|
|
16566
|
+
url: toPathString(localVarUrlObj),
|
|
16567
|
+
options: localVarRequestOptions,
|
|
16568
|
+
};
|
|
16569
|
+
}),
|
|
16570
|
+
/**
|
|
16571
|
+
* 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.
|
|
16572
|
+
* @summary Remove a member from a place membership
|
|
16573
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16574
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
16575
|
+
* @param {*} [options] Override http request option.
|
|
16576
|
+
* @throws {RequiredError}
|
|
16577
|
+
*/
|
|
16578
|
+
deletePlaceMembershipMember: (placeMembershipId_1, placeMembershipMemberId_1, ...args_1) => __awaiter(this, [placeMembershipId_1, placeMembershipMemberId_1, ...args_1], void 0, function* (placeMembershipId, placeMembershipMemberId, options = {}) {
|
|
16579
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16580
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipId', placeMembershipId);
|
|
16581
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
16582
|
+
assertParamExists('deletePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId);
|
|
16583
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
16584
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
16585
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
16586
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16587
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16588
|
+
let baseOptions;
|
|
16589
|
+
if (configuration) {
|
|
16590
|
+
baseOptions = configuration.baseOptions;
|
|
16591
|
+
}
|
|
16592
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
16593
|
+
const localVarHeaderParameter = {};
|
|
16594
|
+
const localVarQueryParameter = {};
|
|
16595
|
+
// authentication ApiKeyAuth required
|
|
16596
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16597
|
+
// authentication OrganizationId required
|
|
16598
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16599
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16600
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16601
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16602
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16603
|
+
return {
|
|
16604
|
+
url: toPathString(localVarUrlObj),
|
|
16605
|
+
options: localVarRequestOptions,
|
|
16606
|
+
};
|
|
16607
|
+
}),
|
|
16608
|
+
/**
|
|
16609
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
16610
|
+
* @summary Delete a place membership type
|
|
16611
|
+
* @param {string} placeId The place identifier
|
|
16612
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
16613
|
+
* @param {*} [options] Override http request option.
|
|
16614
|
+
* @throws {RequiredError}
|
|
16615
|
+
*/
|
|
16616
|
+
deletePlaceMembershipType: (placeId_1, placeMembershipTypeId_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, options = {}) {
|
|
16617
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16618
|
+
assertParamExists('deletePlaceMembershipType', 'placeId', placeId);
|
|
16619
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
16620
|
+
assertParamExists('deletePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
16621
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
16622
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
16623
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
16624
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16625
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16626
|
+
let baseOptions;
|
|
16627
|
+
if (configuration) {
|
|
16628
|
+
baseOptions = configuration.baseOptions;
|
|
16629
|
+
}
|
|
16630
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
16631
|
+
const localVarHeaderParameter = {};
|
|
16632
|
+
const localVarQueryParameter = {};
|
|
16633
|
+
// authentication ApiKeyAuth required
|
|
16634
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16635
|
+
// authentication OrganizationId required
|
|
16636
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16637
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16638
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16639
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16640
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16641
|
+
return {
|
|
16642
|
+
url: toPathString(localVarUrlObj),
|
|
16643
|
+
options: localVarRequestOptions,
|
|
16644
|
+
};
|
|
16645
|
+
}),
|
|
16646
|
+
/**
|
|
16647
|
+
* 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\".
|
|
16648
|
+
* @summary Get a place membership
|
|
16649
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16650
|
+
* @param {*} [options] Override http request option.
|
|
16651
|
+
* @throws {RequiredError}
|
|
16652
|
+
*/
|
|
16653
|
+
getPlaceMembership: (placeMembershipId_1, ...args_1) => __awaiter(this, [placeMembershipId_1, ...args_1], void 0, function* (placeMembershipId, options = {}) {
|
|
16654
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16655
|
+
assertParamExists('getPlaceMembership', 'placeMembershipId', placeMembershipId);
|
|
16656
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
16657
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
16658
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16659
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16660
|
+
let baseOptions;
|
|
16661
|
+
if (configuration) {
|
|
16662
|
+
baseOptions = configuration.baseOptions;
|
|
16663
|
+
}
|
|
16664
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16665
|
+
const localVarHeaderParameter = {};
|
|
16666
|
+
const localVarQueryParameter = {};
|
|
16667
|
+
// authentication ApiKeyAuth required
|
|
16668
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16669
|
+
// authentication OrganizationId required
|
|
16670
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16671
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16672
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16673
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16674
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16675
|
+
return {
|
|
16676
|
+
url: toPathString(localVarUrlObj),
|
|
16677
|
+
options: localVarRequestOptions,
|
|
16678
|
+
};
|
|
16679
|
+
}),
|
|
16680
|
+
/**
|
|
16681
|
+
* 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\".
|
|
16682
|
+
* @summary List bookings that applied a place membership
|
|
16683
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16684
|
+
* @param {number} [page] Page number
|
|
16685
|
+
* @param {number} [pageSize] Number of items per page
|
|
16686
|
+
* @param {string} [orderBy] Field to order by
|
|
16687
|
+
* @param {string} [search] Search query
|
|
16688
|
+
* @param {*} [options] Override http request option.
|
|
16689
|
+
* @throws {RequiredError}
|
|
16690
|
+
*/
|
|
16691
|
+
getPlaceMembershipBookings: (placeMembershipId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [placeMembershipId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (placeMembershipId, page, pageSize, orderBy, search, options = {}) {
|
|
16692
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16693
|
+
assertParamExists('getPlaceMembershipBookings', 'placeMembershipId', placeMembershipId);
|
|
16694
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/bookings`
|
|
16695
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
16696
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16697
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16698
|
+
let baseOptions;
|
|
16699
|
+
if (configuration) {
|
|
16700
|
+
baseOptions = configuration.baseOptions;
|
|
16701
|
+
}
|
|
16702
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16703
|
+
const localVarHeaderParameter = {};
|
|
16704
|
+
const localVarQueryParameter = {};
|
|
16705
|
+
// authentication ApiKeyAuth required
|
|
16706
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16707
|
+
// authentication OrganizationId required
|
|
16708
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16709
|
+
if (page !== undefined) {
|
|
16710
|
+
localVarQueryParameter['page'] = page;
|
|
16711
|
+
}
|
|
16712
|
+
if (pageSize !== undefined) {
|
|
16713
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
16714
|
+
}
|
|
16715
|
+
if (orderBy !== undefined) {
|
|
16716
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
16717
|
+
}
|
|
16718
|
+
if (search !== undefined) {
|
|
16719
|
+
localVarQueryParameter['search'] = search;
|
|
16720
|
+
}
|
|
16721
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16722
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16723
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16724
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16725
|
+
return {
|
|
16726
|
+
url: toPathString(localVarUrlObj),
|
|
16727
|
+
options: localVarRequestOptions,
|
|
16728
|
+
};
|
|
16729
|
+
}),
|
|
16730
|
+
/**
|
|
16731
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
16732
|
+
* @summary List a place membership\'s members
|
|
16733
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16734
|
+
* @param {number} [page] Page number
|
|
16735
|
+
* @param {number} [pageSize] Number of items per page
|
|
16736
|
+
* @param {string} [orderBy] Field to order by
|
|
16737
|
+
* @param {string} [search] Search query
|
|
16738
|
+
* @param {*} [options] Override http request option.
|
|
16739
|
+
* @throws {RequiredError}
|
|
16740
|
+
*/
|
|
16741
|
+
getPlaceMembershipMembers: (placeMembershipId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [placeMembershipId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (placeMembershipId, page, pageSize, orderBy, search, options = {}) {
|
|
16742
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16743
|
+
assertParamExists('getPlaceMembershipMembers', 'placeMembershipId', placeMembershipId);
|
|
16744
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members`
|
|
16745
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
16746
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16747
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16748
|
+
let baseOptions;
|
|
16749
|
+
if (configuration) {
|
|
16750
|
+
baseOptions = configuration.baseOptions;
|
|
16751
|
+
}
|
|
16752
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16753
|
+
const localVarHeaderParameter = {};
|
|
16754
|
+
const localVarQueryParameter = {};
|
|
16755
|
+
// authentication ApiKeyAuth required
|
|
16756
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16757
|
+
// authentication OrganizationId required
|
|
16758
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16759
|
+
if (page !== undefined) {
|
|
16760
|
+
localVarQueryParameter['page'] = page;
|
|
16761
|
+
}
|
|
16762
|
+
if (pageSize !== undefined) {
|
|
16763
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
16764
|
+
}
|
|
16765
|
+
if (orderBy !== undefined) {
|
|
16766
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
16767
|
+
}
|
|
16768
|
+
if (search !== undefined) {
|
|
16769
|
+
localVarQueryParameter['search'] = search;
|
|
16770
|
+
}
|
|
16771
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16772
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16773
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16774
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16775
|
+
return {
|
|
16776
|
+
url: toPathString(localVarUrlObj),
|
|
16777
|
+
options: localVarRequestOptions,
|
|
16778
|
+
};
|
|
16779
|
+
}),
|
|
16780
|
+
/**
|
|
16781
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
16782
|
+
* @summary Get a place membership type
|
|
16783
|
+
* @param {string} placeId The place identifier
|
|
16784
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
16785
|
+
* @param {*} [options] Override http request option.
|
|
16786
|
+
* @throws {RequiredError}
|
|
16787
|
+
*/
|
|
16788
|
+
getPlaceMembershipType: (placeId_1, placeMembershipTypeId_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, options = {}) {
|
|
16789
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16790
|
+
assertParamExists('getPlaceMembershipType', 'placeId', placeId);
|
|
16791
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
16792
|
+
assertParamExists('getPlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
16793
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
16794
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
16795
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
16796
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16797
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16798
|
+
let baseOptions;
|
|
16799
|
+
if (configuration) {
|
|
16800
|
+
baseOptions = configuration.baseOptions;
|
|
16801
|
+
}
|
|
16802
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16803
|
+
const localVarHeaderParameter = {};
|
|
16804
|
+
const localVarQueryParameter = {};
|
|
16805
|
+
// authentication ApiKeyAuth required
|
|
16806
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16807
|
+
// authentication OrganizationId required
|
|
16808
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16809
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16810
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16811
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16812
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16813
|
+
return {
|
|
16814
|
+
url: toPathString(localVarUrlObj),
|
|
16815
|
+
options: localVarRequestOptions,
|
|
16816
|
+
};
|
|
16817
|
+
}),
|
|
16818
|
+
/**
|
|
16819
|
+
* 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\".
|
|
16820
|
+
* @summary List a place\'s membership types
|
|
16821
|
+
* @param {string} placeId The place identifier
|
|
16822
|
+
* @param {boolean} [archived] Filter by archived
|
|
16823
|
+
* @param {number} [page] Page number
|
|
16824
|
+
* @param {number} [pageSize] Number of items per page
|
|
16825
|
+
* @param {string} [orderBy] Field to order by
|
|
16826
|
+
* @param {string} [search] Search query
|
|
16827
|
+
* @param {*} [options] Override http request option.
|
|
16828
|
+
* @throws {RequiredError}
|
|
16829
|
+
*/
|
|
16830
|
+
getPlaceMembershipTypes: (placeId_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [placeId_1, archived_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (placeId, archived, page, pageSize, orderBy, search, options = {}) {
|
|
16831
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16832
|
+
assertParamExists('getPlaceMembershipTypes', 'placeId', placeId);
|
|
16833
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes`
|
|
16834
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
16835
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16836
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16837
|
+
let baseOptions;
|
|
16838
|
+
if (configuration) {
|
|
16839
|
+
baseOptions = configuration.baseOptions;
|
|
16840
|
+
}
|
|
16841
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16842
|
+
const localVarHeaderParameter = {};
|
|
16843
|
+
const localVarQueryParameter = {};
|
|
16844
|
+
// authentication ApiKeyAuth required
|
|
16845
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16846
|
+
// authentication OrganizationId required
|
|
16847
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16848
|
+
if (archived !== undefined) {
|
|
16849
|
+
localVarQueryParameter['archived'] = archived;
|
|
16850
|
+
}
|
|
16851
|
+
if (page !== undefined) {
|
|
16852
|
+
localVarQueryParameter['page'] = page;
|
|
16853
|
+
}
|
|
16854
|
+
if (pageSize !== undefined) {
|
|
16855
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
16856
|
+
}
|
|
16857
|
+
if (orderBy !== undefined) {
|
|
16858
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
16859
|
+
}
|
|
16860
|
+
if (search !== undefined) {
|
|
16861
|
+
localVarQueryParameter['search'] = search;
|
|
16862
|
+
}
|
|
16863
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16864
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16865
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16866
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16867
|
+
return {
|
|
16868
|
+
url: toPathString(localVarUrlObj),
|
|
16869
|
+
options: localVarRequestOptions,
|
|
16870
|
+
};
|
|
16871
|
+
}),
|
|
16872
|
+
/**
|
|
16873
|
+
* 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\".
|
|
16874
|
+
* @summary List a place\'s memberships
|
|
16875
|
+
* @param {string} placeId The place identifier
|
|
16876
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
16877
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
16878
|
+
* @param {boolean} [active] Filter by active
|
|
16879
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
16880
|
+
* @param {boolean} [expired] Filter by expired
|
|
16881
|
+
* @param {number} [page] Page number
|
|
16882
|
+
* @param {number} [pageSize] Number of items per page
|
|
16883
|
+
* @param {string} [orderBy] Field to order by
|
|
16884
|
+
* @param {string} [search] Search query
|
|
16885
|
+
* @param {*} [options] Override http request option.
|
|
16886
|
+
* @throws {RequiredError}
|
|
16887
|
+
*/
|
|
16888
|
+
getPlaceMemberships: (placeId_1, placeMembershipTypeId_1, status_1, active_1, upcoming_1, expired_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, status_1, active_1, upcoming_1, expired_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, status, active, upcoming, expired, page, pageSize, orderBy, search, options = {}) {
|
|
16889
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
16890
|
+
assertParamExists('getPlaceMemberships', 'placeId', placeId);
|
|
16891
|
+
const localVarPath = `/bookings/places/{placeId}/memberships`
|
|
16892
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)));
|
|
16893
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16894
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16895
|
+
let baseOptions;
|
|
16896
|
+
if (configuration) {
|
|
16897
|
+
baseOptions = configuration.baseOptions;
|
|
16898
|
+
}
|
|
16899
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
16900
|
+
const localVarHeaderParameter = {};
|
|
16901
|
+
const localVarQueryParameter = {};
|
|
16902
|
+
// authentication ApiKeyAuth required
|
|
16903
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16904
|
+
// authentication OrganizationId required
|
|
16905
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16906
|
+
if (placeMembershipTypeId !== undefined) {
|
|
16907
|
+
localVarQueryParameter['placeMembershipTypeId'] = placeMembershipTypeId;
|
|
16908
|
+
}
|
|
16909
|
+
if (status !== undefined) {
|
|
16910
|
+
localVarQueryParameter['status'] = status;
|
|
16911
|
+
}
|
|
16912
|
+
if (active !== undefined) {
|
|
16913
|
+
localVarQueryParameter['active'] = active;
|
|
16914
|
+
}
|
|
16915
|
+
if (upcoming !== undefined) {
|
|
16916
|
+
localVarQueryParameter['upcoming'] = upcoming;
|
|
16917
|
+
}
|
|
16918
|
+
if (expired !== undefined) {
|
|
16919
|
+
localVarQueryParameter['expired'] = expired;
|
|
16920
|
+
}
|
|
16921
|
+
if (page !== undefined) {
|
|
16922
|
+
localVarQueryParameter['page'] = page;
|
|
16923
|
+
}
|
|
16924
|
+
if (pageSize !== undefined) {
|
|
16925
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
16926
|
+
}
|
|
16927
|
+
if (orderBy !== undefined) {
|
|
16928
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
16929
|
+
}
|
|
16930
|
+
if (search !== undefined) {
|
|
16931
|
+
localVarQueryParameter['search'] = search;
|
|
16932
|
+
}
|
|
16933
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16934
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16935
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16936
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16937
|
+
return {
|
|
16938
|
+
url: toPathString(localVarUrlObj),
|
|
16939
|
+
options: localVarRequestOptions,
|
|
16940
|
+
};
|
|
16941
|
+
}),
|
|
16942
|
+
/**
|
|
16943
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
16944
|
+
* @summary Update a place membership
|
|
16945
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16946
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
16947
|
+
* @param {*} [options] Override http request option.
|
|
16948
|
+
* @throws {RequiredError}
|
|
16949
|
+
*/
|
|
16950
|
+
updatePlaceMembership: (placeMembershipId_1, placeMembershipUpdateInputs_1, ...args_1) => __awaiter(this, [placeMembershipId_1, placeMembershipUpdateInputs_1, ...args_1], void 0, function* (placeMembershipId, placeMembershipUpdateInputs, options = {}) {
|
|
16951
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16952
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipId', placeMembershipId);
|
|
16953
|
+
// verify required parameter 'placeMembershipUpdateInputs' is not null or undefined
|
|
16954
|
+
assertParamExists('updatePlaceMembership', 'placeMembershipUpdateInputs', placeMembershipUpdateInputs);
|
|
16955
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}`
|
|
16956
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)));
|
|
16957
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
16958
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
16959
|
+
let baseOptions;
|
|
16960
|
+
if (configuration) {
|
|
16961
|
+
baseOptions = configuration.baseOptions;
|
|
16962
|
+
}
|
|
16963
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
16964
|
+
const localVarHeaderParameter = {};
|
|
16965
|
+
const localVarQueryParameter = {};
|
|
16966
|
+
// authentication ApiKeyAuth required
|
|
16967
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
16968
|
+
// authentication OrganizationId required
|
|
16969
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
16970
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
16971
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
16972
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
16973
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
16974
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
16975
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipUpdateInputs, localVarRequestOptions, configuration);
|
|
16976
|
+
return {
|
|
16977
|
+
url: toPathString(localVarUrlObj),
|
|
16978
|
+
options: localVarRequestOptions,
|
|
16979
|
+
};
|
|
16980
|
+
}),
|
|
16981
|
+
/**
|
|
16982
|
+
* 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.
|
|
16983
|
+
* @summary Update a place membership member
|
|
16984
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
16985
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
16986
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
16987
|
+
* @param {*} [options] Override http request option.
|
|
16988
|
+
* @throws {RequiredError}
|
|
16989
|
+
*/
|
|
16990
|
+
updatePlaceMembershipMember: (placeMembershipId_1, placeMembershipMemberId_1, placeMembershipMemberUpdateInputs_1, ...args_1) => __awaiter(this, [placeMembershipId_1, placeMembershipMemberId_1, placeMembershipMemberUpdateInputs_1, ...args_1], void 0, function* (placeMembershipId, placeMembershipMemberId, placeMembershipMemberUpdateInputs, options = {}) {
|
|
16991
|
+
// verify required parameter 'placeMembershipId' is not null or undefined
|
|
16992
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipId', placeMembershipId);
|
|
16993
|
+
// verify required parameter 'placeMembershipMemberId' is not null or undefined
|
|
16994
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberId', placeMembershipMemberId);
|
|
16995
|
+
// verify required parameter 'placeMembershipMemberUpdateInputs' is not null or undefined
|
|
16996
|
+
assertParamExists('updatePlaceMembershipMember', 'placeMembershipMemberUpdateInputs', placeMembershipMemberUpdateInputs);
|
|
16997
|
+
const localVarPath = `/bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId}`
|
|
16998
|
+
.replace('{placeMembershipId}', encodeURIComponent(String(placeMembershipId)))
|
|
16999
|
+
.replace('{placeMembershipMemberId}', encodeURIComponent(String(placeMembershipMemberId)));
|
|
17000
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17001
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17002
|
+
let baseOptions;
|
|
17003
|
+
if (configuration) {
|
|
17004
|
+
baseOptions = configuration.baseOptions;
|
|
17005
|
+
}
|
|
17006
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
17007
|
+
const localVarHeaderParameter = {};
|
|
17008
|
+
const localVarQueryParameter = {};
|
|
17009
|
+
// authentication ApiKeyAuth required
|
|
17010
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17011
|
+
// authentication OrganizationId required
|
|
17012
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17013
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17014
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17015
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17016
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17017
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17018
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipMemberUpdateInputs, localVarRequestOptions, configuration);
|
|
17019
|
+
return {
|
|
17020
|
+
url: toPathString(localVarUrlObj),
|
|
17021
|
+
options: localVarRequestOptions,
|
|
17022
|
+
};
|
|
17023
|
+
}),
|
|
17024
|
+
/**
|
|
17025
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
17026
|
+
* @summary Update a place membership type
|
|
17027
|
+
* @param {string} placeId The place identifier
|
|
17028
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17029
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
17030
|
+
* @param {*} [options] Override http request option.
|
|
17031
|
+
* @throws {RequiredError}
|
|
17032
|
+
*/
|
|
17033
|
+
updatePlaceMembershipType: (placeId_1, placeMembershipTypeId_1, placeMembershipTypeUpdateInputs_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, placeMembershipTypeUpdateInputs_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, placeMembershipTypeUpdateInputs, options = {}) {
|
|
17034
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
17035
|
+
assertParamExists('updatePlaceMembershipType', 'placeId', placeId);
|
|
17036
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
17037
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
17038
|
+
// verify required parameter 'placeMembershipTypeUpdateInputs' is not null or undefined
|
|
17039
|
+
assertParamExists('updatePlaceMembershipType', 'placeMembershipTypeUpdateInputs', placeMembershipTypeUpdateInputs);
|
|
17040
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}`
|
|
17041
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
17042
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
17043
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17044
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17045
|
+
let baseOptions;
|
|
17046
|
+
if (configuration) {
|
|
17047
|
+
baseOptions = configuration.baseOptions;
|
|
17048
|
+
}
|
|
17049
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
17050
|
+
const localVarHeaderParameter = {};
|
|
17051
|
+
const localVarQueryParameter = {};
|
|
17052
|
+
// authentication ApiKeyAuth required
|
|
17053
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17054
|
+
// authentication OrganizationId required
|
|
17055
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17056
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17057
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17058
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17059
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17060
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17061
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeUpdateInputs, localVarRequestOptions, configuration);
|
|
17062
|
+
return {
|
|
17063
|
+
url: toPathString(localVarUrlObj),
|
|
17064
|
+
options: localVarRequestOptions,
|
|
17065
|
+
};
|
|
17066
|
+
}),
|
|
17067
|
+
};
|
|
17068
|
+
};
|
|
17069
|
+
/**
|
|
17070
|
+
* BookingsMembershipsApi - functional programming interface
|
|
17071
|
+
*/
|
|
17072
|
+
export const BookingsMembershipsApiFp = function (configuration) {
|
|
17073
|
+
const localVarAxiosParamCreator = BookingsMembershipsApiAxiosParamCreator(configuration);
|
|
17074
|
+
return {
|
|
17075
|
+
/**
|
|
17076
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
17077
|
+
* @summary Grant a place membership
|
|
17078
|
+
* @param {string} placeId The place identifier
|
|
17079
|
+
* @param {PlaceMembershipCreateInputs} placeMembershipCreateInputs
|
|
17080
|
+
* @param {*} [options] Override http request option.
|
|
17081
|
+
* @throws {RequiredError}
|
|
17082
|
+
*/
|
|
17083
|
+
createPlaceMembership(placeId, placeMembershipCreateInputs, options) {
|
|
17084
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17085
|
+
var _a, _b, _c;
|
|
17086
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPlaceMembership(placeId, placeMembershipCreateInputs, options);
|
|
17087
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17088
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.createPlaceMembership']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17089
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17090
|
+
});
|
|
17091
|
+
},
|
|
17092
|
+
/**
|
|
17093
|
+
* 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.
|
|
17094
|
+
* @summary Add a member to a place membership
|
|
17095
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17096
|
+
* @param {PlaceMembershipMemberCreateInputs} placeMembershipMemberCreateInputs
|
|
17097
|
+
* @param {*} [options] Override http request option.
|
|
17098
|
+
* @throws {RequiredError}
|
|
17099
|
+
*/
|
|
17100
|
+
createPlaceMembershipMember(placeMembershipId, placeMembershipMemberCreateInputs, options) {
|
|
17101
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17102
|
+
var _a, _b, _c;
|
|
17103
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPlaceMembershipMember(placeMembershipId, placeMembershipMemberCreateInputs, options);
|
|
17104
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17105
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.createPlaceMembershipMember']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17106
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17107
|
+
});
|
|
17108
|
+
},
|
|
17109
|
+
/**
|
|
17110
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
17111
|
+
* @summary Create a place membership type
|
|
17112
|
+
* @param {string} placeId The place identifier
|
|
17113
|
+
* @param {PlaceMembershipTypeCreateInputs} placeMembershipTypeCreateInputs
|
|
17114
|
+
* @param {*} [options] Override http request option.
|
|
17115
|
+
* @throws {RequiredError}
|
|
17116
|
+
*/
|
|
17117
|
+
createPlaceMembershipType(placeId, placeMembershipTypeCreateInputs, options) {
|
|
17118
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17119
|
+
var _a, _b, _c;
|
|
17120
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPlaceMembershipType(placeId, placeMembershipTypeCreateInputs, options);
|
|
17121
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17122
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.createPlaceMembershipType']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17123
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17124
|
+
});
|
|
17125
|
+
},
|
|
17126
|
+
/**
|
|
17127
|
+
* 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.
|
|
17128
|
+
* @summary Remove a member from a place membership
|
|
17129
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17130
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
17131
|
+
* @param {*} [options] Override http request option.
|
|
17132
|
+
* @throws {RequiredError}
|
|
17133
|
+
*/
|
|
17134
|
+
deletePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, options) {
|
|
17135
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17136
|
+
var _a, _b, _c;
|
|
17137
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, options);
|
|
17138
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17139
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipMember']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17140
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17141
|
+
});
|
|
17142
|
+
},
|
|
17143
|
+
/**
|
|
17144
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
17145
|
+
* @summary Delete a place membership type
|
|
17146
|
+
* @param {string} placeId The place identifier
|
|
17147
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17148
|
+
* @param {*} [options] Override http request option.
|
|
17149
|
+
* @throws {RequiredError}
|
|
17150
|
+
*/
|
|
17151
|
+
deletePlaceMembershipType(placeId, placeMembershipTypeId, options) {
|
|
17152
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17153
|
+
var _a, _b, _c;
|
|
17154
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
17155
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17156
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.deletePlaceMembershipType']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17157
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17158
|
+
});
|
|
17159
|
+
},
|
|
17160
|
+
/**
|
|
17161
|
+
* 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\".
|
|
17162
|
+
* @summary Get a place membership
|
|
17163
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17164
|
+
* @param {*} [options] Override http request option.
|
|
17165
|
+
* @throws {RequiredError}
|
|
17166
|
+
*/
|
|
17167
|
+
getPlaceMembership(placeMembershipId, options) {
|
|
17168
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17169
|
+
var _a, _b, _c;
|
|
17170
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembership(placeMembershipId, options);
|
|
17171
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17172
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMembership']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17173
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17174
|
+
});
|
|
17175
|
+
},
|
|
17176
|
+
/**
|
|
17177
|
+
* 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\".
|
|
17178
|
+
* @summary List bookings that applied a place membership
|
|
17179
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17180
|
+
* @param {number} [page] Page number
|
|
17181
|
+
* @param {number} [pageSize] Number of items per page
|
|
17182
|
+
* @param {string} [orderBy] Field to order by
|
|
17183
|
+
* @param {string} [search] Search query
|
|
17184
|
+
* @param {*} [options] Override http request option.
|
|
17185
|
+
* @throws {RequiredError}
|
|
17186
|
+
*/
|
|
17187
|
+
getPlaceMembershipBookings(placeMembershipId, page, pageSize, orderBy, search, options) {
|
|
17188
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17189
|
+
var _a, _b, _c;
|
|
17190
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipBookings(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
17191
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17192
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMembershipBookings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17193
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17194
|
+
});
|
|
17195
|
+
},
|
|
17196
|
+
/**
|
|
17197
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
17198
|
+
* @summary List a place membership\'s members
|
|
17199
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17200
|
+
* @param {number} [page] Page number
|
|
17201
|
+
* @param {number} [pageSize] Number of items per page
|
|
17202
|
+
* @param {string} [orderBy] Field to order by
|
|
17203
|
+
* @param {string} [search] Search query
|
|
17204
|
+
* @param {*} [options] Override http request option.
|
|
17205
|
+
* @throws {RequiredError}
|
|
17206
|
+
*/
|
|
17207
|
+
getPlaceMembershipMembers(placeMembershipId, page, pageSize, orderBy, search, options) {
|
|
17208
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17209
|
+
var _a, _b, _c;
|
|
17210
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipMembers(placeMembershipId, page, pageSize, orderBy, search, options);
|
|
17211
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17212
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMembershipMembers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17213
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17214
|
+
});
|
|
17215
|
+
},
|
|
17216
|
+
/**
|
|
17217
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
17218
|
+
* @summary Get a place membership type
|
|
17219
|
+
* @param {string} placeId The place identifier
|
|
17220
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17221
|
+
* @param {*} [options] Override http request option.
|
|
17222
|
+
* @throws {RequiredError}
|
|
17223
|
+
*/
|
|
17224
|
+
getPlaceMembershipType(placeId, placeMembershipTypeId, options) {
|
|
17225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17226
|
+
var _a, _b, _c;
|
|
17227
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipType(placeId, placeMembershipTypeId, options);
|
|
17228
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17229
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMembershipType']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17230
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17231
|
+
});
|
|
17232
|
+
},
|
|
17233
|
+
/**
|
|
17234
|
+
* 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\".
|
|
17235
|
+
* @summary List a place\'s membership types
|
|
17236
|
+
* @param {string} placeId The place identifier
|
|
17237
|
+
* @param {boolean} [archived] Filter by archived
|
|
17238
|
+
* @param {number} [page] Page number
|
|
17239
|
+
* @param {number} [pageSize] Number of items per page
|
|
17240
|
+
* @param {string} [orderBy] Field to order by
|
|
17241
|
+
* @param {string} [search] Search query
|
|
17242
|
+
* @param {*} [options] Override http request option.
|
|
17243
|
+
* @throws {RequiredError}
|
|
17244
|
+
*/
|
|
17245
|
+
getPlaceMembershipTypes(placeId, archived, page, pageSize, orderBy, search, options) {
|
|
17246
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17247
|
+
var _a, _b, _c;
|
|
17248
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipTypes(placeId, archived, page, pageSize, orderBy, search, options);
|
|
17249
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17250
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMembershipTypes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17251
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17252
|
+
});
|
|
17253
|
+
},
|
|
17254
|
+
/**
|
|
17255
|
+
* 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\".
|
|
17256
|
+
* @summary List a place\'s memberships
|
|
17257
|
+
* @param {string} placeId The place identifier
|
|
17258
|
+
* @param {string} [placeMembershipTypeId] Filter by placeMembershipTypeId
|
|
17259
|
+
* @param {PurchaseStatus} [status] Filter by status
|
|
17260
|
+
* @param {boolean} [active] Filter by active
|
|
17261
|
+
* @param {boolean} [upcoming] Filter by upcoming
|
|
17262
|
+
* @param {boolean} [expired] Filter by expired
|
|
17263
|
+
* @param {number} [page] Page number
|
|
17264
|
+
* @param {number} [pageSize] Number of items per page
|
|
17265
|
+
* @param {string} [orderBy] Field to order by
|
|
17266
|
+
* @param {string} [search] Search query
|
|
17267
|
+
* @param {*} [options] Override http request option.
|
|
17268
|
+
* @throws {RequiredError}
|
|
17269
|
+
*/
|
|
17270
|
+
getPlaceMemberships(placeId, placeMembershipTypeId, status, active, upcoming, expired, page, pageSize, orderBy, search, options) {
|
|
17271
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17272
|
+
var _a, _b, _c;
|
|
17273
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMemberships(placeId, placeMembershipTypeId, status, active, upcoming, expired, page, pageSize, orderBy, search, options);
|
|
17274
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17275
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.getPlaceMemberships']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17276
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17277
|
+
});
|
|
17278
|
+
},
|
|
17279
|
+
/**
|
|
17280
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
17281
|
+
* @summary Update a place membership
|
|
17282
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17283
|
+
* @param {PlaceMembershipUpdateInputs} placeMembershipUpdateInputs
|
|
17284
|
+
* @param {*} [options] Override http request option.
|
|
17285
|
+
* @throws {RequiredError}
|
|
17286
|
+
*/
|
|
17287
|
+
updatePlaceMembership(placeMembershipId, placeMembershipUpdateInputs, options) {
|
|
17288
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17289
|
+
var _a, _b, _c;
|
|
17290
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlaceMembership(placeMembershipId, placeMembershipUpdateInputs, options);
|
|
17291
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17292
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.updatePlaceMembership']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17293
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17294
|
+
});
|
|
17295
|
+
},
|
|
17296
|
+
/**
|
|
17297
|
+
* 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.
|
|
17298
|
+
* @summary Update a place membership member
|
|
17299
|
+
* @param {string} placeMembershipId The placeMembership identifier
|
|
17300
|
+
* @param {string} placeMembershipMemberId The placeMembershipMember identifier
|
|
17301
|
+
* @param {PlaceMembershipMemberUpdateInputs} placeMembershipMemberUpdateInputs
|
|
17302
|
+
* @param {*} [options] Override http request option.
|
|
17303
|
+
* @throws {RequiredError}
|
|
17304
|
+
*/
|
|
17305
|
+
updatePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, placeMembershipMemberUpdateInputs, options) {
|
|
17306
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17307
|
+
var _a, _b, _c;
|
|
17308
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlaceMembershipMember(placeMembershipId, placeMembershipMemberId, placeMembershipMemberUpdateInputs, options);
|
|
17309
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17310
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipMember']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17311
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17312
|
+
});
|
|
17313
|
+
},
|
|
17314
|
+
/**
|
|
17315
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
17316
|
+
* @summary Update a place membership type
|
|
17317
|
+
* @param {string} placeId The place identifier
|
|
17318
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17319
|
+
* @param {PlaceMembershipTypeUpdateInputs} placeMembershipTypeUpdateInputs
|
|
17320
|
+
* @param {*} [options] Override http request option.
|
|
17321
|
+
* @throws {RequiredError}
|
|
17322
|
+
*/
|
|
17323
|
+
updatePlaceMembershipType(placeId, placeMembershipTypeId, placeMembershipTypeUpdateInputs, options) {
|
|
17324
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17325
|
+
var _a, _b, _c;
|
|
17326
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlaceMembershipType(placeId, placeMembershipTypeId, placeMembershipTypeUpdateInputs, options);
|
|
17327
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17328
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsApi.updatePlaceMembershipType']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17329
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17330
|
+
});
|
|
17331
|
+
},
|
|
17332
|
+
};
|
|
17333
|
+
};
|
|
17334
|
+
/**
|
|
17335
|
+
* BookingsMembershipsApi - factory interface
|
|
17336
|
+
*/
|
|
17337
|
+
export const BookingsMembershipsApiFactory = function (configuration, basePath, axios) {
|
|
17338
|
+
const localVarFp = BookingsMembershipsApiFp(configuration);
|
|
17339
|
+
return {
|
|
17340
|
+
/**
|
|
17341
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
17342
|
+
* @summary Grant a place membership
|
|
17343
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
17344
|
+
* @param {*} [options] Override http request option.
|
|
17345
|
+
* @throws {RequiredError}
|
|
17346
|
+
*/
|
|
17347
|
+
createPlaceMembership(requestParameters, options) {
|
|
17348
|
+
return localVarFp.createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(axios, basePath));
|
|
17349
|
+
},
|
|
17350
|
+
/**
|
|
17351
|
+
* 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.
|
|
17352
|
+
* @summary Add a member to a place membership
|
|
17353
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17354
|
+
* @param {*} [options] Override http request option.
|
|
17355
|
+
* @throws {RequiredError}
|
|
17356
|
+
*/
|
|
17357
|
+
createPlaceMembershipMember(requestParameters, options) {
|
|
17358
|
+
return localVarFp.createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(axios, basePath));
|
|
17359
|
+
},
|
|
17360
|
+
/**
|
|
17361
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
17362
|
+
* @summary Create a place membership type
|
|
17363
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17364
|
+
* @param {*} [options] Override http request option.
|
|
17365
|
+
* @throws {RequiredError}
|
|
17366
|
+
*/
|
|
17367
|
+
createPlaceMembershipType(requestParameters, options) {
|
|
17368
|
+
return localVarFp.createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(axios, basePath));
|
|
17369
|
+
},
|
|
17370
|
+
/**
|
|
17371
|
+
* 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.
|
|
17372
|
+
* @summary Remove a member from a place membership
|
|
17373
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17374
|
+
* @param {*} [options] Override http request option.
|
|
17375
|
+
* @throws {RequiredError}
|
|
17376
|
+
*/
|
|
17377
|
+
deletePlaceMembershipMember(requestParameters, options) {
|
|
17378
|
+
return localVarFp.deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(axios, basePath));
|
|
17379
|
+
},
|
|
17380
|
+
/**
|
|
17381
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
17382
|
+
* @summary Delete a place membership type
|
|
17383
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17384
|
+
* @param {*} [options] Override http request option.
|
|
17385
|
+
* @throws {RequiredError}
|
|
17386
|
+
*/
|
|
17387
|
+
deletePlaceMembershipType(requestParameters, options) {
|
|
17388
|
+
return localVarFp.deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
17389
|
+
},
|
|
17390
|
+
/**
|
|
17391
|
+
* 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\".
|
|
17392
|
+
* @summary Get a place membership
|
|
17393
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
17394
|
+
* @param {*} [options] Override http request option.
|
|
17395
|
+
* @throws {RequiredError}
|
|
17396
|
+
*/
|
|
17397
|
+
getPlaceMembership(requestParameters, options) {
|
|
17398
|
+
return localVarFp.getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(axios, basePath));
|
|
17399
|
+
},
|
|
17400
|
+
/**
|
|
17401
|
+
* 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\".
|
|
17402
|
+
* @summary List bookings that applied a place membership
|
|
17403
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
17404
|
+
* @param {*} [options] Override http request option.
|
|
17405
|
+
* @throws {RequiredError}
|
|
17406
|
+
*/
|
|
17407
|
+
getPlaceMembershipBookings(requestParameters, options) {
|
|
17408
|
+
return localVarFp.getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
17409
|
+
},
|
|
17410
|
+
/**
|
|
17411
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
17412
|
+
* @summary List a place membership\'s members
|
|
17413
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
17414
|
+
* @param {*} [options] Override http request option.
|
|
17415
|
+
* @throws {RequiredError}
|
|
17416
|
+
*/
|
|
17417
|
+
getPlaceMembershipMembers(requestParameters, options) {
|
|
17418
|
+
return localVarFp.getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
17419
|
+
},
|
|
17420
|
+
/**
|
|
17421
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
17422
|
+
* @summary Get a place membership type
|
|
17423
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17424
|
+
* @param {*} [options] Override http request option.
|
|
17425
|
+
* @throws {RequiredError}
|
|
17426
|
+
*/
|
|
17427
|
+
getPlaceMembershipType(requestParameters, options) {
|
|
17428
|
+
return localVarFp.getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(axios, basePath));
|
|
17429
|
+
},
|
|
17430
|
+
/**
|
|
17431
|
+
* 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\".
|
|
17432
|
+
* @summary List a place\'s membership types
|
|
17433
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
17434
|
+
* @param {*} [options] Override http request option.
|
|
17435
|
+
* @throws {RequiredError}
|
|
17436
|
+
*/
|
|
17437
|
+
getPlaceMembershipTypes(requestParameters, options) {
|
|
17438
|
+
return localVarFp.getPlaceMembershipTypes(requestParameters.placeId, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
17439
|
+
},
|
|
17440
|
+
/**
|
|
17441
|
+
* 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\".
|
|
17442
|
+
* @summary List a place\'s memberships
|
|
17443
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
17444
|
+
* @param {*} [options] Override http request option.
|
|
17445
|
+
* @throws {RequiredError}
|
|
17446
|
+
*/
|
|
17447
|
+
getPlaceMemberships(requestParameters, options) {
|
|
17448
|
+
return localVarFp.getPlaceMemberships(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.status, requestParameters.active, requestParameters.upcoming, requestParameters.expired, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
17449
|
+
},
|
|
17450
|
+
/**
|
|
17451
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
17452
|
+
* @summary Update a place membership
|
|
17453
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
17454
|
+
* @param {*} [options] Override http request option.
|
|
17455
|
+
* @throws {RequiredError}
|
|
17456
|
+
*/
|
|
17457
|
+
updatePlaceMembership(requestParameters, options) {
|
|
17458
|
+
return localVarFp.updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(axios, basePath));
|
|
17459
|
+
},
|
|
17460
|
+
/**
|
|
17461
|
+
* 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.
|
|
17462
|
+
* @summary Update a place membership member
|
|
17463
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17464
|
+
* @param {*} [options] Override http request option.
|
|
17465
|
+
* @throws {RequiredError}
|
|
17466
|
+
*/
|
|
17467
|
+
updatePlaceMembershipMember(requestParameters, options) {
|
|
17468
|
+
return localVarFp.updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(axios, basePath));
|
|
17469
|
+
},
|
|
17470
|
+
/**
|
|
17471
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
17472
|
+
* @summary Update a place membership type
|
|
17473
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17474
|
+
* @param {*} [options] Override http request option.
|
|
17475
|
+
* @throws {RequiredError}
|
|
17476
|
+
*/
|
|
17477
|
+
updatePlaceMembershipType(requestParameters, options) {
|
|
17478
|
+
return localVarFp.updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(axios, basePath));
|
|
17479
|
+
},
|
|
17480
|
+
};
|
|
17481
|
+
};
|
|
17482
|
+
/**
|
|
17483
|
+
* BookingsMembershipsApi - object-oriented interface
|
|
17484
|
+
*/
|
|
17485
|
+
export class BookingsMembershipsApi extends BaseAPI {
|
|
17486
|
+
/**
|
|
17487
|
+
* Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
17488
|
+
* @summary Grant a place membership
|
|
17489
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipRequest} requestParameters Request parameters.
|
|
17490
|
+
* @param {*} [options] Override http request option.
|
|
17491
|
+
* @throws {RequiredError}
|
|
17492
|
+
*/
|
|
17493
|
+
createPlaceMembership(requestParameters, options) {
|
|
17494
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembership(requestParameters.placeId, requestParameters.placeMembershipCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17495
|
+
}
|
|
17496
|
+
/**
|
|
17497
|
+
* 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.
|
|
17498
|
+
* @summary Add a member to a place membership
|
|
17499
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17500
|
+
* @param {*} [options] Override http request option.
|
|
17501
|
+
* @throws {RequiredError}
|
|
17502
|
+
*/
|
|
17503
|
+
createPlaceMembershipMember(requestParameters, options) {
|
|
17504
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17505
|
+
}
|
|
17506
|
+
/**
|
|
17507
|
+
* Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
17508
|
+
* @summary Create a place membership type
|
|
17509
|
+
* @param {BookingsMembershipsApiCreatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17510
|
+
* @param {*} [options] Override http request option.
|
|
17511
|
+
* @throws {RequiredError}
|
|
17512
|
+
*/
|
|
17513
|
+
createPlaceMembershipType(requestParameters, options) {
|
|
17514
|
+
return BookingsMembershipsApiFp(this.configuration).createPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17515
|
+
}
|
|
17516
|
+
/**
|
|
17517
|
+
* 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.
|
|
17518
|
+
* @summary Remove a member from a place membership
|
|
17519
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17520
|
+
* @param {*} [options] Override http request option.
|
|
17521
|
+
* @throws {RequiredError}
|
|
17522
|
+
*/
|
|
17523
|
+
deletePlaceMembershipMember(requestParameters, options) {
|
|
17524
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, options).then((request) => request(this.axios, this.basePath));
|
|
17525
|
+
}
|
|
17526
|
+
/**
|
|
17527
|
+
* Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
17528
|
+
* @summary Delete a place membership type
|
|
17529
|
+
* @param {BookingsMembershipsApiDeletePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17530
|
+
* @param {*} [options] Override http request option.
|
|
17531
|
+
* @throws {RequiredError}
|
|
17532
|
+
*/
|
|
17533
|
+
deletePlaceMembershipType(requestParameters, options) {
|
|
17534
|
+
return BookingsMembershipsApiFp(this.configuration).deletePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
17535
|
+
}
|
|
17536
|
+
/**
|
|
17537
|
+
* 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\".
|
|
17538
|
+
* @summary Get a place membership
|
|
17539
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipRequest} requestParameters Request parameters.
|
|
17540
|
+
* @param {*} [options] Override http request option.
|
|
17541
|
+
* @throws {RequiredError}
|
|
17542
|
+
*/
|
|
17543
|
+
getPlaceMembership(requestParameters, options) {
|
|
17544
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembership(requestParameters.placeMembershipId, options).then((request) => request(this.axios, this.basePath));
|
|
17545
|
+
}
|
|
17546
|
+
/**
|
|
17547
|
+
* 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\".
|
|
17548
|
+
* @summary List bookings that applied a place membership
|
|
17549
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipBookingsRequest} requestParameters Request parameters.
|
|
17550
|
+
* @param {*} [options] Override http request option.
|
|
17551
|
+
* @throws {RequiredError}
|
|
17552
|
+
*/
|
|
17553
|
+
getPlaceMembershipBookings(requestParameters, options) {
|
|
17554
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipBookings(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
17555
|
+
}
|
|
17556
|
+
/**
|
|
17557
|
+
* Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
17558
|
+
* @summary List a place membership\'s members
|
|
17559
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipMembersRequest} requestParameters Request parameters.
|
|
17560
|
+
* @param {*} [options] Override http request option.
|
|
17561
|
+
* @throws {RequiredError}
|
|
17562
|
+
*/
|
|
17563
|
+
getPlaceMembershipMembers(requestParameters, options) {
|
|
17564
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipMembers(requestParameters.placeMembershipId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
17565
|
+
}
|
|
17566
|
+
/**
|
|
17567
|
+
* Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
17568
|
+
* @summary Get a place membership type
|
|
17569
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17570
|
+
* @param {*} [options] Override http request option.
|
|
17571
|
+
* @throws {RequiredError}
|
|
17572
|
+
*/
|
|
17573
|
+
getPlaceMembershipType(requestParameters, options) {
|
|
17574
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, options).then((request) => request(this.axios, this.basePath));
|
|
17575
|
+
}
|
|
17576
|
+
/**
|
|
17577
|
+
* 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\".
|
|
17578
|
+
* @summary List a place\'s membership types
|
|
17579
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipTypesRequest} requestParameters Request parameters.
|
|
17580
|
+
* @param {*} [options] Override http request option.
|
|
17581
|
+
* @throws {RequiredError}
|
|
17582
|
+
*/
|
|
17583
|
+
getPlaceMembershipTypes(requestParameters, options) {
|
|
17584
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMembershipTypes(requestParameters.placeId, requestParameters.archived, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
17585
|
+
}
|
|
17586
|
+
/**
|
|
17587
|
+
* 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\".
|
|
17588
|
+
* @summary List a place\'s memberships
|
|
17589
|
+
* @param {BookingsMembershipsApiGetPlaceMembershipsRequest} requestParameters Request parameters.
|
|
17590
|
+
* @param {*} [options] Override http request option.
|
|
17591
|
+
* @throws {RequiredError}
|
|
17592
|
+
*/
|
|
17593
|
+
getPlaceMemberships(requestParameters, options) {
|
|
17594
|
+
return BookingsMembershipsApiFp(this.configuration).getPlaceMemberships(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.status, requestParameters.active, requestParameters.upcoming, requestParameters.expired, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
17595
|
+
}
|
|
17596
|
+
/**
|
|
17597
|
+
* Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
17598
|
+
* @summary Update a place membership
|
|
17599
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipRequest} requestParameters Request parameters.
|
|
17600
|
+
* @param {*} [options] Override http request option.
|
|
17601
|
+
* @throws {RequiredError}
|
|
17602
|
+
*/
|
|
17603
|
+
updatePlaceMembership(requestParameters, options) {
|
|
17604
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembership(requestParameters.placeMembershipId, requestParameters.placeMembershipUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17605
|
+
}
|
|
17606
|
+
/**
|
|
17607
|
+
* 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.
|
|
17608
|
+
* @summary Update a place membership member
|
|
17609
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipMemberRequest} requestParameters Request parameters.
|
|
17610
|
+
* @param {*} [options] Override http request option.
|
|
17611
|
+
* @throws {RequiredError}
|
|
17612
|
+
*/
|
|
17613
|
+
updatePlaceMembershipMember(requestParameters, options) {
|
|
17614
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipMember(requestParameters.placeMembershipId, requestParameters.placeMembershipMemberId, requestParameters.placeMembershipMemberUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17615
|
+
}
|
|
17616
|
+
/**
|
|
17617
|
+
* Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
17618
|
+
* @summary Update a place membership type
|
|
17619
|
+
* @param {BookingsMembershipsApiUpdatePlaceMembershipTypeRequest} requestParameters Request parameters.
|
|
17620
|
+
* @param {*} [options] Override http request option.
|
|
17621
|
+
* @throws {RequiredError}
|
|
17622
|
+
*/
|
|
17623
|
+
updatePlaceMembershipType(requestParameters, options) {
|
|
17624
|
+
return BookingsMembershipsApiFp(this.configuration).updatePlaceMembershipType(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.placeMembershipTypeUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17625
|
+
}
|
|
17626
|
+
}
|
|
17627
|
+
/**
|
|
17628
|
+
* BookingsMembershipsTranslationsApi - axios parameter creator
|
|
17629
|
+
*/
|
|
17630
|
+
export const BookingsMembershipsTranslationsApiAxiosParamCreator = function (configuration) {
|
|
17631
|
+
return {
|
|
17632
|
+
/**
|
|
17633
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
17634
|
+
* @summary Delete a place membership type translation
|
|
17635
|
+
* @param {string} placeId The place identifier
|
|
17636
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17637
|
+
* @param {string} locale The locale identifier
|
|
17638
|
+
* @param {*} [options] Override http request option.
|
|
17639
|
+
* @throws {RequiredError}
|
|
17640
|
+
*/
|
|
17641
|
+
deletePlaceMembershipTypeTranslation: (placeId_1, placeMembershipTypeId_1, locale_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, locale_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, locale, options = {}) {
|
|
17642
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
17643
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeId', placeId);
|
|
17644
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
17645
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
17646
|
+
// verify required parameter 'locale' is not null or undefined
|
|
17647
|
+
assertParamExists('deletePlaceMembershipTypeTranslation', 'locale', locale);
|
|
17648
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
17649
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
17650
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
17651
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
17652
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17653
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17654
|
+
let baseOptions;
|
|
17655
|
+
if (configuration) {
|
|
17656
|
+
baseOptions = configuration.baseOptions;
|
|
17657
|
+
}
|
|
17658
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
17659
|
+
const localVarHeaderParameter = {};
|
|
17660
|
+
const localVarQueryParameter = {};
|
|
17661
|
+
// authentication ApiKeyAuth required
|
|
17662
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17663
|
+
// authentication OrganizationId required
|
|
17664
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17665
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17666
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17667
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17668
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17669
|
+
return {
|
|
17670
|
+
url: toPathString(localVarUrlObj),
|
|
17671
|
+
options: localVarRequestOptions,
|
|
17672
|
+
};
|
|
17673
|
+
}),
|
|
17674
|
+
/**
|
|
17675
|
+
* 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\".
|
|
17676
|
+
* @summary Get a place membership type\'s translation
|
|
17677
|
+
* @param {string} placeId The place identifier
|
|
17678
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17679
|
+
* @param {string} locale The locale identifier
|
|
17680
|
+
* @param {*} [options] Override http request option.
|
|
17681
|
+
* @throws {RequiredError}
|
|
17682
|
+
*/
|
|
17683
|
+
getPlaceMembershipTypeTranslation: (placeId_1, placeMembershipTypeId_1, locale_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, locale_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, locale, options = {}) {
|
|
17684
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
17685
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeId', placeId);
|
|
17686
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
17687
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
17688
|
+
// verify required parameter 'locale' is not null or undefined
|
|
17689
|
+
assertParamExists('getPlaceMembershipTypeTranslation', 'locale', locale);
|
|
17690
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
17691
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
17692
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
17693
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
17694
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17695
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17696
|
+
let baseOptions;
|
|
17697
|
+
if (configuration) {
|
|
17698
|
+
baseOptions = configuration.baseOptions;
|
|
17699
|
+
}
|
|
17700
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17701
|
+
const localVarHeaderParameter = {};
|
|
17702
|
+
const localVarQueryParameter = {};
|
|
17703
|
+
// authentication ApiKeyAuth required
|
|
17704
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17705
|
+
// authentication OrganizationId required
|
|
17706
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17707
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17708
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17709
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17710
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17711
|
+
return {
|
|
17712
|
+
url: toPathString(localVarUrlObj),
|
|
17713
|
+
options: localVarRequestOptions,
|
|
17714
|
+
};
|
|
17715
|
+
}),
|
|
17716
|
+
/**
|
|
17717
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
17718
|
+
* @summary List a place membership type\'s translations
|
|
17719
|
+
* @param {string} placeId The place identifier
|
|
17720
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17721
|
+
* @param {number} [page] Page number
|
|
17722
|
+
* @param {number} [pageSize] Number of items per page
|
|
17723
|
+
* @param {string} [orderBy] Field to order by
|
|
17724
|
+
* @param {string} [search] Search query
|
|
17725
|
+
* @param {*} [options] Override http request option.
|
|
17726
|
+
* @throws {RequiredError}
|
|
17727
|
+
*/
|
|
17728
|
+
getPlaceMembershipTypeTranslations: (placeId_1, placeMembershipTypeId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, page, pageSize, orderBy, search, options = {}) {
|
|
17729
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
17730
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeId', placeId);
|
|
17731
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
17732
|
+
assertParamExists('getPlaceMembershipTypeTranslations', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
17733
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations`
|
|
17734
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
17735
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)));
|
|
17736
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17737
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17738
|
+
let baseOptions;
|
|
17739
|
+
if (configuration) {
|
|
17740
|
+
baseOptions = configuration.baseOptions;
|
|
17741
|
+
}
|
|
17742
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
17743
|
+
const localVarHeaderParameter = {};
|
|
17744
|
+
const localVarQueryParameter = {};
|
|
17745
|
+
// authentication ApiKeyAuth required
|
|
17746
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17747
|
+
// authentication OrganizationId required
|
|
17748
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17749
|
+
if (page !== undefined) {
|
|
17750
|
+
localVarQueryParameter['page'] = page;
|
|
17751
|
+
}
|
|
17752
|
+
if (pageSize !== undefined) {
|
|
17753
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
17754
|
+
}
|
|
17755
|
+
if (orderBy !== undefined) {
|
|
17756
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
17757
|
+
}
|
|
17758
|
+
if (search !== undefined) {
|
|
17759
|
+
localVarQueryParameter['search'] = search;
|
|
17760
|
+
}
|
|
17761
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17762
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17763
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17764
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17765
|
+
return {
|
|
17766
|
+
url: toPathString(localVarUrlObj),
|
|
17767
|
+
options: localVarRequestOptions,
|
|
17768
|
+
};
|
|
17769
|
+
}),
|
|
17770
|
+
/**
|
|
17771
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
17772
|
+
* @summary Update a place membership type\'s translation
|
|
17773
|
+
* @param {string} placeId The place identifier
|
|
17774
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17775
|
+
* @param {string} locale The locale identifier
|
|
17776
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
17777
|
+
* @param {*} [options] Override http request option.
|
|
17778
|
+
* @throws {RequiredError}
|
|
17779
|
+
*/
|
|
17780
|
+
updatePlaceMembershipTypeTranslation: (placeId_1, placeMembershipTypeId_1, locale_1, placeMembershipTypeTranslationUpdateInputs_1, ...args_1) => __awaiter(this, [placeId_1, placeMembershipTypeId_1, locale_1, placeMembershipTypeTranslationUpdateInputs_1, ...args_1], void 0, function* (placeId, placeMembershipTypeId, locale, placeMembershipTypeTranslationUpdateInputs, options = {}) {
|
|
17781
|
+
// verify required parameter 'placeId' is not null or undefined
|
|
17782
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeId', placeId);
|
|
17783
|
+
// verify required parameter 'placeMembershipTypeId' is not null or undefined
|
|
17784
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeId', placeMembershipTypeId);
|
|
17785
|
+
// verify required parameter 'locale' is not null or undefined
|
|
17786
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'locale', locale);
|
|
17787
|
+
// verify required parameter 'placeMembershipTypeTranslationUpdateInputs' is not null or undefined
|
|
17788
|
+
assertParamExists('updatePlaceMembershipTypeTranslation', 'placeMembershipTypeTranslationUpdateInputs', placeMembershipTypeTranslationUpdateInputs);
|
|
17789
|
+
const localVarPath = `/bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale}`
|
|
17790
|
+
.replace('{placeId}', encodeURIComponent(String(placeId)))
|
|
17791
|
+
.replace('{placeMembershipTypeId}', encodeURIComponent(String(placeMembershipTypeId)))
|
|
17792
|
+
.replace('{locale}', encodeURIComponent(String(locale)));
|
|
17793
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
17794
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
17795
|
+
let baseOptions;
|
|
17796
|
+
if (configuration) {
|
|
17797
|
+
baseOptions = configuration.baseOptions;
|
|
17798
|
+
}
|
|
17799
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
17800
|
+
const localVarHeaderParameter = {};
|
|
17801
|
+
const localVarQueryParameter = {};
|
|
17802
|
+
// authentication ApiKeyAuth required
|
|
17803
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
17804
|
+
// authentication OrganizationId required
|
|
17805
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
17806
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
17807
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
17808
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
17809
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
17810
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
17811
|
+
localVarRequestOptions.data = serializeDataIfNeeded(placeMembershipTypeTranslationUpdateInputs, localVarRequestOptions, configuration);
|
|
17812
|
+
return {
|
|
17813
|
+
url: toPathString(localVarUrlObj),
|
|
17814
|
+
options: localVarRequestOptions,
|
|
17815
|
+
};
|
|
17816
|
+
}),
|
|
17817
|
+
};
|
|
17818
|
+
};
|
|
17819
|
+
/**
|
|
17820
|
+
* BookingsMembershipsTranslationsApi - functional programming interface
|
|
17821
|
+
*/
|
|
17822
|
+
export const BookingsMembershipsTranslationsApiFp = function (configuration) {
|
|
17823
|
+
const localVarAxiosParamCreator = BookingsMembershipsTranslationsApiAxiosParamCreator(configuration);
|
|
17824
|
+
return {
|
|
17825
|
+
/**
|
|
17826
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
17827
|
+
* @summary Delete a place membership type translation
|
|
17828
|
+
* @param {string} placeId The place identifier
|
|
17829
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17830
|
+
* @param {string} locale The locale identifier
|
|
17831
|
+
* @param {*} [options] Override http request option.
|
|
17832
|
+
* @throws {RequiredError}
|
|
17833
|
+
*/
|
|
17834
|
+
deletePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options) {
|
|
17835
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17836
|
+
var _a, _b, _c;
|
|
17837
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
17838
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17839
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsTranslationsApi.deletePlaceMembershipTypeTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17840
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17841
|
+
});
|
|
17842
|
+
},
|
|
17843
|
+
/**
|
|
17844
|
+
* 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\".
|
|
17845
|
+
* @summary Get a place membership type\'s translation
|
|
17846
|
+
* @param {string} placeId The place identifier
|
|
17847
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17848
|
+
* @param {string} locale The locale identifier
|
|
17849
|
+
* @param {*} [options] Override http request option.
|
|
17850
|
+
* @throws {RequiredError}
|
|
17851
|
+
*/
|
|
17852
|
+
getPlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options) {
|
|
17853
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17854
|
+
var _a, _b, _c;
|
|
17855
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, options);
|
|
17856
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17857
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17858
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17859
|
+
});
|
|
17860
|
+
},
|
|
17861
|
+
/**
|
|
17862
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
17863
|
+
* @summary List a place membership type\'s translations
|
|
17864
|
+
* @param {string} placeId The place identifier
|
|
17865
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17866
|
+
* @param {number} [page] Page number
|
|
17867
|
+
* @param {number} [pageSize] Number of items per page
|
|
17868
|
+
* @param {string} [orderBy] Field to order by
|
|
17869
|
+
* @param {string} [search] Search query
|
|
17870
|
+
* @param {*} [options] Override http request option.
|
|
17871
|
+
* @throws {RequiredError}
|
|
17872
|
+
*/
|
|
17873
|
+
getPlaceMembershipTypeTranslations(placeId, placeMembershipTypeId, page, pageSize, orderBy, search, options) {
|
|
17874
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17875
|
+
var _a, _b, _c;
|
|
17876
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPlaceMembershipTypeTranslations(placeId, placeMembershipTypeId, page, pageSize, orderBy, search, options);
|
|
17877
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17878
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsTranslationsApi.getPlaceMembershipTypeTranslations']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17879
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17880
|
+
});
|
|
17881
|
+
},
|
|
17882
|
+
/**
|
|
17883
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
17884
|
+
* @summary Update a place membership type\'s translation
|
|
17885
|
+
* @param {string} placeId The place identifier
|
|
17886
|
+
* @param {string} placeMembershipTypeId The placeMembershipType identifier
|
|
17887
|
+
* @param {string} locale The locale identifier
|
|
17888
|
+
* @param {PlaceMembershipTypeTranslationUpdateInputs} placeMembershipTypeTranslationUpdateInputs
|
|
17889
|
+
* @param {*} [options] Override http request option.
|
|
17890
|
+
* @throws {RequiredError}
|
|
17891
|
+
*/
|
|
17892
|
+
updatePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, placeMembershipTypeTranslationUpdateInputs, options) {
|
|
17893
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
17894
|
+
var _a, _b, _c;
|
|
17895
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlaceMembershipTypeTranslation(placeId, placeMembershipTypeId, locale, placeMembershipTypeTranslationUpdateInputs, options);
|
|
17896
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
17897
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['BookingsMembershipsTranslationsApi.updatePlaceMembershipTypeTranslation']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
17898
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
17899
|
+
});
|
|
17900
|
+
},
|
|
17901
|
+
};
|
|
17902
|
+
};
|
|
17903
|
+
/**
|
|
17904
|
+
* BookingsMembershipsTranslationsApi - factory interface
|
|
17905
|
+
*/
|
|
17906
|
+
export const BookingsMembershipsTranslationsApiFactory = function (configuration, basePath, axios) {
|
|
17907
|
+
const localVarFp = BookingsMembershipsTranslationsApiFp(configuration);
|
|
17908
|
+
return {
|
|
17909
|
+
/**
|
|
17910
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
17911
|
+
* @summary Delete a place membership type translation
|
|
17912
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17913
|
+
* @param {*} [options] Override http request option.
|
|
17914
|
+
* @throws {RequiredError}
|
|
17915
|
+
*/
|
|
17916
|
+
deletePlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17917
|
+
return localVarFp.deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
17918
|
+
},
|
|
17919
|
+
/**
|
|
17920
|
+
* 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\".
|
|
17921
|
+
* @summary Get a place membership type\'s translation
|
|
17922
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17923
|
+
* @param {*} [options] Override http request option.
|
|
17924
|
+
* @throws {RequiredError}
|
|
17925
|
+
*/
|
|
17926
|
+
getPlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17927
|
+
return localVarFp.getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(axios, basePath));
|
|
17928
|
+
},
|
|
17929
|
+
/**
|
|
17930
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
17931
|
+
* @summary List a place membership type\'s translations
|
|
17932
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
17933
|
+
* @param {*} [options] Override http request option.
|
|
17934
|
+
* @throws {RequiredError}
|
|
17935
|
+
*/
|
|
17936
|
+
getPlaceMembershipTypeTranslations(requestParameters, options) {
|
|
17937
|
+
return localVarFp.getPlaceMembershipTypeTranslations(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
17938
|
+
},
|
|
17939
|
+
/**
|
|
17940
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
17941
|
+
* @summary Update a place membership type\'s translation
|
|
17942
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17943
|
+
* @param {*} [options] Override http request option.
|
|
17944
|
+
* @throws {RequiredError}
|
|
17945
|
+
*/
|
|
17946
|
+
updatePlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17947
|
+
return localVarFp.updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(axios, basePath));
|
|
17948
|
+
},
|
|
17949
|
+
};
|
|
17950
|
+
};
|
|
17951
|
+
/**
|
|
17952
|
+
* BookingsMembershipsTranslationsApi - object-oriented interface
|
|
17953
|
+
*/
|
|
17954
|
+
export class BookingsMembershipsTranslationsApi extends BaseAPI {
|
|
17955
|
+
/**
|
|
17956
|
+
* Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
17957
|
+
* @summary Delete a place membership type translation
|
|
17958
|
+
* @param {BookingsMembershipsTranslationsApiDeletePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17959
|
+
* @param {*} [options] Override http request option.
|
|
17960
|
+
* @throws {RequiredError}
|
|
17961
|
+
*/
|
|
17962
|
+
deletePlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17963
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).deletePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
17964
|
+
}
|
|
17965
|
+
/**
|
|
17966
|
+
* 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\".
|
|
17967
|
+
* @summary Get a place membership type\'s translation
|
|
17968
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17969
|
+
* @param {*} [options] Override http request option.
|
|
17970
|
+
* @throws {RequiredError}
|
|
17971
|
+
*/
|
|
17972
|
+
getPlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17973
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).getPlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
17974
|
+
}
|
|
17975
|
+
/**
|
|
17976
|
+
* Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
17977
|
+
* @summary List a place membership type\'s translations
|
|
17978
|
+
* @param {BookingsMembershipsTranslationsApiGetPlaceMembershipTypeTranslationsRequest} requestParameters Request parameters.
|
|
17979
|
+
* @param {*} [options] Override http request option.
|
|
17980
|
+
* @throws {RequiredError}
|
|
17981
|
+
*/
|
|
17982
|
+
getPlaceMembershipTypeTranslations(requestParameters, options) {
|
|
17983
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).getPlaceMembershipTypeTranslations(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
17984
|
+
}
|
|
17985
|
+
/**
|
|
17986
|
+
* Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
17987
|
+
* @summary Update a place membership type\'s translation
|
|
17988
|
+
* @param {BookingsMembershipsTranslationsApiUpdatePlaceMembershipTypeTranslationRequest} requestParameters Request parameters.
|
|
17989
|
+
* @param {*} [options] Override http request option.
|
|
17990
|
+
* @throws {RequiredError}
|
|
17991
|
+
*/
|
|
17992
|
+
updatePlaceMembershipTypeTranslation(requestParameters, options) {
|
|
17993
|
+
return BookingsMembershipsTranslationsApiFp(this.configuration).updatePlaceMembershipTypeTranslation(requestParameters.placeId, requestParameters.placeMembershipTypeId, requestParameters.locale, requestParameters.placeMembershipTypeTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
17994
|
+
}
|
|
17995
|
+
}
|
|
16400
17996
|
/**
|
|
16401
17997
|
* BookingsPlacesApi - axios parameter creator
|
|
16402
17998
|
*/
|
|
@@ -104182,7 +105778,7 @@ export const StreamsApiAxiosParamCreator = function (configuration) {
|
|
|
104182
105778
|
};
|
|
104183
105779
|
}),
|
|
104184
105780
|
/**
|
|
104185
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
105781
|
+
* 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.
|
|
104186
105782
|
* @summary Delete a stream input
|
|
104187
105783
|
* @param {string} streamId The stream identifier
|
|
104188
105784
|
* @param {*} [options] Override http request option.
|
|
@@ -104464,7 +106060,7 @@ export const StreamsApiFp = function (configuration) {
|
|
|
104464
106060
|
});
|
|
104465
106061
|
},
|
|
104466
106062
|
/**
|
|
104467
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106063
|
+
* 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.
|
|
104468
106064
|
* @summary Delete a stream input
|
|
104469
106065
|
* @param {string} streamId The stream identifier
|
|
104470
106066
|
* @param {*} [options] Override http request option.
|
|
@@ -104591,7 +106187,7 @@ export const StreamsApiFactory = function (configuration, basePath, axios) {
|
|
|
104591
106187
|
return localVarFp.createStreamInput(requestParameters.streamInputCreateInputs, options).then((request) => request(axios, basePath));
|
|
104592
106188
|
},
|
|
104593
106189
|
/**
|
|
104594
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106190
|
+
* 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.
|
|
104595
106191
|
* @summary Delete a stream input
|
|
104596
106192
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
104597
106193
|
* @param {*} [options] Override http request option.
|
|
@@ -104667,7 +106263,7 @@ export class StreamsApi extends BaseAPI {
|
|
|
104667
106263
|
return StreamsApiFp(this.configuration).createStreamInput(requestParameters.streamInputCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
104668
106264
|
}
|
|
104669
106265
|
/**
|
|
104670
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106266
|
+
* 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.
|
|
104671
106267
|
* @summary Delete a stream input
|
|
104672
106268
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
104673
106269
|
* @param {*} [options] Override http request option.
|
|
@@ -105233,6 +106829,102 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
105233
106829
|
options: localVarRequestOptions,
|
|
105234
106830
|
};
|
|
105235
106831
|
}),
|
|
106832
|
+
/**
|
|
106833
|
+
* 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.
|
|
106834
|
+
* @summary Request an export of a stream session by session id
|
|
106835
|
+
* @param {string} sessionId The session identifier
|
|
106836
|
+
* @param {*} [options] Override http request option.
|
|
106837
|
+
* @throws {RequiredError}
|
|
106838
|
+
*/
|
|
106839
|
+
exportStreamSessionById: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
106840
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
106841
|
+
assertParamExists('exportStreamSessionById', 'sessionId', sessionId);
|
|
106842
|
+
const localVarPath = `/streams/sessions/{sessionId}/export`
|
|
106843
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
106844
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106845
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106846
|
+
let baseOptions;
|
|
106847
|
+
if (configuration) {
|
|
106848
|
+
baseOptions = configuration.baseOptions;
|
|
106849
|
+
}
|
|
106850
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
106851
|
+
const localVarHeaderParameter = {};
|
|
106852
|
+
const localVarQueryParameter = {};
|
|
106853
|
+
// authentication ApiKeyAuth required
|
|
106854
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106855
|
+
// authentication OrganizationId required
|
|
106856
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106857
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106858
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106859
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106860
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106861
|
+
return {
|
|
106862
|
+
url: toPathString(localVarUrlObj),
|
|
106863
|
+
options: localVarRequestOptions,
|
|
106864
|
+
};
|
|
106865
|
+
}),
|
|
106866
|
+
/**
|
|
106867
|
+
* 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.
|
|
106868
|
+
* @summary List stream sessions across all stream inputs
|
|
106869
|
+
* @param {string} [streamId] Filter by streamId
|
|
106870
|
+
* @param {string} [eventId] Filter by eventId
|
|
106871
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
106872
|
+
* @param {string} [status] Filter by status
|
|
106873
|
+
* @param {number} [page] Page number
|
|
106874
|
+
* @param {number} [pageSize] Number of items per page
|
|
106875
|
+
* @param {string} [orderBy] Field to order by
|
|
106876
|
+
* @param {string} [search] Search query
|
|
106877
|
+
* @param {*} [options] Override http request option.
|
|
106878
|
+
* @throws {RequiredError}
|
|
106879
|
+
*/
|
|
106880
|
+
getAllStreamSessions: (streamId_1, eventId_1, eventSessionId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [streamId_1, eventId_1, eventSessionId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options = {}) {
|
|
106881
|
+
const localVarPath = `/streams/sessions`;
|
|
106882
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106883
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106884
|
+
let baseOptions;
|
|
106885
|
+
if (configuration) {
|
|
106886
|
+
baseOptions = configuration.baseOptions;
|
|
106887
|
+
}
|
|
106888
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
106889
|
+
const localVarHeaderParameter = {};
|
|
106890
|
+
const localVarQueryParameter = {};
|
|
106891
|
+
// authentication ApiKeyAuth required
|
|
106892
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106893
|
+
// authentication OrganizationId required
|
|
106894
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106895
|
+
if (streamId !== undefined) {
|
|
106896
|
+
localVarQueryParameter['streamId'] = streamId;
|
|
106897
|
+
}
|
|
106898
|
+
if (eventId !== undefined) {
|
|
106899
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
106900
|
+
}
|
|
106901
|
+
if (eventSessionId !== undefined) {
|
|
106902
|
+
localVarQueryParameter['eventSessionId'] = eventSessionId;
|
|
106903
|
+
}
|
|
106904
|
+
if (status !== undefined) {
|
|
106905
|
+
localVarQueryParameter['status'] = status;
|
|
106906
|
+
}
|
|
106907
|
+
if (page !== undefined) {
|
|
106908
|
+
localVarQueryParameter['page'] = page;
|
|
106909
|
+
}
|
|
106910
|
+
if (pageSize !== undefined) {
|
|
106911
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
106912
|
+
}
|
|
106913
|
+
if (orderBy !== undefined) {
|
|
106914
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
106915
|
+
}
|
|
106916
|
+
if (search !== undefined) {
|
|
106917
|
+
localVarQueryParameter['search'] = search;
|
|
106918
|
+
}
|
|
106919
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106920
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106921
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106922
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106923
|
+
return {
|
|
106924
|
+
url: toPathString(localVarUrlObj),
|
|
106925
|
+
options: localVarRequestOptions,
|
|
106926
|
+
};
|
|
106927
|
+
}),
|
|
105236
106928
|
/**
|
|
105237
106929
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
105238
106930
|
* @summary Get a single stream session
|
|
@@ -105271,6 +106963,128 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
105271
106963
|
options: localVarRequestOptions,
|
|
105272
106964
|
};
|
|
105273
106965
|
}),
|
|
106966
|
+
/**
|
|
106967
|
+
* 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.
|
|
106968
|
+
* @summary Get a stream session by id
|
|
106969
|
+
* @param {string} sessionId The session identifier
|
|
106970
|
+
* @param {*} [options] Override http request option.
|
|
106971
|
+
* @throws {RequiredError}
|
|
106972
|
+
*/
|
|
106973
|
+
getStreamSessionById: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
106974
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
106975
|
+
assertParamExists('getStreamSessionById', 'sessionId', sessionId);
|
|
106976
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
106977
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
106978
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106979
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106980
|
+
let baseOptions;
|
|
106981
|
+
if (configuration) {
|
|
106982
|
+
baseOptions = configuration.baseOptions;
|
|
106983
|
+
}
|
|
106984
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
106985
|
+
const localVarHeaderParameter = {};
|
|
106986
|
+
const localVarQueryParameter = {};
|
|
106987
|
+
// authentication ApiKeyAuth required
|
|
106988
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106989
|
+
// authentication OrganizationId required
|
|
106990
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106991
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106992
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106993
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106994
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106995
|
+
return {
|
|
106996
|
+
url: toPathString(localVarUrlObj),
|
|
106997
|
+
options: localVarRequestOptions,
|
|
106998
|
+
};
|
|
106999
|
+
}),
|
|
107000
|
+
/**
|
|
107001
|
+
* 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.
|
|
107002
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107003
|
+
* @param {string} sessionId The session identifier
|
|
107004
|
+
* @param {*} [options] Override http request option.
|
|
107005
|
+
* @throws {RequiredError}
|
|
107006
|
+
*/
|
|
107007
|
+
getStreamSessionByIdChat: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
107008
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107009
|
+
assertParamExists('getStreamSessionByIdChat', 'sessionId', sessionId);
|
|
107010
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat`
|
|
107011
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107012
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107013
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107014
|
+
let baseOptions;
|
|
107015
|
+
if (configuration) {
|
|
107016
|
+
baseOptions = configuration.baseOptions;
|
|
107017
|
+
}
|
|
107018
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
107019
|
+
const localVarHeaderParameter = {};
|
|
107020
|
+
const localVarQueryParameter = {};
|
|
107021
|
+
// authentication ApiKeyAuth required
|
|
107022
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107023
|
+
// authentication OrganizationId required
|
|
107024
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107025
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107026
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107027
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107028
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107029
|
+
return {
|
|
107030
|
+
url: toPathString(localVarUrlObj),
|
|
107031
|
+
options: localVarRequestOptions,
|
|
107032
|
+
};
|
|
107033
|
+
}),
|
|
107034
|
+
/**
|
|
107035
|
+
* 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.
|
|
107036
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107037
|
+
* @param {string} sessionId The session identifier
|
|
107038
|
+
* @param {boolean} [active] Filter by active
|
|
107039
|
+
* @param {number} [page] Page number
|
|
107040
|
+
* @param {number} [pageSize] Number of items per page
|
|
107041
|
+
* @param {string} [orderBy] Field to order by
|
|
107042
|
+
* @param {string} [search] Search query
|
|
107043
|
+
* @param {*} [options] Override http request option.
|
|
107044
|
+
* @throws {RequiredError}
|
|
107045
|
+
*/
|
|
107046
|
+
getStreamSessionByIdSubscriptions: (sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, active, page, pageSize, orderBy, search, options = {}) {
|
|
107047
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107048
|
+
assertParamExists('getStreamSessionByIdSubscriptions', 'sessionId', sessionId);
|
|
107049
|
+
const localVarPath = `/streams/sessions/{sessionId}/subscriptions`
|
|
107050
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107051
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107052
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107053
|
+
let baseOptions;
|
|
107054
|
+
if (configuration) {
|
|
107055
|
+
baseOptions = configuration.baseOptions;
|
|
107056
|
+
}
|
|
107057
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
107058
|
+
const localVarHeaderParameter = {};
|
|
107059
|
+
const localVarQueryParameter = {};
|
|
107060
|
+
// authentication ApiKeyAuth required
|
|
107061
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107062
|
+
// authentication OrganizationId required
|
|
107063
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107064
|
+
if (active !== undefined) {
|
|
107065
|
+
localVarQueryParameter['active'] = active;
|
|
107066
|
+
}
|
|
107067
|
+
if (page !== undefined) {
|
|
107068
|
+
localVarQueryParameter['page'] = page;
|
|
107069
|
+
}
|
|
107070
|
+
if (pageSize !== undefined) {
|
|
107071
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
107072
|
+
}
|
|
107073
|
+
if (orderBy !== undefined) {
|
|
107074
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
107075
|
+
}
|
|
107076
|
+
if (search !== undefined) {
|
|
107077
|
+
localVarQueryParameter['search'] = search;
|
|
107078
|
+
}
|
|
107079
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107080
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107081
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107082
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107083
|
+
return {
|
|
107084
|
+
url: toPathString(localVarUrlObj),
|
|
107085
|
+
options: localVarRequestOptions,
|
|
107086
|
+
};
|
|
107087
|
+
}),
|
|
105274
107088
|
/**
|
|
105275
107089
|
* 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.
|
|
105276
107090
|
* @summary List a stream session\'s chat messages
|
|
@@ -105421,6 +107235,45 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
105421
107235
|
options: localVarRequestOptions,
|
|
105422
107236
|
};
|
|
105423
107237
|
}),
|
|
107238
|
+
/**
|
|
107239
|
+
* 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.
|
|
107240
|
+
* @summary Update a stream session
|
|
107241
|
+
* @param {string} sessionId The session identifier
|
|
107242
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
107243
|
+
* @param {*} [options] Override http request option.
|
|
107244
|
+
* @throws {RequiredError}
|
|
107245
|
+
*/
|
|
107246
|
+
updateStreamSession: (sessionId_1, streamSessionUpdateInputs_1, ...args_1) => __awaiter(this, [sessionId_1, streamSessionUpdateInputs_1, ...args_1], void 0, function* (sessionId, streamSessionUpdateInputs, options = {}) {
|
|
107247
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107248
|
+
assertParamExists('updateStreamSession', 'sessionId', sessionId);
|
|
107249
|
+
// verify required parameter 'streamSessionUpdateInputs' is not null or undefined
|
|
107250
|
+
assertParamExists('updateStreamSession', 'streamSessionUpdateInputs', streamSessionUpdateInputs);
|
|
107251
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
107252
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107253
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107254
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107255
|
+
let baseOptions;
|
|
107256
|
+
if (configuration) {
|
|
107257
|
+
baseOptions = configuration.baseOptions;
|
|
107258
|
+
}
|
|
107259
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
107260
|
+
const localVarHeaderParameter = {};
|
|
107261
|
+
const localVarQueryParameter = {};
|
|
107262
|
+
// authentication ApiKeyAuth required
|
|
107263
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107264
|
+
// authentication OrganizationId required
|
|
107265
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107266
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
107267
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107268
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107269
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107270
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107271
|
+
localVarRequestOptions.data = serializeDataIfNeeded(streamSessionUpdateInputs, localVarRequestOptions, configuration);
|
|
107272
|
+
return {
|
|
107273
|
+
url: toPathString(localVarUrlObj),
|
|
107274
|
+
options: localVarRequestOptions,
|
|
107275
|
+
};
|
|
107276
|
+
}),
|
|
105424
107277
|
};
|
|
105425
107278
|
};
|
|
105426
107279
|
/**
|
|
@@ -105463,6 +107316,45 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
105463
107316
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
105464
107317
|
});
|
|
105465
107318
|
},
|
|
107319
|
+
/**
|
|
107320
|
+
* 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.
|
|
107321
|
+
* @summary Request an export of a stream session by session id
|
|
107322
|
+
* @param {string} sessionId The session identifier
|
|
107323
|
+
* @param {*} [options] Override http request option.
|
|
107324
|
+
* @throws {RequiredError}
|
|
107325
|
+
*/
|
|
107326
|
+
exportStreamSessionById(sessionId, options) {
|
|
107327
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107328
|
+
var _a, _b, _c;
|
|
107329
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportStreamSessionById(sessionId, options);
|
|
107330
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107331
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.exportStreamSessionById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107332
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107333
|
+
});
|
|
107334
|
+
},
|
|
107335
|
+
/**
|
|
107336
|
+
* 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.
|
|
107337
|
+
* @summary List stream sessions across all stream inputs
|
|
107338
|
+
* @param {string} [streamId] Filter by streamId
|
|
107339
|
+
* @param {string} [eventId] Filter by eventId
|
|
107340
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
107341
|
+
* @param {string} [status] Filter by status
|
|
107342
|
+
* @param {number} [page] Page number
|
|
107343
|
+
* @param {number} [pageSize] Number of items per page
|
|
107344
|
+
* @param {string} [orderBy] Field to order by
|
|
107345
|
+
* @param {string} [search] Search query
|
|
107346
|
+
* @param {*} [options] Override http request option.
|
|
107347
|
+
* @throws {RequiredError}
|
|
107348
|
+
*/
|
|
107349
|
+
getAllStreamSessions(streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options) {
|
|
107350
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107351
|
+
var _a, _b, _c;
|
|
107352
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllStreamSessions(streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options);
|
|
107353
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107354
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getAllStreamSessions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107355
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107356
|
+
});
|
|
107357
|
+
},
|
|
105466
107358
|
/**
|
|
105467
107359
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
105468
107360
|
* @summary Get a single stream session
|
|
@@ -105480,6 +107372,59 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
105480
107372
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
105481
107373
|
});
|
|
105482
107374
|
},
|
|
107375
|
+
/**
|
|
107376
|
+
* 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.
|
|
107377
|
+
* @summary Get a stream session by id
|
|
107378
|
+
* @param {string} sessionId The session identifier
|
|
107379
|
+
* @param {*} [options] Override http request option.
|
|
107380
|
+
* @throws {RequiredError}
|
|
107381
|
+
*/
|
|
107382
|
+
getStreamSessionById(sessionId, options) {
|
|
107383
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107384
|
+
var _a, _b, _c;
|
|
107385
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionById(sessionId, options);
|
|
107386
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107387
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107388
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107389
|
+
});
|
|
107390
|
+
},
|
|
107391
|
+
/**
|
|
107392
|
+
* 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.
|
|
107393
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107394
|
+
* @param {string} sessionId The session identifier
|
|
107395
|
+
* @param {*} [options] Override http request option.
|
|
107396
|
+
* @throws {RequiredError}
|
|
107397
|
+
*/
|
|
107398
|
+
getStreamSessionByIdChat(sessionId, options) {
|
|
107399
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107400
|
+
var _a, _b, _c;
|
|
107401
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionByIdChat(sessionId, options);
|
|
107402
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107403
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionByIdChat']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107404
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107405
|
+
});
|
|
107406
|
+
},
|
|
107407
|
+
/**
|
|
107408
|
+
* 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.
|
|
107409
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107410
|
+
* @param {string} sessionId The session identifier
|
|
107411
|
+
* @param {boolean} [active] Filter by active
|
|
107412
|
+
* @param {number} [page] Page number
|
|
107413
|
+
* @param {number} [pageSize] Number of items per page
|
|
107414
|
+
* @param {string} [orderBy] Field to order by
|
|
107415
|
+
* @param {string} [search] Search query
|
|
107416
|
+
* @param {*} [options] Override http request option.
|
|
107417
|
+
* @throws {RequiredError}
|
|
107418
|
+
*/
|
|
107419
|
+
getStreamSessionByIdSubscriptions(sessionId, active, page, pageSize, orderBy, search, options) {
|
|
107420
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107421
|
+
var _a, _b, _c;
|
|
107422
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionByIdSubscriptions(sessionId, active, page, pageSize, orderBy, search, options);
|
|
107423
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107424
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionByIdSubscriptions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107425
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107426
|
+
});
|
|
107427
|
+
},
|
|
105483
107428
|
/**
|
|
105484
107429
|
* 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.
|
|
105485
107430
|
* @summary List a stream session\'s chat messages
|
|
@@ -105540,6 +107485,23 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
105540
107485
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
105541
107486
|
});
|
|
105542
107487
|
},
|
|
107488
|
+
/**
|
|
107489
|
+
* 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.
|
|
107490
|
+
* @summary Update a stream session
|
|
107491
|
+
* @param {string} sessionId The session identifier
|
|
107492
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
107493
|
+
* @param {*} [options] Override http request option.
|
|
107494
|
+
* @throws {RequiredError}
|
|
107495
|
+
*/
|
|
107496
|
+
updateStreamSession(sessionId, streamSessionUpdateInputs, options) {
|
|
107497
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107498
|
+
var _a, _b, _c;
|
|
107499
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateStreamSession(sessionId, streamSessionUpdateInputs, options);
|
|
107500
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107501
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.updateStreamSession']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107502
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107503
|
+
});
|
|
107504
|
+
},
|
|
105543
107505
|
};
|
|
105544
107506
|
};
|
|
105545
107507
|
/**
|
|
@@ -105568,6 +107530,26 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
105568
107530
|
exportStreamSession(requestParameters, options) {
|
|
105569
107531
|
return localVarFp.exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
105570
107532
|
},
|
|
107533
|
+
/**
|
|
107534
|
+
* 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.
|
|
107535
|
+
* @summary Request an export of a stream session by session id
|
|
107536
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107537
|
+
* @param {*} [options] Override http request option.
|
|
107538
|
+
* @throws {RequiredError}
|
|
107539
|
+
*/
|
|
107540
|
+
exportStreamSessionById(requestParameters, options) {
|
|
107541
|
+
return localVarFp.exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107542
|
+
},
|
|
107543
|
+
/**
|
|
107544
|
+
* 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.
|
|
107545
|
+
* @summary List stream sessions across all stream inputs
|
|
107546
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
107547
|
+
* @param {*} [options] Override http request option.
|
|
107548
|
+
* @throws {RequiredError}
|
|
107549
|
+
*/
|
|
107550
|
+
getAllStreamSessions(requestParameters = {}, options) {
|
|
107551
|
+
return localVarFp.getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107552
|
+
},
|
|
105571
107553
|
/**
|
|
105572
107554
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
105573
107555
|
* @summary Get a single stream session
|
|
@@ -105578,6 +107560,36 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
105578
107560
|
getStreamSession(requestParameters, options) {
|
|
105579
107561
|
return localVarFp.getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
105580
107562
|
},
|
|
107563
|
+
/**
|
|
107564
|
+
* 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.
|
|
107565
|
+
* @summary Get a stream session by id
|
|
107566
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107567
|
+
* @param {*} [options] Override http request option.
|
|
107568
|
+
* @throws {RequiredError}
|
|
107569
|
+
*/
|
|
107570
|
+
getStreamSessionById(requestParameters, options) {
|
|
107571
|
+
return localVarFp.getStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107572
|
+
},
|
|
107573
|
+
/**
|
|
107574
|
+
* 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.
|
|
107575
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107576
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
107577
|
+
* @param {*} [options] Override http request option.
|
|
107578
|
+
* @throws {RequiredError}
|
|
107579
|
+
*/
|
|
107580
|
+
getStreamSessionByIdChat(requestParameters, options) {
|
|
107581
|
+
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107582
|
+
},
|
|
107583
|
+
/**
|
|
107584
|
+
* 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.
|
|
107585
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107586
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107587
|
+
* @param {*} [options] Override http request option.
|
|
107588
|
+
* @throws {RequiredError}
|
|
107589
|
+
*/
|
|
107590
|
+
getStreamSessionByIdSubscriptions(requestParameters, options) {
|
|
107591
|
+
return localVarFp.getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107592
|
+
},
|
|
105581
107593
|
/**
|
|
105582
107594
|
* 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.
|
|
105583
107595
|
* @summary List a stream session\'s chat messages
|
|
@@ -105608,6 +107620,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
105608
107620
|
getStreamSessions(requestParameters, options) {
|
|
105609
107621
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
105610
107622
|
},
|
|
107623
|
+
/**
|
|
107624
|
+
* 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.
|
|
107625
|
+
* @summary Update a stream session
|
|
107626
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
107627
|
+
* @param {*} [options] Override http request option.
|
|
107628
|
+
* @throws {RequiredError}
|
|
107629
|
+
*/
|
|
107630
|
+
updateStreamSession(requestParameters, options) {
|
|
107631
|
+
return localVarFp.updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(axios, basePath));
|
|
107632
|
+
},
|
|
105611
107633
|
};
|
|
105612
107634
|
};
|
|
105613
107635
|
/**
|
|
@@ -105634,6 +107656,26 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
105634
107656
|
exportStreamSession(requestParameters, options) {
|
|
105635
107657
|
return StreamsSessionsApiFp(this.configuration).exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
105636
107658
|
}
|
|
107659
|
+
/**
|
|
107660
|
+
* 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.
|
|
107661
|
+
* @summary Request an export of a stream session by session id
|
|
107662
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107663
|
+
* @param {*} [options] Override http request option.
|
|
107664
|
+
* @throws {RequiredError}
|
|
107665
|
+
*/
|
|
107666
|
+
exportStreamSessionById(requestParameters, options) {
|
|
107667
|
+
return StreamsSessionsApiFp(this.configuration).exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107668
|
+
}
|
|
107669
|
+
/**
|
|
107670
|
+
* 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.
|
|
107671
|
+
* @summary List stream sessions across all stream inputs
|
|
107672
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
107673
|
+
* @param {*} [options] Override http request option.
|
|
107674
|
+
* @throws {RequiredError}
|
|
107675
|
+
*/
|
|
107676
|
+
getAllStreamSessions(requestParameters = {}, options) {
|
|
107677
|
+
return StreamsSessionsApiFp(this.configuration).getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107678
|
+
}
|
|
105637
107679
|
/**
|
|
105638
107680
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
105639
107681
|
* @summary Get a single stream session
|
|
@@ -105644,6 +107686,36 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
105644
107686
|
getStreamSession(requestParameters, options) {
|
|
105645
107687
|
return StreamsSessionsApiFp(this.configuration).getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
105646
107688
|
}
|
|
107689
|
+
/**
|
|
107690
|
+
* 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.
|
|
107691
|
+
* @summary Get a stream session by id
|
|
107692
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107693
|
+
* @param {*} [options] Override http request option.
|
|
107694
|
+
* @throws {RequiredError}
|
|
107695
|
+
*/
|
|
107696
|
+
getStreamSessionById(requestParameters, options) {
|
|
107697
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107698
|
+
}
|
|
107699
|
+
/**
|
|
107700
|
+
* 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.
|
|
107701
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107702
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
107703
|
+
* @param {*} [options] Override http request option.
|
|
107704
|
+
* @throws {RequiredError}
|
|
107705
|
+
*/
|
|
107706
|
+
getStreamSessionByIdChat(requestParameters, options) {
|
|
107707
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107708
|
+
}
|
|
107709
|
+
/**
|
|
107710
|
+
* 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.
|
|
107711
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107712
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107713
|
+
* @param {*} [options] Override http request option.
|
|
107714
|
+
* @throws {RequiredError}
|
|
107715
|
+
*/
|
|
107716
|
+
getStreamSessionByIdSubscriptions(requestParameters, options) {
|
|
107717
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107718
|
+
}
|
|
105647
107719
|
/**
|
|
105648
107720
|
* 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.
|
|
105649
107721
|
* @summary List a stream session\'s chat messages
|
|
@@ -105674,6 +107746,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
105674
107746
|
getStreamSessions(requestParameters, options) {
|
|
105675
107747
|
return StreamsSessionsApiFp(this.configuration).getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
105676
107748
|
}
|
|
107749
|
+
/**
|
|
107750
|
+
* 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.
|
|
107751
|
+
* @summary Update a stream session
|
|
107752
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
107753
|
+
* @param {*} [options] Override http request option.
|
|
107754
|
+
* @throws {RequiredError}
|
|
107755
|
+
*/
|
|
107756
|
+
updateStreamSession(requestParameters, options) {
|
|
107757
|
+
return StreamsSessionsApiFp(this.configuration).updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
107758
|
+
}
|
|
105677
107759
|
}
|
|
105678
107760
|
/**
|
|
105679
107761
|
* SupportApi - axios parameter creator
|