@connectedxm/admin-sdk 16.14.0 → 16.16.0

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 16.14.0
+ * The version of the OpenAPI document: 16.16.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ChannelsInterestsApi.md

@@ -0,0 +1,364 @@
+# ChannelsInterestsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addChannelContentInterest**](#addchannelcontentinterest) | **POST** /channels/{channelId}/contents/{contentId}/interests/{interestId} | Add an interest to a content item|
+|[**addChannelInterest**](#addchannelinterest) | **POST** /channels/{channelId}/interests/{interestId} | Add an interest to a channel|
+|[**getChannelContentInterests**](#getchannelcontentinterests) | **GET** /channels/{channelId}/contents/{contentId}/interests | List a content item\'s interests|
+|[**getChannelInterests**](#getchannelinterests) | **GET** /channels/{channelId}/interests | List a channel\'s interests|
+|[**removeChannelContentInterest**](#removechannelcontentinterest) | **DELETE** /channels/{channelId}/contents/{contentId}/interests/{interestId} | Remove an interest from a content item|
+|[**removeChannelInterest**](#removechannelinterest) | **DELETE** /channels/{channelId}/interests/{interestId} | Remove an interest from a channel|
+
+# **addChannelContentInterest**
+> CreateChannelContent200Response addChannelContentInterest()
+
+Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addChannelContentInterest(
+    channelId,
+    contentId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannelContent200Response**
+
+### 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)
+
+# **addChannelInterest**
+> CreateChannel200Response addChannelInterest()
+
+Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addChannelInterest(
+    channelId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannel200Response**
+
+### 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)
+
+# **getChannelContentInterests**
+> GetAccountInterests200Response getChannelContentInterests()
+
+Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content 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.getChannelContentInterests(
+    channelId,
+    contentId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content 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
+
+**GetAccountInterests200Response**
+
+### 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)
+
+# **getChannelInterests**
+> GetAccountInterests200Response getChannelInterests()
+
+Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel 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.getChannelInterests(
+    channelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel 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
+
+**GetAccountInterests200Response**
+
+### 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)
+
+# **removeChannelContentInterest**
+> CreateChannelContent200Response removeChannelContentInterest()
+
+Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeChannelContentInterest(
+    channelId,
+    contentId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannelContent200Response**
+
+### 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)
+
+# **removeChannelInterest**
+> CreateChannel200Response removeChannelInterest()
+
+Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeChannelInterest(
+    channelId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannel200Response**
+
+### 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/EventPassTypePriceScheduleTranslation.md

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

@@ -0,0 +1,181 @@
+# EventsInterestsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventInterest**](#addeventinterest) | **POST** /events/{eventId}/interests/{interestId} | Add an interest to an event|
+|[**getEventInterests**](#geteventinterests) | **GET** /events/{eventId}/interests | List an event\'s interests|
+|[**removeEventInterest**](#removeeventinterest) | **DELETE** /events/{eventId}/interests/{interestId} | Remove an interest from an event|
+
+# **addEventInterest**
+> CreateEvent200Response addEventInterest()
+
+Associates an existing interest with an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventInterest(
+    eventId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEvent200Response**
+
+### 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)
+
+# **getEventInterests**
+> GetAccountInterests200Response getEventInterests()
+
+Returns a paginated list of interest tags associated with the given event, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on events and interests.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event 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.getEventInterests(
+    eventId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event 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
+
+**GetAccountInterests200Response**
+
+### 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)
+
+# **removeEventInterest**
+> CreateEvent200Response removeEventInterest()
+
+Removes an interest from an event, requiring update permission on both events and interests; the event\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    EventsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsInterestsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventInterest(
+    eventId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEvent200Response**
+
+### 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)
+