@connectedxm/admin-sdk 16.14.0 → 16.16.0

package/docs/EventsPasstypesPriceschedulesTranslationsApi.md

@@ -0,0 +1,264 @@
+# EventsPasstypesPriceschedulesTranslationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteEventPassTypePriceScheduleTranslation**](#deleteeventpasstypepricescheduletranslation) | **DELETE** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId}/translations/{locale} | Delete a pass type price schedule translation|
+|[**getEventPassTypePriceScheduleTranslation**](#geteventpasstypepricescheduletranslation) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId}/translations/{locale} | Get a pass type price schedule\'s translation|
+|[**getEventPassTypePriceScheduleTranslations**](#geteventpasstypepricescheduletranslations) | **GET** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId}/translations | List translations for a pass type price schedule|
+|[**updateEventPassTypePriceScheduleTranslation**](#updateeventpasstypepricescheduletranslation) | **PUT** /events/{eventId}/passTypes/{passTypeId}/priceSchedules/{scheduleId}/translations/{locale} | Update a pass type price schedule\'s translation|
+
+# **deleteEventPassTypePriceScheduleTranslation**
+> UpdateEventPassTypePriceScheduleTranslation200Response deleteEventPassTypePriceScheduleTranslation()
+
+Deletes the translation for the given locale on an event pass type price schedule, requiring the \"update\" permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasstypesPriceschedulesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasstypesPriceschedulesTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+let scheduleId: string; //The schedule identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteEventPassTypePriceScheduleTranslation(
+    eventId,
+    passTypeId,
+    scheduleId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+| **scheduleId** | [**string**] | The schedule identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateEventPassTypePriceScheduleTranslation200Response**
+
+### 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)
+
+# **getEventPassTypePriceScheduleTranslation**
+> GetEventPassTypePriceScheduleTranslation200Response getEventPassTypePriceScheduleTranslation()
+
+Retrieves the translation for a specific pass type price schedule in a given locale, returning null if no translation exists for that locale; requires read permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasstypesPriceschedulesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasstypesPriceschedulesTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+let scheduleId: string; //The schedule identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+
+const { status, data } = await apiInstance.getEventPassTypePriceScheduleTranslation(
+    eventId,
+    passTypeId,
+    scheduleId,
+    locale
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+| **scheduleId** | [**string**] | The schedule identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**GetEventPassTypePriceScheduleTranslation200Response**
+
+### 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)
+
+# **getEventPassTypePriceScheduleTranslations**
+> GetEventPassTypePriceScheduleTranslations200Response getEventPassTypePriceScheduleTranslations()
+
+Returns a paginated list of locale translations for a specific price schedule of an event pass type, supporting ordering; requires read permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasstypesPriceschedulesTranslationsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasstypesPriceschedulesTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+let scheduleId: string; //The schedule 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.getEventPassTypePriceScheduleTranslations(
+    eventId,
+    passTypeId,
+    scheduleId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+| **scheduleId** | [**string**] | The schedule 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
+
+**GetEventPassTypePriceScheduleTranslations200Response**
+
+### 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)
+
+# **updateEventPassTypePriceScheduleTranslation**
+> UpdateEventPassTypePriceScheduleTranslation200Response updateEventPassTypePriceScheduleTranslation(passTypePriceScheduleTranslationUpdateInputs)
+
+Creates or updates the localized name for a specific pass type price schedule in the given locale, upserting the translation record; requires update permission on events.
+
+### Example
+
+```typescript
+import {
+    EventsPasstypesPriceschedulesTranslationsApi,
+    Configuration,
+    PassTypePriceScheduleTranslationUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new EventsPasstypesPriceschedulesTranslationsApi(configuration);
+
+let eventId: string; //The event identifier (default to undefined)
+let passTypeId: string; //The passType identifier (default to undefined)
+let scheduleId: string; //The schedule identifier (default to undefined)
+let locale: string; //The locale identifier (default to undefined)
+let passTypePriceScheduleTranslationUpdateInputs: PassTypePriceScheduleTranslationUpdateInputs; //
+
+const { status, data } = await apiInstance.updateEventPassTypePriceScheduleTranslation(
+    eventId,
+    passTypeId,
+    scheduleId,
+    locale,
+    passTypePriceScheduleTranslationUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passTypePriceScheduleTranslationUpdateInputs** | **PassTypePriceScheduleTranslationUpdateInputs**|  | |
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **passTypeId** | [**string**] | The passType identifier | defaults to undefined|
+| **scheduleId** | [**string**] | The schedule identifier | defaults to undefined|
+| **locale** | [**string**] | The locale identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateEventPassTypePriceScheduleTranslation200Response**
+
+### 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/GetEventPassTypePriceScheduleTranslation200Response.md

@@ -0,0 +1,24 @@
+# GetEventPassTypePriceScheduleTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**EventPassTypePriceScheduleTranslation**](EventPassTypePriceScheduleTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventPassTypePriceScheduleTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventPassTypePriceScheduleTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/GetEventPassTypePriceScheduleTranslations200Response.md

@@ -0,0 +1,26 @@
+# GetEventPassTypePriceScheduleTranslations200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<EventPassTypePriceScheduleTranslation>**](EventPassTypePriceScheduleTranslation.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetEventPassTypePriceScheduleTranslations200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetEventPassTypePriceScheduleTranslations200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[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/GroupsInterestsApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 # **addGroupInterest**
 > CreateGroup200Response addGroupInterest()
 
-Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
+Associates an existing interest with a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
 
 ### Example
 
@@ -128,7 +128,7 @@ const { status, data } = await apiInstance.getGroupInterests(
 # **removeGroupInterest**
 > CreateGroup200Response removeGroupInterest()
 
-Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list is invalidated.
+Disassociates an interest from a group, requiring update permission on both groups and interests; the group\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
 
 ### Example
 

package/docs/PassTypePriceScheduleTranslationUpdateInputs.md

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

@@ -0,0 +1,24 @@
+# UpdateEventPassTypePriceScheduleTranslation200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**EventPassTypePriceScheduleTranslation**](EventPassTypePriceScheduleTranslation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateEventPassTypePriceScheduleTranslation200Response } from '@connectedxm/admin-sdk';
+
+const instance: UpdateEventPassTypePriceScheduleTranslation200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/package.json

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