Class: TriglavClient::MessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/triglav_client/api/messages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagesApi

Returns a new instance of MessagesApi.



30
31
32
 
# File 'lib/triglav_client/api/messages_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/triglav_client/api/messages_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#fetch_messages(offset, opts = {}) ⇒ Array<MessageEachResponse>

Fetch messages

Parameters:

  • offset —

    Offset (Greater than or equal to) ID for Messages to list from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of limits

  • :resource_uris (String) —

    URIs of Resource

Returns:



41
42
43
44
 
# File 'lib/triglav_client/api/messages_api.rb', line 41

def fetch_messages(offset, opts = {})
  data, _status_code, _headers = fetch_messages_with_http_info(offset, opts)
  return data
end

#fetch_messages_with_http_info(offset, opts = {}) ⇒ Array<(Array<MessageEachResponse>, Fixnum, Hash)>

Fetch messages

Parameters:

  • offset —

    Offset (Greater than or equal to) ID for Messages to list from

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of limits

  • :resource_uris (String) —

    URIs of Resource

Returns:

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

    Array<MessageEachResponse> data, response status code and response headers



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/triglav_client/api/messages_api.rb', line 53

def fetch_messages_with_http_info(offset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.fetch_messages ..."
  end
  # verify the required parameter 'offset' is set
  fail ArgumentError, "Missing the required parameter 'offset' when calling MessagesApi.fetch_messages" if offset.nil?
  # resource path
  local_var_path = "/messages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'resource_uris'] = opts[:'resource_uris'] if !opts[:'resource_uris'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'Array<MessageEachResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#fetch_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_last_message_id(opts = {}) ⇒ LastMessageIdResponse

Get the current last message id which would be used as a first offset to fetch messages

Parameters:

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/triglav_client/api/messages_api.rb', line 102

def get_last_message_id(opts = {})
  data, _status_code, _headers = get_last_message_id_with_http_info(opts)
  return data
end

#get_last_message_id_with_http_info(opts = {}) ⇒ Array<(LastMessageIdResponse, Fixnum, Hash)>

Get the current last message id which would be used as a first offset to fetch messages

Parameters:

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

    the optional parameters

Returns:

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

    LastMessageIdResponse data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/triglav_client/api/messages_api.rb', line 111

def get_last_message_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.get_last_message_id ..."
  end
  # resource path
  local_var_path = "/messages/last_id".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'LastMessageIdResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#get_last_message_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_messages(messages, opts = {}) ⇒ BulkinsertResponse

Enqueues new messages

Parameters:

  • messages —

    Messages to enqueue

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/triglav_client/api/messages_api.rb', line 156

def send_messages(messages, opts = {})
  data, _status_code, _headers = send_messages_with_http_info(messages, opts)
  return data
end

#send_messages_with_http_info(messages, opts = {}) ⇒ Array<(BulkinsertResponse, Fixnum, Hash)>

Enqueues new messages

Parameters:

  • messages —

    Messages to enqueue

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

    the optional parameters

Returns:

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

    BulkinsertResponse data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/triglav_client/api/messages_api.rb', line 166

def send_messages_with_http_info(messages, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.send_messages ..."
  end
  # verify the required parameter 'messages' is set
  fail ArgumentError, "Missing the required parameter 'messages' when calling MessagesApi.send_messages" if messages.nil?
  # resource path
  local_var_path = "/messages".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(messages)
  auth_names = ['api_key']
  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 => 'BulkinsertResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#send_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end