class Omnichannel::DeliveryReportApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/omnichannel/api/delivery_report_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
retrieve_delivery_report(omnimessage_id, opts = {})
click to toggle source
Retrieves the delivery report for the Omnimessage
@param omnimessage_id UUID of the Omnimessage
to for which the delivery report is to be retrieved @param [Hash] opts the optional parameters @return [DeliveryReportResponse]
# 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 = {})
click to toggle source
Retrieves the delivery report for the Omnimessage
@param omnimessage_id UUID of the Omnimessage
to for which the delivery report is to be retrieved @param [Hash] opts the optional parameters @return [Array<(DeliveryReportResponse
, Fixnum, Hash)>] DeliveryReportResponse
data, response status code and response headers
# 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