class SmoochApi::MenuApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/smooch-api/api/menu_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_menu(appId, opts = {}) click to toggle source

Remove the specified app’s menu. @param appId Identifies the app. @param [Hash] opts the optional parameters @return [MenuResponse]

# File lib/smooch-api/api/menu_api.rb, line 28
def delete_menu(appId, opts = {})
  data, _status_code, _headers = delete_menu_with_http_info(appId, opts)
  return data
end
delete_menu_with_http_info(appId, opts = {}) click to toggle source

Remove the specified app’s menu. @param appId Identifies the app. @param [Hash] opts the optional parameters @return [Array<(MenuResponse, Fixnum, Hash)>] MenuResponse data, response status code and response headers

# File lib/smooch-api/api/menu_api.rb, line 38
def delete_menu_with_http_info(appId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MenuApi.delete_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling MenuApi.delete_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/menu".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MenuApi#delete_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_menu(appId, opts = {}) click to toggle source

Get the specified app’s menu. @param appId Identifies the app. @param [Hash] opts the optional parameters @return [MenuResponse]

# File lib/smooch-api/api/menu_api.rb, line 83
def get_menu(appId, opts = {})
  data, _status_code, _headers = get_menu_with_http_info(appId, opts)
  return data
end
get_menu_with_http_info(appId, opts = {}) click to toggle source

Get the specified app’s menu. @param appId Identifies the app. @param [Hash] opts the optional parameters @return [Array<(MenuResponse, Fixnum, Hash)>] MenuResponse data, response status code and response headers

# File lib/smooch-api/api/menu_api.rb, line 93
def get_menu_with_http_info(appId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MenuApi.get_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling MenuApi.get_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/menu".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MenuApi#get_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_menu(appId, menuUpdateBody, opts = {}) click to toggle source

Configure the specified app’s menu. @param appId Identifies the app. @param menuUpdateBody Body for a updateMenu request. @param [Hash] opts the optional parameters @return [MenuResponse]

# File lib/smooch-api/api/menu_api.rb, line 139
def update_menu(appId, menuUpdateBody, opts = {})
  data, _status_code, _headers = update_menu_with_http_info(appId, menuUpdateBody, opts)
  return data
end
update_menu_with_http_info(appId, menuUpdateBody, opts = {}) click to toggle source

Configure the specified app’s menu. @param appId Identifies the app. @param menuUpdateBody Body for a updateMenu request. @param [Hash] opts the optional parameters @return [Array<(MenuResponse, Fixnum, Hash)>] MenuResponse data, response status code and response headers

# File lib/smooch-api/api/menu_api.rb, line 150
def update_menu_with_http_info(appId, menuUpdateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MenuApi.update_menu ..."
  end
  # verify the required parameter 'appId' is set
  if @api_client.config.client_side_validation && appId.nil?
    fail ArgumentError, "Missing the required parameter 'appId' when calling MenuApi.update_menu"
  end
  # verify the required parameter 'menuUpdateBody' is set
  if @api_client.config.client_side_validation && menuUpdateBody.nil?
    fail ArgumentError, "Missing the required parameter 'menuUpdateBody' when calling MenuApi.update_menu"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/menu".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(menuUpdateBody)
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MenuResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MenuApi#update_menu\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end