class SmoochApi::TemplateApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create a template for the specified app. @param appId Identifies the app. @param templateCreateBody Body for a createTemplate request. @param [Hash] opts the optional parameters @return [TemplateResponse]

# File lib/smooch-api/api/template_api.rb, line 29
def create_template(appId, templateCreateBody, opts = {})
  data, _status_code, _headers = create_template_with_http_info(appId, templateCreateBody, opts)
  return data
end
create_template_with_http_info(appId, templateCreateBody, opts = {}) click to toggle source

Create a template for the specified app. @param appId Identifies the app. @param templateCreateBody Body for a createTemplate request. @param [Hash] opts the optional parameters @return [Array<(TemplateResponse, Fixnum, Hash)>] TemplateResponse data, response status code and response headers

# File lib/smooch-api/api/template_api.rb, line 40
def create_template_with_http_info(appId, templateCreateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TemplateApi.create_template ..."
  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 TemplateApi.create_template"
  end
  # verify the required parameter 'templateCreateBody' is set
  if @api_client.config.client_side_validation && templateCreateBody.nil?
    fail ArgumentError, "Missing the required parameter 'templateCreateBody' when calling TemplateApi.create_template"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/templates".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(templateCreateBody)
  auth_names = ['basicAuth', 'jwt']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TemplateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplateApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_template(appId, templateId, opts = {}) click to toggle source

Delete the specified template. @param appId Identifies the app. @param templateId Identifies the template. @param [Hash] opts the optional parameters @return [nil]

# File lib/smooch-api/api/template_api.rb, line 90
def delete_template(appId, templateId, opts = {})
  delete_template_with_http_info(appId, templateId, opts)
  return nil
end
delete_template_with_http_info(appId, templateId, opts = {}) click to toggle source

Delete the specified template. @param appId Identifies the app. @param templateId Identifies the template. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/smooch-api/api/template_api.rb, line 101
def delete_template_with_http_info(appId, templateId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TemplateApi.delete_template ..."
  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 TemplateApi.delete_template"
  end
  # verify the required parameter 'templateId' is set
  if @api_client.config.client_side_validation && templateId.nil?
    fail ArgumentError, "Missing the required parameter 'templateId' when calling TemplateApi.delete_template"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/templates/{templateId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'templateId' + '}', templateId.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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplateApi#delete_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_template(appId, templateId, opts = {}) click to toggle source

Get the specified template. @param appId Identifies the app. @param templateId Identifies the template. @param [Hash] opts the optional parameters @return [TemplateResponse]

# File lib/smooch-api/api/template_api.rb, line 150
def get_template(appId, templateId, opts = {})
  data, _status_code, _headers = get_template_with_http_info(appId, templateId, opts)
  return data
end
get_template_with_http_info(appId, templateId, opts = {}) click to toggle source

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

# File lib/smooch-api/api/template_api.rb, line 161
def get_template_with_http_info(appId, templateId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TemplateApi.get_template ..."
  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 TemplateApi.get_template"
  end
  # verify the required parameter 'templateId' is set
  if @api_client.config.client_side_validation && templateId.nil?
    fail ArgumentError, "Missing the required parameter 'templateId' when calling TemplateApi.get_template"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/templates/{templateId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'templateId' + '}', templateId.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 => 'TemplateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplateApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_templates(appId, opts = {}) click to toggle source

List templates for the specified app. @param appId Identifies the app. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of records to return. (default to 25) @option opts [Integer] :offset The number of initial records to skip before picking records to return. (default to 0) @return [ListTemplatesResponse]

# File lib/smooch-api/api/template_api.rb, line 212
def list_templates(appId, opts = {})
  data, _status_code, _headers = list_templates_with_http_info(appId, opts)
  return data
end
list_templates_with_http_info(appId, opts = {}) click to toggle source

List templates for the specified app. @param appId Identifies the app. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of records to return. @option opts [Integer] :offset The number of initial records to skip before picking records to return. @return [Array<(ListTemplatesResponse, Fixnum, Hash)>] ListTemplatesResponse data, response status code and response headers

# File lib/smooch-api/api/template_api.rb, line 224
def list_templates_with_http_info(appId, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TemplateApi.list_templates ..."
  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 TemplateApi.list_templates"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/templates".sub('{' + 'appId' + '}', appId.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # 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 => 'ListTemplatesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplateApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_template(appId, templateId, templateUpdateBody, opts = {}) click to toggle source

Update the specified template. @param appId Identifies the app. @param templateId Identifies the template. @param templateUpdateBody Body for an updateTemplate request. @param [Hash] opts the optional parameters @return [TemplateResponse]

# File lib/smooch-api/api/template_api.rb, line 273
def update_template(appId, templateId, templateUpdateBody, opts = {})
  data, _status_code, _headers = update_template_with_http_info(appId, templateId, templateUpdateBody, opts)
  return data
end
update_template_with_http_info(appId, templateId, templateUpdateBody, opts = {}) click to toggle source

Update the specified template. @param appId Identifies the app. @param templateId Identifies the template. @param templateUpdateBody Body for an updateTemplate request. @param [Hash] opts the optional parameters @return [Array<(TemplateResponse, Fixnum, Hash)>] TemplateResponse data, response status code and response headers

# File lib/smooch-api/api/template_api.rb, line 285
def update_template_with_http_info(appId, templateId, templateUpdateBody, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TemplateApi.update_template ..."
  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 TemplateApi.update_template"
  end
  # verify the required parameter 'templateId' is set
  if @api_client.config.client_side_validation && templateId.nil?
    fail ArgumentError, "Missing the required parameter 'templateId' when calling TemplateApi.update_template"
  end
  # verify the required parameter 'templateUpdateBody' is set
  if @api_client.config.client_side_validation && templateUpdateBody.nil?
    fail ArgumentError, "Missing the required parameter 'templateUpdateBody' when calling TemplateApi.update_template"
  end
  # resource path
  local_var_path = "/v1.1/apps/{appId}/templates/{templateId}".sub('{' + 'appId' + '}', appId.to_s).sub('{' + 'templateId' + '}', templateId.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(templateUpdateBody)
  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 => 'TemplateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TemplateApi#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end