Class: Omnichannel::OmnimessageApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OmnimessageApi

Returns a new instance of OmnimessageApi.



19
20
21
 
# File 'lib/omnichannel/api/omnimessage_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/omnimessage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_scheduled_message(omnimessage_id, opts = {}) ⇒ nil

Cancels a scheduled Omnimessage

Parameters:

  • omnimessage_id —

    UUID of the scheduled Omnimessage to be cancelled

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# 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

#cancel_scheduled_message_with_http_info(omnimessage_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancels a scheduled Omnimessage

Parameters:

  • omnimessage_id —

    UUID of the scheduled Omnimessage to be cancelled

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

    the optional parameters

Returns:

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

    nil, 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
 
# 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

#send_omnimessage(omnimessage, opts = {}) ⇒ OmniMessageCreateSuccessResponse

Sends an Omnimessage

Parameters:

  • omnimessage —

    Omnimessage to be sent

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

    the optional parameters

Returns:



76
77
78
79
 
# 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

#send_omnimessage_with_http_info(omnimessage, opts = {}) ⇒ Array<(OmniMessageCreateSuccessResponse, Fixnum, Hash)>

Sends an Omnimessage

Parameters:

  • omnimessage —

    Omnimessage to be sent

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

    the optional parameters

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# 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