cfchat

Cfchat - the Ruby gem for the CF Chat

This is the API documentation for CF Chat server.

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cfchat.gemspec

Then either install the gem locally:

gem install ./cfchat-1.0.0.gem

(for development, run gem install --dev ./cfchat-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cfchat', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cfchat', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cfchat'

# Setup authorization
Cfchat.configure do |config|
  # Configure API key authorization: userApiKey
  config.api_key['userApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['userApiKey'] = 'Bearer'
end

api_instance = Cfchat::AccountAgentBotsApi.new
account_id = 56 # Integer | The numeric ID of the account
data = Cfchat::AgentBotCreateUpdatePayload.new # AgentBotCreateUpdatePayload | 

begin
  #Create an Agent Bot
  result = api_instance.create_an_account_agent_bot(account_id, data)
  p result
rescue Cfchat::ApiError => e
  puts "Exception when calling AccountAgentBotsApi->create_an_account_agent_bot: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://chat.myclickfunnels.com

Class	Method	HTTP request	Description
Cfchat::AccountAgentBotsApi	create_an_account_agent_bot	POST /api/v1/accounts/{account_id}/agent_bots	Create an Agent Bot
Cfchat::AccountAgentBotsApi	delete_an_account_agent_bot	DELETE /api/v1/accounts/{account_id}/agent_bots/{id}	Delete an AgentBot
Cfchat::AccountAgentBotsApi	get_details_of_a_single_account_agent_bot	GET /api/v1/accounts/{account_id}/agent_bots/{id}	Get an agent bot details
Cfchat::AccountAgentBotsApi	list_all_account_agent_bots	GET /api/v1/accounts/{account_id}/agent_bots	List all AgentBots
Cfchat::AccountAgentBotsApi	update_an_account_agent_bot	PATCH /api/v1/accounts/{account_id}/agent_bots/{id}	Update an agent bot
Cfchat::AccountUsersApi	create_an_account_user	POST /platform/api/v1/accounts/{account_id}/account_users	Create an Account User
Cfchat::AccountUsersApi	delete_an_account_user	DELETE /platform/api/v1/accounts/{account_id}/account_users	Delete an Account User
Cfchat::AccountUsersApi	list_all_account_users	GET /platform/api/v1/accounts/{account_id}/account_users	List all Account Users
Cfchat::AccountsApi	create_an_account	POST /platform/api/v1/accounts	Create an Account
Cfchat::AccountsApi	delete_an_account	DELETE /platform/api/v1/accounts/{account_id}	Delete an Account
Cfchat::AccountsApi	get_details_of_an_account	GET /platform/api/v1/accounts/{account_id}	Get an account details
Cfchat::AccountsApi	update_an_account	PATCH /platform/api/v1/accounts/{account_id}	Update an account
Cfchat::AgentBotsApi	create_an_agent_bot	POST /platform/api/v1/agent_bots	Create an Agent Bot
Cfchat::AgentBotsApi	delete_an_agent_bot	DELETE /platform/api/v1/agent_bots/{id}	Delete an AgentBot
Cfchat::AgentBotsApi	get_details_of_a_single_agent_bot	GET /platform/api/v1/agent_bots/{id}	Get an agent bot details
Cfchat::AgentBotsApi	list_all_agent_bots	GET /platform/api/v1/agent_bots	List all AgentBots
Cfchat::AgentBotsApi	update_an_agent_bot	PATCH /platform/api/v1/agent_bots/{id}	Update an agent bot
Cfchat::AgentsApi	add_new_agent_to_account	POST /api/v1/accounts/{account_id}/agents	Add a New Agent
Cfchat::AgentsApi	delete_agent_from_account	DELETE /api/v1/accounts/{account_id}/agents/{id}	Remove an Agent from Account
Cfchat::AgentsApi	get_account_agents	GET /api/v1/accounts/{account_id}/agents	List Agents in Account
Cfchat::AgentsApi	update_agent_in_account	PATCH /api/v1/accounts/{account_id}/agents/{id}	Update Agent in Account
Cfchat::AutomationRuleApi	add_new_automation_rule_to_account	POST /api/v1/accounts/{account_id}/automation_rules	Add a new automation rule
Cfchat::AutomationRuleApi	delete_automation_rule_from_account	DELETE /api/v1/accounts/{account_id}/automation_rules/{id}	Remove a automation rule from account
Cfchat::AutomationRuleApi	get_account_automation_rule	GET /api/v1/accounts/{account_id}/automation_rules	List all automation rules in an account
Cfchat::AutomationRuleApi	get_details_of_a_single_automation_rule	GET /api/v1/accounts/{account_id}/automation_rules/{id}	Get a automation rule details
Cfchat::AutomationRuleApi	update_automation_rule_in_account	PATCH /api/v1/accounts/{account_id}/automation_rules/{id}	Update automation rule in Account
Cfchat::CannedResponseApi	update_canned_response_in_account	PATCH /api/v1/accounts/{account_id}/canned_responses/{id}	Update Canned Response in Account
Cfchat::CannedResponsesApi	add_new_canned_response_to_account	POST /api/v1/accounts/{account_id}/canned_responses	Add a New Canned Response
Cfchat::CannedResponsesApi	delete_canned_response_from_account	DELETE /api/v1/accounts/{account_id}/canned_responses/{id}	Remove a Canned Response from Account
Cfchat::CannedResponsesApi	get_account_canned_response	GET /api/v1/accounts/{account_id}/canned_responses	List all Canned Responses in an Account
Cfchat::ContactApi	contact_inbox_creation	POST /api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes	Create contact inbox
Cfchat::ContactApi	contactable_inboxes_get	GET /api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes	Get Contactable Inboxes
Cfchat::ContactsApi	contact_conversations	GET /api/v1/accounts/{account_id}/contacts/{id}/conversations	Contact Conversations
Cfchat::ContactsApi	contact_create	POST /api/v1/accounts/{account_id}/contacts	Create Contact
Cfchat::ContactsApi	contact_delete	DELETE /api/v1/accounts/{account_id}/contacts/{id}	Delete Contact
Cfchat::ContactsApi	contact_details	GET /api/v1/accounts/{account_id}/contacts/{id}	Show Contact
Cfchat::ContactsApi	contact_filter	POST /api/v1/accounts/{account_id}/contacts/filter	Contact Filter
Cfchat::ContactsApi	contact_list	GET /api/v1/accounts/{account_id}/contacts	List Contacts
Cfchat::ContactsApi	contact_search	GET /api/v1/accounts/{account_id}/contacts/search	Search Contacts
Cfchat::ContactsApi	contact_update	PUT /api/v1/accounts/{account_id}/contacts/{id}	Update Contact
Cfchat::ContactsAPIApi	create_a_contact	POST /public/api/v1/inboxes/{inbox_identifier}/contacts	Create a contact
Cfchat::ContactsAPIApi	get_details_of_a_contact	GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}	Get a contact
Cfchat::ContactsAPIApi	update_a_contact	PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}	Update a contact
Cfchat::ConversationAssignmentApi	assign_a_conversation	POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments	Assign Conversation
Cfchat::ConversationLabelsApi	conversation_add_labels	POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels	Add Labels
Cfchat::ConversationLabelsApi	list_all_labels_of_a_conversation	GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/labels	List Labels
Cfchat::ConversationsApi	conversation_filter	POST /api/v1/accounts/{account_id}/conversations/filter	Conversations Filter
Cfchat::ConversationsApi	conversation_list	GET /api/v1/accounts/{account_id}/conversations	Conversations List
Cfchat::ConversationsApi	conversation_list_meta	GET /api/v1/accounts/{account_id}/conversations/meta	Get Conversation Counts
Cfchat::ConversationsApi	get_details_of_a_conversation	GET /api/v1/accounts/{account_id}/conversations/{conversation_id}	Conversation Details
Cfchat::ConversationsApi	new_conversation	POST /api/v1/accounts/{account_id}/conversations	Create New Conversation
Cfchat::ConversationsApi	toggle_status_of_a_conversation	POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status	Toggle Status
Cfchat::ConversationsAPIApi	create_a_conversation	POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations	Create a conversation
Cfchat::ConversationsAPIApi	list_all_contact_conversations	GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations	List all conversations
Cfchat::CustomAttributesApi	add_new_custom_attribute_to_account	POST /api/v1/accounts/{account_id}/custom_attribute_definitions	Add a new custom attribute
Cfchat::CustomAttributesApi	delete_custom_attribute_from_account	DELETE /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}	Remove a custom attribute from account
Cfchat::CustomAttributesApi	get_account_custom_attribute	GET /api/v1/accounts/{account_id}/custom_attribute_definitions	List all custom attributes in an account
Cfchat::CustomAttributesApi	get_details_of_a_single_custom_attribute	GET /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}	Get a custom attribute details
Cfchat::CustomAttributesApi	update_custom_attribute_in_account	PATCH /api/v1/accounts/{account_id}/custom_attribute_definitions/{id}	Update custom attribute in Account
Cfchat::CustomFiltersApi	create_a_custom_filter	POST /api/v1/accounts/{account_id}/custom_filters	Create a custom filter
Cfchat::CustomFiltersApi	delete_a_custom_filter	DELETE /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}	Delete a custom filter
Cfchat::CustomFiltersApi	get_details_of_a_single_custom_filter	GET /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}	Get a custom filter details
Cfchat::CustomFiltersApi	list_all_filters	GET /api/v1/accounts/{account_id}/custom_filters	List all custom filters
Cfchat::CustomFiltersApi	update_a_custom_filter	PATCH /api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}	Update a custom filter
Cfchat::InboxAPIApi	get_details_of_a_inbox	GET /public/api/v1/inboxes/{inbox_identifier}	Inbox details
Cfchat::InboxesApi	add_new_agent_to_inbox	POST /api/v1/accounts/{account_id}/inbox_members	Add a New Agent
Cfchat::InboxesApi	delete_agent_in_inbox	DELETE /api/v1/accounts/{account_id}/inbox_members	Remove an Agent from Inbox
Cfchat::InboxesApi	get_inbox	GET /api/v1/accounts/{account_id}/inboxes/{id}/	Get an inbox
Cfchat::InboxesApi	get_inbox_agent_bot	GET /api/v1/accounts/{account_id}/inboxes/{id}/agent_bot	Show Inbox Agent Bot
Cfchat::InboxesApi	get_inbox_members	GET /api/v1/accounts/{account_id}/inbox_members/{inbox_id}	List Agents in Inbox
Cfchat::InboxesApi	inbox_creation	POST /api/v1/accounts/{account_id}/inboxes/	Create an inbox
Cfchat::InboxesApi	list_all_inboxes	GET /api/v1/accounts/{account_id}/inboxes	List all inboxes
Cfchat::InboxesApi	update_agent_bot	POST /api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot	Add or remove agent bot
Cfchat::InboxesApi	update_agents_in_inbox	PATCH /api/v1/accounts/{account_id}/inbox_members	Update Agents in Inbox
Cfchat::InboxesApi	update_inbox	PATCH /api/v1/accounts/{account_id}/inboxes/{id}	Update Inbox
Cfchat::IntegrationsApi	create_an_integration_hook	POST /api/v1/accounts/{account_id}/integrations/hooks	Create an integration hook
Cfchat::IntegrationsApi	delete_an_integration_hook	DELETE /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}	Delete an Integration Hook
Cfchat::IntegrationsApi	get_details_of_all_integrations	GET /api/v1/accounts/{account_id}/integrations/apps	List all the Integrations
Cfchat::IntegrationsApi	update_an_integrations_hook	PATCH /api/v1/accounts/{account_id}/integrations/hooks/{hook_id}	Update an Integration Hook
Cfchat::MessagesApi	create_a_new_message_in_a_conversation	POST /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages	Create New Message
Cfchat::MessagesApi	delete_a_message	DELETE /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}	Delete a message
Cfchat::MessagesApi	list_all_messages	GET /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages	Get messages
Cfchat::MessagesAPIApi	create_a_message	POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages	Create a message
Cfchat::MessagesAPIApi	list_all_converation_messages	GET /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages	List all messages
Cfchat::MessagesAPIApi	update_a_message	PATCH /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}	Update a message
Cfchat::ProfileApi	fetch_profile	GET /api/v1/profile	Fetch user profile
Cfchat::ReportsApi	get_account_conversation_metrics	GET /api/v2/accounts/{account_id}/reports/conversations	Account Conversation Metrics
Cfchat::ReportsApi	get_agent_conversation_metrics	GET /api/v2/accounts/{account_id}/reports/conversations/	Agent Conversation Metrics
Cfchat::ReportsApi	list_all_conversation_statistics	GET /api/v2/accounts/{account_id}/reports	Get Account reports
Cfchat::ReportsApi	list_all_conversation_statistics_summary	GET /api/v2/accounts/{account_id}/reports/summary	Get Account reports summary
Cfchat::TeamsApi	add_new_agent_to_team	POST /api/v1/accounts/{account_id}/teams/{team_id}/team_members	Add a New Agent
Cfchat::TeamsApi	create_a_team	POST /api/v1/accounts/{account_id}/teams	Create a team
Cfchat::TeamsApi	delete_a_team	DELETE /api/v1/accounts/{account_id}/teams/{team_id}	Delete a team
Cfchat::TeamsApi	delete_agent_in_team	DELETE /api/v1/accounts/{account_id}/teams/{team_id}/team_members	Remove an Agent from Team
Cfchat::TeamsApi	get_details_of_a_single_team	GET /api/v1/accounts/{account_id}/teams/{team_id}	Get a team details
Cfchat::TeamsApi	get_team_members	GET /api/v1/accounts/{account_id}/teams/{team_id}/team_members	List Agents in Team
Cfchat::TeamsApi	list_all_teams	GET /api/v1/accounts/{account_id}/teams	List all teams
Cfchat::TeamsApi	update_a_team	PATCH /api/v1/accounts/{account_id}/teams/{team_id}	Update a team
Cfchat::TeamsApi	update_agents_in_team	PATCH /api/v1/accounts/{account_id}/teams/{team_id}/team_members	Update Agents in Team
Cfchat::UsersApi	create_a_user	POST /platform/api/v1/users	Create a User
Cfchat::UsersApi	delete_a_user	DELETE /platform/api/v1/users/{id}	Delete a User
Cfchat::UsersApi	get_details_of_a_user	GET /platform/api/v1/users/{id}	Get an user details
Cfchat::UsersApi	get_sso_url_of_a_user	GET /platform/api/v1/users/{id}/login	Get User SSO Link
Cfchat::UsersApi	update_a_user	PATCH /platform/api/v1/users/{id}	Update a user
Cfchat::WebhooksApi	create_a_webhook	POST /api/v1/accounts/{account_id}/webhooks	Add a webhook
Cfchat::WebhooksApi	delete_a_webhook	DELETE /api/v1/accounts/{account_id}/webhooks/{webhook_id}	Delete a webhook
Cfchat::WebhooksApi	list_all_webhooks	GET /api/v1/accounts/{account_id}/webhooks	List all webhooks
Cfchat::WebhooksApi	update_a_webhook	PATCH /api/v1/accounts/{account_id}/webhooks/{webhook_id}	Update a webhook object

