RainbowSubmarineTest3356::MenuApi

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

Method	HTTP request	Description
delete_menu	DELETE /menu
get_menu	GET /menu
update_menu	PUT /menu

delete_menu

MenuResponse delete_menu

Remove the specified app’s menu.

Example

# load the gem
require 'rainbow-submarine-test-3356'
# setup authorization
RainbowSubmarineTest3356.configure do |config|
  # Configure API key authorization: appToken
  config.api_key['app-token'] = '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['app-token'] = 'Bearer'

  # Configure API key authorization: jwt
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = RainbowSubmarineTest3356::MenuApi.new

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

Parameters

This endpoint does not need any parameter.

Return type

MenuResponse

Authorization

appToken, jwt

HTTP request headers

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

get_menu

MenuResponse get_menu

Get the specified app’s menu.

Example

# load the gem
require 'rainbow-submarine-test-3356'
# setup authorization
RainbowSubmarineTest3356.configure do |config|
  # Configure API key authorization: jwt
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = RainbowSubmarineTest3356::MenuApi.new

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

Parameters

This endpoint does not need any parameter.

Return type

MenuResponse

Authorization

jwt

HTTP request headers

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

update_menu

MenuResponse update_menu(menu_update)

Configure the specified app’s menu.

Example

# load the gem
require 'rainbow-submarine-test-3356'
# setup authorization
RainbowSubmarineTest3356.configure do |config|
  # Configure API key authorization: jwt
  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
end

api_instance = RainbowSubmarineTest3356::MenuApi.new

menu_update = RainbowSubmarineTest3356::Menu.new # Menu | Supported properties for a updateMenu request.


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

Parameters

Name	Type	Description	Notes
menu_update	Menu	Supported properties for a updateMenu request.

Return type

MenuResponse

Authorization

jwt

HTTP request headers

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