# EventsSponsorshipsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createEventSponsorship**](#createeventsponsorship) | **POST** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships | Create a sponsorship on a sponsorship level|
|[**deleteEventSponsorship**](#deleteeventsponsorship) | **DELETE** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Delete a sponsorship from a sponsorship level|
|[**getEventSponsorship**](#geteventsponsorship) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Get a sponsorship within a level|
|[**getEventSponsorships**](#geteventsponsorships) | **GET** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships | List sponsorships within a level|
|[**reorderEventSponsorships**](#reordereventsponsorships) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/reorder | Reorder sponsorships within a sponsorship level|
|[**updateEventSponsorship**](#updateeventsponsorship) | **PUT** /events/{eventId}/sponsorshipLevels/{levelId}/sponsorships/{sponsorshipId} | Update an event sponsorship|

# **createEventSponsorship**
> CreateEventSponsorship200Response createEventSponsorship(eventSponsorshipCreateInputs)

Creates a new sponsorship (a sponsor placed at a given sponsorship level) for an event; requires update permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration,
    EventSponsorshipCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let levelId: string; //The level identifier (default to undefined)
let eventSponsorshipCreateInputs: EventSponsorshipCreateInputs; //

const { status, data } = await apiInstance.createEventSponsorship(
    eventId,
    levelId,
    eventSponsorshipCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventSponsorshipCreateInputs** | **EventSponsorshipCreateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **levelId** | [**string**] | The level identifier | defaults to undefined|


### Return type

**CreateEventSponsorship200Response**

### 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)

# **deleteEventSponsorship**
> CreateAccountInvitations200Response deleteEventSponsorship()

Permanently deletes a sponsorship from the given event sponsorship level; requires update permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let levelId: string; //The level identifier (default to undefined)
let sponsorshipId: string; //The sponsorship identifier (default to undefined)

const { status, data } = await apiInstance.deleteEventSponsorship(
    eventId,
    levelId,
    sponsorshipId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
| **sponsorshipId** | [**string**] | The sponsorship 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)

# **getEventSponsorship**
> CreateEventSponsorship200Response getEventSponsorship()

Returns a single sponsorship record (the sponsor assigned to a sponsorship level) for the given event; requires read permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let levelId: string; //The level identifier (default to undefined)
let sponsorshipId: string; //The sponsorship identifier (default to undefined)

const { status, data } = await apiInstance.getEventSponsorship(
    eventId,
    levelId,
    sponsorshipId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|


### Return type

**CreateEventSponsorship200Response**

### 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)

# **getEventSponsorships**
> GetEventSponsorships200Response getEventSponsorships()

Returns a paginated list of sponsorships (sponsors assigned) under the given sponsorship level of an event, supporting search and ordering; requires read permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(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.getEventSponsorships(
    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

**GetEventSponsorships200Response**

### 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)

# **reorderEventSponsorships**
> ReorderEventSponsorships200Response reorderEventSponsorships(reorderEventSponsorshipsRequest)

Sets the display order of the sponsorships within an event sponsorship level by supplying the full ordered list of sponsorship IDs; requires update permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration,
    ReorderEventSponsorshipsRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let levelId: string; //The level identifier (default to undefined)
let reorderEventSponsorshipsRequest: ReorderEventSponsorshipsRequest; //

const { status, data } = await apiInstance.reorderEventSponsorships(
    eventId,
    levelId,
    reorderEventSponsorshipsRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **reorderEventSponsorshipsRequest** | **ReorderEventSponsorshipsRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **levelId** | [**string**] | The level identifier | defaults to undefined|


### Return type

**ReorderEventSponsorships200Response**

### 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)

# **updateEventSponsorship**
> CreateEventSponsorship200Response updateEventSponsorship(eventSponsorshipUpdateInputs)

Updates the details of a sponsorship record at a given sponsorship level for an event, such as its name, description, or links, and requires update permission on events.

### Example

```typescript
import {
    EventsSponsorshipsApi,
    Configuration,
    EventSponsorshipUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsSponsorshipsApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let levelId: string; //The level identifier (default to undefined)
let sponsorshipId: string; //The sponsorship identifier (default to undefined)
let eventSponsorshipUpdateInputs: EventSponsorshipUpdateInputs; //

const { status, data } = await apiInstance.updateEventSponsorship(
    eventId,
    levelId,
    sponsorshipId,
    eventSponsorshipUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventSponsorshipUpdateInputs** | **EventSponsorshipUpdateInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **levelId** | [**string**] | The level identifier | defaults to undefined|
| **sponsorshipId** | [**string**] | The sponsorship identifier | defaults to undefined|


### Return type

**CreateEventSponsorship200Response**

### 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)