late-sdk 0.0.67 → 0.0.69

data/docs/ContactsApi.md

@@ -0,0 +1,500 @@
+# Late::ContactsApi
+
+All URIs are relative to *https://zernio.com/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_create_contacts**](ContactsApi.md#bulk_create_contacts) | **POST** /v1/contacts/bulk | Bulk create contacts |
+| [**create_contact**](ContactsApi.md#create_contact) | **POST** /v1/contacts | Create a contact |
+| [**delete_contact**](ContactsApi.md#delete_contact) | **DELETE** /v1/contacts/{contactId} | Delete a contact |
+| [**get_contact**](ContactsApi.md#get_contact) | **GET** /v1/contacts/{contactId} | Get contact with channels |
+| [**get_contact_channels**](ContactsApi.md#get_contact_channels) | **GET** /v1/contacts/{contactId}/channels | List channels for a contact |
+| [**list_contacts**](ContactsApi.md#list_contacts) | **GET** /v1/contacts | List contacts |
+| [**update_contact**](ContactsApi.md#update_contact) | **PATCH** /v1/contacts/{contactId} | Update a contact |
+
+
+## bulk_create_contacts
+
+> bulk_create_contacts(bulk_create_contacts_request)
+
+Bulk create contacts
+
+Import up to 1000 contacts at a time. Skips duplicates.
+
+### 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::ContactsApi.new
+bulk_create_contacts_request = Late::BulkCreateContactsRequest.new({profile_id: 'profile_id_example', account_id: 'account_id_example', platform: 'platform_example', contacts: [Late::BulkCreateContactsRequestContactsInner.new({name: 'name_example', platform_identifier: 'platform_identifier_example'})]}) # BulkCreateContactsRequest | 
+
+begin
+  # Bulk create contacts
+  api_instance.bulk_create_contacts(bulk_create_contacts_request)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->bulk_create_contacts: #{e}"
+end
+```
+
+#### Using the bulk_create_contacts_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)> bulk_create_contacts_with_http_info(bulk_create_contacts_request)
+
+```ruby
+begin
+  # Bulk create contacts
+  data, status_code, headers = api_instance.bulk_create_contacts_with_http_info(bulk_create_contacts_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->bulk_create_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_create_contacts_request** | [**BulkCreateContactsRequest**](BulkCreateContactsRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_contact
+
+> create_contact(create_contact_request)
+
+Create a contact
+
+Create a new contact. Optionally create a platform channel in the same request by providing accountId, platform, and platformIdentifier.
+
+### 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::ContactsApi.new
+create_contact_request = Late::CreateContactRequest.new({profile_id: 'profile_id_example', name: 'name_example'}) # CreateContactRequest | 
+
+begin
+  # Create a contact
+  api_instance.create_contact(create_contact_request)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->create_contact: #{e}"
+end
+```
+
+#### Using the create_contact_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_contact_with_http_info(create_contact_request)
+
+```ruby
+begin
+  # Create a contact
+  data, status_code, headers = api_instance.create_contact_with_http_info(create_contact_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->create_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_contact_request** | [**CreateContactRequest**](CreateContactRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_contact
+
+> delete_contact(contact_id)
+
+Delete a contact
+
+### 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::ContactsApi.new
+contact_id = 'contact_id_example' # String | 
+
+begin
+  # Delete a contact
+  api_instance.delete_contact(contact_id)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact: #{e}"
+end
+```
+
+#### Using the delete_contact_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_contact_with_http_info(contact_id)
+
+```ruby
+begin
+  # Delete a contact
+  data, status_code, headers = api_instance.delete_contact_with_http_info(contact_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->delete_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_contact
+
+> get_contact(contact_id)
+
+Get contact with channels
+
+### 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::ContactsApi.new
+contact_id = 'contact_id_example' # String | 
+
+begin
+  # Get contact with channels
+  api_instance.get_contact(contact_id)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->get_contact: #{e}"
+end
+```
+
+#### Using the get_contact_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_contact_with_http_info(contact_id)
+
+```ruby
+begin
+  # Get contact with channels
+  data, status_code, headers = api_instance.get_contact_with_http_info(contact_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_contact_channels
+
+> get_contact_channels(contact_id)
+
+List channels for a contact
+
+### 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::ContactsApi.new
+contact_id = 'contact_id_example' # String | 
+
+begin
+  # List channels for a contact
+  api_instance.get_contact_channels(contact_id)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_channels: #{e}"
+end
+```
+
+#### Using the get_contact_channels_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_contact_channels_with_http_info(contact_id)
+
+```ruby
+begin
+  # List channels for a contact
+  data, status_code, headers = api_instance.get_contact_channels_with_http_info(contact_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->get_contact_channels_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_contacts
+
+> list_contacts(profile_id, opts)
+
+List contacts
+
+List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and full-text search.
+
+### 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::ContactsApi.new
+profile_id = 'profile_id_example' # String | 
+opts = {
+  search: 'search_example', # String | 
+  tag: 'tag_example', # String | 
+  platform: 'instagram', # String | 
+  is_subscribed: 'true', # String | 
+  limit: 56, # Integer | 
+  skip: 56 # Integer | 
+}
+
+begin
+  # List contacts
+  api_instance.list_contacts(profile_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->list_contacts: #{e}"
+end
+```
+
+#### Using the list_contacts_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_contacts_with_http_info(profile_id, opts)
+
+```ruby
+begin
+  # List contacts
+  data, status_code, headers = api_instance.list_contacts_with_http_info(profile_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->list_contacts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **search** | **String** |  | [optional] |
+| **tag** | **String** |  | [optional] |
+| **platform** | **String** |  | [optional] |
+| **is_subscribed** | **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
+
+
+## update_contact
+
+> update_contact(contact_id, opts)
+
+Update a contact
+
+### 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::ContactsApi.new
+contact_id = 'contact_id_example' # String | 
+opts = {
+  update_contact_request: Late::UpdateContactRequest.new # UpdateContactRequest | 
+}
+
+begin
+  # Update a contact
+  api_instance.update_contact(contact_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->update_contact: #{e}"
+end
+```
+
+#### Using the update_contact_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_contact_with_http_info(contact_id, opts)
+
+```ruby
+begin
+  # Update a contact
+  data, status_code, headers = api_instance.update_contact_with_http_info(contact_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling ContactsApi->update_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contact_id** | **String** |  |  |
+| **update_contact_request** | [**UpdateContactRequest**](UpdateContactRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateBroadcastRequest.md

@@ -0,0 +1,32 @@
+# Late::CreateBroadcastRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **message** | [**CreateBroadcastRequestMessage**](CreateBroadcastRequestMessage.md) |  | [optional] |
+| **template** | [**CreateBroadcastRequestTemplate**](CreateBroadcastRequestTemplate.md) |  | [optional] |
+| **segment_filters** | [**CreateBroadcastRequestSegmentFilters**](CreateBroadcastRequestSegmentFilters.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateBroadcastRequest.new(
+  profile_id: null,
+  account_id: null,
+  platform: null,
+  name: null,
+  description: null,
+  message: null,
+  template: null,
+  segment_filters: null
+)
+```
+

data/docs/CreateBroadcastRequestMessage.md

@@ -0,0 +1,20 @@
+# Late::CreateBroadcastRequestMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  | [optional] |
+| **attachments** | [**Array<CreateBroadcastRequestMessageAttachmentsInner>**](CreateBroadcastRequestMessageAttachmentsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateBroadcastRequestMessage.new(
+  text: null,
+  attachments: null
+)
+```
+

data/docs/CreateBroadcastRequestMessageAttachmentsInner.md

@@ -0,0 +1,22 @@
+# Late::CreateBroadcastRequestMessageAttachmentsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **filename** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateBroadcastRequestMessageAttachmentsInner.new(
+  type: null,
+  url: null,
+  filename: null
+)
+```
+

data/docs/CreateBroadcastRequestSegmentFilters.md

@@ -0,0 +1,20 @@
+# Late::CreateBroadcastRequestSegmentFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tags** | **Array<String>** |  | [optional] |
+| **is_subscribed** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateBroadcastRequestSegmentFilters.new(
+  tags: null,
+  is_subscribed: null
+)
+```
+

data/docs/CreateBroadcastRequestTemplate.md

@@ -0,0 +1,22 @@
+# Late::CreateBroadcastRequestTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **language** | **String** |  | [optional] |
+| **components** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateBroadcastRequestTemplate.new(
+  name: null,
+  language: null,
+  components: null
+)
+```
+

data/docs/CreateCommentAutomationRequest.md

@@ -0,0 +1,36 @@
+# Late::CreateCommentAutomationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **account_id** | **String** | Instagram or Facebook account ID |  |
+| **platform_post_id** | **String** | Platform media/post ID |  |
+| **post_id** | **String** | Zernio post ID (optional) | [optional] |
+| **post_title** | **String** | Post content snippet for display | [optional] |
+| **name** | **String** | Automation label |  |
+| **keywords** | **Array<String>** | Trigger keywords (empty = any comment triggers) | [optional] |
+| **match_mode** | **String** |  | [optional][default to 'contains'] |
+| **dm_message** | **String** | DM text to send to commenter |  |
+| **comment_reply** | **String** | Optional public reply to the comment | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateCommentAutomationRequest.new(
+  profile_id: null,
+  account_id: null,
+  platform_post_id: null,
+  post_id: null,
+  post_title: null,
+  name: null,
+  keywords: null,
+  match_mode: null,
+  dm_message: null,
+  comment_reply: null
+)
+```
+

data/docs/CreateContactRequest.md

@@ -0,0 +1,38 @@
+# Late::CreateContactRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **email** | **String** |  | [optional] |
+| **company** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **is_subscribed** | **Boolean** |  | [optional][default to true] |
+| **notes** | **String** |  | [optional] |
+| **account_id** | **String** | Optional. Creates a channel if provided with platform + platformIdentifier | [optional] |
+| **platform** | **String** |  | [optional] |
+| **platform_identifier** | **String** |  | [optional] |
+| **display_identifier** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::CreateContactRequest.new(
+  profile_id: null,
+  name: null,
+  email: null,
+  company: null,
+  tags: null,
+  is_subscribed: null,
+  notes: null,
+  account_id: null,
+  platform: null,
+  platform_identifier: null,
+  display_identifier: null
+)
+```
+