Class: Teleswagger::MessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/teleswagger/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/teleswagger/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/teleswagger/api/messages_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#delete_message(token, chat_id, message_id, opts = {}) ⇒ ResponseBool

Parameters:

  • token —

    bot's token to authorize the request

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

    the optional parameters

Returns:



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

def delete_message(token, chat_id, message_id, opts = {})
  data, _status_code, _headers = delete_message_with_http_info(token, chat_id, message_id, opts)
  return data
end

#delete_message_with_http_info(token, chat_id, message_id, opts = {}) ⇒ Array<(ResponseBool, Fixnum, Hash)>

Returns ResponseBool data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Returns:

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

    ResponseBool 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
97
98
99
 
# File 'lib/teleswagger/api/messages_api.rb', line 53

def delete_message_with_http_info(token, chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.delete_message ..."
  end
  # verify the required parameter 'token' is set
  fail ArgumentError, "Missing the required parameter 'token' when calling MessagesApi.delete_message" if token.nil?
  # verify the required parameter 'chat_id' is set
  fail ArgumentError, "Missing the required parameter 'chat_id' when calling MessagesApi.delete_message" if chat_id.nil?
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling MessagesApi.delete_message" if message_id.nil?
  # resource path
  local_var_path = "/bot{token}/deleteMessage".sub('{format}','json').sub('{' + 'token' + '}', token.to_s)

  # query parameters
  query_params = {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_id'] = message_id

  # 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 = []
  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 => 'ResponseBool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#delete_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_caption(token, opts = {}) ⇒ InlineResponse200

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:



107
108
109
110
 
# File 'lib/teleswagger/api/messages_api.rb', line 107

def edit_message_caption(token, opts = {})
  data, _status_code, _headers = edit_message_caption_with_http_info(token, opts)
  return data
end

#edit_message_caption_with_http_info(token, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Returns InlineResponse200 data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse200 data, response status code and response headers



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
150
151
152
153
154
155
156
157
158
 
# File 'lib/teleswagger/api/messages_api.rb', line 118

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

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

#edit_message_reply_markup(token, opts = {}) ⇒ InlineResponse200

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:



166
167
168
169
 
# File 'lib/teleswagger/api/messages_api.rb', line 166

def edit_message_reply_markup(token, opts = {})
  data, _status_code, _headers = edit_message_reply_markup_with_http_info(token, opts)
  return data
end

#edit_message_reply_markup_with_http_info(token, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Returns InlineResponse200 data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse200 data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/teleswagger/api/messages_api.rb', line 177

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

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

#edit_message_text(token, opts = {}) ⇒ InlineResponse200

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:



225
226
227
228
 
# File 'lib/teleswagger/api/messages_api.rb', line 225

def edit_message_text(token, opts = {})
  data, _status_code, _headers = edit_message_text_with_http_info(token, opts)
  return data
end

#edit_message_text_with_http_info(token, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Returns InlineResponse200 data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse200 data, response status code and response headers



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/teleswagger/api/messages_api.rb', line 236

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

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

#forward_message(token, chat_id, from_chat_id, message_id, opts = {}) ⇒ ResponseMessage

Parameters:

  • token —

    bot&#39;s token to authorize the request

  • chat_id
  • from_chat_id
  • message_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :disable_notification (BOOLEAN)

Returns:



287
288
289
290
 
# File 'lib/teleswagger/api/messages_api.rb', line 287

def forward_message(token, chat_id, from_chat_id, message_id, opts = {})
  data, _status_code, _headers = forward_message_with_http_info(token, chat_id, from_chat_id, message_id, opts)
  return data
end

#forward_message_with_http_info(token, chat_id, from_chat_id, message_id, opts = {}) ⇒ Array<(ResponseMessage, Fixnum, Hash)>

Returns ResponseMessage data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

  • chat_id
  • from_chat_id
  • message_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :disable_notification (BOOLEAN)

Returns:

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

    ResponseMessage data, response status code and response headers



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/teleswagger/api/messages_api.rb', line 301

def forward_message_with_http_info(token, chat_id, from_chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.forward_message ..."
  end
  # verify the required parameter 'token' is set
  fail ArgumentError, "Missing the required parameter 'token' when calling MessagesApi.forward_message" if token.nil?
  # verify the required parameter 'chat_id' is set
  fail ArgumentError, "Missing the required parameter 'chat_id' when calling MessagesApi.forward_message" if chat_id.nil?
  # verify the required parameter 'from_chat_id' is set
  fail ArgumentError, "Missing the required parameter 'from_chat_id' when calling MessagesApi.forward_message" if from_chat_id.nil?
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling MessagesApi.forward_message" if message_id.nil?
  # resource path
  local_var_path = "/bot{token}/forwardMessage".sub('{format}','json').sub('{' + 'token' + '}', token.to_s)

  # 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/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["chat_id"] = chat_id
  form_params["from_chat_id"] = from_chat_id
  form_params["message_id"] = message_id
  form_params["disable_notification"] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?

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

#send_message(token, opts = {}) ⇒ ResponseMessage

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:



359
360
361
362
 
# File 'lib/teleswagger/api/messages_api.rb', line 359

def send_message(token, opts = {})
  data, _status_code, _headers = send_message_with_http_info(token, opts)
  return data
end

#send_message_bytes(token, body, opts = {}) ⇒ ResponseMessage

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Returns:



418
419
420
421
 
# File 'lib/teleswagger/api/messages_api.rb', line 418

def send_message_bytes(token, body, opts = {})
  data, _status_code, _headers = send_message_bytes_with_http_info(token, body, opts)
  return data
end

#send_message_bytes_with_http_info(token, body, opts = {}) ⇒ Array<(ResponseMessage, Fixnum, Hash)>

Returns ResponseMessage data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Returns:

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

    ResponseMessage data, response status code and response headers



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/teleswagger/api/messages_api.rb', line 429

def send_message_bytes_with_http_info(token, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MessagesApi.send_message_bytes ..."
  end
  # verify the required parameter 'token' is set
  fail ArgumentError, "Missing the required parameter 'token' when calling MessagesApi.send_message_bytes" if token.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MessagesApi.send_message_bytes" if body.nil?
  # resource path
  local_var_path = "/bot{token}/sendMessage#bytes".sub('{format}','json').sub('{' + 'token' + '}', token.to_s)

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

#send_message_with_http_info(token, opts = {}) ⇒ Array<(ResponseMessage, Fixnum, Hash)>

Returns ResponseMessage data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ResponseMessage data, response status code and response headers



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/teleswagger/api/messages_api.rb', line 370

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

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