@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
|
@@ -0,0 +1,840 @@
|
|
|
1
|
+
# BookingsMembershipsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createPlaceMembership**](#createplacemembership) | **POST** /bookings/places/{placeId}/memberships | Grant a place membership|
|
|
8
|
+
|[**createPlaceMembershipMember**](#createplacemembershipmember) | **POST** /bookings/placeMemberships/{placeMembershipId}/members | Add a member to a place membership|
|
|
9
|
+
|[**createPlaceMembershipType**](#createplacemembershiptype) | **POST** /bookings/places/{placeId}/membershipTypes | Create a place membership type|
|
|
10
|
+
|[**deletePlaceMembershipMember**](#deleteplacemembershipmember) | **DELETE** /bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId} | Remove a member from a place membership|
|
|
11
|
+
|[**deletePlaceMembershipType**](#deleteplacemembershiptype) | **DELETE** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId} | Delete a place membership type|
|
|
12
|
+
|[**getPlaceMembership**](#getplacemembership) | **GET** /bookings/placeMemberships/{placeMembershipId} | Get a place membership|
|
|
13
|
+
|[**getPlaceMembershipBookings**](#getplacemembershipbookings) | **GET** /bookings/placeMemberships/{placeMembershipId}/bookings | List bookings that applied a place membership|
|
|
14
|
+
|[**getPlaceMembershipMembers**](#getplacemembershipmembers) | **GET** /bookings/placeMemberships/{placeMembershipId}/members | List a place membership\'s members|
|
|
15
|
+
|[**getPlaceMembershipType**](#getplacemembershiptype) | **GET** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId} | Get a place membership type|
|
|
16
|
+
|[**getPlaceMembershipTypes**](#getplacemembershiptypes) | **GET** /bookings/places/{placeId}/membershipTypes | List a place\'s membership types|
|
|
17
|
+
|[**getPlaceMemberships**](#getplacememberships) | **GET** /bookings/places/{placeId}/memberships | List a place\'s memberships|
|
|
18
|
+
|[**updatePlaceMembership**](#updateplacemembership) | **PUT** /bookings/placeMemberships/{placeMembershipId} | Update a place membership|
|
|
19
|
+
|[**updatePlaceMembershipMember**](#updateplacemembershipmember) | **PUT** /bookings/placeMemberships/{placeMembershipId}/members/{placeMembershipMemberId} | Update a place membership member|
|
|
20
|
+
|[**updatePlaceMembershipType**](#updateplacemembershiptype) | **PUT** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId} | Update a place membership type|
|
|
21
|
+
|
|
22
|
+
# **createPlaceMembership**
|
|
23
|
+
> GetPlaceMembership200Response createPlaceMembership(placeMembershipCreateInputs)
|
|
24
|
+
|
|
25
|
+
Creates a ready place membership for an account without payment (a grant), optionally with custom start and expiry dates; requires the create bookings permission.
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import {
|
|
31
|
+
BookingsMembershipsApi,
|
|
32
|
+
Configuration,
|
|
33
|
+
PlaceMembershipCreateInputs
|
|
34
|
+
} from '@connectedxm/admin-sdk';
|
|
35
|
+
|
|
36
|
+
const configuration = new Configuration();
|
|
37
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
38
|
+
|
|
39
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
40
|
+
let placeMembershipCreateInputs: PlaceMembershipCreateInputs; //
|
|
41
|
+
|
|
42
|
+
const { status, data } = await apiInstance.createPlaceMembership(
|
|
43
|
+
placeId,
|
|
44
|
+
placeMembershipCreateInputs
|
|
45
|
+
);
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Parameters
|
|
49
|
+
|
|
50
|
+
|Name | Type | Description | Notes|
|
|
51
|
+
|------------- | ------------- | ------------- | -------------|
|
|
52
|
+
| **placeMembershipCreateInputs** | **PlaceMembershipCreateInputs**| | |
|
|
53
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
**GetPlaceMembership200Response**
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: application/json
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### HTTP response details
|
|
71
|
+
| Status code | Description | Response headers |
|
|
72
|
+
|-------------|-------------|------------------|
|
|
73
|
+
|**200** | Successful response | - |
|
|
74
|
+
|
|
75
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
76
|
+
|
|
77
|
+
# **createPlaceMembershipMember**
|
|
78
|
+
> CreatePlaceMembershipMember200Response createPlaceMembershipMember(placeMembershipMemberCreateInputs)
|
|
79
|
+
|
|
80
|
+
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.
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
import {
|
|
86
|
+
BookingsMembershipsApi,
|
|
87
|
+
Configuration,
|
|
88
|
+
PlaceMembershipMemberCreateInputs
|
|
89
|
+
} from '@connectedxm/admin-sdk';
|
|
90
|
+
|
|
91
|
+
const configuration = new Configuration();
|
|
92
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
93
|
+
|
|
94
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
95
|
+
let placeMembershipMemberCreateInputs: PlaceMembershipMemberCreateInputs; //
|
|
96
|
+
|
|
97
|
+
const { status, data } = await apiInstance.createPlaceMembershipMember(
|
|
98
|
+
placeMembershipId,
|
|
99
|
+
placeMembershipMemberCreateInputs
|
|
100
|
+
);
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
|Name | Type | Description | Notes|
|
|
106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
107
|
+
| **placeMembershipMemberCreateInputs** | **PlaceMembershipMemberCreateInputs**| | |
|
|
108
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### Return type
|
|
112
|
+
|
|
113
|
+
**CreatePlaceMembershipMember200Response**
|
|
114
|
+
|
|
115
|
+
### Authorization
|
|
116
|
+
|
|
117
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
118
|
+
|
|
119
|
+
### HTTP request headers
|
|
120
|
+
|
|
121
|
+
- **Content-Type**: application/json
|
|
122
|
+
- **Accept**: application/json
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### HTTP response details
|
|
126
|
+
| Status code | Description | Response headers |
|
|
127
|
+
|-------------|-------------|------------------|
|
|
128
|
+
|**200** | Successful response | - |
|
|
129
|
+
|
|
130
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
131
|
+
|
|
132
|
+
# **createPlaceMembershipType**
|
|
133
|
+
> CreatePlaceMembershipType200Response createPlaceMembershipType(placeMembershipTypeCreateInputs)
|
|
134
|
+
|
|
135
|
+
Creates a new membership type on a booking place (name, price, term, and max members), requiring the update bookings permission.
|
|
136
|
+
|
|
137
|
+
### Example
|
|
138
|
+
|
|
139
|
+
```typescript
|
|
140
|
+
import {
|
|
141
|
+
BookingsMembershipsApi,
|
|
142
|
+
Configuration,
|
|
143
|
+
PlaceMembershipTypeCreateInputs
|
|
144
|
+
} from '@connectedxm/admin-sdk';
|
|
145
|
+
|
|
146
|
+
const configuration = new Configuration();
|
|
147
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
148
|
+
|
|
149
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
150
|
+
let placeMembershipTypeCreateInputs: PlaceMembershipTypeCreateInputs; //
|
|
151
|
+
|
|
152
|
+
const { status, data } = await apiInstance.createPlaceMembershipType(
|
|
153
|
+
placeId,
|
|
154
|
+
placeMembershipTypeCreateInputs
|
|
155
|
+
);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|Name | Type | Description | Notes|
|
|
161
|
+
|------------- | ------------- | ------------- | -------------|
|
|
162
|
+
| **placeMembershipTypeCreateInputs** | **PlaceMembershipTypeCreateInputs**| | |
|
|
163
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
### Return type
|
|
167
|
+
|
|
168
|
+
**CreatePlaceMembershipType200Response**
|
|
169
|
+
|
|
170
|
+
### Authorization
|
|
171
|
+
|
|
172
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
173
|
+
|
|
174
|
+
### HTTP request headers
|
|
175
|
+
|
|
176
|
+
- **Content-Type**: application/json
|
|
177
|
+
- **Accept**: application/json
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### HTTP response details
|
|
181
|
+
| Status code | Description | Response headers |
|
|
182
|
+
|-------------|-------------|------------------|
|
|
183
|
+
|**200** | Successful response | - |
|
|
184
|
+
|
|
185
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
186
|
+
|
|
187
|
+
# **deletePlaceMembershipMember**
|
|
188
|
+
> CreateAccountInvitations200Response deletePlaceMembershipMember()
|
|
189
|
+
|
|
190
|
+
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.
|
|
191
|
+
|
|
192
|
+
### Example
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
import {
|
|
196
|
+
BookingsMembershipsApi,
|
|
197
|
+
Configuration
|
|
198
|
+
} from '@connectedxm/admin-sdk';
|
|
199
|
+
|
|
200
|
+
const configuration = new Configuration();
|
|
201
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
202
|
+
|
|
203
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
204
|
+
let placeMembershipMemberId: string; //The placeMembershipMember identifier (default to undefined)
|
|
205
|
+
|
|
206
|
+
const { status, data } = await apiInstance.deletePlaceMembershipMember(
|
|
207
|
+
placeMembershipId,
|
|
208
|
+
placeMembershipMemberId
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
217
|
+
| **placeMembershipMemberId** | [**string**] | The placeMembershipMember identifier | defaults to undefined|
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
**CreateAccountInvitations200Response**
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: application/json
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### HTTP response details
|
|
235
|
+
| Status code | Description | Response headers |
|
|
236
|
+
|-------------|-------------|------------------|
|
|
237
|
+
|**200** | Successful response | - |
|
|
238
|
+
|
|
239
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
240
|
+
|
|
241
|
+
# **deletePlaceMembershipType**
|
|
242
|
+
> CreateAccountInvitations200Response deletePlaceMembershipType()
|
|
243
|
+
|
|
244
|
+
Permanently deletes a place membership type. Refused while any memberships of that type exist; requires the update bookings permission.
|
|
245
|
+
|
|
246
|
+
### Example
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import {
|
|
250
|
+
BookingsMembershipsApi,
|
|
251
|
+
Configuration
|
|
252
|
+
} from '@connectedxm/admin-sdk';
|
|
253
|
+
|
|
254
|
+
const configuration = new Configuration();
|
|
255
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
256
|
+
|
|
257
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
258
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
259
|
+
|
|
260
|
+
const { status, data } = await apiInstance.deletePlaceMembershipType(
|
|
261
|
+
placeId,
|
|
262
|
+
placeMembershipTypeId
|
|
263
|
+
);
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Parameters
|
|
267
|
+
|
|
268
|
+
|Name | Type | Description | Notes|
|
|
269
|
+
|------------- | ------------- | ------------- | -------------|
|
|
270
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
271
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
### Return type
|
|
275
|
+
|
|
276
|
+
**CreateAccountInvitations200Response**
|
|
277
|
+
|
|
278
|
+
### Authorization
|
|
279
|
+
|
|
280
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
281
|
+
|
|
282
|
+
### HTTP request headers
|
|
283
|
+
|
|
284
|
+
- **Content-Type**: Not defined
|
|
285
|
+
- **Accept**: application/json
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
### HTTP response details
|
|
289
|
+
| Status code | Description | Response headers |
|
|
290
|
+
|-------------|-------------|------------------|
|
|
291
|
+
|**200** | Successful response | - |
|
|
292
|
+
|
|
293
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
294
|
+
|
|
295
|
+
# **getPlaceMembership**
|
|
296
|
+
> GetPlaceMembership200Response getPlaceMembership()
|
|
297
|
+
|
|
298
|
+
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\".
|
|
299
|
+
|
|
300
|
+
### Example
|
|
301
|
+
|
|
302
|
+
```typescript
|
|
303
|
+
import {
|
|
304
|
+
BookingsMembershipsApi,
|
|
305
|
+
Configuration
|
|
306
|
+
} from '@connectedxm/admin-sdk';
|
|
307
|
+
|
|
308
|
+
const configuration = new Configuration();
|
|
309
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
310
|
+
|
|
311
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
312
|
+
|
|
313
|
+
const { status, data } = await apiInstance.getPlaceMembership(
|
|
314
|
+
placeMembershipId
|
|
315
|
+
);
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
|Name | Type | Description | Notes|
|
|
321
|
+
|------------- | ------------- | ------------- | -------------|
|
|
322
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
### Return type
|
|
326
|
+
|
|
327
|
+
**GetPlaceMembership200Response**
|
|
328
|
+
|
|
329
|
+
### Authorization
|
|
330
|
+
|
|
331
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
332
|
+
|
|
333
|
+
### HTTP request headers
|
|
334
|
+
|
|
335
|
+
- **Content-Type**: Not defined
|
|
336
|
+
- **Accept**: application/json
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
### HTTP response details
|
|
340
|
+
| Status code | Description | Response headers |
|
|
341
|
+
|-------------|-------------|------------------|
|
|
342
|
+
|**200** | Successful response | - |
|
|
343
|
+
|
|
344
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
345
|
+
|
|
346
|
+
# **getPlaceMembershipBookings**
|
|
347
|
+
> GetAccountBookings200Response getPlaceMembershipBookings()
|
|
348
|
+
|
|
349
|
+
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\".
|
|
350
|
+
|
|
351
|
+
### Example
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
import {
|
|
355
|
+
BookingsMembershipsApi,
|
|
356
|
+
Configuration
|
|
357
|
+
} from '@connectedxm/admin-sdk';
|
|
358
|
+
|
|
359
|
+
const configuration = new Configuration();
|
|
360
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
361
|
+
|
|
362
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
363
|
+
let page: number; //Page number (optional) (default to 1)
|
|
364
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
365
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
366
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
367
|
+
|
|
368
|
+
const { status, data } = await apiInstance.getPlaceMembershipBookings(
|
|
369
|
+
placeMembershipId,
|
|
370
|
+
page,
|
|
371
|
+
pageSize,
|
|
372
|
+
orderBy,
|
|
373
|
+
search
|
|
374
|
+
);
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
|Name | Type | Description | Notes|
|
|
380
|
+
|------------- | ------------- | ------------- | -------------|
|
|
381
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
382
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
383
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
384
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
385
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### Return type
|
|
389
|
+
|
|
390
|
+
**GetAccountBookings200Response**
|
|
391
|
+
|
|
392
|
+
### Authorization
|
|
393
|
+
|
|
394
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
395
|
+
|
|
396
|
+
### HTTP request headers
|
|
397
|
+
|
|
398
|
+
- **Content-Type**: Not defined
|
|
399
|
+
- **Accept**: application/json
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
### HTTP response details
|
|
403
|
+
| Status code | Description | Response headers |
|
|
404
|
+
|-------------|-------------|------------------|
|
|
405
|
+
|**200** | Successful response | - |
|
|
406
|
+
|
|
407
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
408
|
+
|
|
409
|
+
# **getPlaceMembershipMembers**
|
|
410
|
+
> GetPlaceMembershipMembers200Response getPlaceMembershipMembers()
|
|
411
|
+
|
|
412
|
+
Returns a paginated list of named members on a place membership, searchable by name; requires the \"read\" permission on \"bookings\".
|
|
413
|
+
|
|
414
|
+
### Example
|
|
415
|
+
|
|
416
|
+
```typescript
|
|
417
|
+
import {
|
|
418
|
+
BookingsMembershipsApi,
|
|
419
|
+
Configuration
|
|
420
|
+
} from '@connectedxm/admin-sdk';
|
|
421
|
+
|
|
422
|
+
const configuration = new Configuration();
|
|
423
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
424
|
+
|
|
425
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
426
|
+
let page: number; //Page number (optional) (default to 1)
|
|
427
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
428
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
429
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
430
|
+
|
|
431
|
+
const { status, data } = await apiInstance.getPlaceMembershipMembers(
|
|
432
|
+
placeMembershipId,
|
|
433
|
+
page,
|
|
434
|
+
pageSize,
|
|
435
|
+
orderBy,
|
|
436
|
+
search
|
|
437
|
+
);
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
### Parameters
|
|
441
|
+
|
|
442
|
+
|Name | Type | Description | Notes|
|
|
443
|
+
|------------- | ------------- | ------------- | -------------|
|
|
444
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
445
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
446
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
447
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
448
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
**GetPlaceMembershipMembers200Response**
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: Not defined
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
### HTTP response details
|
|
466
|
+
| Status code | Description | Response headers |
|
|
467
|
+
|-------------|-------------|------------------|
|
|
468
|
+
|**200** | Successful response | - |
|
|
469
|
+
|
|
470
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
471
|
+
|
|
472
|
+
# **getPlaceMembershipType**
|
|
473
|
+
> CreatePlaceMembershipType200Response getPlaceMembershipType()
|
|
474
|
+
|
|
475
|
+
Retrieves a single place membership type by ID, including tax, payment integration, and entity fields; requires the \"read\" permission on \"bookings\".
|
|
476
|
+
|
|
477
|
+
### Example
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
import {
|
|
481
|
+
BookingsMembershipsApi,
|
|
482
|
+
Configuration
|
|
483
|
+
} from '@connectedxm/admin-sdk';
|
|
484
|
+
|
|
485
|
+
const configuration = new Configuration();
|
|
486
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
487
|
+
|
|
488
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
489
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
490
|
+
|
|
491
|
+
const { status, data } = await apiInstance.getPlaceMembershipType(
|
|
492
|
+
placeId,
|
|
493
|
+
placeMembershipTypeId
|
|
494
|
+
);
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### Parameters
|
|
498
|
+
|
|
499
|
+
|Name | Type | Description | Notes|
|
|
500
|
+
|------------- | ------------- | ------------- | -------------|
|
|
501
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
502
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
### Return type
|
|
506
|
+
|
|
507
|
+
**CreatePlaceMembershipType200Response**
|
|
508
|
+
|
|
509
|
+
### Authorization
|
|
510
|
+
|
|
511
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
512
|
+
|
|
513
|
+
### HTTP request headers
|
|
514
|
+
|
|
515
|
+
- **Content-Type**: Not defined
|
|
516
|
+
- **Accept**: application/json
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
### HTTP response details
|
|
520
|
+
| Status code | Description | Response headers |
|
|
521
|
+
|-------------|-------------|------------------|
|
|
522
|
+
|**200** | Successful response | - |
|
|
523
|
+
|
|
524
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
525
|
+
|
|
526
|
+
# **getPlaceMembershipTypes**
|
|
527
|
+
> GetPlaceMembershipTypes200Response getPlaceMembershipTypes()
|
|
528
|
+
|
|
529
|
+
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\".
|
|
530
|
+
|
|
531
|
+
### Example
|
|
532
|
+
|
|
533
|
+
```typescript
|
|
534
|
+
import {
|
|
535
|
+
BookingsMembershipsApi,
|
|
536
|
+
Configuration
|
|
537
|
+
} from '@connectedxm/admin-sdk';
|
|
538
|
+
|
|
539
|
+
const configuration = new Configuration();
|
|
540
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
541
|
+
|
|
542
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
543
|
+
let archived: boolean; //Filter by archived (optional) (default to undefined)
|
|
544
|
+
let page: number; //Page number (optional) (default to 1)
|
|
545
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
546
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
547
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
548
|
+
|
|
549
|
+
const { status, data } = await apiInstance.getPlaceMembershipTypes(
|
|
550
|
+
placeId,
|
|
551
|
+
archived,
|
|
552
|
+
page,
|
|
553
|
+
pageSize,
|
|
554
|
+
orderBy,
|
|
555
|
+
search
|
|
556
|
+
);
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### Parameters
|
|
560
|
+
|
|
561
|
+
|Name | Type | Description | Notes|
|
|
562
|
+
|------------- | ------------- | ------------- | -------------|
|
|
563
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
564
|
+
| **archived** | [**boolean**] | Filter by archived | (optional) defaults to undefined|
|
|
565
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
566
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
567
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
568
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
### Return type
|
|
572
|
+
|
|
573
|
+
**GetPlaceMembershipTypes200Response**
|
|
574
|
+
|
|
575
|
+
### Authorization
|
|
576
|
+
|
|
577
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
578
|
+
|
|
579
|
+
### HTTP request headers
|
|
580
|
+
|
|
581
|
+
- **Content-Type**: Not defined
|
|
582
|
+
- **Accept**: application/json
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
### HTTP response details
|
|
586
|
+
| Status code | Description | Response headers |
|
|
587
|
+
|-------------|-------------|------------------|
|
|
588
|
+
|**200** | Successful response | - |
|
|
589
|
+
|
|
590
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
591
|
+
|
|
592
|
+
# **getPlaceMemberships**
|
|
593
|
+
> GetPlaceMemberships200Response getPlaceMemberships()
|
|
594
|
+
|
|
595
|
+
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\".
|
|
596
|
+
|
|
597
|
+
### Example
|
|
598
|
+
|
|
599
|
+
```typescript
|
|
600
|
+
import {
|
|
601
|
+
BookingsMembershipsApi,
|
|
602
|
+
Configuration
|
|
603
|
+
} from '@connectedxm/admin-sdk';
|
|
604
|
+
|
|
605
|
+
const configuration = new Configuration();
|
|
606
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
607
|
+
|
|
608
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
609
|
+
let placeMembershipTypeId: string; //Filter by placeMembershipTypeId (optional) (default to undefined)
|
|
610
|
+
let status: PurchaseStatus; //Filter by status (optional) (default to undefined)
|
|
611
|
+
let active: boolean; //Filter by active (optional) (default to undefined)
|
|
612
|
+
let upcoming: boolean; //Filter by upcoming (optional) (default to undefined)
|
|
613
|
+
let expired: boolean; //Filter by expired (optional) (default to undefined)
|
|
614
|
+
let page: number; //Page number (optional) (default to 1)
|
|
615
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
616
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
617
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
618
|
+
|
|
619
|
+
const { status, data } = await apiInstance.getPlaceMemberships(
|
|
620
|
+
placeId,
|
|
621
|
+
placeMembershipTypeId,
|
|
622
|
+
status,
|
|
623
|
+
active,
|
|
624
|
+
upcoming,
|
|
625
|
+
expired,
|
|
626
|
+
page,
|
|
627
|
+
pageSize,
|
|
628
|
+
orderBy,
|
|
629
|
+
search
|
|
630
|
+
);
|
|
631
|
+
```
|
|
632
|
+
|
|
633
|
+
### Parameters
|
|
634
|
+
|
|
635
|
+
|Name | Type | Description | Notes|
|
|
636
|
+
|------------- | ------------- | ------------- | -------------|
|
|
637
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
638
|
+
| **placeMembershipTypeId** | [**string**] | Filter by placeMembershipTypeId | (optional) defaults to undefined|
|
|
639
|
+
| **status** | **PurchaseStatus** | Filter by status | (optional) defaults to undefined|
|
|
640
|
+
| **active** | [**boolean**] | Filter by active | (optional) defaults to undefined|
|
|
641
|
+
| **upcoming** | [**boolean**] | Filter by upcoming | (optional) defaults to undefined|
|
|
642
|
+
| **expired** | [**boolean**] | Filter by expired | (optional) defaults to undefined|
|
|
643
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
644
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
645
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
646
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
### Return type
|
|
650
|
+
|
|
651
|
+
**GetPlaceMemberships200Response**
|
|
652
|
+
|
|
653
|
+
### Authorization
|
|
654
|
+
|
|
655
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
656
|
+
|
|
657
|
+
### HTTP request headers
|
|
658
|
+
|
|
659
|
+
- **Content-Type**: Not defined
|
|
660
|
+
- **Accept**: application/json
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
### HTTP response details
|
|
664
|
+
| Status code | Description | Response headers |
|
|
665
|
+
|-------------|-------------|------------------|
|
|
666
|
+
|**200** | Successful response | - |
|
|
667
|
+
|
|
668
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
669
|
+
|
|
670
|
+
# **updatePlaceMembership**
|
|
671
|
+
> GetPlaceMembership200Response updatePlaceMembership(placeMembershipUpdateInputs)
|
|
672
|
+
|
|
673
|
+
Updates a place membership\'s status (ready or canceled), start date, or expiry date; requires the update bookings permission.
|
|
674
|
+
|
|
675
|
+
### Example
|
|
676
|
+
|
|
677
|
+
```typescript
|
|
678
|
+
import {
|
|
679
|
+
BookingsMembershipsApi,
|
|
680
|
+
Configuration,
|
|
681
|
+
PlaceMembershipUpdateInputs
|
|
682
|
+
} from '@connectedxm/admin-sdk';
|
|
683
|
+
|
|
684
|
+
const configuration = new Configuration();
|
|
685
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
686
|
+
|
|
687
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
688
|
+
let placeMembershipUpdateInputs: PlaceMembershipUpdateInputs; //
|
|
689
|
+
|
|
690
|
+
const { status, data } = await apiInstance.updatePlaceMembership(
|
|
691
|
+
placeMembershipId,
|
|
692
|
+
placeMembershipUpdateInputs
|
|
693
|
+
);
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
### Parameters
|
|
697
|
+
|
|
698
|
+
|Name | Type | Description | Notes|
|
|
699
|
+
|------------- | ------------- | ------------- | -------------|
|
|
700
|
+
| **placeMembershipUpdateInputs** | **PlaceMembershipUpdateInputs**| | |
|
|
701
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
### Return type
|
|
705
|
+
|
|
706
|
+
**GetPlaceMembership200Response**
|
|
707
|
+
|
|
708
|
+
### Authorization
|
|
709
|
+
|
|
710
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
711
|
+
|
|
712
|
+
### HTTP request headers
|
|
713
|
+
|
|
714
|
+
- **Content-Type**: application/json
|
|
715
|
+
- **Accept**: application/json
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
### HTTP response details
|
|
719
|
+
| Status code | Description | Response headers |
|
|
720
|
+
|-------------|-------------|------------------|
|
|
721
|
+
|**200** | Successful response | - |
|
|
722
|
+
|
|
723
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
724
|
+
|
|
725
|
+
# **updatePlaceMembershipMember**
|
|
726
|
+
> CreatePlaceMembershipMember200Response updatePlaceMembershipMember(placeMembershipMemberUpdateInputs)
|
|
727
|
+
|
|
728
|
+
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.
|
|
729
|
+
|
|
730
|
+
### Example
|
|
731
|
+
|
|
732
|
+
```typescript
|
|
733
|
+
import {
|
|
734
|
+
BookingsMembershipsApi,
|
|
735
|
+
Configuration,
|
|
736
|
+
PlaceMembershipMemberUpdateInputs
|
|
737
|
+
} from '@connectedxm/admin-sdk';
|
|
738
|
+
|
|
739
|
+
const configuration = new Configuration();
|
|
740
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
741
|
+
|
|
742
|
+
let placeMembershipId: string; //The placeMembership identifier (default to undefined)
|
|
743
|
+
let placeMembershipMemberId: string; //The placeMembershipMember identifier (default to undefined)
|
|
744
|
+
let placeMembershipMemberUpdateInputs: PlaceMembershipMemberUpdateInputs; //
|
|
745
|
+
|
|
746
|
+
const { status, data } = await apiInstance.updatePlaceMembershipMember(
|
|
747
|
+
placeMembershipId,
|
|
748
|
+
placeMembershipMemberId,
|
|
749
|
+
placeMembershipMemberUpdateInputs
|
|
750
|
+
);
|
|
751
|
+
```
|
|
752
|
+
|
|
753
|
+
### Parameters
|
|
754
|
+
|
|
755
|
+
|Name | Type | Description | Notes|
|
|
756
|
+
|------------- | ------------- | ------------- | -------------|
|
|
757
|
+
| **placeMembershipMemberUpdateInputs** | **PlaceMembershipMemberUpdateInputs**| | |
|
|
758
|
+
| **placeMembershipId** | [**string**] | The placeMembership identifier | defaults to undefined|
|
|
759
|
+
| **placeMembershipMemberId** | [**string**] | The placeMembershipMember identifier | defaults to undefined|
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
### Return type
|
|
763
|
+
|
|
764
|
+
**CreatePlaceMembershipMember200Response**
|
|
765
|
+
|
|
766
|
+
### Authorization
|
|
767
|
+
|
|
768
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
769
|
+
|
|
770
|
+
### HTTP request headers
|
|
771
|
+
|
|
772
|
+
- **Content-Type**: application/json
|
|
773
|
+
- **Accept**: application/json
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
### HTTP response details
|
|
777
|
+
| Status code | Description | Response headers |
|
|
778
|
+
|-------------|-------------|------------------|
|
|
779
|
+
|**200** | Successful response | - |
|
|
780
|
+
|
|
781
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
782
|
+
|
|
783
|
+
# **updatePlaceMembershipType**
|
|
784
|
+
> CreatePlaceMembershipType200Response updatePlaceMembershipType(placeMembershipTypeUpdateInputs)
|
|
785
|
+
|
|
786
|
+
Updates an existing place membership type by ID, including price, term, visibility, and tax fields; requires the update bookings permission.
|
|
787
|
+
|
|
788
|
+
### Example
|
|
789
|
+
|
|
790
|
+
```typescript
|
|
791
|
+
import {
|
|
792
|
+
BookingsMembershipsApi,
|
|
793
|
+
Configuration,
|
|
794
|
+
PlaceMembershipTypeUpdateInputs
|
|
795
|
+
} from '@connectedxm/admin-sdk';
|
|
796
|
+
|
|
797
|
+
const configuration = new Configuration();
|
|
798
|
+
const apiInstance = new BookingsMembershipsApi(configuration);
|
|
799
|
+
|
|
800
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
801
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
802
|
+
let placeMembershipTypeUpdateInputs: PlaceMembershipTypeUpdateInputs; //
|
|
803
|
+
|
|
804
|
+
const { status, data } = await apiInstance.updatePlaceMembershipType(
|
|
805
|
+
placeId,
|
|
806
|
+
placeMembershipTypeId,
|
|
807
|
+
placeMembershipTypeUpdateInputs
|
|
808
|
+
);
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
### Parameters
|
|
812
|
+
|
|
813
|
+
|Name | Type | Description | Notes|
|
|
814
|
+
|------------- | ------------- | ------------- | -------------|
|
|
815
|
+
| **placeMembershipTypeUpdateInputs** | **PlaceMembershipTypeUpdateInputs**| | |
|
|
816
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
817
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
### Return type
|
|
821
|
+
|
|
822
|
+
**CreatePlaceMembershipType200Response**
|
|
823
|
+
|
|
824
|
+
### Authorization
|
|
825
|
+
|
|
826
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
827
|
+
|
|
828
|
+
### HTTP request headers
|
|
829
|
+
|
|
830
|
+
- **Content-Type**: application/json
|
|
831
|
+
- **Accept**: application/json
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
### HTTP response details
|
|
835
|
+
| Status code | Description | Response headers |
|
|
836
|
+
|-------------|-------------|------------------|
|
|
837
|
+
|**200** | Successful response | - |
|
|
838
|
+
|
|
839
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
840
|
+
|