late-sdk 0.0.67 → 0.0.69

data/docs/BulkCreateContactsRequestContactsInner.md

@@ -0,0 +1,28 @@
+# Late::BulkCreateContactsRequestContactsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **platform_identifier** | **String** |  |  |
+| **display_identifier** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **company** | **String** |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'late-sdk'
+
+instance = Late::BulkCreateContactsRequestContactsInner.new(
+  name: null,
+  platform_identifier: null,
+  display_identifier: null,
+  email: null,
+  company: null,
+  tags: null
+)
+```
+

data/docs/CommentAutomationsApi.md

@@ -0,0 +1,428 @@
+# Late::CommentAutomationsApi
+
+All URIs are relative to *https://zernio.com/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_comment_automation**](CommentAutomationsApi.md#create_comment_automation) | **POST** /v1/comment-automations | Create a comment-to-DM automation |
+| [**delete_comment_automation**](CommentAutomationsApi.md#delete_comment_automation) | **DELETE** /v1/comment-automations/{automationId} | Delete automation and all logs |
+| [**get_comment_automation**](CommentAutomationsApi.md#get_comment_automation) | **GET** /v1/comment-automations/{automationId} | Get automation details with recent logs |
+| [**list_comment_automation_logs**](CommentAutomationsApi.md#list_comment_automation_logs) | **GET** /v1/comment-automations/{automationId}/logs | List trigger logs for an automation |
+| [**list_comment_automations**](CommentAutomationsApi.md#list_comment_automations) | **GET** /v1/comment-automations | List comment-to-DM automations |
+| [**update_comment_automation**](CommentAutomationsApi.md#update_comment_automation) | **PATCH** /v1/comment-automations/{automationId} | Update automation settings |
+
+
+## create_comment_automation
+
+> create_comment_automation(create_comment_automation_request)
+
+Create a comment-to-DM automation
+
+Create a keyword-triggered DM automation on an Instagram or Facebook post. When someone comments a matching keyword, they automatically receive a DM. Only one active automation per post is allowed. 
+
+### 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::CommentAutomationsApi.new
+create_comment_automation_request = Late::CreateCommentAutomationRequest.new({profile_id: 'profile_id_example', account_id: 'account_id_example', platform_post_id: 'platform_post_id_example', name: 'name_example', dm_message: 'dm_message_example'}) # CreateCommentAutomationRequest | 
+
+begin
+  # Create a comment-to-DM automation
+  api_instance.create_comment_automation(create_comment_automation_request)
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->create_comment_automation: #{e}"
+end
+```
+
+#### Using the create_comment_automation_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_comment_automation_with_http_info(create_comment_automation_request)
+
+```ruby
+begin
+  # Create a comment-to-DM automation
+  data, status_code, headers = api_instance.create_comment_automation_with_http_info(create_comment_automation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->create_comment_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_comment_automation_request** | [**CreateCommentAutomationRequest**](CreateCommentAutomationRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_comment_automation
+
+> delete_comment_automation(automation_id)
+
+Delete automation and all logs
+
+### 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::CommentAutomationsApi.new
+automation_id = 'automation_id_example' # String | 
+
+begin
+  # Delete automation and all logs
+  api_instance.delete_comment_automation(automation_id)
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->delete_comment_automation: #{e}"
+end
+```
+
+#### Using the delete_comment_automation_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_comment_automation_with_http_info(automation_id)
+
+```ruby
+begin
+  # Delete automation and all logs
+  data, status_code, headers = api_instance.delete_comment_automation_with_http_info(automation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->delete_comment_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **automation_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_comment_automation
+
+> get_comment_automation(automation_id)
+
+Get automation details with recent logs
+
+### 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::CommentAutomationsApi.new
+automation_id = 'automation_id_example' # String | 
+
+begin
+  # Get automation details with recent logs
+  api_instance.get_comment_automation(automation_id)
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->get_comment_automation: #{e}"
+end
+```
+
+#### Using the get_comment_automation_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_comment_automation_with_http_info(automation_id)
+
+```ruby
+begin
+  # Get automation details with recent logs
+  data, status_code, headers = api_instance.get_comment_automation_with_http_info(automation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->get_comment_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **automation_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_comment_automation_logs
+
+> list_comment_automation_logs(automation_id, opts)
+
+List trigger logs for an automation
+
+Paginated list of every comment that triggered this automation, with send status and commenter info.
+
+### 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::CommentAutomationsApi.new
+automation_id = 'automation_id_example' # String | 
+opts = {
+  status: 'sent', # String | Filter by result status
+  limit: 56, # Integer | 
+  skip: 56 # Integer | 
+}
+
+begin
+  # List trigger logs for an automation
+  api_instance.list_comment_automation_logs(automation_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->list_comment_automation_logs: #{e}"
+end
+```
+
+#### Using the list_comment_automation_logs_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_comment_automation_logs_with_http_info(automation_id, opts)
+
+```ruby
+begin
+  # List trigger logs for an automation
+  data, status_code, headers = api_instance.list_comment_automation_logs_with_http_info(automation_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->list_comment_automation_logs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **automation_id** | **String** |  |  |
+| **status** | **String** | Filter by result status | [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_comment_automations
+
+> <ListCommentAutomations200Response> list_comment_automations(profile_id)
+
+List comment-to-DM automations
+
+List all comment-to-DM automations for a profile. Returns automations with their stats.
+
+### 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::CommentAutomationsApi.new
+profile_id = 'profile_id_example' # String | Profile ID
+
+begin
+  # List comment-to-DM automations
+  result = api_instance.list_comment_automations(profile_id)
+  p result
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->list_comment_automations: #{e}"
+end
+```
+
+#### Using the list_comment_automations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCommentAutomations200Response>, Integer, Hash)> list_comment_automations_with_http_info(profile_id)
+
+```ruby
+begin
+  # List comment-to-DM automations
+  data, status_code, headers = api_instance.list_comment_automations_with_http_info(profile_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCommentAutomations200Response>
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->list_comment_automations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** | Profile ID |  |
+
+### Return type
+
+[**ListCommentAutomations200Response**](ListCommentAutomations200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_comment_automation
+
+> update_comment_automation(automation_id, opts)
+
+Update automation settings
+
+### 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::CommentAutomationsApi.new
+automation_id = 'automation_id_example' # String | 
+opts = {
+  update_comment_automation_request: Late::UpdateCommentAutomationRequest.new # UpdateCommentAutomationRequest | 
+}
+
+begin
+  # Update automation settings
+  api_instance.update_comment_automation(automation_id, opts)
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->update_comment_automation: #{e}"
+end
+```
+
+#### Using the update_comment_automation_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_comment_automation_with_http_info(automation_id, opts)
+
+```ruby
+begin
+  # Update automation settings
+  data, status_code, headers = api_instance.update_comment_automation_with_http_info(automation_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Late::ApiError => e
+  puts "Error when calling CommentAutomationsApi->update_comment_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **automation_id** | **String** |  |  |
+| **update_comment_automation_request** | [**UpdateCommentAutomationRequest**](UpdateCommentAutomationRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+