class SwaggerClient::AppUserApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/swagger_client/api/app_user_api.rb, line 18
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

app_user_device_update(user_id, device_id, app_user_device_update, opts = {}) click to toggle source

Update specified device information. @param user_id Identifies the user. Can be either the smoochId or the userId. @param device_id Id of the device. @param app_user_device_update Supported properties for an updateAppUserDevice request. @param [Hash] opts the optional parameters @return [ClientResponse]

# File lib/swagger_client/api/app_user_api.rb, line 29
def app_user_device_update(user_id, device_id, app_user_device_update, opts = {})
  data, _status_code, _headers = app_user_device_update_with_http_info(user_id, device_id, app_user_device_update, opts)
  return data
end
app_user_device_update_with_http_info(user_id, device_id, app_user_device_update, opts = {}) click to toggle source

Update specified device information. @param user_id Identifies the user. Can be either the smoochId or the userId. @param device_id Id of the device. @param app_user_device_update Supported properties for an updateAppUserDevice request. @param [Hash] opts the optional parameters @return [Array<(ClientResponse, Fixnum, Hash)>] ClientResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 41
def app_user_device_update_with_http_info(user_id, device_id, app_user_device_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.app_user_device_update ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.app_user_device_update" if user_id.nil?
  # verify the required parameter 'device_id' is set
  fail ArgumentError, "Missing the required parameter 'device_id' when calling AppUserApi.app_user_device_update" if device_id.nil?
  # verify the required parameter 'app_user_device_update' is set
  fail ArgumentError, "Missing the required parameter 'app_user_device_update' when calling AppUserApi.app_user_device_update" if app_user_device_update.nil?
  # resource path
  local_var_path = "/appusers/{userId}/devices/{deviceId}".sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'deviceId' + '}', device_id.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(app_user_device_update)
  auth_names = ['appToken', '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 => 'ClientResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#app_user_device_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_app_user_profile(user_id, opts = {}) click to toggle source

Delete specified app users profile. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [AppUserResponse]

# File lib/swagger_client/api/app_user_api.rb, line 88
def delete_app_user_profile(user_id, opts = {})
  data, _status_code, _headers = delete_app_user_profile_with_http_info(user_id, opts)
  return data
end
delete_app_user_profile_with_http_info(user_id, opts = {}) click to toggle source

Delete specified app users profile. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 98
def delete_app_user_profile_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.delete_app_user_profile ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.delete_app_user_profile" if user_id.nil?
  # resource path
  local_var_path = "/appusers/{userId}/profile".sub('{' + 'userId' + '}', user_id.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 = ['appToken', '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 => 'AppUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#delete_app_user_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_app_user(user_id, opts = {}) click to toggle source

Get the specified app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [AppUserResponse]

# File lib/swagger_client/api/app_user_api.rb, line 141
def get_app_user(user_id, opts = {})
  data, _status_code, _headers = get_app_user_with_http_info(user_id, opts)
  return data
end
get_app_user_entity_ids(user_id, opts = {}) click to toggle source

Get specified app users channel entity IDs. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [AppUserResponse]

# File lib/swagger_client/api/app_user_api.rb, line 194
def get_app_user_entity_ids(user_id, opts = {})
  data, _status_code, _headers = get_app_user_entity_ids_with_http_info(user_id, opts)
  return data
end
get_app_user_entity_ids_with_http_info(user_id, opts = {}) click to toggle source

Get specified app users channel entity IDs. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 204
def get_app_user_entity_ids_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.get_app_user_entity_ids ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.get_app_user_entity_ids" if user_id.nil?
  # resource path
  local_var_path = "/appusers/{userId}/channels".sub('{' + 'userId' + '}', user_id.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 = ['appToken', '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 => 'AppUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#get_app_user_entity_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_app_user_with_http_info(user_id, opts = {}) click to toggle source

Get the specified app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param [Hash] opts the optional parameters @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 151
def get_app_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.get_app_user ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.get_app_user" if user_id.nil?
  # resource path
  local_var_path = "/appusers/{userId}".sub('{' + 'userId' + '}', user_id.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 = ['appToken', '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 => 'AppUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#get_app_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_image_message(user_id, source, role, opts = {}) click to toggle source

Send an image message to the conversation @param user_id Identifies the user. Can be either the smoochId or the userId. @param source Image to be uploaded @param role Role of the sender @param [Hash] opts the optional parameters @return [MessageResponse]

# File lib/swagger_client/api/app_user_api.rb, line 306
def post_image_message(user_id, source, role, opts = {})
  data, _status_code, _headers = post_image_message_with_http_info(user_id, source, role, opts)
  return data
end
post_image_message_with_http_info(user_id, source, role, opts = {}) click to toggle source

Send an image message to the conversation @param user_id Identifies the user. Can be either the smoochId or the userId. @param source Image to be uploaded @param role Role of the sender @param [Hash] opts the optional parameters @return [Array<(MessageResponse, Fixnum, Hash)>] MessageResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 318
def post_image_message_with_http_info(user_id, source, role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.post_image_message ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.post_image_message" if user_id.nil?
  # verify the required parameter 'source' is set
  fail ArgumentError, "Missing the required parameter 'source' when calling AppUserApi.post_image_message" if source.nil?
  # verify the required parameter 'role' is set
  fail ArgumentError, "Missing the required parameter 'role' when calling AppUserApi.post_image_message" if role.nil?
  # resource path
  local_var_path = "/appusers/{userId}/images".sub('{' + 'userId' + '}', user_id.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["source"] = source
  form_params["role"] = role

  # http body (model)
  post_body = nil
  auth_names = ['appToken', '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 => 'MessageResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#post_image_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
pre_create_app_user(app_user_pre_create, opts = {}) click to toggle source

Pre-create an app user. @param app_user_pre_create Supported properties for a preCreateAppUser request. @param [Hash] opts the optional parameters @return [AppUserResponse]

# File lib/swagger_client/api/app_user_api.rb, line 367
def pre_create_app_user(app_user_pre_create, opts = {})
  data, _status_code, _headers = pre_create_app_user_with_http_info(app_user_pre_create, opts)
  return data
end
pre_create_app_user_with_http_info(app_user_pre_create, opts = {}) click to toggle source

Pre-create an app user. @param app_user_pre_create Supported properties for a preCreateAppUser request. @param [Hash] opts the optional parameters @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 377
def pre_create_app_user_with_http_info(app_user_pre_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.pre_create_app_user ..."
  end
  # verify the required parameter 'app_user_pre_create' is set
  fail ArgumentError, "Missing the required parameter 'app_user_pre_create' when calling AppUserApi.pre_create_app_user" if app_user_pre_create.nil?
  # resource path
  local_var_path = "/appusers"

  # 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(app_user_pre_create)
  auth_names = ['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 => 'AppUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#pre_create_app_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
track_event(user_id, event, opts = {}) click to toggle source

Track an event for the given app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param event Supported properties for a trackEvent request. @param [Hash] opts the optional parameters @return [TrackEventResponse]

# File lib/swagger_client/api/app_user_api.rb, line 421
def track_event(user_id, event, opts = {})
  data, _status_code, _headers = track_event_with_http_info(user_id, event, opts)
  return data
end
track_event_with_http_info(user_id, event, opts = {}) click to toggle source

Track an event for the given app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param event Supported properties for a trackEvent request. @param [Hash] opts the optional parameters @return [Array<(TrackEventResponse, Fixnum, Hash)>] TrackEventResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 432
def track_event_with_http_info(user_id, event, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.track_event ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.track_event" if user_id.nil?
  # verify the required parameter 'event' is set
  fail ArgumentError, "Missing the required parameter 'event' when calling AppUserApi.track_event" if event.nil?
  # resource path
  local_var_path = "/appusers/{userId}/events".sub('{' + 'userId' + '}', user_id.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(event)
  auth_names = ['appToken', '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 => 'TrackEventResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#track_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_app_user(user_id, app_user_update, opts = {}) click to toggle source

Update the specified app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param app_user_update Supported properties for an updateAppUser request. @param [Hash] opts the optional parameters @return [AppUserResponse]

# File lib/swagger_client/api/app_user_api.rb, line 534
def update_app_user(user_id, app_user_update, opts = {})
  data, _status_code, _headers = update_app_user_with_http_info(user_id, app_user_update, opts)
  return data
end
update_app_user_with_http_info(user_id, app_user_update, opts = {}) click to toggle source

Update the specified app user. @param user_id Identifies the user. Can be either the smoochId or the userId. @param app_user_update Supported properties for an updateAppUser request. @param [Hash] opts the optional parameters @return [Array<(AppUserResponse, Fixnum, Hash)>] AppUserResponse data, response status code and response headers

# File lib/swagger_client/api/app_user_api.rb, line 545
def update_app_user_with_http_info(user_id, app_user_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppUserApi.update_app_user ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling AppUserApi.update_app_user" if user_id.nil?
  # verify the required parameter 'app_user_update' is set
  fail ArgumentError, "Missing the required parameter 'app_user_update' when calling AppUserApi.update_app_user" if app_user_update.nil?
  # resource path
  local_var_path = "/appusers/{userId}".sub('{' + 'userId' + '}', user_id.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(app_user_update)
  auth_names = ['appToken', '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 => 'AppUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppUserApi#update_app_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end