@connectedxm/admin-sdk 6.7.7 → 6.9.0

package/docs/EventsBlocksApi.md

@@ -0,0 +1,479 @@
+# EventsBlocksApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addEventBlockSession**](#addeventblocksession) | **POST** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Add Event Block Session|
+|[**createEventBlock**](#createeventblock) | **POST** /events/{eventId}/blocks | Create Event Block|
+|[**deleteEventBlock**](#deleteeventblock) | **DELETE** /events/{eventId}/blocks/{blockId} | Delete Event Block|
+|[**getEventBlock**](#geteventblock) | **GET** /events/{eventId}/blocks/{blockId} | Get Event Block|
+|[**getEventBlockSessions**](#geteventblocksessions) | **GET** /events/{eventId}/blocks/{blockId}/sessions | Get Event Block Sessions|
+|[**getEventBlocks**](#geteventblocks) | **GET** /events/{eventId}/blocks | Get Event Blocks|
+|[**removeEventBlockSession**](#removeeventblocksession) | **DELETE** /events/{eventId}/blocks/{blockId}/sessions/{sessionId} | Remove Event Block Session|
+|[**updateEventBlock**](#updateeventblock) | **PUT** /events/{eventId}/blocks/{blockId} | Update Event Block|
+
+# **addEventBlockSession**
+> CreateEventBlock200Response addEventBlockSession()
+
+Add Event Block Session endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventBlockSession(
+    eventId,
+    blockId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBlock200Response**
+
+### 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)
+
+# **createEventBlock**
+> CreateEventBlock200Response createEventBlock(eventBlockCreateInputs)
+
+Create Event Block endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration,
+    EventBlockCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let eventBlockCreateInputs: EventBlockCreateInputs; //
+
+const { status, data } = await apiInstance.createEventBlock(
+    eventId,
+    eventBlockCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventBlockCreateInputs** | **EventBlockCreateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBlock200Response**
+
+### 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)
+
+# **deleteEventBlock**
+> CreateAccountInvitations200Response deleteEventBlock()
+
+Delete Event Block endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventBlock(
+    eventId,
+    blockId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block 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)
+
+# **getEventBlock**
+> CreateEventBlock200Response getEventBlock()
+
+Get Event Block endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventBlock(
+    eventId,
+    blockId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBlock200Response**
+
+### 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)
+
+# **getEventBlockSessions**
+> GetAccountInvitations200Response getEventBlockSessions()
+
+Get Event Block Sessions endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block 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.getEventBlockSessions(
+    eventId,
+    blockId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block 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)
+
+# **getEventBlocks**
+> GetEventBlocks200Response getEventBlocks()
+
+Get Event Blocks endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(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.getEventBlocks(
+    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
+
+**GetEventBlocks200Response**
+
+### 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)
+
+# **removeEventBlockSession**
+> CreateEventBlock200Response removeEventBlockSession()
+
+Remove Event Block Session endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block identifier (default to undefined)
+let sessionId: string; //The session identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventBlockSession(
+    eventId,
+    blockId,
+    sessionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block identifier | defaults to undefined|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBlock200Response**
+
+### 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)
+
+# **updateEventBlock**
+> CreateEventBlock200Response updateEventBlock(eventBlockUpdateInputs)
+
+Update Event Block endpoint
+
+### Example
+
+```typescript
+import {
+    EventsBlocksApi,
+    Configuration,
+    EventBlockUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsBlocksApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let blockId: string; //The block identifier (default to undefined)
+let eventBlockUpdateInputs: EventBlockUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventBlock(
+    eventId,
+    blockId,
+    eventBlockUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventBlockUpdateInputs** | **EventBlockUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **blockId** | [**string**] | The block identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventBlock200Response**
+
+### 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/EventsCouponsApi.md

@@ -507,6 +507,7 @@ const apiInstance = new EventsCouponsApi(configuration);
 
 let eventId: string; //The event identifier (default to undefined)
 let prePaid: boolean; //Filter by prePaid (optional) (default to undefined)
+let includeVariants: object; //Filter by includeVariants (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)
@@ -515,6 +516,7 @@ let search: string; //Search query (optional) (default to undefined)
 const { status, data } = await apiInstance.getEventCoupons(
     eventId,
     prePaid,
+    includeVariants,
     page,
     pageSize,
     orderBy,
@@ -528,6 +530,7 @@ const { status, data } = await apiInstance.getEventCoupons(
 |------------- | ------------- | ------------- | -------------|
 | **eventId** | [**string**] | The event identifier | defaults to undefined|
 | **prePaid** | [**boolean**] | Filter by prePaid | (optional) defaults to undefined|
+| **includeVariants** | **object** | Filter by includeVariants | (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|