@connectedxm/admin-sdk 1.0.0

package/docs/AdvertisementsApi.md

@@ -0,0 +1,409 @@
+# AdvertisementsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createAdvertisement**](#createadvertisement) | **POST** /advertisements | Create Advertisement|
+|[**deleteAdvertisement**](#deleteadvertisement) | **DELETE** /advertisements/{advertisementId} | Delete Advertisement|
+|[**getAdvertisement**](#getadvertisement) | **GET** /advertisements/{advertisementId} | Get Advertisement|
+|[**getAdvertisementClicks**](#getadvertisementclicks) | **GET** /advertisements/{advertisementId}/clicks | Get Advertisement Clicks|
+|[**getAdvertisementViews**](#getadvertisementviews) | **GET** /advertisements/{advertisementId}/views | Get Advertisement Views|
+|[**getAdvertisements**](#getadvertisements) | **GET** /advertisements | Get Advertisements|
+|[**updateAdvertisement**](#updateadvertisement) | **PUT** /advertisements/{advertisementId} | Update Advertisement|
+
+# **createAdvertisement**
+> CreateAdvertisement200Response createAdvertisement(advertisementCreateInputs)
+
+Create Advertisement endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration,
+    AdvertisementCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementCreateInputs: AdvertisementCreateInputs; //
+
+const { status, data } = await apiInstance.createAdvertisement(
+    advertisementCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementCreateInputs** | **AdvertisementCreateInputs**|  | |
+
+
+### Return type
+
+**CreateAdvertisement200Response**
+
+### 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)
+
+# **deleteAdvertisement**
+> CreateAccountInvitations200Response deleteAdvertisement()
+
+Delete Advertisement endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementId: string; //The advertisement identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteAdvertisement(
+    advertisementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementId** | [**string**] | The advertisement 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)
+
+# **getAdvertisement**
+> CreateAdvertisement200Response getAdvertisement()
+
+Get Advertisement endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementId: string; //The advertisement identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAdvertisement(
+    advertisementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementId** | [**string**] | The advertisement identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAdvertisement200Response**
+
+### 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)
+
+# **getAdvertisementClicks**
+> GetAccountInvitations200Response getAdvertisementClicks()
+
+Get Advertisement Clicks endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementId: string; //The advertisement 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.getAdvertisementClicks(
+    advertisementId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementId** | [**string**] | The advertisement 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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **getAdvertisementViews**
+> GetAccountInvitations200Response getAdvertisementViews()
+
+Get Advertisement Views endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementId: string; //The advertisement 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.getAdvertisementViews(
+    advertisementId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementId** | [**string**] | The advertisement 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
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **getAdvertisements**
+> GetAdvertisements200Response getAdvertisements()
+
+Get Advertisements endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+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.getAdvertisements(
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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
+
+**GetAdvertisements200Response**
+
+### 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)
+
+# **updateAdvertisement**
+> CreateAdvertisement200Response updateAdvertisement(advertisementUpdateInputs)
+
+Update Advertisement endpoint
+
+### Example
+
+```typescript
+import {
+    AdvertisementsApi,
+    Configuration,
+    AdvertisementUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AdvertisementsApi(configuration);
+
+let advertisementId: string; //The advertisement identifier (default to undefined)
+let advertisementUpdateInputs: AdvertisementUpdateInputs; //
+
+const { status, data } = await apiInstance.updateAdvertisement(
+    advertisementId,
+    advertisementUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **advertisementUpdateInputs** | **AdvertisementUpdateInputs**|  | |
+| **advertisementId** | [**string**] | The advertisement identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAdvertisement200Response**
+
+### 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/Announcement.md

@@ -0,0 +1,48 @@
+# Announcement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_count** | [**AnnouncementCount**](AnnouncementCount.md) |  | [default to undefined]
+**verifiedAccounts** | **boolean** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**creator** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
+**group** | [**BaseGroup**](BaseGroup.md) |  | [default to undefined]
+**tier** | [**BaseTier**](BaseTier.md) |  | [default to undefined]
+**channel** | [**BaseChannel**](BaseChannel.md) |  | [default to undefined]
+**sponsorshipLevelId** | **string** |  | [default to undefined]
+**sponsorshipLevel** | [**BaseLevel**](BaseLevel.md) |  | [default to undefined]
+**ticket** | [**BaseEventPassType**](BaseEventPassType.md) |  | [default to undefined]
+**user** | [**BaseUser**](BaseUser.md) |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**filters** | [**EventAnnouncementFilters**](EventAnnouncementFilters.md) |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Announcement } from '@connectedxm/admin-sdk';
+
+const instance: Announcement = {
+    _count,
+    verifiedAccounts,
+    account,
+    creator,
+    event,
+    group,
+    tier,
+    channel,
+    sponsorshipLevelId,
+    sponsorshipLevel,
+    ticket,
+    user,
+    message,
+    filters,
+    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/AnnouncementCount.md

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

@@ -0,0 +1,48 @@
+# AnnouncementCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [default to undefined]
+**html** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**creatorId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+**tierId** | **string** |  | [optional] [default to undefined]
+**channelId** | **string** |  | [optional] [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**verifiedAccounts** | **boolean** |  | [optional] [default to undefined]
+**sponsorshipLevelId** | **string** |  | [optional] [default to undefined]
+**email** | **boolean** |  | [optional] [default to undefined]
+**push** | **boolean** |  | [optional] [default to undefined]
+**filters** | [**EventAnnouncementFilters**](EventAnnouncementFilters.md) |  | [optional] [default to undefined]
+**includePasses** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementCreateInputs = {
+    title,
+    html,
+    slug,
+    creatorId,
+    eventId,
+    groupId,
+    tierId,
+    channelId,
+    accountId,
+    verifiedAccounts,
+    sponsorshipLevelId,
+    email,
+    push,
+    filters,
+    includePasses,
+};
+```
+
+[[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/AnnouncementFilters.md

@@ -0,0 +1,32 @@
+# AnnouncementFilters
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**verifiedAccounts** | **boolean** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+**tierId** | **string** |  | [optional] [default to undefined]
+**channelId** | **string** |  | [optional] [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**sponsorshipLevelId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementFilters } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementFilters = {
+    verifiedAccounts,
+    eventId,
+    groupId,
+    tierId,
+    channelId,
+    accountId,
+    sponsorshipLevelId,
+};
+```
+
+[[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/AnnouncementTranslation.md

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

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

@@ -0,0 +1,32 @@
+# AnnouncementUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** |  | [optional] [default to undefined]
+**html** | **string** |  | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**email** | **boolean** |  | [optional] [default to undefined]
+**push** | **boolean** |  | [optional] [default to undefined]
+**filters** | [**EventAnnouncementFilters**](EventAnnouncementFilters.md) |  | [optional] [default to undefined]
+**includePasses** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnnouncementUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: AnnouncementUpdateInputs = {
+    title,
+    html,
+    slug,
+    email,
+    push,
+    filters,
+    includePasses,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)