late-sdk 0.0.67 → 0.0.69

data/docs/BroadcastsApi.md

@@ -0,0 +1,699 @@
+# Late::BroadcastsApi
+
+All URIs are relative to *https://zernio.com/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_broadcast_recipients**](BroadcastsApi.md#add_broadcast_recipients) | **POST** /v1/broadcasts/{broadcastId}/recipients | Add recipients to a broadcast |
+| [**cancel_broadcast**](BroadcastsApi.md#cancel_broadcast) | **POST** /v1/broadcasts/{broadcastId}/cancel | Cancel a broadcast |
+| [**create_broadcast**](BroadcastsApi.md#create_broadcast) | **POST** /v1/broadcasts | Create a broadcast draft |
+| [**delete_broadcast**](BroadcastsApi.md#delete_broadcast) | **DELETE** /v1/broadcasts/{broadcastId} | Delete a broadcast (draft only) |
+| [**get_broadcast**](BroadcastsApi.md#get_broadcast) | **GET** /v1/broadcasts/{broadcastId} | Get broadcast details |
+| [**list_broadcast_recipients**](BroadcastsApi.md#list_broadcast_recipients) | **GET** /v1/broadcasts/{broadcastId}/recipients | List broadcast recipients |
+| [**list_broadcasts**](BroadcastsApi.md#list_broadcasts) | **GET** /v1/broadcasts | List broadcasts |
+| [**schedule_broadcast**](BroadcastsApi.md#schedule_broadcast) | **POST** /v1/broadcasts/{broadcastId}/schedule | Schedule broadcast for later |
+| [**send_broadcast**](BroadcastsApi.md#send_broadcast) | **POST** /v1/broadcasts/{broadcastId}/send | Trigger immediate send |
+| [**update_broadcast**](BroadcastsApi.md#update_broadcast) | **PATCH** /v1/broadcasts/{broadcastId} | Update a broadcast |
+
+
+## add_broadcast_recipients
+
+> add_broadcast_recipients(broadcast_id, add_broadcast_recipients_request)
+
+Add recipients to a broadcast
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+add_broadcast_recipients_request = Late::AddBroadcastRecipientsRequest.new # AddBroadcastRecipientsRequest | 
+
+begin
+  # Add recipients to a broadcast
+  api_instance.add_broadcast_recipients(broadcast_id, add_broadcast_recipients_request)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->add_broadcast_recipients: #{e}"
+end
+```
+
+#### Using the add_broadcast_recipients_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)> add_broadcast_recipients_with_http_info(broadcast_id, add_broadcast_recipients_request)
+
+```ruby
+begin
+  # Add recipients to a broadcast
+  data, status_code, headers = api_instance.add_broadcast_recipients_with_http_info(broadcast_id, add_broadcast_recipients_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->add_broadcast_recipients_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+| **add_broadcast_recipients_request** | [**AddBroadcastRecipientsRequest**](AddBroadcastRecipientsRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## cancel_broadcast
+
+> cancel_broadcast(broadcast_id)
+
+Cancel a broadcast
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+
+begin
+  # Cancel a broadcast
+  api_instance.cancel_broadcast(broadcast_id)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->cancel_broadcast: #{e}"
+end
+```
+
+#### Using the cancel_broadcast_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)> cancel_broadcast_with_http_info(broadcast_id)
+
+```ruby
+begin
+  # Cancel a broadcast
+  data, status_code, headers = api_instance.cancel_broadcast_with_http_info(broadcast_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->cancel_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_broadcast
+
+> create_broadcast(create_broadcast_request)
+
+Create a broadcast draft
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+create_broadcast_request = Late::CreateBroadcastRequest.new({profile_id: 'profile_id_example', account_id: 'account_id_example', platform: 'instagram', name: 'name_example'}) # CreateBroadcastRequest | 
+
+begin
+  # Create a broadcast draft
+  api_instance.create_broadcast(create_broadcast_request)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->create_broadcast: #{e}"
+end
+```
+
+#### Using the create_broadcast_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)> create_broadcast_with_http_info(create_broadcast_request)
+
+```ruby
+begin
+  # Create a broadcast draft
+  data, status_code, headers = api_instance.create_broadcast_with_http_info(create_broadcast_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->create_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_broadcast_request** | [**CreateBroadcastRequest**](CreateBroadcastRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_broadcast
+
+> delete_broadcast(broadcast_id)
+
+Delete a broadcast (draft only)
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+
+begin
+  # Delete a broadcast (draft only)
+  api_instance.delete_broadcast(broadcast_id)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->delete_broadcast: #{e}"
+end
+```
+
+#### Using the delete_broadcast_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)> delete_broadcast_with_http_info(broadcast_id)
+
+```ruby
+begin
+  # Delete a broadcast (draft only)
+  data, status_code, headers = api_instance.delete_broadcast_with_http_info(broadcast_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->delete_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_broadcast
+
+> get_broadcast(broadcast_id)
+
+Get broadcast details
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+
+begin
+  # Get broadcast details
+  api_instance.get_broadcast(broadcast_id)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->get_broadcast: #{e}"
+end
+```
+
+#### Using the get_broadcast_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)> get_broadcast_with_http_info(broadcast_id)
+
+```ruby
+begin
+  # Get broadcast details
+  data, status_code, headers = api_instance.get_broadcast_with_http_info(broadcast_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->get_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_broadcast_recipients
+
+> list_broadcast_recipients(broadcast_id, opts)
+
+List broadcast recipients
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+opts = {
+  status: 'pending', # String | 
+  limit: 56, # Integer | 
+  skip: 56 # Integer | 
+}
+
+begin
+  # List broadcast recipients
+  api_instance.list_broadcast_recipients(broadcast_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->list_broadcast_recipients: #{e}"
+end
+```
+
+#### Using the list_broadcast_recipients_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)> list_broadcast_recipients_with_http_info(broadcast_id, opts)
+
+```ruby
+begin
+  # List broadcast recipients
+  data, status_code, headers = api_instance.list_broadcast_recipients_with_http_info(broadcast_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->list_broadcast_recipients_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+| **status** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **skip** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_broadcasts
+
+> list_broadcasts(profile_id, opts)
+
+List broadcasts
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+profile_id = 'profile_id_example' # String | 
+opts = {
+  status: 'draft', # String | 
+  platform: 'platform_example', # String | 
+  limit: 56, # Integer | 
+  skip: 56 # Integer | 
+}
+
+begin
+  # List broadcasts
+  api_instance.list_broadcasts(profile_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->list_broadcasts: #{e}"
+end
+```
+
+#### Using the list_broadcasts_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)> list_broadcasts_with_http_info(profile_id, opts)
+
+```ruby
+begin
+  # List broadcasts
+  data, status_code, headers = api_instance.list_broadcasts_with_http_info(profile_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->list_broadcasts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **status** | **String** |  | [optional] |
+| **platform** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **skip** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## schedule_broadcast
+
+> schedule_broadcast(broadcast_id, schedule_broadcast_request)
+
+Schedule broadcast for later
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+schedule_broadcast_request = Late::ScheduleBroadcastRequest.new({scheduled_at: Time.now}) # ScheduleBroadcastRequest | 
+
+begin
+  # Schedule broadcast for later
+  api_instance.schedule_broadcast(broadcast_id, schedule_broadcast_request)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->schedule_broadcast: #{e}"
+end
+```
+
+#### Using the schedule_broadcast_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)> schedule_broadcast_with_http_info(broadcast_id, schedule_broadcast_request)
+
+```ruby
+begin
+  # Schedule broadcast for later
+  data, status_code, headers = api_instance.schedule_broadcast_with_http_info(broadcast_id, schedule_broadcast_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->schedule_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+| **schedule_broadcast_request** | [**ScheduleBroadcastRequest**](ScheduleBroadcastRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_broadcast
+
+> send_broadcast(broadcast_id)
+
+Trigger immediate send
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+
+begin
+  # Trigger immediate send
+  api_instance.send_broadcast(broadcast_id)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->send_broadcast: #{e}"
+end
+```
+
+#### Using the send_broadcast_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)> send_broadcast_with_http_info(broadcast_id)
+
+```ruby
+begin
+  # Trigger immediate send
+  data, status_code, headers = api_instance.send_broadcast_with_http_info(broadcast_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->send_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_broadcast
+
+> update_broadcast(broadcast_id)
+
+Update a broadcast
+
+### Examples
+
+```ruby
+require 'time'
+require 'late-sdk'
+# setup authorization
+Late.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Late::BroadcastsApi.new
+broadcast_id = 'broadcast_id_example' # String | 
+
+begin
+  # Update a broadcast
+  api_instance.update_broadcast(broadcast_id)
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->update_broadcast: #{e}"
+end
+```
+
+#### Using the update_broadcast_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_broadcast_with_http_info(broadcast_id)
+
+```ruby
+begin
+  # Update a broadcast
+  data, status_code, headers = api_instance.update_broadcast_with_http_info(broadcast_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling BroadcastsApi->update_broadcast_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **broadcast_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BulkCreateContactsRequest.md

@@ -0,0 +1,24 @@
+# Late::BulkCreateContactsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **contacts** | [**Array<BulkCreateContactsRequestContactsInner>**](BulkCreateContactsRequestContactsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::BulkCreateContactsRequest.new(
+  profile_id: null,
+  account_id: null,
+  platform: null,
+  contacts: null
+)
+```
+