constant_contact_client 1.0.0 → 1.5.0

data/docs/EventsApi.md

@@ -0,0 +1,881 @@
+# ConstantContactClient::EventsApi
+
+All URIs are relative to *https://api.cc.email/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_in_tickets**](EventsApi.md#check_in_tickets) | **POST** /events/{event_id}/check_in/tickets | Check in event tickets. |
+| [**copy_event**](EventsApi.md#copy_event) | **POST** /events/{event_id}/copy | POST (copy) an existing event. |
+| [**create_event**](EventsApi.md#create_event) | **POST** /events/default | POST (create) a new event. |
+| [**find_events**](EventsApi.md#find_events) | **GET** /events | GET a collection of events. |
+| [**find_registrations_using_get**](EventsApi.md#find_registrations_using_get) | **GET** /events/{event_id}/tracks/{track_id}/registrations | Get a list of registrations for an event. |
+| [**get_event2**](EventsApi.md#get_event2) | **GET** /events/{event_id} | GET details for a single event. |
+| [**get_registration_info**](EventsApi.md#get_registration_info) | **GET** /events/{event_id}/tracks/{track_id}/registrations/{registration_id} | Get registration details for an event. |
+| [**undo_check_in_tickets**](EventsApi.md#undo_check_in_tickets) | **POST** /events/{event_id}/undo_check_in/tickets | Undo event ticket check-in. |
+| [**update_event**](EventsApi.md#update_event) | **PATCH** /events/{event_id} | PATCH (update) an event. |
+| [**update_registration_payment_status_using_put**](EventsApi.md#update_registration_payment_status_using_put) | **PUT** /events/{event_id}/tracks/{track_id}/registrations/payment_status | Update payment status for event registrations. |
+| [**update_registration_status_using_put**](EventsApi.md#update_registration_status_using_put) | **PUT** /events/{event_id}/tracks/{track_id}/registrations | Update status for event registrations. |
+
+
+## check_in_tickets
+
+> check_in_tickets(event_id, check_in_tickets_request)
+
+Check in event tickets.
+
+Use this endpoint to mark one or more tickets as checked in. The event must be in `ACTIVE` or `COMPLETE` status. Tickets with `CANCELLED` status cannot be checked in (returns HTTP 400).
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '07216444-4e3b-41ea-a3b8-5a418fce41f4' # String | The ID that uniquely identifies the event.
+check_in_tickets_request = ConstantContactClient::CheckInTicketsRequest.new({order_ticket_keys: ["a1b2c3", "d4e5f6"]}) # CheckInTicketsRequest | Set of order ticket keys to mark as checked in.
+
+begin
+  # Check in event tickets.
+  api_instance.check_in_tickets(event_id, check_in_tickets_request)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->check_in_tickets: #{e}"
+end
+```
+
+#### Using the check_in_tickets_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> check_in_tickets_with_http_info(event_id, check_in_tickets_request)
+
+```ruby
+begin
+  # Check in event tickets.
+  data, status_code, headers = api_instance.check_in_tickets_with_http_info(event_id, check_in_tickets_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->check_in_tickets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **check_in_tickets_request** | [**CheckInTicketsRequest**](CheckInTicketsRequest.md) | Set of order ticket keys to mark as checked in. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## copy_event
+
+> <CreateEvent201Response> copy_event(event_id, copy_event_request)
+
+POST (copy) an existing event.
+
+Creates a deep copy of an existing event with all its settings, registration forms, and landing pages. The copied event is created in DRAFT status. Events in DRAFT, ACTIVE, COMPLETE, or CANCELED status can be copied. DELETED events cannot be copied.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '1697732a-8664-4675-8415-c4aabaa17dae' # String | The ID of the event to copy.
+copy_event_request = ConstantContactClient::CopyEventRequest.new({target_event_name: 'My Copied Event'}) # CopyEventRequest | A JSON request body containing the copy options.
+
+begin
+  # POST (copy) an existing event.
+  result = api_instance.copy_event(event_id, copy_event_request)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->copy_event: #{e}"
+end
+```
+
+#### Using the copy_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateEvent201Response>, Integer, Hash)> copy_event_with_http_info(event_id, copy_event_request)
+
+```ruby
+begin
+  # POST (copy) an existing event.
+  data, status_code, headers = api_instance.copy_event_with_http_info(event_id, copy_event_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateEvent201Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->copy_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID of the event to copy. |  |
+| **copy_event_request** | [**CopyEventRequest**](CopyEventRequest.md) | A JSON request body containing the copy options. |  |
+
+### Return type
+
+[**CreateEvent201Response**](CreateEvent201Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_event
+
+> <CreateEvent201Response> create_event(opts)
+
+POST (create) a new event.
+
+Creates a new event with default settings, registration form, and landing page. The event will be created in DRAFT status.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+opts = {
+  name: 'My Event', # String | Name for the new event. If not provided, a default name will be generated.
+  start_time: '2024-01-15T10:00:00Z', # String | Event start time in ISO 8601 format. If not provided, defaults to a future date.
+  end_time: '2024-01-15T18:00:00Z', # String | Event end time in ISO 8601 format. If not provided, defaults to one hour after start time.
+  placeholder_campaign_id: 'campaign-123' # String | Placeholder campaign ID for the event.
+}
+
+begin
+  # POST (create) a new event.
+  result = api_instance.create_event(opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->create_event: #{e}"
+end
+```
+
+#### Using the create_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateEvent201Response>, Integer, Hash)> create_event_with_http_info(opts)
+
+```ruby
+begin
+  # POST (create) a new event.
+  data, status_code, headers = api_instance.create_event_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateEvent201Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->create_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name for the new event. If not provided, a default name will be generated. | [optional] |
+| **start_time** | **String** | Event start time in ISO 8601 format. If not provided, defaults to a future date. | [optional] |
+| **end_time** | **String** | Event end time in ISO 8601 format. If not provided, defaults to one hour after start time. | [optional] |
+| **placeholder_campaign_id** | **String** | Placeholder campaign ID for the event. | [optional] |
+
+### Return type
+
+[**CreateEvent201Response**](CreateEvent201Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_events
+
+> <FindEvents200Response> find_events(opts)
+
+GET a collection of events.
+
+Retrieve a collection of events with event details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+opts = {
+  event_status: 'DRAFT', # String | Use to return only events that meet the specified status. Acceptable values include `ACTIVE`,`DRAFT`, `COMPLETE`, `DELETED`,`CANCELLED`, and `ERROR`.
+  search_text: 'reunion', # String | Use to return only events that include the specified text.
+  sort_by: 'created_time', # String | Use to sort resulting events by one of the following properties: `name`, `start_time`, `end_time`, `created_time`, or `updated_time`.
+  sort_order: 'DESC', # String | Sort order for the `sort_by parameter`. Accepted values include `ASC` (ascending) or `DESC` (descending). Defaults to `ASC` if `sort_by` is provided.
+  limit: '5', # String | Limit the number of results to return per page. Default and maximum is `100`.
+  prev: '7zDEe3DhD5gUiwRFsvWKKZlZO1j6-YihH2hyVWD8GaW7JnzXbHFP8Tou212KoU20mOjvM6pdWwycDWC3X-Hb_xY-RK1eBwYp_pc4X2CvLxo.', # String | Cursor for retrieving the previous page of results. This value is obtained from the `prev_cursor` field in a previous response.
+  _next: '7zDEe3DhD5gUiwRFsvWKKZlZO1j6-YihH2hyVWD8GaW7JnzXbHFP8Tou212KoU20mOjvM6pdWwycDWC3X-Hb_xY-RK1eBwYp_pc4X2CvLxo' # String | Cursor for retrieving the next page of results. This value is obtained from the `next_cursor` field in a previous response.
+}
+
+begin
+  # GET a collection of events.
+  result = api_instance.find_events(opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->find_events: #{e}"
+end
+```
+
+#### Using the find_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FindEvents200Response>, Integer, Hash)> find_events_with_http_info(opts)
+
+```ruby
+begin
+  # GET a collection of events.
+  data, status_code, headers = api_instance.find_events_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FindEvents200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->find_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_status** | **String** | Use to return only events that meet the specified status. Acceptable values include &#x60;ACTIVE&#x60;,&#x60;DRAFT&#x60;, &#x60;COMPLETE&#x60;, &#x60;DELETED&#x60;,&#x60;CANCELLED&#x60;, and &#x60;ERROR&#x60;. | [optional] |
+| **search_text** | **String** | Use to return only events that include the specified text. | [optional] |
+| **sort_by** | **String** | Use to sort resulting events by one of the following properties: &#x60;name&#x60;, &#x60;start_time&#x60;, &#x60;end_time&#x60;, &#x60;created_time&#x60;, or &#x60;updated_time&#x60;. | [optional] |
+| **sort_order** | **String** | Sort order for the &#x60;sort_by parameter&#x60;. Accepted values include &#x60;ASC&#x60; (ascending) or &#x60;DESC&#x60; (descending). Defaults to &#x60;ASC&#x60; if &#x60;sort_by&#x60; is provided. | [optional] |
+| **limit** | **String** | Limit the number of results to return per page. Default and maximum is &#x60;100&#x60;. | [optional] |
+| **prev** | **String** | Cursor for retrieving the previous page of results. This value is obtained from the &#x60;prev_cursor&#x60; field in a previous response. | [optional] |
+| **_next** | **String** | Cursor for retrieving the next page of results. This value is obtained from the &#x60;next_cursor&#x60; field in a previous response. | [optional] |
+
+### Return type
+
+[**FindEvents200Response**](FindEvents200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## find_registrations_using_get
+
+> <FindRegistrationsUsingGET200Response> find_registrations_using_get(event_id, track_id, opts)
+
+Get a list of registrations for an event.
+
+Use the `event_id` and `track_id` path parameters to get a list of registrations for an event. Use optional query parameters to limit the number of results returned per page, the sort order, or to filter results by specific criteria; such as registration `status`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '1697732a-8664-4675-8415-c4aabaa17dae' # String | The ID that uniquely identifies the event.
+track_id = 's8zabc' # String | The track ID that uniquely identifies the event track.
+opts = {
+  registration_status: 'PENDING', # String | Filter registration results by status.
+  payment_status: 'PENDING', # String | Filter registration results by payment status.
+  search_text: 'john.doe@example.com', # String | Filter registration results by first name, last name, or email address.
+  sort_by: 'first_name', # String | Specify the field to use to sort the results.
+  sort_order: 'ASC', # String | Use to specify how you want the results sorted.
+  page_size: '50', # String | Alternative to the <code>limit</code> parameter to limit the number of results returned per page. If specifying both the <code>limit</code> and <code>page_size</code> query parameters, they must be the same value.
+  limit: '50', # String | Limit the number of results returned per page. If specifying both the <code>limit</code> and <code>page_size</code> query parameters, they must be the same value.
+  prev: 'bSzsyWkkq95R44vIFEpY62gr8_xSeRXsEQkhnhltPgiT', # String | Cursor for pagination used to get the previous page of results (mutually exclusive with <code>next</code>).
+  _next: 'cTk9xLmmr06S55wJGfQ73hs9_yTfSYtFRlimimQhjUj' # String | Cursor for pagination used to get the next page of results (mutually exclusive with <code>prev</code>).
+}
+
+begin
+  # Get a list of registrations for an event.
+  result = api_instance.find_registrations_using_get(event_id, track_id, opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->find_registrations_using_get: #{e}"
+end
+```
+
+#### Using the find_registrations_using_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FindRegistrationsUsingGET200Response>, Integer, Hash)> find_registrations_using_get_with_http_info(event_id, track_id, opts)
+
+```ruby
+begin
+  # Get a list of registrations for an event.
+  data, status_code, headers = api_instance.find_registrations_using_get_with_http_info(event_id, track_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FindRegistrationsUsingGET200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->find_registrations_using_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **track_id** | **String** | The track ID that uniquely identifies the event track. |  |
+| **registration_status** | **String** | Filter registration results by status. | [optional] |
+| **payment_status** | **String** | Filter registration results by payment status. | [optional] |
+| **search_text** | **String** | Filter registration results by first name, last name, or email address. | [optional] |
+| **sort_by** | **String** | Specify the field to use to sort the results. | [optional] |
+| **sort_order** | **String** | Use to specify how you want the results sorted. | [optional] |
+| **page_size** | **String** | Alternative to the &lt;code&gt;limit&lt;/code&gt; parameter to limit the number of results returned per page. If specifying both the &lt;code&gt;limit&lt;/code&gt; and &lt;code&gt;page_size&lt;/code&gt; query parameters, they must be the same value. | [optional] |
+| **limit** | **String** | Limit the number of results returned per page. If specifying both the &lt;code&gt;limit&lt;/code&gt; and &lt;code&gt;page_size&lt;/code&gt; query parameters, they must be the same value. | [optional] |
+| **prev** | **String** | Cursor for pagination used to get the previous page of results (mutually exclusive with &lt;code&gt;next&lt;/code&gt;). | [optional] |
+| **_next** | **String** | Cursor for pagination used to get the next page of results (mutually exclusive with &lt;code&gt;prev&lt;/code&gt;). | [optional] |
+
+### Return type
+
+[**FindRegistrationsUsingGET200Response**](FindRegistrationsUsingGET200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_event2
+
+> <CreateEvent201Response> get_event2(event_id, opts)
+
+GET details for a single event.
+
+Specify the `event_id` path parameter to retrieve the event's details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '1697732a-8664-4675-8415-c4aabaa17dae' # String | The ID that uniquely identifies the event.
+opts = {
+  include: true # Boolean | Use to include (`true`) or exclude (`false`) event setting properties in the results.
+}
+
+begin
+  # GET details for a single event.
+  result = api_instance.get_event2(event_id, opts)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->get_event2: #{e}"
+end
+```
+
+#### Using the get_event2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateEvent201Response>, Integer, Hash)> get_event2_with_http_info(event_id, opts)
+
+```ruby
+begin
+  # GET details for a single event.
+  data, status_code, headers = api_instance.get_event2_with_http_info(event_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateEvent201Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->get_event2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **include** | **Boolean** | Use to include (&#x60;true&#x60;) or exclude (&#x60;false&#x60;) event setting properties in the results. | [optional] |
+
+### Return type
+
+[**CreateEvent201Response**](CreateEvent201Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_registration_info
+
+> <GetRegistrationInfo200Response> get_registration_info(event_id, track_id, registration_id)
+
+Get registration details for an event.
+
+Use the `event_id`, `registration_id`, and `track_id` path parameters to get registration details.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '1697732a-8664-4675-8415-c4aabaa17dae' # String | The ID that uniquely identifies the event.
+track_id = 's8zabc' # String | The track key that uniquely identifies the event track.
+registration_id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' # String | The ID that uniquely identifies the registration.
+
+begin
+  # Get registration details for an event.
+  result = api_instance.get_registration_info(event_id, track_id, registration_id)
+  p result
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->get_registration_info: #{e}"
+end
+```
+
+#### Using the get_registration_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetRegistrationInfo200Response>, Integer, Hash)> get_registration_info_with_http_info(event_id, track_id, registration_id)
+
+```ruby
+begin
+  # Get registration details for an event.
+  data, status_code, headers = api_instance.get_registration_info_with_http_info(event_id, track_id, registration_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetRegistrationInfo200Response>
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->get_registration_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **track_id** | **String** | The track key that uniquely identifies the event track. |  |
+| **registration_id** | **String** | The ID that uniquely identifies the registration. |  |
+
+### Return type
+
+[**GetRegistrationInfo200Response**](GetRegistrationInfo200Response.md)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## undo_check_in_tickets
+
+> undo_check_in_tickets(event_id, check_in_tickets_request)
+
+Undo event ticket check-in.
+
+Use this endpoint to undo check-in for one or more tickets, marking them as not checked in. The event must be in `ACTIVE` or `COMPLETE` status.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '07216444-4e3b-41ea-a3b8-5a418fce41f4' # String | The ID that uniquely identifies the event.
+check_in_tickets_request = ConstantContactClient::CheckInTicketsRequest.new({order_ticket_keys: ["a1b2c3", "d4e5f6"]}) # CheckInTicketsRequest | Set of order ticket keys to mark as not checked in.
+
+begin
+  # Undo event ticket check-in.
+  api_instance.undo_check_in_tickets(event_id, check_in_tickets_request)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->undo_check_in_tickets: #{e}"
+end
+```
+
+#### Using the undo_check_in_tickets_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> undo_check_in_tickets_with_http_info(event_id, check_in_tickets_request)
+
+```ruby
+begin
+  # Undo event ticket check-in.
+  data, status_code, headers = api_instance.undo_check_in_tickets_with_http_info(event_id, check_in_tickets_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->undo_check_in_tickets_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **check_in_tickets_request** | [**CheckInTicketsRequest**](CheckInTicketsRequest.md) | Set of order ticket keys to mark as not checked in. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## update_event
+
+> update_event(event_id, create_event201_response)
+
+PATCH (update) an event.
+
+Partially updates an event with the provided fields. Only the specified fields will be updated. This endpoint only works for events in DRAFT or ACTIVE status. Events in COMPLETE, CANCELED, or DELETED status cannot be updated.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '1697732a-8664-4675-8415-c4aabaa17dae' # String | The ID that uniquely identifies the event to update.
+create_event201_response = ConstantContactClient::CreateEvent201Response.new({description: 'It's time for the High-Class Reunion. A night of reminiscing, networking, and celebrating shared success amongst old friends.', title: 'Riverdale High - Class of 2015 Reunion', name: 'Class of 2015 Reunion', campaign_id: '05cf4d60-56ea-4023-bf49-b35e56a9c7b5', event_start: '2023-12-01T20:30:00Z', event_end: '2023-12-01T21:30:00Z', event_type: 'PERFORMING_ARTS', default_track: ConstantContactClient::TrackDto1.new({campaign_activity_id: '31bb0c22-1c72-4841-9d2c-8bd41ed526bc'}), location_type: 'PHYSICAL', time_zone: 'US/Eastern'}) # CreateEvent201Response | A JSON request body containing the event fields to update.
+
+begin
+  # PATCH (update) an event.
+  api_instance.update_event(event_id, create_event201_response)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_event: #{e}"
+end
+```
+
+#### Using the update_event_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_event_with_http_info(event_id, create_event201_response)
+
+```ruby
+begin
+  # PATCH (update) an event.
+  data, status_code, headers = api_instance.update_event_with_http_info(event_id, create_event201_response)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event to update. |  |
+| **create_event201_response** | [**CreateEvent201Response**](CreateEvent201Response.md) | A JSON request body containing the event fields to update. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## update_registration_payment_status_using_put
+
+> update_registration_payment_status_using_put(event_id, track_id, update_registration_payment_status_using_put_request)
+
+Update payment status for event registrations.
+
+Use this endpoint to update the payment status for one or more registrations. This endpoint only processes registrations with a payment method (PAYPAL, WEPAY, STRIPE, DOOR, or CHECK). Free registrations without a payment method are silently excluded.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = 'c5da3665-88f9-4b15-82bc-cd6593c32537' # String | The ID that uniquely identifies the event.
+track_id = '2unzqq' # String | The track key that uniquely identifies the event track.
+update_registration_payment_status_using_put_request = ConstantContactClient::UpdateRegistrationPaymentStatusUsingPUTRequest.new({registration_ids: ["4460bdcd-1a8a-434a-a7bf-c72a500743b2", "2ed7e310-ab71-4e8f-8863-8784e7ee4183"], payment_status: 'Paid'}) # UpdateRegistrationPaymentStatusUsingPUTRequest | Payment status update request data.
+
+begin
+  # Update payment status for event registrations.
+  api_instance.update_registration_payment_status_using_put(event_id, track_id, update_registration_payment_status_using_put_request)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_registration_payment_status_using_put: #{e}"
+end
+```
+
+#### Using the update_registration_payment_status_using_put_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_registration_payment_status_using_put_with_http_info(event_id, track_id, update_registration_payment_status_using_put_request)
+
+```ruby
+begin
+  # Update payment status for event registrations.
+  data, status_code, headers = api_instance.update_registration_payment_status_using_put_with_http_info(event_id, track_id, update_registration_payment_status_using_put_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_registration_payment_status_using_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **track_id** | **String** | The track key that uniquely identifies the event track. |  |
+| **update_registration_payment_status_using_put_request** | [**UpdateRegistrationPaymentStatusUsingPUTRequest**](UpdateRegistrationPaymentStatusUsingPUTRequest.md) | Payment status update request data. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_registration_status_using_put
+
+> update_registration_status_using_put(event_id, track_id, update_registration_status_using_put_request, opts)
+
+Update status for event registrations.
+
+Use this endpoint to update the registration status for one or more registrations within an event track.
+
+### Examples
+
+```ruby
+require 'time'
+require 'constant_contact_client'
+# setup authorization
+ConstantContactClient.configure do |config|
+  # Configure OAuth2 access token for authorization: oauth2_access_code
+  config.access_token = 'YOUR ACCESS TOKEN'
+
+  # Configure OAuth2 access token for authorization: oauth2_implicit
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = ConstantContactClient::EventsApi.new
+event_id = '07216444-4e3b-41ea-a3b8-5a418fce41f4' # String | The ID that uniquely identifies the event.
+track_id = 'gqz1gb' # String | The track key that uniquely identifies the event track.
+update_registration_status_using_put_request = ConstantContactClient::UpdateRegistrationStatusUsingPUTRequest.new({registration_ids: ["0c6a6ce8-e620-4ffc-92e6-6ffb689eb9d2", "15cdb4d3-86b9-4b9d-9431-4a5a0de53c4f"], registration_status: 'CANCELED'}) # UpdateRegistrationStatusUsingPUTRequest | Registration status update request data.
+opts = {
+  increase_count: true, # Boolean | Override count flag.
+  increase_item_count: true, # Boolean | Override item count flag.
+  return_items_to_inventory: true # Boolean | Return items to inventory flag. Defaults to `true`.
+}
+
+begin
+  # Update status for event registrations.
+  api_instance.update_registration_status_using_put(event_id, track_id, update_registration_status_using_put_request, opts)
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_registration_status_using_put: #{e}"
+end
+```
+
+#### Using the update_registration_status_using_put_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_registration_status_using_put_with_http_info(event_id, track_id, update_registration_status_using_put_request, opts)
+
+```ruby
+begin
+  # Update status for event registrations.
+  data, status_code, headers = api_instance.update_registration_status_using_put_with_http_info(event_id, track_id, update_registration_status_using_put_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ConstantContactClient::ApiError => e
+  puts "Error when calling EventsApi->update_registration_status_using_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The ID that uniquely identifies the event. |  |
+| **track_id** | **String** | The track key that uniquely identifies the event track. |  |
+| **update_registration_status_using_put_request** | [**UpdateRegistrationStatusUsingPUTRequest**](UpdateRegistrationStatusUsingPUTRequest.md) | Registration status update request data. |  |
+| **increase_count** | **Boolean** | Override count flag. | [optional] |
+| **increase_item_count** | **Boolean** | Override item count flag. | [optional] |
+| **return_items_to_inventory** | **Boolean** | Return items to inventory flag. Defaults to &#x60;true&#x60;. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth2_access_code](../README.md#oauth2_access_code), [oauth2_implicit](../README.md#oauth2_implicit)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+