class Omnichannel::OmnimessageApi
Attributes
Public Class Methods
# File lib/omnichannel/api/omnimessage_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Cancels a scheduled Omnimessage
@param omnimessage_id UUID of the scheduled Omnimessage
to be cancelled @param [Hash] opts the optional parameters @return [nil]
# File lib/omnichannel/api/omnimessage_api.rb, line 26 def cancel_scheduled_message(omnimessage_id, opts = {}) cancel_scheduled_message_with_http_info(omnimessage_id, opts) nil end
Cancels a scheduled Omnimessage
@param omnimessage_id UUID of the scheduled Omnimessage
to be cancelled @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/omnichannel/api/omnimessage_api.rb, line 35 def cancel_scheduled_message_with_http_info(omnimessage_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OmnimessageApi.cancel_scheduled_message ...' 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 OmnimessageApi.cancel_scheduled_message" end # resource path local_var_path = '/omnimessage/{omnimessage_id}'.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(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: OmnimessageApi#cancel_scheduled_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Sends an Omnimessage
@param omnimessage Omnimessage
to be sent @param [Hash] opts the optional parameters @return [OmniMessageCreateSuccessResponse]
# File lib/omnichannel/api/omnimessage_api.rb, line 76 def send_omnimessage(omnimessage, opts = {}) data, _status_code, _headers = send_omnimessage_with_http_info(omnimessage, opts) data end
Sends an Omnimessage
@param omnimessage Omnimessage
to be sent @param [Hash] opts the optional parameters @return [Array<(OmniMessageCreateSuccessResponse
, Fixnum, Hash)>] OmniMessageCreateSuccessResponse
data, response status code and response headers
# File lib/omnichannel/api/omnimessage_api.rb, line 85 def send_omnimessage_with_http_info(omnimessage, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OmnimessageApi.send_omnimessage ...' end # verify the required parameter 'omnimessage' is set if @api_client.config.client_side_validation && omnimessage.nil? fail ArgumentError, "Missing the required parameter 'omnimessage' when calling OmnimessageApi.send_omnimessage" end # resource path local_var_path = '/omnimessage' # 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(omnimessage) 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 => 'OmniMessageCreateSuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: OmnimessageApi#send_omnimessage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end