@connectedxm/admin-sdk 16.8.1 → 16.9.0

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.8.1
+ * The version of the OpenAPI document: 16.9.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.8.1
+ * The version of the OpenAPI document: 16.9.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/EventsPagesApi.md

@@ -5,12 +5,18 @@ All URIs are relative to *https://admin-api.connected.dev*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**addEventPageImage**](#addeventpageimage) | **POST** /events/{eventId}/pages/{pageId}/images/{imageId} | Add an image to an event page|
+|[**addEventPagePassType**](#addeventpagepasstype) | **POST** /events/{eventId}/pages/{pageId}/passTypes/{passTypeId} | Restrict an event page to a pass type|
+|[**addEventPageTier**](#addeventpagetier) | **POST** /events/{eventId}/pages/{pageId}/tiers/{tierId} | Restrict an event page to a tier|
 |[**createEventPage**](#createeventpage) | **POST** /events/{eventId}/pages | Create an event page|
 |[**deleteEventPage**](#deleteeventpage) | **DELETE** /events/{eventId}/pages/{pageId} | Delete an event page|
 |[**getEventPage**](#geteventpage) | **GET** /events/{eventId}/pages/{pageId} | Get an event page|
 |[**getEventPageImages**](#geteventpageimages) | **GET** /events/{eventId}/pages/{pageId}/images | List an event page\'s images|
+|[**getEventPagePassTypes**](#geteventpagepasstypes) | **GET** /events/{eventId}/pages/{pageId}/passTypes | List pass types linked to an event page|
+|[**getEventPageTiers**](#geteventpagetiers) | **GET** /events/{eventId}/pages/{pageId}/tiers | List tiers linked to an event page|
 |[**getEventPages**](#geteventpages) | **GET** /events/{eventId}/pages | List an event\'s pages|
 |[**removeEventPageImage**](#removeeventpageimage) | **DELETE** /events/{eventId}/pages/{pageId}/images/{imageId} | Remove an image from an event page|
+|[**removeEventPagePassType**](#removeeventpagepasstype) | **DELETE** /events/{eventId}/pages/{pageId}/passTypes/{passTypeId} | Remove a pass type restriction from an event page|
+|[**removeEventPageTier**](#removeeventpagetier) | **DELETE** /events/{eventId}/pages/{pageId}/tiers/{tierId} | Remove a tier restriction from an event page|
 |[**updateEventPage**](#updateeventpage) | **PUT** /events/{eventId}/pages/{pageId} | Update an event page|
 
 # **addEventPageImage**
@@ -49,6 +55,120 @@ const { status, data } = await apiInstance.addEventPageImage(
 | **imageId** | [**string**] | The image identifier | defaults to undefined|
 
 
+### Return type
+
+**CreateEventPage200Response**
+
+### 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)
+
+# **addEventPagePassType**
+> CreateEventPage200Response addEventPagePassType()
+
+Grants a specific pass type access to an event page, restricting who can view it, and requires read and update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventPagePassType(
+    eventId,
+    pageId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPage200Response**
+
+### 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)
+
+# **addEventPageTier**
+> CreateEventPage200Response addEventPageTier()
+
+Grants a specific account tier (tier/segment) access to an event page, restricting who can view it, and requires read and update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page identifier (default to undefined)
+let tierId: string; //The tier identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventPageTier(
+    eventId,
+    pageId,
+    tierId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page identifier | defaults to undefined|
+| **tierId** | [**string**] | The tier identifier | defaults to undefined|
+
+
 ### Return type
 
 **CreateEventPage200Response**
@@ -292,6 +412,138 @@ const { status, data } = await apiInstance.getEventPageImages(
  - **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)
+
+# **getEventPagePassTypes**
+> GetEventAddOnPassTypes200Response getEventPagePassTypes()
+
+Returns a paginated list of the event\'s pass types (ticket types) that are associated with a given event page, supporting search and ordering; requires read access to events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page 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.getEventPagePassTypes(
+    eventId,
+    pageId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page 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
+
+**GetEventAddOnPassTypes200Response**
+
+### 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)
+
+# **getEventPageTiers**
+> GetAccountTiers200Response getEventPageTiers()
+
+Returns a paginated list of the event\'s account tiers (tiers/segments) that are associated with a given event page, supporting search and ordering; requires read access to events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page 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.getEventPageTiers(
+    eventId,
+    pageId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page 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
+
+**GetAccountTiers200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -398,6 +650,120 @@ const { status, data } = await apiInstance.removeEventPageImage(
 | **imageId** | [**string**] | The image identifier | defaults to undefined|
 
 
+### Return type
+
+**CreateEventPage200Response**
+
+### 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)
+
+# **removeEventPagePassType**
+> CreateEventPage200Response removeEventPagePassType()
+
+Revokes a pass type\'s access to an event page, and requires read and update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventPagePassType(
+    eventId,
+    pageId,
+    passTypeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventPage200Response**
+
+### 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)
+
+# **removeEventPageTier**
+> CreateEventPage200Response removeEventPageTier()
+
+Revokes an account tier\'s (tier/segment) access to an event page, and requires read and update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPagesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPagesApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let pageId: string; //The page identifier (default to undefined)
+let tierId: string; //The tier identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventPageTier(
+    eventId,
+    pageId,
+    tierId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **pageId** | [**string**] | The page identifier | defaults to undefined|
+| **tierId** | [**string**] | The tier identifier | defaults to undefined|
+
+
 ### Return type
 
 **CreateEventPage200Response**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "16.8.1",
+  "version": "16.9.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {