@connectedxm/admin-sdk 1.0.0

package/docs/EventsSponsorsApi.md

@@ -0,0 +1,245 @@
+# EventsSponsorsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventSponsorAccount**](#addeventsponsoraccount) | **POST** /events/{eventId}/sponsors/accounts/{accountId} | Add Event Sponsor Account|
+|[**getEventSponsorAccounts**](#geteventsponsoraccounts) | **GET** /events/{eventId}/sponsors/accounts | Get Event Sponsor Accounts|
+|[**getEventSponsors**](#geteventsponsors) | **GET** /events/{eventId}/sponsors | Get Event Sponsors|
+|[**removeEventSponsorAccount**](#removeeventsponsoraccount) | **DELETE** /events/{eventId}/sponsors/accounts/{accountId} | Remove Event Sponsor Account|
+
+# **addEventSponsorAccount**
+> CreateEvent200Response addEventSponsorAccount()
+
+Add Event Sponsor Account endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventSponsorAccount(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+
+# **getEventSponsorAccounts**
+> GetAccounts200Response getEventSponsorAccounts()
+
+Get Event Sponsor Accounts endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorsApi(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.getEventSponsorAccounts(
+    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
+
+**GetAccounts200Response**
+
+### 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)
+
+# **getEventSponsors**
+> GetAccounts200Response getEventSponsors()
+
+Get Event Sponsors endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorsApi(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.getEventSponsors(
+    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
+
+**GetAccounts200Response**
+
+### 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)
+
+# **removeEventSponsorAccount**
+> CreateEvent200Response removeEventSponsorAccount()
+
+Remove Event Sponsor Account endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventSponsorAccount(
+    eventId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+

package/docs/EventsSponsorshiplevelsApi.md

@@ -0,0 +1,351 @@
+# EventsSponsorshiplevelsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createEventSponsorshipLevel**](#createeventsponsorshiplevel) | **POST** /events/{eventId}/sponsorshipLevels | Create Event Sponsorship Level|
+|[**deleteEventSponsorshipLevel**](#deleteeventsponsorshiplevel) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId} | Delete Event Sponsorship Level|
+|[**getEventSponsorshipLevel**](#geteventsponsorshiplevel) | **GET** /events/{eventId}/sponsorshipLevels/{levelId} | Get Event Sponsorship Level|
+|[**getEventSponsorshipLevels**](#geteventsponsorshiplevels) | **GET** /events/{eventId}/sponsorshipLevels | Get Event Sponsorship Levels|
+|[**reorderEventSponsorshipLevels**](#reordereventsponsorshiplevels) | **PUT** /events/{eventId}/sponsorshipLevels/reorder | Reorder Event Sponsorship Levels|
+|[**updateEventSponsorshipLevel**](#updateeventsponsorshiplevel) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId} | Update Event Sponsorship Level|
+
+# **createEventSponsorshipLevel**
+> CreateAccountAddress200Response createEventSponsorshipLevel(eventSponsorshipLevelCreateInputs)
+
+Create Event Sponsorship Level endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration,
+    EventSponsorshipLevelCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventSponsorshipLevelCreateInputs: EventSponsorshipLevelCreateInputs; //
+
+const { status, data } = await apiInstance.createEventSponsorshipLevel(
+    eventId,
+    eventSponsorshipLevelCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventSponsorshipLevelCreateInputs** | **EventSponsorshipLevelCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **deleteEventSponsorshipLevel**
+> CreateAccountInvitations200Response deleteEventSponsorshipLevel()
+
+Delete Event Sponsorship Level endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventSponsorshipLevel(
+    eventId,
+    levelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level 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)
+
+# **getEventSponsorshipLevel**
+> CreateAccountAddress200Response getEventSponsorshipLevel()
+
+Get Event Sponsorship Level endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventSponsorshipLevel(
+    eventId,
+    levelId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **getEventSponsorshipLevels**
+> GetAccountInvitations200Response getEventSponsorshipLevels()
+
+Get Event Sponsorship Levels endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(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.getEventSponsorshipLevels(
+    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
+
+**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)
+
+# **reorderEventSponsorshipLevels**
+> CreateAccountAddress200Response reorderEventSponsorshipLevels()
+
+Reorder Event Sponsorship Levels endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelIds: Array<string>; //Filter by levelIds (default to undefined)
+
+const { status, data } = await apiInstance.reorderEventSponsorshipLevels(
+    eventId,
+    levelIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelIds** | **Array&lt;string&gt;** | Filter by levelIds | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **updateEventSponsorshipLevel**
+> CreateAccountAddress200Response updateEventSponsorshipLevel()
+
+Update Event Sponsorship Level endpoint
+
+### Example
+
+```typescript
+import {
+    EventsSponsorshiplevelsApi,
+    Configuration,
+    EventSponsorshipLevelUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsSponsorshiplevelsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let levelId: string; //The level identifier (default to undefined)
+let sponsorshipLevel: EventSponsorshipLevelUpdateInputs; //Filter by sponsorshipLevel (default to undefined)
+
+const { status, data } = await apiInstance.updateEventSponsorshipLevel(
+    eventId,
+    levelId,
+    sponsorshipLevel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **sponsorshipLevel** | **EventSponsorshipLevelUpdateInputs** | Filter by sponsorshipLevel | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+