Documentation for Models

• Cfchat::Account
• Cfchat::AccountCreateUpdatePayload
• Cfchat::AccountSummary
• Cfchat::AccountSummaryPrevious
• Cfchat::AddNewAgentToAccountRequest
• Cfchat::AddNewAgentToInboxRequest
• Cfchat::AddNewAgentToTeamRequest
• Cfchat::Agent
• Cfchat::AgentBot
• Cfchat::AgentBotCreateUpdatePayload
• Cfchat::AgentConversationMetrics
• Cfchat::AgentConversationMetricsMetric
• Cfchat::AssignAConversationRequest
• Cfchat::AutomationRule
• Cfchat::AutomationRuleCreateUpdatePayload
• Cfchat::BadRequestError
• Cfchat::CannedResponse
• Cfchat::CannedResponseCreateUpdatePayload
• Cfchat::Contact
• Cfchat::ContactBase
• Cfchat::ContactConversationsInner
• Cfchat::ContactConversationsInnerAllOf
• Cfchat::ContactConversationsInnerAllOf1
• Cfchat::ContactConversationsInnerAllOfMeta
• Cfchat::ContactConversationsInnerAllOfMetaSender
• Cfchat::ContactCreate
• Cfchat::ContactFilterRequestInner
• Cfchat::ContactInboxCreationRequest
• Cfchat::ContactInboxes
• Cfchat::ContactListInner
• Cfchat::ContactPayload
• Cfchat::ContactPayloadContact
• Cfchat::ContactSearch200Response
• Cfchat::ContactUpdate
• Cfchat::ContactableInboxes
• Cfchat::Conversation
• Cfchat::ConversationAddLabelsRequest
• Cfchat::ConversationLabels
• Cfchat::ConversationList
• Cfchat::ConversationListData
• Cfchat::ConversationListDataPayloadInner
• Cfchat::ConversationListMeta200Response
• Cfchat::ConversationListMeta200ResponseMeta
• Cfchat::ConversationMessageCreate
• Cfchat::ConversationShow
• Cfchat::ConversationShowAllOf
• Cfchat::ConversationShowAllOfMeta
• Cfchat::ConversationShowAllOfMetaSender
• Cfchat::ConversationStatusToggle
• Cfchat::ConversationStatusTogglePayload
• Cfchat::CreateANewMessageInAConversation200Response
• Cfchat::CreateAnAccountUserRequest
• Cfchat::CustomAttribute
• Cfchat::CustomAttributeCreateUpdatePayload
• Cfchat::CustomFilter
• Cfchat::CustomFilterCreateUpdatePayload
• Cfchat::DeleteAgentInInboxRequest
• Cfchat::DeleteAgentInTeamRequest
• Cfchat::DeleteAnAccountUserRequest
• Cfchat::ExtendedContact
• Cfchat::ExtendedContactAllOf
• Cfchat::GenericId
• Cfchat::GetAccountConversationMetrics200Response
• Cfchat::GetSsoUrlOfAUser200Response
• Cfchat::Inbox
• Cfchat::InboxCreationRequest
• Cfchat::InboxCreationRequestChannel
• Cfchat::IntegrationsApp
• Cfchat::IntegrationsHook
• Cfchat::IntegrationsHookCreatePayload
• Cfchat::IntegrationsHookUpdatePayload
• Cfchat::ListAllAccountUsers200ResponseInner
• Cfchat::ListAllConversationStatistics200ResponseInner
• Cfchat::ListAllMessages200ResponseInner
• Cfchat::Message
• Cfchat::NewConversation200Response
• Cfchat::NewConversationRequest
• Cfchat::PlatformAccount
• Cfchat::PublicContact
• Cfchat::PublicContactCreateUpdatePayload
• Cfchat::PublicConversation
• Cfchat::PublicInbox
• Cfchat::PublicInboxWorkingHoursInner
• Cfchat::PublicMessage
• Cfchat::PublicMessageCreatePayload
• Cfchat::PublicMessageUpdatePayload
• Cfchat::RequestError
• Cfchat::Team
• Cfchat::TeamCreateUpdatePayload
• Cfchat::ToggleStatusOfAConversationRequest
• Cfchat::UpdateAgentBotRequest
• Cfchat::UpdateAgentInAccountRequest
• Cfchat::UpdateInboxRequest
• Cfchat::UpdateInboxRequestChannel
• Cfchat::User
• Cfchat::UserCreateUpdatePayload
• Cfchat::Webhook
• Cfchat::WebhookCreateUpdatePayload

Documentation for Authorization

Authentication schemes defined for the API:

userApiKey

• Type: API key
• API key parameter name: api_access_token
• Location: HTTP header

agentBotApiKey

• Type: API key
• API key parameter name: api_access_token
• Location: HTTP header

platformAppApiKey

• Type: API key
• API key parameter name: api_access_token
• Location: HTTP header