class ClickSendClient::MMSApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

mms_price_post(mms_messages, opts = {}) click to toggle source

Get Price for MMS sent Get Price for MMS sent @param mms_messages MmsMessageCollection model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/mms_api.rb, line 27
def mms_price_post(mms_messages, opts = {})
  data, _status_code, _headers = mms_price_post_with_http_info(mms_messages, opts)
  data
end
mms_price_post_with_http_info(mms_messages, opts = {}) click to toggle source

Get Price for MMS sent Get Price for MMS sent @param mms_messages MmsMessageCollection model @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/mms_api.rb, line 37
def mms_price_post_with_http_info(mms_messages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_price_post ...'
  end
  # verify the required parameter 'mms_messages' is set
  if @api_client.config.client_side_validation && mms_messages.nil?
    fail ArgumentError, "Missing the required parameter 'mms_messages' when calling MMSApi.mms_price_post"
  end
  # resource path
  local_var_path = '/mms/price'

  # 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(mms_messages)
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mms_receipts_get(opts = {}) click to toggle source

Get all delivery receipts Get all delivery receipts @param [Hash] opts the optional parameters @option opts [Integer] :page Page number (default to 1) @option opts [Integer] :limit Number of records per page (default to 10) @return [String]

# File lib/clicksend_client/api/mms_api.rb, line 82
def mms_receipts_get(opts = {})
  data, _status_code, _headers = mms_receipts_get_with_http_info(opts)
  data
end
mms_receipts_get_with_http_info(opts = {}) click to toggle source

Get all delivery receipts Get all delivery receipts @param [Hash] opts the optional parameters @option opts [Integer] :page Page number @option opts [Integer] :limit Number of records per page @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/mms_api.rb, line 93
def mms_receipts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_receipts_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MMSApi.mms_receipts_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MMSApi.mms_receipts_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/mms/receipts'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_receipts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mms_receipts_read_put(opts = {}) click to toggle source

Mark delivery receipts as read Mark delivery receipts as read @param [Hash] opts the optional parameters @option opts [DateBefore] :date_before DateBefore model @return [String]

# File lib/clicksend_client/api/mms_api.rb, line 143
def mms_receipts_read_put(opts = {})
  data, _status_code, _headers = mms_receipts_read_put_with_http_info(opts)
  data
end
mms_receipts_read_put_with_http_info(opts = {}) click to toggle source

Mark delivery receipts as read Mark delivery receipts as read @param [Hash] opts the optional parameters @option opts [DateBefore] :date_before DateBefore model @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/mms_api.rb, line 153
def mms_receipts_read_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_receipts_read_put ...'
  end
  # resource path
  local_var_path = '/mms/receipts-read'

  # 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(opts[:'date_before'])
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MMSApi#mms_receipts_read_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
mms_send_post(mms_messages, opts = {}) click to toggle source

Send MMS Send MMS @param mms_messages MmsMessageCollection model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/mms_api.rb, line 193
def mms_send_post(mms_messages, opts = {})
  data, _status_code, _headers = mms_send_post_with_http_info(mms_messages, opts)
  data
end
mms_send_post_with_http_info(mms_messages, opts = {}) click to toggle source

Send MMS Send MMS @param mms_messages MmsMessageCollection model @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/mms_api.rb, line 203
def mms_send_post_with_http_info(mms_messages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MMSApi.mms_send_post ...'
  end
  # verify the required parameter 'mms_messages' is set
  if @api_client.config.client_side_validation && mms_messages.nil?
    fail ArgumentError, "Missing the required parameter 'mms_messages' when calling MMSApi.mms_send_post"
  end
  # resource path
  local_var_path = '/mms/send'

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