@connectedxm/admin-sdk 13.3.0 → 13.5.0

package/docs/PlaceMembership.md

@@ -0,0 +1,38 @@
+# PlaceMembership
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**status** | [**PurchaseStatus**](PurchaseStatus.md) |  | [default to undefined]
+**startsAt** | **string** |  | [default to undefined]
+**expiresAt** | **string** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**placeMembershipType** | [**BasePlaceMembershipType**](BasePlaceMembershipType.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**lineItem** | [**PaymentLineItem**](PaymentLineItem.md) |  | [default to undefined]
+**members** | [**Array<PlaceMembershipMember>**](PlaceMembershipMember.md) |  | [default to undefined]
+**_count** | [**PlaceMembershipAllOfCount**](PlaceMembershipAllOfCount.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembership } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembership = {
+    id,
+    status,
+    startsAt,
+    expiresAt,
+    account,
+    placeMembershipType,
+    createdAt,
+    lineItem,
+    members,
+    _count,
+};
+```
+
+[[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/PlaceMembershipAllOfCount.md

@@ -0,0 +1,20 @@
+# PlaceMembershipAllOfCount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bookings** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipAllOfCount } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipAllOfCount = {
+    bookings,
+};
+```
+
+[[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/PlaceMembershipCreateInputs.md

@@ -0,0 +1,26 @@
+# PlaceMembershipCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [default to undefined]
+**placeMembershipTypeId** | **string** |  | [default to undefined]
+**startsAt** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipCreateInputs = {
+    accountId,
+    placeMembershipTypeId,
+    startsAt,
+    expiresAt,
+};
+```
+
+[[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/PlaceMembershipMember.md

@@ -0,0 +1,28 @@
+# PlaceMembershipMember
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipMember } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipMember = {
+    id,
+    name,
+    image,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/PlaceMembershipMemberCreateInputs.md

@@ -0,0 +1,22 @@
+# PlaceMembershipMemberCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipMemberCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipMemberCreateInputs = {
+    name,
+    imageId,
+};
+```
+
+[[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/PlaceMembershipMemberUpdateInputs.md

@@ -0,0 +1,22 @@
+# PlaceMembershipMemberUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipMemberUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipMemberUpdateInputs = {
+    name,
+    imageId,
+};
+```
+
+[[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/PlaceMembershipType.md

@@ -0,0 +1,60 @@
+# PlaceMembershipType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**slug** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+**price** | **number** |  | [default to undefined]
+**termDays** | **number** |  | [default to undefined]
+**maxMembers** | **number** |  | [default to undefined]
+**sortOrder** | **number** |  | [default to undefined]
+**visible** | **boolean** |  | [default to undefined]
+**archived** | **boolean** |  | [default to undefined]
+**taxCode** | **string** |  | [default to undefined]
+**taxIncluded** | **boolean** |  | [default to undefined]
+**taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [default to undefined]
+**paymentIntegrationId** | **string** |  | [default to undefined]
+**paymentIntegration** | [**BasePaymentIntegration**](BasePaymentIntegration.md) |  | [default to undefined]
+**entityId** | **string** |  | [default to undefined]
+**entity** | [**BaseOrganizationEntity**](BaseOrganizationEntity.md) |  | [default to undefined]
+**placeId** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipType } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipType = {
+    id,
+    slug,
+    name,
+    description,
+    image,
+    price,
+    termDays,
+    maxMembers,
+    sortOrder,
+    visible,
+    archived,
+    taxCode,
+    taxIncluded,
+    taxLocation,
+    paymentIntegrationId,
+    paymentIntegration,
+    entityId,
+    entity,
+    placeId,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/PlaceMembershipTypeCreateInputs.md

@@ -0,0 +1,44 @@
+# PlaceMembershipTypeCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**termDays** | **number** |  | [default to undefined]
+**maxMembers** | **number** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**visible** | **boolean** |  | [optional] [default to undefined]
+**taxCode** | **string** |  | [optional] [default to undefined]
+**taxIncluded** | **boolean** |  | [optional] [default to undefined]
+**taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [optional] [default to undefined]
+**paymentIntegrationId** | **string** |  | [optional] [default to undefined]
+**entityId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipTypeCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipTypeCreateInputs = {
+    name,
+    description,
+    imageId,
+    price,
+    termDays,
+    maxMembers,
+    sortOrder,
+    visible,
+    taxCode,
+    taxIncluded,
+    taxLocation,
+    paymentIntegrationId,
+    entityId,
+};
+```
+
+[[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/PlaceMembershipTypeTranslation.md

@@ -0,0 +1,30 @@
+# PlaceMembershipTypeTranslation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**locale** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipTypeTranslation } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipTypeTranslation = {
+    id,
+    locale,
+    name,
+    description,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/PlaceMembershipTypeTranslationUpdateInputs.md

@@ -0,0 +1,22 @@
+# PlaceMembershipTypeTranslationUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipTypeTranslationUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipTypeTranslationUpdateInputs = {
+    name,
+    description,
+};
+```
+
+[[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/PlaceMembershipTypeUpdateInputs.md

@@ -0,0 +1,46 @@
+# PlaceMembershipTypeUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**price** | **number** |  | [optional] [default to undefined]
+**termDays** | **number** |  | [optional] [default to undefined]
+**maxMembers** | **number** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**visible** | **boolean** |  | [optional] [default to undefined]
+**archived** | **boolean** |  | [optional] [default to undefined]
+**taxCode** | **string** |  | [optional] [default to undefined]
+**taxIncluded** | **boolean** |  | [optional] [default to undefined]
+**taxLocation** | [**TaxLocationType**](TaxLocationType.md) |  | [optional] [default to undefined]
+**paymentIntegrationId** | **string** |  | [optional] [default to undefined]
+**entityId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipTypeUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipTypeUpdateInputs = {
+    name,
+    description,
+    imageId,
+    price,
+    termDays,
+    maxMembers,
+    sortOrder,
+    visible,
+    archived,
+    taxCode,
+    taxIncluded,
+    taxLocation,
+    paymentIntegrationId,
+    entityId,
+};
+```
+
+[[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/PlaceMembershipUpdateInputs.md

@@ -0,0 +1,24 @@
+# PlaceMembershipUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [optional] [default to undefined]
+**startsAt** | **string** |  | [optional] [default to undefined]
+**expiresAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PlaceMembershipUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: PlaceMembershipUpdateInputs = {
+    status,
+    startsAt,
+    expiresAt,
+};
+```
+
+[[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/StreamSession.md

@@ -8,12 +8,17 @@ Name | Type | Description | Notes
 **id** | **string** |  | [default to undefined]
 **organizationId** | **string** |  | [default to undefined]
 **streamId** | **string** |  | [default to undefined]
-**status** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**eventSessionId** | **string** |  | [default to undefined]
+**status** | [**StreamSessionStatus**](StreamSessionStatus.md) |  | [default to undefined]
 **startedAt** | **string** |  | [default to undefined]
 **endedAt** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
 **stream** | [**BaseStreamInput**](BaseStreamInput.md) |  | [default to undefined]
+**event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
+**eventSession** | [**BaseEventSession**](BaseEventSession.md) |  | [default to undefined]
 **organization** | [**BaseOrganization**](BaseOrganization.md) |  | [default to undefined]
 
 ## Example
@@ -25,12 +30,17 @@ const instance: StreamSession = {
     id,
     organizationId,
     streamId,
+    name,
+    eventId,
+    eventSessionId,
     status,
     startedAt,
     endedAt,
     createdAt,
     updatedAt,
     stream,
+    event,
+    eventSession,
     organization,
 };
 ```

package/docs/StreamSessionStatus.md

@@ -0,0 +1,10 @@
+# StreamSessionStatus
+
+
+## Enum
+
+* `Active` (value: `'ACTIVE'`)
+
+* `Ended` (value: `'ENDED'`)
+
+[[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/StreamSessionUpdateInputs.md

@@ -0,0 +1,24 @@
+# StreamSessionUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**eventSessionId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StreamSessionUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: StreamSessionUpdateInputs = {
+    name,
+    eventId,
+    eventSessionId,
+};
+```
+
+[[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/StreamsApi.md

@@ -67,7 +67,7 @@ const { status, data } = await apiInstance.createStreamInput(
 # **deleteStreamInput**
 > CreateAccountInvitations200Response deleteStreamInput()
 
-Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
+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.
 
 ### Example