@connectedxm/admin-sdk 15.3.2 → 15.4.0

package/docs/EventsSponsorshiplevelsApi.md

@@ -4,13 +4,73 @@ All URIs are relative to *https://admin-api.connected.dev*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**addEventSponsorshipLevelSurvey**](#addeventsponsorshiplevelsurvey) | **POST** /events/{eventId}/sponsorshipLevels/{levelId}/surveys/{surveyId} | Add a survey to a sponsorship level|
 |[**createEventSponsorshipLevel**](#createeventsponsorshiplevel) | **POST** /events/{eventId}/sponsorshipLevels | Create an event sponsorship level|
 |[**deleteEventSponsorshipLevel**](#deleteeventsponsorshiplevel) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId} | Delete an event sponsorship level|
 |[**getEventSponsorshipLevel**](#geteventsponsorshiplevel) | **GET** /events/{eventId}/sponsorshipLevels/{levelId} | Get an event sponsorship level|
+|[**getEventSponsorshipLevelSurveys**](#geteventsponsorshiplevelsurveys) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/surveys | List surveys on a sponsorship level|
 |[**getEventSponsorshipLevels**](#geteventsponsorshiplevels) | **GET** /events/{eventId}/sponsorshipLevels | List an event\'s sponsorship levels|
+|[**removeEventSponsorshipLevelSurvey**](#removeeventsponsorshiplevelsurvey) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/surveys/{surveyId} | Remove a survey from a sponsorship level|
 |[**reorderEventSponsorshipLevels**](#reordereventsponsorshiplevels) | **PUT** /events/{eventId}/sponsorshipLevels/reorder | Reorder an event\'s sponsorship levels|
 |[**updateEventSponsorshipLevel**](#updateeventsponsorshiplevel) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId} | Update an event sponsorship level|
 
+# **addEventSponsorshipLevelSurvey**
+> CreateEventSponsorshipLevel200Response addEventSponsorshipLevelSurvey()
+
+Links a survey to an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+
+### 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)
+let surveyId: string; //The survey identifier (default to undefined)
+
+const { status, data } = await apiInstance.addEventSponsorshipLevelSurvey(
+    eventId,
+    levelId,
+    surveyId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSponsorshipLevel200Response**
+
+### 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)
+
 # **createEventSponsorshipLevel**
 > CreateEventSponsorshipLevel200Response createEventSponsorshipLevel(eventSponsorshipLevelCreateInputs)
 
@@ -167,6 +227,72 @@ const { status, data } = await apiInstance.getEventSponsorshipLevel(
  - **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)
+
+# **getEventSponsorshipLevelSurveys**
+> GetEventSponsorshipLevelSurveys200Response getEventSponsorshipLevelSurveys()
+
+Returns a paginated list of surveys linked to the given event sponsorship level, supporting search and ordering; requires read permission on events and surveys.
+
+### 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)
+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.getEventSponsorshipLevelSurveys(
+    eventId,
+    levelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level 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
+
+**GetEventSponsorshipLevelSurveys200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -230,6 +356,63 @@ const { status, data } = await apiInstance.getEventSponsorshipLevels(
  - **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)
+
+# **removeEventSponsorshipLevelSurvey**
+> CreateEventSponsorshipLevel200Response removeEventSponsorshipLevelSurvey()
+
+Unlinks a survey from an event sponsorship level and returns the level; requires read and update permission on events and surveys.
+
+### 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)
+let surveyId: string; //The survey identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeEventSponsorshipLevelSurvey(
+    eventId,
+    levelId,
+    surveyId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventId** | [**string**] | The event identifier | defaults to undefined|
+| **levelId** | [**string**] | The level identifier | defaults to undefined|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateEventSponsorshipLevel200Response**
+
+### 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 |
 |-------------|-------------|------------------|

package/docs/GetEventSponsorshipLevelSurveys200Response.md

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

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **complete** | **boolean** |  | [default to undefined]
 **created** | **number** |  | [default to undefined]
 **allowance** | **number** |  | [default to undefined]
-**unavailable** | **boolean** |  | [default to undefined]
 
 ## Example
 
@@ -21,7 +20,6 @@ const instance: SponsorshipAdvertisementProgress = {
     complete,
     created,
     allowance,
-    unavailable,
 };
 ```
 

package/docs/SponsorshipBenefitProgress.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **complete** | **boolean** |  | [default to undefined]
 **created** | **number** |  | [default to undefined]
 **allowance** | **number** |  | [default to undefined]
-**unavailable** | **boolean** |  | [default to undefined]
 
 ## Example
 
@@ -21,7 +20,6 @@ const instance: SponsorshipBenefitProgress = {
     complete,
     created,
     allowance,
-    unavailable,
 };
 ```
 

package/docs/SponsorshipProgressCheck.md

@@ -10,7 +10,8 @@ Name | Type | Description | Notes
 **missing** | [**Array<SponsorshipBrandingField>**](SponsorshipBrandingField.md) |  | [default to undefined]
 **created** | **number** |  | [default to undefined]
 **allowance** | **number** |  | [default to undefined]
-**unavailable** | **boolean** |  | [default to undefined]
+**submitted** | **number** |  | [default to undefined]
+**required** | **number** |  | [default to undefined]
 
 ## Example
 
@@ -23,7 +24,8 @@ const instance: SponsorshipProgressCheck = {
     missing,
     created,
     allowance,
-    unavailable,
+    submitted,
+    required,
 };
 ```
 

package/docs/{UnavailableSponsorshipBenefitProgress.md → SponsorshipSurveyProgress.md}

@@ -1,4 +1,4 @@
-# UnavailableSponsorshipBenefitProgress
+# SponsorshipSurveyProgress
 
 
 ## Properties
@@ -7,19 +7,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **string** |  | [default to undefined]
 **complete** | **boolean** |  | [default to undefined]
-**unavailable** | **boolean** |  | [default to undefined]
-**allowance** | **number** |  | [default to undefined]
+**submitted** | **number** |  | [default to undefined]
+**required** | **number** |  | [default to undefined]
 
 ## Example
 
 ```typescript
-import { UnavailableSponsorshipBenefitProgress } from '@connectedxm/admin-sdk';
+import { SponsorshipSurveyProgress } from '@connectedxm/admin-sdk';
 
-const instance: UnavailableSponsorshipBenefitProgress = {
+const instance: SponsorshipSurveyProgress = {
     type,
     complete,
-    unavailable,
-    allowance,
+    submitted,
+    required,
 };
 ```
 

package/package.json

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

package/docs/UnavailableSponsorshipAdvertisementProgress.md

@@ -1,26 +0,0 @@
-# UnavailableSponsorshipAdvertisementProgress
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **string** |  | [default to undefined]
-**complete** | **boolean** |  | [default to undefined]
-**unavailable** | **boolean** |  | [default to undefined]
-**allowance** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { UnavailableSponsorshipAdvertisementProgress } from '@connectedxm/admin-sdk';
-
-const instance: UnavailableSponsorshipAdvertisementProgress = {
-    type,
-    complete,
-    unavailable,
-    allowance,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)