@connectedxm/admin-sdk 13.2.0 → 13.4.0

package/docs/BookingsMembershipsTranslationsApi.md

@@ -0,0 +1,252 @@
+# BookingsMembershipsTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deletePlaceMembershipTypeTranslation**](#deleteplacemembershiptypetranslation) | **DELETE** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Delete a place membership type translation|
+|[**getPlaceMembershipTypeTranslation**](#getplacemembershiptypetranslation) | **GET** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Get a place membership type\'s translation|
+|[**getPlaceMembershipTypeTranslations**](#getplacemembershiptypetranslations) | **GET** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations | List a place membership type\'s translations|
+|[**updatePlaceMembershipTypeTranslation**](#updateplacemembershiptypetranslation) | **PUT** /bookings/places/{placeId}/membershipTypes/{placeMembershipTypeId}/translations/{locale} | Update a place membership type\'s translation|
+
+# **deletePlaceMembershipTypeTranslation**
+> CreateAccountInvitations200Response deletePlaceMembershipTypeTranslation()
+
+Permanently deletes the translated content for the given locale on the specified place membership type; requires the update bookings permission.
+
+### Example
+
+```typescript
+import {
+    BookingsMembershipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
+
+let placeId: string; //The place identifier (default to undefined)
+let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deletePlaceMembershipTypeTranslation(
+    placeId,
+    placeMembershipTypeId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **placeId** | [**string**] | The place identifier | defaults to undefined|
+| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getPlaceMembershipTypeTranslation**
+> GetPlaceMembershipTypeTranslation200Response getPlaceMembershipTypeTranslation()
+
+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\".
+
+### Example
+
+```typescript
+import {
+    BookingsMembershipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
+
+let placeId: string; //The place identifier (default to undefined)
+let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getPlaceMembershipTypeTranslation(
+    placeId,
+    placeMembershipTypeId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **placeId** | [**string**] | The place identifier | defaults to undefined|
+| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetPlaceMembershipTypeTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getPlaceMembershipTypeTranslations**
+> GetPlaceMembershipTypeTranslations200Response getPlaceMembershipTypeTranslations()
+
+Returns a paginated list of locale translations for a place membership type, supporting search and ordering; requires the \"read\" permission on \"bookings\".
+
+### Example
+
+```typescript
+import {
+    BookingsMembershipsTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
+
+let placeId: string; //The place identifier (default to undefined)
+let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getPlaceMembershipTypeTranslations(
+    placeId,
+    placeMembershipTypeId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **placeId** | [**string**] | The place identifier | defaults to undefined|
+| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetPlaceMembershipTypeTranslations200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **updatePlaceMembershipTypeTranslation**
+> UpdatePlaceMembershipTypeTranslation200Response updatePlaceMembershipTypeTranslation(placeMembershipTypeTranslationUpdateInputs)
+
+Updates the translated name and description for a place membership type in the given locale; requires the update bookings permission.
+
+### Example
+
+```typescript
+import {
+    BookingsMembershipsTranslationsApi,
+    Configuration,
+    PlaceMembershipTypeTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new BookingsMembershipsTranslationsApi(configuration);
+
+let placeId: string; //The place identifier (default to undefined)
+let placeMembershipTypeId: string; //The placeMembershipType identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let placeMembershipTypeTranslationUpdateInputs: PlaceMembershipTypeTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updatePlaceMembershipTypeTranslation(
+    placeId,
+    placeMembershipTypeId,
+    locale,
+    placeMembershipTypeTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **placeMembershipTypeTranslationUpdateInputs** | **PlaceMembershipTypeTranslationUpdateInputs**|  | |
+| **placeId** | [**string**] | The place identifier | defaults to undefined|
+| **placeMembershipTypeId** | [**string**] | The placeMembershipType identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdatePlaceMembershipTypeTranslation200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/CreatePlaceMembershipMember200Response.md

@@ -0,0 +1,24 @@
+# CreatePlaceMembershipMember200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PlaceMembershipMember**](PlaceMembershipMember.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePlaceMembershipMember200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreatePlaceMembershipMember200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/CreatePlaceMembershipType200Response.md

@@ -0,0 +1,24 @@
+# CreatePlaceMembershipType200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PlaceMembershipType**](PlaceMembershipType.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePlaceMembershipType200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreatePlaceMembershipType200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/Export.md

@@ -0,0 +1,40 @@
+# Export
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+**status** | [**ExportStatus**](ExportStatus.md) |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**userId** | **string** |  | [default to undefined]
+**expiration** | **string** |  | [default to undefined]
+**downloadUrl** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**user** | [**BaseUser**](BaseUser.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Export } from '@connectedxm/admin-sdk';
+
+const instance: Export = {
+    id,
+    type,
+    status,
+    message,
+    eventId,
+    userId,
+    expiration,
+    downloadUrl,
+    createdAt,
+    updatedAt,
+    user,
+};
+```
+
+[[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/ExportsApi.md

@@ -0,0 +1,123 @@
+# ExportsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getExport**](#getexport) | **GET** /exports/{exportId} | Get a single export|
+|[**getExports**](#getexports) | **GET** /exports | List data exports|
+
+# **getExport**
+> GetExport200Response getExport()
+
+Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+
+### Example
+
+```typescript
+import {
+    ExportsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ExportsApi(configuration);
+
+let exportId: string; //The export identifier (default to undefined)
+
+const { status, data } = await apiInstance.getExport(
+    exportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **exportId** | [**string**] | The export identifier | defaults to undefined|
+
+
+### Return type
+
+**GetExport200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getExports**
+> GetExports200Response getExports()
+
+Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+
+### Example
+
+```typescript
+import {
+    ExportsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ExportsApi(configuration);
+
+let status: ExportStatus; //Filter by status (optional) (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getExports(
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | **ExportStatus** | Filter by status | (optional) defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetExports200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/GetExport200Response.md

@@ -0,0 +1,24 @@
+# GetExport200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Export**](Export.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetExport200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetExport200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/GetExports200Response.md

@@ -0,0 +1,26 @@
+# GetExports200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<Export>**](Export.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetExports200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetExports200Response = {
+    status,
+    message,
+    data,
+    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/GetPlaceMembership200Response.md

@@ -0,0 +1,24 @@
+# GetPlaceMembership200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PlaceMembership**](PlaceMembership.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMembership200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMembership200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/GetPlaceMembershipMembers200Response.md

@@ -0,0 +1,26 @@
+# GetPlaceMembershipMembers200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<PlaceMembershipMember>**](PlaceMembershipMember.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMembershipMembers200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMembershipMembers200Response = {
+    status,
+    message,
+    data,
+    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/GetPlaceMembershipTypeTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetPlaceMembershipTypeTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**PlaceMembershipTypeTranslation**](PlaceMembershipTypeTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMembershipTypeTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMembershipTypeTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/GetPlaceMembershipTypeTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetPlaceMembershipTypeTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<PlaceMembershipTypeTranslation>**](PlaceMembershipTypeTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMembershipTypeTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMembershipTypeTranslations200Response = {
+    status,
+    message,
+    data,
+    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/GetPlaceMembershipTypes200Response.md

@@ -0,0 +1,26 @@
+# GetPlaceMembershipTypes200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<PlaceMembershipType>**](PlaceMembershipType.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMembershipTypes200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMembershipTypes200Response = {
+    status,
+    message,
+    data,
+    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/GetPlaceMemberships200Response.md

@@ -0,0 +1,26 @@
+# GetPlaceMemberships200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<PlaceMembership>**](PlaceMembership.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetPlaceMemberships200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetPlaceMemberships200Response = {
+    status,
+    message,
+    data,
+    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)