class IntegrationApi::SMSApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_vendor_call_limit(sms_id, opts = {}) click to toggle source

Fetch details for corresponding sms_id Fetch details for corresponding sms_id @param sms_id sms_id @param [Hash] opts the optional parameters @return [SMS]

# File lib/integration_api/api/sms_api.rb, line 27
def get_vendor_call_limit(sms_id, opts = {})
  data, _status_code, _headers = get_vendor_call_limit_with_http_info(sms_id, opts)
  data
end
get_vendor_call_limit_with_http_info(sms_id, opts = {}) click to toggle source

Fetch details for corresponding sms_id Fetch details for corresponding sms_id @param sms_id sms_id @param [Hash] opts the optional parameters @return [Array<(SMS, Fixnum, Hash)>] SMS data, response status code and response headers

# File lib/integration_api/api/sms_api.rb, line 37
def get_vendor_call_limit_with_http_info(sms_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSApi.get_vendor_call_limit ...'
  end
  # verify the required parameter 'sms_id' is set
  if @api_client.config.client_side_validation && sms_id.nil?
    fail ArgumentError, "Missing the required parameter 'sms_id' when calling SMSApi.get_vendor_call_limit"
  end
  # resource path
  local_var_path = '/sms/status/{sms_id}'.sub('{' + 'sms_id' + '}', sms_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'SMS')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SMSApi#get_vendor_call_limit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
send_mail(sms_vo, opts = {}) click to toggle source

Send SMS to recipient Send SMS to recipient @param sms_vo smsVO @param [Hash] opts the optional parameters @return [SMSResponseVO]

# File lib/integration_api/api/sms_api.rb, line 79
def send_mail(sms_vo, opts = {})
  data, _status_code, _headers = send_mail_with_http_info(sms_vo, opts)
  data
end
send_mail_with_http_info(sms_vo, opts = {}) click to toggle source

Send SMS to recipient Send SMS to recipient @param sms_vo smsVO @param [Hash] opts the optional parameters @return [Array<(SMSResponseVO, Fixnum, Hash)>] SMSResponseVO data, response status code and response headers

# File lib/integration_api/api/sms_api.rb, line 89
def send_mail_with_http_info(sms_vo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SMSApi.send_mail ...'
  end
  # verify the required parameter 'sms_vo' is set
  if @api_client.config.client_side_validation && sms_vo.nil?
    fail ArgumentError, "Missing the required parameter 'sms_vo' when calling SMSApi.send_mail"
  end
  # resource path
  local_var_path = '/sms'

  # 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(sms_vo)
  auth_names = ['oauth2']
  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 => 'SMSResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SMSApi#send_mail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end