Class: Omnichannel::DeliveryReportApi

Inherits:
Object
  • Object
show all
Defined in:
lib/omnichannel/api/delivery_report_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliveryReportApi

Returns a new instance of DeliveryReportApi.



19
20
21
 
# File 'lib/omnichannel/api/delivery_report_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/omnichannel/api/delivery_report_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#retrieve_delivery_report(omnimessage_id, opts = {}) ⇒ DeliveryReportResponse

Retrieves the delivery report for the Omnimessage

Parameters:

  • omnimessage_id —

    UUID of the Omnimessage to for which the delivery report is to be retrieved

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/omnichannel/api/delivery_report_api.rb', line 26

def retrieve_delivery_report(omnimessage_id, opts = {})
  data, _status_code, _headers = retrieve_delivery_report_with_http_info(omnimessage_id, opts)
  data
end

#retrieve_delivery_report_with_http_info(omnimessage_id, opts = {}) ⇒ Array<(DeliveryReportResponse, Fixnum, Hash)>

Retrieves the delivery report for the Omnimessage

Parameters:

  • omnimessage_id —

    UUID of the Omnimessage to for which the delivery report is to be retrieved

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DeliveryReportResponse, Fixnum, Hash)>) —

    DeliveryReportResponse data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/omnichannel/api/delivery_report_api.rb', line 35

def retrieve_delivery_report_with_http_info(omnimessage_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryReportApi.retrieve_delivery_report ...'
  end
  # verify the required parameter 'omnimessage_id' is set
  if @api_client.config.client_side_validation && omnimessage_id.nil?
    fail ArgumentError, "Missing the required parameter 'omnimessage_id' when calling DeliveryReportApi.retrieve_delivery_report"
  end
  # resource path
  local_var_path = '/omnimessage/{omnimessage_id}/status'.sub('{' + 'omnimessage_id' + '}', omnimessage_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 = ['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 => 'DeliveryReportResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeliveryReportApi#retrieve_delivery_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end