SmoochApi::MenuApi

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

Method	HTTP request	Description
delete_menu	DELETE /v1.1/apps/appId/menu
get_menu	GET /v1.1/apps/appId/menu
update_menu	PUT /v1.1/apps/appId/menu

delete_menu

MenuResponse delete_menu(appId)

Remove the specified app’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::MenuApi.new

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


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

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

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

get_menu

MenuResponse get_menu(appId)

Get the specified app’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::MenuApi.new

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


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

Parameters

Name	Type	Description	Notes
appId	String	Identifies the app.

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

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

update_menu

MenuResponse update_menu(appId, menuUpdateBody)

Configure the specified app’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::MenuApi.new

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

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


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

Parameters

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

Return type

MenuResponse

Authorization

basicAuth, jwt

HTTP request headers

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