SmoochApi::IntegrationApi

All URIs are relative to https://api.smooch.io

Method	HTTP request	Description
create_integration	POST /v1.1/apps/appId/integrations
create_integration_menu	POST /v1.1/apps/appId/integrations/integrationId/menu
delete_integration	DELETE /v1.1/apps/appId/integrations/integrationId
delete_integration_menu	DELETE /v1.1/apps/appId/integrations/integrationId/menu
get_integration	GET /v1.1/apps/appId/integrations/integrationId
get_integration_menu	GET /v1.1/apps/appId/integrations/integrationId/menu
get_integration_profile	GET /v1.1/apps/appId/integrations/integrationId/profile
list_integrations	GET /v1.1/apps/appId/integrations
update_integration	PUT /v1.1/apps/appId/integrations/integrationId
update_integration_menu	PUT /v1.1/apps/appId/integrations/integrationId/menu
update_integration_profile	PUT /v1.1/apps/appId/integrations/integrationId/profile
upload_integration_profile_photo	PUT /v1.1/apps/appId/integrations/integrationId/profile/photo

create_integration

IntegrationResponse create_integration(appId, integrationCreateBody)

Create an integration for the specified app.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationCreateBody = SmoochApi::IntegrationCreate.new # IntegrationCreate | Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) 


begin
  result = api_instance.create_integration(appId, integrationCreateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->create_integration: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationCreateBody	IntegrationCreate	Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our official docs

Return type

IntegrationResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

create_integration_menu

MenuResponse create_integration_menu(appId, integrationId, menuCreateBody)

Create the specified integration’s menu, overriding the app menu if configured.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.

menuCreateBody = SmoochApi::Menu.new # Menu | Body for a createMenu request.


begin
  result = api_instance.create_integration_menu(appId, integrationId, menuCreateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->create_integration_menu: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.
menuCreateBody	Menu	Body for a createMenu request.

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

delete_integration

delete_integration(appId, integrationId)

Delete the specified integration.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.


begin
  api_instance.delete_integration(appId, integrationId)
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->delete_integration: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.

Return type

nil (empty response body)

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

delete_integration_menu

delete_integration_menu(appId, integrationId)

Delete the specified integration’s menu.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.


begin
  api_instance.delete_integration_menu(appId, integrationId)
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->delete_integration_menu: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.

Return type

nil (empty response body)

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

get_integration

IntegrationResponse get_integration(appId, integrationId)

Get the specified integration.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.


begin
  result = api_instance.get_integration(appId, integrationId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->get_integration: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.

Return type

IntegrationResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

get_integration_menu

MenuResponse get_integration_menu(appId, integrationId)

Get the specified integration's menu.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.


begin
  result = api_instance.get_integration_menu(appId, integrationId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->get_integration_menu: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

get_integration_profile

GetIntegrationProfileResponse get_integration_profile(appId, integrationId)

Get the specified integration’s profile.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.


begin
  result = api_instance.get_integration_profile(appId, integrationId)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->get_integration_profile: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.

Return type

GetIntegrationProfileResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

list_integrations

ListIntegrationsResponse list_integrations(appId, types, limit, offset)

List integrations for the specified app.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

opts = { 
  types: "types_example", # String | List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=*twilio*,*line*. 
  limit: 25, # Integer | The number of records to return.
  offset: 0 # Integer | The number of initial records to skip before picking records to return.
}

begin
  result = api_instance.list_integrations(appId, types, limit, offset)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->list_integrations: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
types	String	List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=twilio,line.	[optional]
limit	Integer	The number of records to return.	[optional] [default to 25]
offset	Integer	The number of initial records to skip before picking records to return.	[optional] [default to 0]

Return type

ListIntegrationsResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

update_integration

IntegrationResponse update_integration(appId, integrationId, integrationUpdateBody)

Update the specified integration.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.

integrationUpdateBody = SmoochApi::IntegrationUpdate.new # IntegrationUpdate | Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#update-integration) 


begin
  result = api_instance.update_integration(appId, integrationId, integrationUpdateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->update_integration: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.
integrationUpdateBody	IntegrationUpdate	Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our official docs

Return type

IntegrationResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

update_integration_menu

MenuResponse update_integration_menu(appId, integrationId, menuUpdateBody)

Update the specified integration’s menu.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.

menuUpdateBody = SmoochApi::Menu.new # Menu | Body for a updateMenu request.


begin
  result = api_instance.update_integration_menu(appId, integrationId, menuUpdateBody)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->update_integration_menu: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.
menuUpdateBody	Menu	Body for a updateMenu request.

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

update_integration_profile

update_integration_profile(appId, integrationId, integrationProfileBody)

Update the specified integration’s profile.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.

integrationProfileBody = SmoochApi::IntegrationProfileUpdate.new # IntegrationProfileUpdate | Body for a profileUpdate request.


begin
  api_instance.update_integration_profile(appId, integrationId, integrationProfileBody)
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->update_integration_profile: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.
integrationProfileBody	IntegrationProfileUpdate	Body for a profileUpdate request.

Return type

nil (empty response body)

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: application/json
• Accept: application/json

upload_integration_profile_photo

UploadIntegrationProfilePhotoResponse upload_integration_profile_photo(appId, integrationId, source)

Upload a photo to be used for the the specified integration’s profile.

Example

# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
  # Configure HTTP basic authorization (recommended): basicAuth
  config.username = 'API_KEY_ID'
  config.password = 'API_KEY_SECRET'


  # OR

  # Configure API key authorization (alternative): jwt
  config.api_key['Authorization'] = 'YOUR JWT'
  config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::IntegrationApi.new

appId = "appId_example" # String | Identifies the app.

integrationId = "integrationId_example" # String | Identifies the integration.

source = File.new("/path/to/file.txt") # File | Photo to be uploaded


begin
  result = api_instance.upload_integration_profile_photo(appId, integrationId, source)
  p result
rescue SmoochApi::ApiError => e
  puts "Exception when calling IntegrationApi->upload_integration_profile_photo: #{e}"
end

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.
integrationId	String	Identifies the integration.
source	File	Photo to be uploaded

Return type

UploadIntegrationProfilePhotoResponse

Authorization

basicAuth, jwt

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json