@connectedxm/admin-sdk 13.3.0 → 13.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +26 -0
- package/AdminApi.ts +6 -0
- package/README.md +2 -2
- package/api.ts +2308 -4
- 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 +1265 -4
- package/dist/api.js +1628 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +3 -1
- package/dist/esm/AdminApi.js +3 -1
- package/dist/esm/api.d.ts +1265 -4
- package/dist/esm/api.js +1592 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseBooking.md +4 -0
- package/docs/BaseBookingPlaceMembership.md +24 -0
- package/docs/BaseBookingSpace.md +2 -0
- package/docs/BasePayment.md +2 -2
- package/docs/BasePaymentIntent.md +4 -0
- package/docs/BasePaymentIntentLineItem.md +2 -0
- package/docs/BasePaymentLineItem.md +2 -0
- package/docs/BasePlaceMembership.md +32 -0
- package/docs/BasePlaceMembershipType.md +40 -0
- package/docs/Booking.md +4 -0
- package/docs/BookingSpace.md +2 -0
- package/docs/BookingSpaceCreateInputs.md +2 -0
- package/docs/BookingSpaceUpdateInputs.md +2 -0
- package/docs/BookingsMembershipsApi.md +840 -0
- package/docs/BookingsMembershipsTranslationsApi.md +252 -0
- package/docs/CreatePlaceMembershipMember200Response.md +24 -0
- package/docs/CreatePlaceMembershipType200Response.md +24 -0
- package/docs/GetPlaceMembership200Response.md +24 -0
- package/docs/GetPlaceMembershipMembers200Response.md +26 -0
- package/docs/GetPlaceMembershipTypeTranslation200Response.md +24 -0
- package/docs/GetPlaceMembershipTypeTranslations200Response.md +26 -0
- package/docs/GetPlaceMembershipTypes200Response.md +26 -0
- package/docs/GetPlaceMemberships200Response.md +26 -0
- package/docs/Payment.md +4 -2
- package/docs/PaymentIntent.md +6 -0
- package/docs/PaymentIntentSource.md +2 -0
- package/docs/PaymentLineItem.md +4 -0
- package/docs/PaymentLineItemType.md +2 -0
- package/docs/PlaceMembership.md +38 -0
- package/docs/PlaceMembershipAllOfCount.md +20 -0
- package/docs/PlaceMembershipCreateInputs.md +26 -0
- package/docs/PlaceMembershipMember.md +28 -0
- package/docs/PlaceMembershipMemberCreateInputs.md +22 -0
- package/docs/PlaceMembershipMemberUpdateInputs.md +22 -0
- package/docs/PlaceMembershipType.md +60 -0
- package/docs/PlaceMembershipTypeCreateInputs.md +44 -0
- package/docs/PlaceMembershipTypeTranslation.md +30 -0
- package/docs/PlaceMembershipTypeTranslationUpdateInputs.md +22 -0
- package/docs/PlaceMembershipTypeUpdateInputs.md +46 -0
- package/docs/PlaceMembershipUpdateInputs.md +24 -0
- package/docs/UpdatePlaceMembershipTypeTranslation200Response.md +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
# BookingsMembershipsTranslationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deletePlaceMembershipTypeTranslation**](#deleteplacemembershiptypetranslation) | **DELETE** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Delete a place membership type translation|
|
|
8
|
+
|[**getPlaceMembershipTypeTranslation**](#getplacemembershiptypetranslation) | **GET** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Get a place membership type\'s translation|
|
|
9
|
+
|[**getPlaceMembershipTypeTranslations**](#getplacemembershiptypetranslations) | **GET** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations | List a place membership type\'s translations|
|
|
10
|
+
|[**updatePlaceMembershipTypeTranslation**](#updateplacemembershiptypetranslation) | **PUT** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Update a place membership type\'s translation|
|
|
11
|
+
|
|
12
|
+
# **deletePlaceMembershipTypeTranslation**
|
|
13
|
+
> CreateAccountInvitations200Response deletePlaceMembershipTypeTranslation()
|
|
14
|
+
|
|
15
|
+
Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
BookingsMembershipsTranslationsApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@connectedxm/admin-sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
|
|
27
|
+
|
|
28
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
29
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
30
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.deletePlaceMembershipTypeTranslation(
|
|
33
|
+
placeId,
|
|
34
|
+
placeMembershipTypeId,
|
|
35
|
+
locale
|
|
36
|
+
);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
|Name | Type | Description | Notes|
|
|
42
|
+
|------------- | ------------- | ------------- | -------------|
|
|
43
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
44
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
45
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**CreateAccountInvitations200Response**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: Not defined
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Successful response | - |
|
|
66
|
+
|
|
67
|
+
[[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)
|
|
68
|
+
|
|
69
|
+
# **getPlaceMembershipTypeTranslation**
|
|
70
|
+
> GetPlaceMembershipTypeTranslation200Response getPlaceMembershipTypeTranslation()
|
|
71
|
+
|
|
72
|
+
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\".
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
BookingsMembershipsTranslationsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@connectedxm/admin-sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
86
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
87
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.getPlaceMembershipTypeTranslation(
|
|
90
|
+
placeId,
|
|
91
|
+
placeMembershipTypeId,
|
|
92
|
+
locale
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
101
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
102
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
### Return type
|
|
106
|
+
|
|
107
|
+
**GetPlaceMembershipTypeTranslation200Response**
|
|
108
|
+
|
|
109
|
+
### Authorization
|
|
110
|
+
|
|
111
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
112
|
+
|
|
113
|
+
### HTTP request headers
|
|
114
|
+
|
|
115
|
+
- **Content-Type**: Not defined
|
|
116
|
+
- **Accept**: application/json
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
### HTTP response details
|
|
120
|
+
| Status code | Description | Response headers |
|
|
121
|
+
|-------------|-------------|------------------|
|
|
122
|
+
|**200** | Successful response | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
126
|
+
# **getPlaceMembershipTypeTranslations**
|
|
127
|
+
> GetPlaceMembershipTypeTranslations200Response getPlaceMembershipTypeTranslations()
|
|
128
|
+
|
|
129
|
+
Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
BookingsMembershipsTranslationsApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@connectedxm/admin-sdk';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
|
|
141
|
+
|
|
142
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
143
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
144
|
+
let page: number; //Page number (optional) (default to 1)
|
|
145
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
146
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
147
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
148
|
+
|
|
149
|
+
const { status, data } = await apiInstance.getPlaceMembershipTypeTranslations(
|
|
150
|
+
placeId,
|
|
151
|
+
placeMembershipTypeId,
|
|
152
|
+
page,
|
|
153
|
+
pageSize,
|
|
154
|
+
orderBy,
|
|
155
|
+
search
|
|
156
|
+
);
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Parameters
|
|
160
|
+
|
|
161
|
+
|Name | Type | Description | Notes|
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
164
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
165
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
166
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
167
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
168
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Return type
|
|
172
|
+
|
|
173
|
+
**GetPlaceMembershipTypeTranslations200Response**
|
|
174
|
+
|
|
175
|
+
### Authorization
|
|
176
|
+
|
|
177
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
178
|
+
|
|
179
|
+
### HTTP request headers
|
|
180
|
+
|
|
181
|
+
- **Content-Type**: Not defined
|
|
182
|
+
- **Accept**: application/json
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### HTTP response details
|
|
186
|
+
| Status code | Description | Response headers |
|
|
187
|
+
|-------------|-------------|------------------|
|
|
188
|
+
|**200** | Successful response | - |
|
|
189
|
+
|
|
190
|
+
[[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)
|
|
191
|
+
|
|
192
|
+
# **updatePlaceMembershipTypeTranslation**
|
|
193
|
+
> UpdatePlaceMembershipTypeTranslation200Response updatePlaceMembershipTypeTranslation(placeMembershipTypeTranslationUpdateInputs)
|
|
194
|
+
|
|
195
|
+
Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
|
|
196
|
+
|
|
197
|
+
### Example
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import {
|
|
201
|
+
BookingsMembershipsTranslationsApi,
|
|
202
|
+
Configuration,
|
|
203
|
+
PlaceMembershipTypeTranslationUpdateInputs
|
|
204
|
+
} from '@connectedxm/admin-sdk';
|
|
205
|
+
|
|
206
|
+
const configuration = new Configuration();
|
|
207
|
+
const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
|
|
208
|
+
|
|
209
|
+
let placeId: string; //The place identifier (default to undefined)
|
|
210
|
+
let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
|
|
211
|
+
let locale: string; //The locale identifier (default to undefined)
|
|
212
|
+
let placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.updatePlaceMembershipTypeTranslation(
|
|
215
|
+
placeId,
|
|
216
|
+
placeMembershipTypeId,
|
|
217
|
+
locale,
|
|
218
|
+
placeMembershipTypeTranslationUpdateInputs
|
|
219
|
+
);
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Parameters
|
|
223
|
+
|
|
224
|
+
|Name | Type | Description | Notes|
|
|
225
|
+
|------------- | ------------- | ------------- | -------------|
|
|
226
|
+
| **placeMembershipTypeTranslationUpdateInputs** | **PlaceMembershipTypeTranslationUpdateInputs**| | |
|
|
227
|
+
| **placeId** | [**string**] | The place identifier | defaults to undefined|
|
|
228
|
+
| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
|
|
229
|
+
| **locale** | [**string**] | The locale identifier | defaults to undefined|
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### Return type
|
|
233
|
+
|
|
234
|
+
**UpdatePlaceMembershipTypeTranslation200Response**
|
|
235
|
+
|
|
236
|
+
### Authorization
|
|
237
|
+
|
|
238
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
239
|
+
|
|
240
|
+
### HTTP request headers
|
|
241
|
+
|
|
242
|
+
- **Content-Type**: application/json
|
|
243
|
+
- **Accept**: application/json
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### HTTP response details
|
|
247
|
+
| Status code | Description | Response headers |
|
|
248
|
+
|-------------|-------------|------------------|
|
|
249
|
+
|**200** | Successful response | - |
|
|
250
|
+
|
|
251
|
+
[[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)
|
|
252
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreatePlaceMembershipMember200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PlaceMembershipMember**](PlaceMembershipMember.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreatePlaceMembershipMember200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreatePlaceMembershipMember200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreatePlaceMembershipType200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PlaceMembershipType**](PlaceMembershipType.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreatePlaceMembershipType200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreatePlaceMembershipType200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetPlaceMembership200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PlaceMembership**](PlaceMembership.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetPlaceMembership200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetPlaceMembership200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetPlaceMembershipMembers200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<PlaceMembershipMember>**](PlaceMembershipMember.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetPlaceMembershipMembers200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetPlaceMembershipMembers200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetPlaceMembershipTypeTranslation200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**PlaceMembershipTypeTranslation**](PlaceMembershipTypeTranslation.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetPlaceMembershipTypeTranslation200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetPlaceMembershipTypeTranslation200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetPlaceMembershipTypeTranslations200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<PlaceMembershipTypeTranslation>**](PlaceMembershipTypeTranslation.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetPlaceMembershipTypeTranslations200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetPlaceMembershipTypeTranslations200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetPlaceMembershipTypes200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<PlaceMembershipType>**](PlaceMembershipType.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetPlaceMembershipTypes200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetPlaceMembershipTypes200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetPlaceMemberships200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<PlaceMembership>**](PlaceMembership.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetPlaceMemberships200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetPlaceMemberships200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Payment.md
CHANGED
|
@@ -29,10 +29,10 @@ Name | Type | Description | Notes
|
|
|
29
29
|
**passId** | **string** | | [default to undefined]
|
|
30
30
|
**sessionId** | **string** | | [default to undefined]
|
|
31
31
|
**spaceId** | **string** | | [default to undefined]
|
|
32
|
-
**membershipId** | **string** | | [default to undefined]
|
|
33
32
|
**couponId** | **string** | | [default to undefined]
|
|
34
33
|
**invoiceId** | **string** | | [default to undefined]
|
|
35
34
|
**seriesId** | **string** | | [default to undefined]
|
|
35
|
+
**placeMembershipTypeId** | **string** | | [default to undefined]
|
|
36
36
|
**taxIntegrationCompanyCode** | **string** | | [default to undefined]
|
|
37
37
|
**taxIntegrationCustomerId** | **string** | | [default to undefined]
|
|
38
38
|
**taxIntegrationEntityUseCode** | **string** | | [default to undefined]
|
|
@@ -64,6 +64,7 @@ Name | Type | Description | Notes
|
|
|
64
64
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
65
65
|
**invoice** | [**BaseInvoice**](BaseInvoice.md) | | [default to undefined]
|
|
66
66
|
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
67
|
+
**placeMembershipType** | [**BasePlaceMembershipType**](BasePlaceMembershipType.md) | | [default to undefined]
|
|
67
68
|
**exchangeTarget** | [**BaseEventPassTypeExchangeTarget**](BaseEventPassTypeExchangeTarget.md) | | [default to undefined]
|
|
68
69
|
**metadata** | **object** | | [optional] [default to undefined]
|
|
69
70
|
|
|
@@ -97,10 +98,10 @@ const instance: Payment = {
|
|
|
97
98
|
passId,
|
|
98
99
|
sessionId,
|
|
99
100
|
spaceId,
|
|
100
|
-
membershipId,
|
|
101
101
|
couponId,
|
|
102
102
|
invoiceId,
|
|
103
103
|
seriesId,
|
|
104
|
+
placeMembershipTypeId,
|
|
104
105
|
taxIntegrationCompanyCode,
|
|
105
106
|
taxIntegrationCustomerId,
|
|
106
107
|
taxIntegrationEntityUseCode,
|
|
@@ -132,6 +133,7 @@ const instance: Payment = {
|
|
|
132
133
|
coupon,
|
|
133
134
|
invoice,
|
|
134
135
|
series,
|
|
136
|
+
placeMembershipType,
|
|
135
137
|
exchangeTarget,
|
|
136
138
|
metadata,
|
|
137
139
|
};
|
package/docs/PaymentIntent.md
CHANGED
|
@@ -22,6 +22,8 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**couponId** | **string** | | [default to undefined]
|
|
23
23
|
**invoiceId** | **string** | | [default to undefined]
|
|
24
24
|
**seriesId** | **string** | | [default to undefined]
|
|
25
|
+
**placeMembershipTypeId** | **string** | | [default to undefined]
|
|
26
|
+
**placeMembershipId** | **string** | | [default to undefined]
|
|
25
27
|
**address1** | **string** | | [default to undefined]
|
|
26
28
|
**address2** | **string** | | [default to undefined]
|
|
27
29
|
**city** | **string** | | [default to undefined]
|
|
@@ -55,6 +57,7 @@ Name | Type | Description | Notes
|
|
|
55
57
|
**space** | [**BaseBookingSpace**](BaseBookingSpace.md) | | [default to undefined]
|
|
56
58
|
**invoice** | [**BaseInvoice**](BaseInvoice.md) | | [default to undefined]
|
|
57
59
|
**series** | [**BaseSeries**](BaseSeries.md) | | [default to undefined]
|
|
60
|
+
**placeMembershipType** | [**BasePlaceMembershipType**](BasePlaceMembershipType.md) | | [default to undefined]
|
|
58
61
|
|
|
59
62
|
## Example
|
|
60
63
|
|
|
@@ -79,6 +82,8 @@ const instance: PaymentIntent = {
|
|
|
79
82
|
couponId,
|
|
80
83
|
invoiceId,
|
|
81
84
|
seriesId,
|
|
85
|
+
placeMembershipTypeId,
|
|
86
|
+
placeMembershipId,
|
|
82
87
|
address1,
|
|
83
88
|
address2,
|
|
84
89
|
city,
|
|
@@ -112,6 +117,7 @@ const instance: PaymentIntent = {
|
|
|
112
117
|
space,
|
|
113
118
|
invoice,
|
|
114
119
|
series,
|
|
120
|
+
placeMembershipType,
|
|
115
121
|
};
|
|
116
122
|
```
|
|
117
123
|
|
package/docs/PaymentLineItem.md
CHANGED
|
@@ -28,12 +28,14 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**reservationId** | **string** | | [default to undefined]
|
|
29
29
|
**accessId** | **string** | | [default to undefined]
|
|
30
30
|
**bookingId** | **string** | | [default to undefined]
|
|
31
|
+
**placeMembershipId** | **string** | | [default to undefined]
|
|
31
32
|
**pass** | [**BaseEventPass**](BaseEventPass.md) | | [default to undefined]
|
|
32
33
|
**_package** | [**BaseEventPackage**](BaseEventPackage.md) | | [default to undefined]
|
|
33
34
|
**passAddOn** | [**BasePassAddOn**](BasePassAddOn.md) | | [default to undefined]
|
|
34
35
|
**reservation** | [**BaseEventRoomTypeReservation**](BaseEventRoomTypeReservation.md) | | [default to undefined]
|
|
35
36
|
**access** | [**BaseEventSessionAccess**](BaseEventSessionAccess.md) | | [default to undefined]
|
|
36
37
|
**booking** | [**BaseBooking**](BaseBooking.md) | | [default to undefined]
|
|
38
|
+
**placeMembership** | [**BasePlaceMembership**](BasePlaceMembership.md) | | [default to undefined]
|
|
37
39
|
**coupon** | [**BaseCoupon**](BaseCoupon.md) | | [default to undefined]
|
|
38
40
|
**seriesRegistration** | [**BaseSeriesRegistration**](BaseSeriesRegistration.md) | | [default to undefined]
|
|
39
41
|
**payment** | [**BasePayment**](BasePayment.md) | | [default to undefined]
|
|
@@ -67,12 +69,14 @@ const instance: PaymentLineItem = {
|
|
|
67
69
|
reservationId,
|
|
68
70
|
accessId,
|
|
69
71
|
bookingId,
|
|
72
|
+
placeMembershipId,
|
|
70
73
|
pass,
|
|
71
74
|
_package,
|
|
72
75
|
passAddOn,
|
|
73
76
|
reservation,
|
|
74
77
|
access,
|
|
75
78
|
booking,
|
|
79
|
+
placeMembership,
|
|
76
80
|
coupon,
|
|
77
81
|
seriesRegistration,
|
|
78
82
|
payment,
|
|
@@ -23,6 +23,8 @@
|
|
|
23
23
|
|
|
24
24
|
* `Series` (value: `'series'`)
|
|
25
25
|
|
|
26
|
+
* `PlaceMembership` (value: `'placeMembership'`)
|
|
27
|
+
|
|
26
28
|
* `Refund` (value: `'refund'`)
|
|
27
29
|
|
|
28
30
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# PlaceMembership
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**status** | [**PurchaseStatus**](PurchaseStatus.md) | | [default to undefined]
|
|
10
|
+
**startsAt** | **string** | | [default to undefined]
|
|
11
|
+
**expiresAt** | **string** | | [default to undefined]
|
|
12
|
+
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
13
|
+
**placeMembershipType** | [**BasePlaceMembershipType**](BasePlaceMembershipType.md) | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) | | [default to undefined]
|
|
16
|
+
**members** | [**Array<PlaceMembershipMember>**](PlaceMembershipMember.md) | | [default to undefined]
|
|
17
|
+
**_count** | [**PlaceMembershipAllOfCount**](PlaceMembershipAllOfCount.md) | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { PlaceMembership } from '@connectedxm/admin-sdk';
|
|
23
|
+
|
|
24
|
+
const instance: PlaceMembership = {
|
|
25
|
+
id,
|
|
26
|
+
status,
|
|
27
|
+
startsAt,
|
|
28
|
+
expiresAt,
|
|
29
|
+
account,
|
|
30
|
+
placeMembershipType,
|
|
31
|
+
createdAt,
|
|
32
|
+
lineItem,
|
|
33
|
+
members,
|
|
34
|
+
_count,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PlaceMembershipAllOfCount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**bookings** | **number** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PlaceMembershipAllOfCount } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PlaceMembershipAllOfCount = {
|
|
16
|
+
bookings,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PlaceMembershipCreateInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
|
+
**placeMembershipTypeId** | **string** | | [default to undefined]
|
|
10
|
+
**startsAt** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**expiresAt** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PlaceMembershipCreateInputs } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PlaceMembershipCreateInputs = {
|
|
19
|
+
accountId,
|
|
20
|
+
placeMembershipTypeId,
|
|
21
|
+
startsAt,
|
|
22
|
+
expiresAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|