Class: TelegramBot::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/telegram-bot/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/telegram-bot/api/default_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/telegram-bot/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_sticker_to_set(user_id, name, sticker, opts = {}) ⇒ SetWebhook200Response

addStickerToSet Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • sticker (InputSticker)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/telegram-bot/api/default_api.rb', line 29

def add_sticker_to_set(user_id, name, sticker, opts = {})
  data, _status_code, _headers = add_sticker_to_set_with_http_info(user_id, name, sticker, opts)
  data
end

#add_sticker_to_set_with_http_info(user_id, name, sticker, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

addStickerToSet Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • sticker (InputSticker)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



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
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
 
# File 'lib/telegram-bot/api/default_api.rb', line 41

def add_sticker_to_set_with_http_info(user_id, name, sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.add_sticker_to_set ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.add_sticker_to_set"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.add_sticker_to_set"
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.add_sticker_to_set"
  end
  # resource path
  local_var_path = '/addStickerToSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'name'] = name
  query_params[:'sticker'] = sticker

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.add_sticker_to_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#add_sticker_to_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#answer_callback_query(callback_query_id, opts = {}) ⇒ SetWebhook200Response

answerCallbackQuery Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :text (String)
  • :show_alert (Boolean)
  • :url (String)
  • :cache_time (Integer)

Returns:



109
110
111
112
 
# File 'lib/telegram-bot/api/default_api.rb', line 109

def answer_callback_query(callback_query_id, opts = {})
  data, _status_code, _headers = answer_callback_query_with_http_info(callback_query_id, opts)
  data
end

#answer_callback_query_with_http_info(callback_query_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

answerCallbackQuery Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :text (String)
  • :show_alert (Boolean)
  • :url (String)
  • :cache_time (Integer)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/telegram-bot/api/default_api.rb', line 123

def answer_callback_query_with_http_info(callback_query_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.answer_callback_query ...'
  end
  # verify the required parameter 'callback_query_id' is set
  if @api_client.config.client_side_validation && callback_query_id.nil?
    fail ArgumentError, "Missing the required parameter 'callback_query_id' when calling DefaultApi.answer_callback_query"
  end
  # resource path
  local_var_path = '/answerCallbackQuery'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'callback_query_id'] = callback_query_id
  query_params[:'text'] = opts[:'text'] if !opts[:'text'].nil?
  query_params[:'show_alert'] = opts[:'show_alert'] if !opts[:'show_alert'].nil?
  query_params[:'url'] = opts[:'url'] if !opts[:'url'].nil?
  query_params[:'cache_time'] = opts[:'cache_time'] if !opts[:'cache_time'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.answer_callback_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#answer_callback_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#answer_inline_query(inline_query_id, results, opts = {}) ⇒ SetWebhook200Response

answerInlineQuery Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Parameters:

  • inline_query_id (String)
  • results (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



186
187
188
189
 
# File 'lib/telegram-bot/api/default_api.rb', line 186

def answer_inline_query(inline_query_id, results, opts = {})
  data, _status_code, _headers = answer_inline_query_with_http_info(inline_query_id, results, opts)
  data
end

#answer_inline_query_with_http_info(inline_query_id, results, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

answerInlineQuery Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed.

Parameters:

  • inline_query_id (String)
  • results (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/telegram-bot/api/default_api.rb', line 201

def answer_inline_query_with_http_info(inline_query_id, results, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.answer_inline_query ...'
  end
  # verify the required parameter 'inline_query_id' is set
  if @api_client.config.client_side_validation && inline_query_id.nil?
    fail ArgumentError, "Missing the required parameter 'inline_query_id' when calling DefaultApi.answer_inline_query"
  end
  # verify the required parameter 'results' is set
  if @api_client.config.client_side_validation && results.nil?
    fail ArgumentError, "Missing the required parameter 'results' when calling DefaultApi.answer_inline_query"
  end
  # resource path
  local_var_path = '/answerInlineQuery'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'inline_query_id'] = inline_query_id
  query_params[:'results'] = @api_client.build_collection_param(results, :multi)
  query_params[:'cache_time'] = opts[:'cache_time'] if !opts[:'cache_time'].nil?
  query_params[:'is_personal'] = opts[:'is_personal'] if !opts[:'is_personal'].nil?
  query_params[:'next_offset'] = opts[:'next_offset'] if !opts[:'next_offset'].nil?
  query_params[:'button'] = opts[:'button'] if !opts[:'button'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.answer_inline_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#answer_inline_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#answer_pre_checkout_query(pre_checkout_query_id, ok, opts = {}) ⇒ SetWebhook200Response

answerPreCheckoutQuery Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Parameters:

  • pre_checkout_query_id (String)
  • ok (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :error_message (String)

Returns:



266
267
268
269
 
# File 'lib/telegram-bot/api/default_api.rb', line 266

def answer_pre_checkout_query(pre_checkout_query_id, ok, opts = {})
  data, _status_code, _headers = answer_pre_checkout_query_with_http_info(pre_checkout_query_id, ok, opts)
  data
end

#answer_pre_checkout_query_with_http_info(pre_checkout_query_id, ok, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

answerPreCheckoutQuery Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.

Parameters:

  • pre_checkout_query_id (String)
  • ok (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :error_message (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
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
 
# File 'lib/telegram-bot/api/default_api.rb', line 278

def answer_pre_checkout_query_with_http_info(pre_checkout_query_id, ok, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.answer_pre_checkout_query ...'
  end
  # verify the required parameter 'pre_checkout_query_id' is set
  if @api_client.config.client_side_validation && pre_checkout_query_id.nil?
    fail ArgumentError, "Missing the required parameter 'pre_checkout_query_id' when calling DefaultApi.answer_pre_checkout_query"
  end
  # verify the required parameter 'ok' is set
  if @api_client.config.client_side_validation && ok.nil?
    fail ArgumentError, "Missing the required parameter 'ok' when calling DefaultApi.answer_pre_checkout_query"
  end
  # resource path
  local_var_path = '/answerPreCheckoutQuery'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pre_checkout_query_id'] = pre_checkout_query_id
  query_params[:'ok'] = ok
  query_params[:'error_message'] = opts[:'error_message'] if !opts[:'error_message'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.answer_pre_checkout_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#answer_pre_checkout_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#answer_shipping_query(shipping_query_id, ok, opts = {}) ⇒ SetWebhook200Response

answerShippingQuery If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Parameters:

  • shipping_query_id (String)
  • ok (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



341
342
343
344
 
# File 'lib/telegram-bot/api/default_api.rb', line 341

def answer_shipping_query(shipping_query_id, ok, opts = {})
  data, _status_code, _headers = answer_shipping_query_with_http_info(shipping_query_id, ok, opts)
  data
end

#answer_shipping_query_with_http_info(shipping_query_id, ok, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

answerShippingQuery If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.

Parameters:

  • shipping_query_id (String)
  • ok (Boolean)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
 
# File 'lib/telegram-bot/api/default_api.rb', line 354

def answer_shipping_query_with_http_info(shipping_query_id, ok, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.answer_shipping_query ...'
  end
  # verify the required parameter 'shipping_query_id' is set
  if @api_client.config.client_side_validation && shipping_query_id.nil?
    fail ArgumentError, "Missing the required parameter 'shipping_query_id' when calling DefaultApi.answer_shipping_query"
  end
  # verify the required parameter 'ok' is set
  if @api_client.config.client_side_validation && ok.nil?
    fail ArgumentError, "Missing the required parameter 'ok' when calling DefaultApi.answer_shipping_query"
  end
  # resource path
  local_var_path = '/answerShippingQuery'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'shipping_query_id'] = shipping_query_id
  query_params[:'ok'] = ok
  query_params[:'shipping_options'] = @api_client.build_collection_param(opts[:'shipping_options'], :multi) if !opts[:'shipping_options'].nil?
  query_params[:'error_message'] = opts[:'error_message'] if !opts[:'error_message'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.answer_shipping_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#answer_shipping_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#answer_web_app_query(web_app_query_id, result, opts = {}) ⇒ AnswerWebAppQuery200Response

answerWebAppQuery Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Parameters:

  • web_app_query_id (String)
  • result (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



416
417
418
419
 
# File 'lib/telegram-bot/api/default_api.rb', line 416

def answer_web_app_query(web_app_query_id, result, opts = {})
  data, _status_code, _headers = answer_web_app_query_with_http_info(web_app_query_id, result, opts)
  data
end

#answer_web_app_query_with_http_info(web_app_query_id, result, opts = {}) ⇒ Array<(AnswerWebAppQuery200Response, Integer, Hash)>

answerWebAppQuery Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

Parameters:

  • web_app_query_id (String)
  • result (Object)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



427
428
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
472
473
474
475
476
477
478
479
 
# File 'lib/telegram-bot/api/default_api.rb', line 427

def answer_web_app_query_with_http_info(web_app_query_id, result, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.answer_web_app_query ...'
  end
  # verify the required parameter 'web_app_query_id' is set
  if @api_client.config.client_side_validation && web_app_query_id.nil?
    fail ArgumentError, "Missing the required parameter 'web_app_query_id' when calling DefaultApi.answer_web_app_query"
  end
  # verify the required parameter 'result' is set
  if @api_client.config.client_side_validation && result.nil?
    fail ArgumentError, "Missing the required parameter 'result' when calling DefaultApi.answer_web_app_query"
  end
  # resource path
  local_var_path = '/answerWebAppQuery'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'web_app_query_id'] = web_app_query_id
  query_params[:'result'] = result

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'AnswerWebAppQuery200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.answer_web_app_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#answer_web_app_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#approve_chat_join_request(chat_id, user_id, opts = {}) ⇒ SetWebhook200Response

approveChatJoinRequest Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters:

Returns:



487
488
489
490
 
# File 'lib/telegram-bot/api/default_api.rb', line 487

def approve_chat_join_request(chat_id, user_id, opts = {})
  data, _status_code, _headers = approve_chat_join_request_with_http_info(chat_id, user_id, opts)
  data
end

#approve_chat_join_request_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

approveChatJoinRequest Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/telegram-bot/api/default_api.rb', line 498

def approve_chat_join_request_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.approve_chat_join_request ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.approve_chat_join_request"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.approve_chat_join_request"
  end
  # resource path
  local_var_path = '/approveChatJoinRequest'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.approve_chat_join_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#approve_chat_join_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ban_chat_member(chat_id, user_id, opts = {}) ⇒ SetWebhook200Response

banChatMember Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :until_date (Integer)
  • :revoke_messages (Boolean)

Returns:



560
561
562
563
 
# File 'lib/telegram-bot/api/default_api.rb', line 560

def ban_chat_member(chat_id, user_id, opts = {})
  data, _status_code, _headers = ban_chat_member_with_http_info(chat_id, user_id, opts)
  data
end

#ban_chat_member_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

banChatMember Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :until_date (Integer)
  • :revoke_messages (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/telegram-bot/api/default_api.rb', line 573

def ban_chat_member_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.ban_chat_member ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.ban_chat_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.ban_chat_member"
  end
  # resource path
  local_var_path = '/banChatMember'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id
  query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?
  query_params[:'revoke_messages'] = opts[:'revoke_messages'] if !opts[:'revoke_messages'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.ban_chat_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#ban_chat_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ban_chat_sender_chat(chat_id, sender_chat_id, opts = {}) ⇒ SetWebhook200Response

banChatSenderChat Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won’t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:



635
636
637
638
 
# File 'lib/telegram-bot/api/default_api.rb', line 635

def ban_chat_sender_chat(chat_id, sender_chat_id, opts = {})
  data, _status_code, _headers = ban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts)
  data
end

#ban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

banChatSenderChat Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won&#39;t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/telegram-bot/api/default_api.rb', line 646

def ban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.ban_chat_sender_chat ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.ban_chat_sender_chat"
  end
  # verify the required parameter 'sender_chat_id' is set
  if @api_client.config.client_side_validation && sender_chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'sender_chat_id' when calling DefaultApi.ban_chat_sender_chat"
  end
  # resource path
  local_var_path = '/banChatSenderChat'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'sender_chat_id'] = sender_chat_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.ban_chat_sender_chat",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#ban_chat_sender_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#close(opts = {}) ⇒ SetWebhook200Response

close Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn’t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Parameters:

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

    the optional parameters

Returns:



704
705
706
707
 
# File 'lib/telegram-bot/api/default_api.rb', line 704

def close(opts = {})
  data, _status_code, _headers = close_with_http_info(opts)
  data
end

#close_forum_topic(chat_id, message_thread_id, opts = {}) ⇒ SetWebhook200Response

closeForumTopic Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Returns:



763
764
765
766
 
# File 'lib/telegram-bot/api/default_api.rb', line 763

def close_forum_topic(chat_id, message_thread_id, opts = {})
  data, _status_code, _headers = close_forum_topic_with_http_info(chat_id, message_thread_id, opts)
  data
end

#close_forum_topic_with_http_info(chat_id, message_thread_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

closeForumTopic Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/telegram-bot/api/default_api.rb', line 774

def close_forum_topic_with_http_info(chat_id, message_thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.close_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.close_forum_topic"
  end
  # verify the required parameter 'message_thread_id' is set
  if @api_client.config.client_side_validation && message_thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_thread_id' when calling DefaultApi.close_forum_topic"
  end
  # resource path
  local_var_path = '/closeForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_thread_id'] = message_thread_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.close_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#close_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#close_general_forum_topic(chat_id, opts = {}) ⇒ SetWebhook200Response

closeGeneralForumTopic Use this method to close an open ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:



833
834
835
836
 
# File 'lib/telegram-bot/api/default_api.rb', line 833

def close_general_forum_topic(chat_id, opts = {})
  data, _status_code, _headers = close_general_forum_topic_with_http_info(chat_id, opts)
  data
end

#close_general_forum_topic_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

closeGeneralForumTopic Use this method to close an open &#39;General&#39; topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/telegram-bot/api/default_api.rb', line 843

def close_general_forum_topic_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.close_general_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.close_general_forum_topic"
  end
  # resource path
  local_var_path = '/closeGeneralForumTopic'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.close_general_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#close_general_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#close_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

close Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn&#39;t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/telegram-bot/api/default_api.rb', line 713

def close_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.close ...'
  end
  # resource path
  local_var_path = '/close'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.close",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#close\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_message(chat_id, from_chat_id, message_id, opts = {}) ⇒ CopyMessage200Response

copyMessage Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn’t have a link to the original message. Returns the MessageId of the sent message on success.

Parameters:

Options Hash (opts):

Returns:



907
908
909
910
 
# File 'lib/telegram-bot/api/default_api.rb', line 907

def copy_message(chat_id, from_chat_id, message_id, opts = {})
  data, _status_code, _headers = copy_message_with_http_info(chat_id, from_chat_id, message_id, opts)
  data
end

#copy_message_with_http_info(chat_id, from_chat_id, message_id, opts = {}) ⇒ Array<(CopyMessage200Response, Integer, Hash)>

copyMessage Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can&#39;t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn&#39;t have a link to the original message. Returns the MessageId of the sent message on success.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(CopyMessage200Response, Integer, Hash)>) —

    CopyMessage200Response data, response status code and response headers



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/telegram-bot/api/default_api.rb', line 927

def copy_message_with_http_info(chat_id, from_chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.copy_message ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.copy_message"
  end
  # verify the required parameter 'from_chat_id' is set
  if @api_client.config.client_side_validation && from_chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'from_chat_id' when calling DefaultApi.copy_message"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling DefaultApi.copy_message"
  end
  # resource path
  local_var_path = '/copyMessage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'from_chat_id'] = from_chat_id
  query_params[:'message_id'] = message_id
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CopyMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.copy_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#copy_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_messages(chat_id, from_chat_id, message_ids, opts = {}) ⇒ ForwardMessages200Response

copyMessages Use this method to copy messages of any kind. If some of the specified messages can’t be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can’t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don’t have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :remove_caption (Boolean)

Returns:



1005
1006
1007
1008
 
# File 'lib/telegram-bot/api/default_api.rb', line 1005

def copy_messages(chat_id, from_chat_id, message_ids, opts = {})
  data, _status_code, _headers = copy_messages_with_http_info(chat_id, from_chat_id, message_ids, opts)
  data
end

#copy_messages_with_http_info(chat_id, from_chat_id, message_ids, opts = {}) ⇒ Array<(ForwardMessages200Response, Integer, Hash)>

copyMessages Use this method to copy messages of any kind. If some of the specified messages can&#39;t be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can&#39;t be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don&#39;t have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :remove_caption (Boolean)

Returns:

  • (Array<(ForwardMessages200Response, Integer, Hash)>) —

    ForwardMessages200Response data, response status code and response headers



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/telegram-bot/api/default_api.rb', line 1021

def copy_messages_with_http_info(chat_id, from_chat_id, message_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.copy_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.copy_messages"
  end
  # verify the required parameter 'from_chat_id' is set
  if @api_client.config.client_side_validation && from_chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'from_chat_id' when calling DefaultApi.copy_messages"
  end
  # verify the required parameter 'message_ids' is set
  if @api_client.config.client_side_validation && message_ids.nil?
    fail ArgumentError, "Missing the required parameter 'message_ids' when calling DefaultApi.copy_messages"
  end
  # resource path
  local_var_path = '/copyMessages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'from_chat_id'] = from_chat_id
  query_params[:'message_ids'] = @api_client.build_collection_param(message_ids, :multi)
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'remove_caption'] = opts[:'remove_caption'] if !opts[:'remove_caption'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ForwardMessages200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.copy_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#copy_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_chat_invite_link(chat_id, opts = {}) ⇒ CreateChatInviteLink200Response

createChatInviteLink Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Parameters:

Options Hash (opts):

  • :name (String)
  • :expire_date (Integer)
  • :member_limit (Integer)
  • :creates_join_request (Boolean)

Returns:



1093
1094
1095
1096
 
# File 'lib/telegram-bot/api/default_api.rb', line 1093

def create_chat_invite_link(chat_id, opts = {})
  data, _status_code, _headers = create_chat_invite_link_with_http_info(chat_id, opts)
  data
end

#create_chat_invite_link_with_http_info(chat_id, opts = {}) ⇒ Array<(CreateChatInviteLink200Response, Integer, Hash)>

createChatInviteLink Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

Parameters:

Options Hash (opts):

  • :name (String)
  • :expire_date (Integer)
  • :member_limit (Integer)
  • :creates_join_request (Boolean)

Returns:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/telegram-bot/api/default_api.rb', line 1107

def create_chat_invite_link_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_chat_invite_link ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.create_chat_invite_link"
  end
  # resource path
  local_var_path = '/createChatInviteLink'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'expire_date'] = opts[:'expire_date'] if !opts[:'expire_date'].nil?
  query_params[:'member_limit'] = opts[:'member_limit'] if !opts[:'member_limit'].nil?
  query_params[:'creates_join_request'] = opts[:'creates_join_request'] if !opts[:'creates_join_request'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateChatInviteLink200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.create_chat_invite_link",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_chat_invite_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_forum_topic(chat_id, name, opts = {}) ⇒ CreateForumTopic200Response

createForumTopic Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Parameters:

Options Hash (opts):

  • :icon_color (Integer)
  • :icon_custom_emoji_id (String)

Returns:



1168
1169
1170
1171
 
# File 'lib/telegram-bot/api/default_api.rb', line 1168

def create_forum_topic(chat_id, name, opts = {})
  data, _status_code, _headers = create_forum_topic_with_http_info(chat_id, name, opts)
  data
end

#create_forum_topic_with_http_info(chat_id, name, opts = {}) ⇒ Array<(CreateForumTopic200Response, Integer, Hash)>

createForumTopic Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Parameters:

Options Hash (opts):

  • :icon_color (Integer)
  • :icon_custom_emoji_id (String)

Returns:

  • (Array<(CreateForumTopic200Response, Integer, Hash)>) —

    CreateForumTopic200Response data, response status code and response headers



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
 
# File 'lib/telegram-bot/api/default_api.rb', line 1181

def create_forum_topic_with_http_info(chat_id, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.create_forum_topic"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.create_forum_topic"
  end
  # resource path
  local_var_path = '/createForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'name'] = name
  query_params[:'icon_color'] = opts[:'icon_color'] if !opts[:'icon_color'].nil?
  query_params[:'icon_custom_emoji_id'] = opts[:'icon_custom_emoji_id'] if !opts[:'icon_custom_emoji_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateForumTopic200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.create_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoice_link(title, description, payload, provider_token, currency, prices, opts = {}) ⇒ ExportChatInviteLink200Response

createInvoiceLink Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Parameters:

  • title (String)
  • description (String)
  • payload (String)
  • provider_token (String)
  • currency (String)
  • prices (Array<LabeledPrice>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :max_tip_amount (Integer)
  • :suggested_tip_amounts (Array<Integer>)
  • :provider_data (String)
  • :photo_url (String)
  • :photo_size (Integer)
  • :photo_width (Integer)
  • :photo_height (Integer)
  • :need_name (Boolean)
  • :need_phone_number (Boolean)
  • :need_email (Boolean)
  • :need_shipping_address (Boolean)
  • :send_phone_number_to_provider (Boolean)
  • :send_email_to_provider (Boolean)
  • :is_flexible (Boolean)

Returns:



1261
1262
1263
1264
 
# File 'lib/telegram-bot/api/default_api.rb', line 1261

def create_invoice_link(title, description, payload, provider_token, currency, prices, opts = {})
  data, _status_code, _headers = create_invoice_link_with_http_info(title, description, payload, provider_token, currency, prices, opts)
  data
end

#create_invoice_link_with_http_info(title, description, payload, provider_token, currency, prices, opts = {}) ⇒ Array<(ExportChatInviteLink200Response, Integer, Hash)>

createInvoiceLink Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Parameters:

  • title (String)
  • description (String)
  • payload (String)
  • provider_token (String)
  • currency (String)
  • prices (Array<LabeledPrice>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :max_tip_amount (Integer)
  • :suggested_tip_amounts (Array<Integer>)
  • :provider_data (String)
  • :photo_url (String)
  • :photo_size (Integer)
  • :photo_width (Integer)
  • :photo_height (Integer)
  • :need_name (Boolean)
  • :need_phone_number (Boolean)
  • :need_email (Boolean)
  • :need_shipping_address (Boolean)
  • :send_phone_number_to_provider (Boolean)
  • :send_email_to_provider (Boolean)
  • :is_flexible (Boolean)

Returns:



1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/telegram-bot/api/default_api.rb', line 1290

def create_invoice_link_with_http_info(title, description, payload, provider_token, currency, prices, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_invoice_link ...'
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.create_invoice_link"
  end
  # verify the required parameter 'description' is set
  if @api_client.config.client_side_validation && description.nil?
    fail ArgumentError, "Missing the required parameter 'description' when calling DefaultApi.create_invoice_link"
  end
  # verify the required parameter 'payload' is set
  if @api_client.config.client_side_validation && payload.nil?
    fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.create_invoice_link"
  end
  # verify the required parameter 'provider_token' is set
  if @api_client.config.client_side_validation && provider_token.nil?
    fail ArgumentError, "Missing the required parameter 'provider_token' when calling DefaultApi.create_invoice_link"
  end
  # verify the required parameter 'currency' is set
  if @api_client.config.client_side_validation && currency.nil?
    fail ArgumentError, "Missing the required parameter 'currency' when calling DefaultApi.create_invoice_link"
  end
  # verify the required parameter 'prices' is set
  if @api_client.config.client_side_validation && prices.nil?
    fail ArgumentError, "Missing the required parameter 'prices' when calling DefaultApi.create_invoice_link"
  end
  # resource path
  local_var_path = '/createInvoiceLink'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'title'] = title
  query_params[:'description'] = description
  query_params[:'payload'] = payload
  query_params[:'provider_token'] = provider_token
  query_params[:'currency'] = currency
  query_params[:'prices'] = @api_client.build_collection_param(prices, :multi)
  query_params[:'max_tip_amount'] = opts[:'max_tip_amount'] if !opts[:'max_tip_amount'].nil?
  query_params[:'suggested_tip_amounts'] = @api_client.build_collection_param(opts[:'suggested_tip_amounts'], :multi) if !opts[:'suggested_tip_amounts'].nil?
  query_params[:'provider_data'] = opts[:'provider_data'] if !opts[:'provider_data'].nil?
  query_params[:'photo_url'] = opts[:'photo_url'] if !opts[:'photo_url'].nil?
  query_params[:'photo_size'] = opts[:'photo_size'] if !opts[:'photo_size'].nil?
  query_params[:'photo_width'] = opts[:'photo_width'] if !opts[:'photo_width'].nil?
  query_params[:'photo_height'] = opts[:'photo_height'] if !opts[:'photo_height'].nil?
  query_params[:'need_name'] = opts[:'need_name'] if !opts[:'need_name'].nil?
  query_params[:'need_phone_number'] = opts[:'need_phone_number'] if !opts[:'need_phone_number'].nil?
  query_params[:'need_email'] = opts[:'need_email'] if !opts[:'need_email'].nil?
  query_params[:'need_shipping_address'] = opts[:'need_shipping_address'] if !opts[:'need_shipping_address'].nil?
  query_params[:'send_phone_number_to_provider'] = opts[:'send_phone_number_to_provider'] if !opts[:'send_phone_number_to_provider'].nil?
  query_params[:'send_email_to_provider'] = opts[:'send_email_to_provider'] if !opts[:'send_email_to_provider'].nil?
  query_params[:'is_flexible'] = opts[:'is_flexible'] if !opts[:'is_flexible'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ExportChatInviteLink200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.create_invoice_link",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_invoice_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_new_sticker_set(user_id, name, title, stickers, opts = {}) ⇒ SetWebhook200Response

createNewStickerSet Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • title (String)
  • stickers (Array<InputSticker>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sticker_type (String)
  • :needs_repainting (Boolean)

Returns:



1388
1389
1390
1391
 
# File 'lib/telegram-bot/api/default_api.rb', line 1388

def create_new_sticker_set(user_id, name, title, stickers, opts = {})
  data, _status_code, _headers = create_new_sticker_set_with_http_info(user_id, name, title, stickers, opts)
  data
end

#create_new_sticker_set_with_http_info(user_id, name, title, stickers, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

createNewStickerSet Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • title (String)
  • stickers (Array<InputSticker>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sticker_type (String)
  • :needs_repainting (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'lib/telegram-bot/api/default_api.rb', line 1403

def create_new_sticker_set_with_http_info(user_id, name, title, stickers, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_new_sticker_set ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.create_new_sticker_set"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.create_new_sticker_set"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.create_new_sticker_set"
  end
  # verify the required parameter 'stickers' is set
  if @api_client.config.client_side_validation && stickers.nil?
    fail ArgumentError, "Missing the required parameter 'stickers' when calling DefaultApi.create_new_sticker_set"
  end
  # resource path
  local_var_path = '/createNewStickerSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'name'] = name
  query_params[:'title'] = title
  query_params[:'stickers'] = @api_client.build_collection_param(stickers, :multi)
  query_params[:'sticker_type'] = opts[:'sticker_type'] if !opts[:'sticker_type'].nil?
  query_params[:'needs_repainting'] = opts[:'needs_repainting'] if !opts[:'needs_repainting'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.create_new_sticker_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_new_sticker_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#decline_chat_join_request(chat_id, user_id, opts = {}) ⇒ SetWebhook200Response

declineChatJoinRequest Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters:

Returns:



1475
1476
1477
1478
 
# File 'lib/telegram-bot/api/default_api.rb', line 1475

def decline_chat_join_request(chat_id, user_id, opts = {})
  data, _status_code, _headers = decline_chat_join_request_with_http_info(chat_id, user_id, opts)
  data
end

#decline_chat_join_request_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

declineChatJoinRequest Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/telegram-bot/api/default_api.rb', line 1486

def decline_chat_join_request_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.decline_chat_join_request ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.decline_chat_join_request"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.decline_chat_join_request"
  end
  # resource path
  local_var_path = '/declineChatJoinRequest'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.decline_chat_join_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#decline_chat_join_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_chat_photo(chat_id, opts = {}) ⇒ SetWebhook200Response

deleteChatPhoto Use this method to delete a chat photo. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:



1545
1546
1547
1548
 
# File 'lib/telegram-bot/api/default_api.rb', line 1545

def delete_chat_photo(chat_id, opts = {})
  data, _status_code, _headers = delete_chat_photo_with_http_info(chat_id, opts)
  data
end

#delete_chat_photo_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteChatPhoto Use this method to delete a chat photo. Photos can&#39;t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/telegram-bot/api/default_api.rb', line 1555

def delete_chat_photo_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_chat_photo ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.delete_chat_photo"
  end
  # resource path
  local_var_path = '/deleteChatPhoto'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_chat_photo",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_chat_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_chat_sticker_set(chat_id, opts = {}) ⇒ SetWebhook200Response

deleteChatStickerSet Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters:

Returns:



1609
1610
1611
1612
 
# File 'lib/telegram-bot/api/default_api.rb', line 1609

def delete_chat_sticker_set(chat_id, opts = {})
  data, _status_code, _headers = delete_chat_sticker_set_with_http_info(chat_id, opts)
  data
end

#delete_chat_sticker_set_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteChatStickerSet Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
 
# File 'lib/telegram-bot/api/default_api.rb', line 1619

def delete_chat_sticker_set_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_chat_sticker_set ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.delete_chat_sticker_set"
  end
  # resource path
  local_var_path = '/deleteChatStickerSet'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_chat_sticker_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_chat_sticker_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_forum_topic(chat_id, message_thread_id, opts = {}) ⇒ SetWebhook200Response

deleteForumTopic Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Parameters:

Returns:



1674
1675
1676
1677
 
# File 'lib/telegram-bot/api/default_api.rb', line 1674

def delete_forum_topic(chat_id, message_thread_id, opts = {})
  data, _status_code, _headers = delete_forum_topic_with_http_info(chat_id, message_thread_id, opts)
  data
end

#delete_forum_topic_with_http_info(chat_id, message_thread_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteForumTopic Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'lib/telegram-bot/api/default_api.rb', line 1685

def delete_forum_topic_with_http_info(chat_id, message_thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.delete_forum_topic"
  end
  # verify the required parameter 'message_thread_id' is set
  if @api_client.config.client_side_validation && message_thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_thread_id' when calling DefaultApi.delete_forum_topic"
  end
  # resource path
  local_var_path = '/deleteForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_thread_id'] = message_thread_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

deleteMessage Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can’t be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.

Parameters:

Returns:



1745
1746
1747
1748
 
# File 'lib/telegram-bot/api/default_api.rb', line 1745

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

#delete_message_with_http_info(chat_id, message_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteMessage Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can&#39;t be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted can_post_messages permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/telegram-bot/api/default_api.rb', line 1756

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_messages(chat_id, message_ids, opts = {}) ⇒ SetWebhook200Response

deleteMessages Use this method to delete multiple messages simultaneously. If some of the specified messages can’t be found, they are skipped. Returns True on success.

Parameters:

Returns:



1816
1817
1818
1819
 
# File 'lib/telegram-bot/api/default_api.rb', line 1816

def delete_messages(chat_id, message_ids, opts = {})
  data, _status_code, _headers = delete_messages_with_http_info(chat_id, message_ids, opts)
  data
end

#delete_messages_with_http_info(chat_id, message_ids, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteMessages Use this method to delete multiple messages simultaneously. If some of the specified messages can&#39;t be found, they are skipped. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
 
# File 'lib/telegram-bot/api/default_api.rb', line 1827

def delete_messages_with_http_info(chat_id, message_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.delete_messages"
  end
  # verify the required parameter 'message_ids' is set
  if @api_client.config.client_side_validation && message_ids.nil?
    fail ArgumentError, "Missing the required parameter 'message_ids' when calling DefaultApi.delete_messages"
  end
  # resource path
  local_var_path = '/deleteMessages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_ids'] = @api_client.build_collection_param(message_ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_my_commands(opts = {}) ⇒ SetWebhook200Response

deleteMyCommands Use this method to delete the list of the bot’s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:



1887
1888
1889
1890
 
# File 'lib/telegram-bot/api/default_api.rb', line 1887

def delete_my_commands(opts = {})
  data, _status_code, _headers = delete_my_commands_with_http_info(opts)
  data
end

#delete_my_commands_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteMyCommands Use this method to delete the list of the bot&#39;s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
 
# File 'lib/telegram-bot/api/default_api.rb', line 1898

def delete_my_commands_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_my_commands ...'
  end
  # resource path
  local_var_path = '/deleteMyCommands'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_my_commands",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_my_commands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sticker_from_set(sticker, opts = {}) ⇒ SetWebhook200Response

deleteStickerFromSet Use this method to delete a sticker from a set created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Returns:



1949
1950
1951
1952
 
# File 'lib/telegram-bot/api/default_api.rb', line 1949

def delete_sticker_from_set(sticker, opts = {})
  data, _status_code, _headers = delete_sticker_from_set_with_http_info(sticker, opts)
  data
end

#delete_sticker_from_set_with_http_info(sticker, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteStickerFromSet Use this method to delete a sticker from a set created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/telegram-bot/api/default_api.rb', line 1959

def delete_sticker_from_set_with_http_info(sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_sticker_from_set ...'
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.delete_sticker_from_set"
  end
  # resource path
  local_var_path = '/deleteStickerFromSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sticker'] = sticker

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_sticker_from_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_sticker_from_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sticker_set(name, opts = {}) ⇒ SetWebhook200Response

deleteStickerSet Use this method to delete a sticker set that was created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Returns:



2013
2014
2015
2016
 
# File 'lib/telegram-bot/api/default_api.rb', line 2013

def delete_sticker_set(name, opts = {})
  data, _status_code, _headers = delete_sticker_set_with_http_info(name, opts)
  data
end

#delete_sticker_set_with_http_info(name, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteStickerSet Use this method to delete a sticker set that was created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
 
# File 'lib/telegram-bot/api/default_api.rb', line 2023

def delete_sticker_set_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_sticker_set ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.delete_sticker_set"
  end
  # resource path
  local_var_path = '/deleteStickerSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_sticker_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_sticker_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_webhook(opts = {}) ⇒ SetWebhook200Response

deleteWebhook Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :drop_pending_updates (Boolean)

Returns:



2077
2078
2079
2080
 
# File 'lib/telegram-bot/api/default_api.rb', line 2077

def delete_webhook(opts = {})
  data, _status_code, _headers = delete_webhook_with_http_info(opts)
  data
end

#delete_webhook_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

deleteWebhook Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :drop_pending_updates (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
 
# File 'lib/telegram-bot/api/default_api.rb', line 2087

def delete_webhook_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_webhook ...'
  end
  # resource path
  local_var_path = '/deleteWebhook'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'drop_pending_updates'] = opts[:'drop_pending_updates'] if !opts[:'drop_pending_updates'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.delete_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_chat_invite_link(chat_id, invite_link, opts = {}) ⇒ CreateChatInviteLink200Response

editChatInviteLink Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Parameters:

Options Hash (opts):

  • :name (String)
  • :expire_date (Integer)
  • :member_limit (Integer)
  • :creates_join_request (Boolean)

Returns:



2142
2143
2144
2145
 
# File 'lib/telegram-bot/api/default_api.rb', line 2142

def edit_chat_invite_link(chat_id, invite_link, opts = {})
  data, _status_code, _headers = edit_chat_invite_link_with_http_info(chat_id, invite_link, opts)
  data
end

#edit_chat_invite_link_with_http_info(chat_id, invite_link, opts = {}) ⇒ Array<(CreateChatInviteLink200Response, Integer, Hash)>

editChatInviteLink Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

Parameters:

Options Hash (opts):

  • :name (String)
  • :expire_date (Integer)
  • :member_limit (Integer)
  • :creates_join_request (Boolean)

Returns:



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/telegram-bot/api/default_api.rb', line 2157

def edit_chat_invite_link_with_http_info(chat_id, invite_link, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_chat_invite_link ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.edit_chat_invite_link"
  end
  # verify the required parameter 'invite_link' is set
  if @api_client.config.client_side_validation && invite_link.nil?
    fail ArgumentError, "Missing the required parameter 'invite_link' when calling DefaultApi.edit_chat_invite_link"
  end
  # resource path
  local_var_path = '/editChatInviteLink'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'invite_link'] = invite_link
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'expire_date'] = opts[:'expire_date'] if !opts[:'expire_date'].nil?
  query_params[:'member_limit'] = opts[:'member_limit'] if !opts[:'member_limit'].nil?
  query_params[:'creates_join_request'] = opts[:'creates_join_request'] if !opts[:'creates_join_request'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateChatInviteLink200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_chat_invite_link",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_chat_invite_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_forum_topic(chat_id, message_thread_id, opts = {}) ⇒ SetWebhook200Response

editForumTopic Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Options Hash (opts):

  • :name (String)
  • :icon_custom_emoji_id (String)

Returns:



2223
2224
2225
2226
 
# File 'lib/telegram-bot/api/default_api.rb', line 2223

def edit_forum_topic(chat_id, message_thread_id, opts = {})
  data, _status_code, _headers = edit_forum_topic_with_http_info(chat_id, message_thread_id, opts)
  data
end

#edit_forum_topic_with_http_info(chat_id, message_thread_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

editForumTopic Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Options Hash (opts):

  • :name (String)
  • :icon_custom_emoji_id (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
 
# File 'lib/telegram-bot/api/default_api.rb', line 2236

def edit_forum_topic_with_http_info(chat_id, message_thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.edit_forum_topic"
  end
  # verify the required parameter 'message_thread_id' is set
  if @api_client.config.client_side_validation && message_thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_thread_id' when calling DefaultApi.edit_forum_topic"
  end
  # resource path
  local_var_path = '/editForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_thread_id'] = message_thread_id
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'icon_custom_emoji_id'] = opts[:'icon_custom_emoji_id'] if !opts[:'icon_custom_emoji_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_general_forum_topic(chat_id, name, opts = {}) ⇒ SetWebhook200Response

editGeneralForumTopic Use this method to edit the name of the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:



2298
2299
2300
2301
 
# File 'lib/telegram-bot/api/default_api.rb', line 2298

def edit_general_forum_topic(chat_id, name, opts = {})
  data, _status_code, _headers = edit_general_forum_topic_with_http_info(chat_id, name, opts)
  data
end

#edit_general_forum_topic_with_http_info(chat_id, name, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

editGeneralForumTopic Use this method to edit the name of the &#39;General&#39; topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
 
# File 'lib/telegram-bot/api/default_api.rb', line 2309

def edit_general_forum_topic_with_http_info(chat_id, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_general_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.edit_general_forum_topic"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.edit_general_forum_topic"
  end
  # resource path
  local_var_path = '/editGeneralForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'name'] = name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_general_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_general_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_caption(opts = {}) ⇒ EditMessageText200Response

editMessageCaption Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2374
2375
2376
2377
 
# File 'lib/telegram-bot/api/default_api.rb', line 2374

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

#edit_message_caption_with_http_info(opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

editMessageCaption Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
 
# File 'lib/telegram-bot/api/default_api.rb', line 2390

def edit_message_caption_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_message_caption ...'
  end
  # resource path
  local_var_path = '/editMessageCaption'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_message_caption",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_message_caption\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_live_location(latitude, longitude, opts = {}) ⇒ EditMessageText200Response

editMessageLiveLocation Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

  • latitude (Float)
  • longitude (Float)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



2454
2455
2456
2457
 
# File 'lib/telegram-bot/api/default_api.rb', line 2454

def edit_message_live_location(latitude, longitude, opts = {})
  data, _status_code, _headers = edit_message_live_location_with_http_info(latitude, longitude, opts)
  data
end

#edit_message_live_location_with_http_info(latitude, longitude, opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

editMessageLiveLocation Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

  • latitude (Float)
  • longitude (Float)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
 
# File 'lib/telegram-bot/api/default_api.rb', line 2472

def edit_message_live_location_with_http_info(latitude, longitude, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_message_live_location ...'
  end
  # verify the required parameter 'latitude' is set
  if @api_client.config.client_side_validation && latitude.nil?
    fail ArgumentError, "Missing the required parameter 'latitude' when calling DefaultApi.edit_message_live_location"
  end
  # verify the required parameter 'longitude' is set
  if @api_client.config.client_side_validation && longitude.nil?
    fail ArgumentError, "Missing the required parameter 'longitude' when calling DefaultApi.edit_message_live_location"
  end
  # resource path
  local_var_path = '/editMessageLiveLocation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'latitude'] = latitude
  query_params[:'longitude'] = longitude
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'horizontal_accuracy'] = opts[:'horizontal_accuracy'] if !opts[:'horizontal_accuracy'].nil?
  query_params[:'heading'] = opts[:'heading'] if !opts[:'heading'].nil?
  query_params[:'proximity_alert_radius'] = opts[:'proximity_alert_radius'] if !opts[:'proximity_alert_radius'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_message_live_location",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_message_live_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_media(media, opts = {}) ⇒ EditMessageText200Response

editMessageMedia Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can’t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2542
2543
2544
2545
 
# File 'lib/telegram-bot/api/default_api.rb', line 2542

def edit_message_media(media, opts = {})
  data, _status_code, _headers = edit_message_media_with_http_info(media, opts)
  data
end

#edit_message_media_with_http_info(media, opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

editMessageMedia Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can&#39;t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
 
# File 'lib/telegram-bot/api/default_api.rb', line 2556

def edit_message_media_with_http_info(media, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_message_media ...'
  end
  # verify the required parameter 'media' is set
  if @api_client.config.client_side_validation && media.nil?
    fail ArgumentError, "Missing the required parameter 'media' when calling DefaultApi.edit_message_media"
  end
  # resource path
  local_var_path = '/editMessageMedia'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'media'] = media
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_message_media",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_message_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_reply_markup(opts = {}) ⇒ EditMessageText200Response

editMessageReplyMarkup Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2617
2618
2619
2620
 
# File 'lib/telegram-bot/api/default_api.rb', line 2617

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

#edit_message_reply_markup_with_http_info(opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

editMessageReplyMarkup Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
 
# File 'lib/telegram-bot/api/default_api.rb', line 2630

def edit_message_reply_markup_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_message_reply_markup ...'
  end
  # resource path
  local_var_path = '/editMessageReplyMarkup'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_message_reply_markup",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_message_reply_markup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#edit_message_text(text, opts = {}) ⇒ EditMessageText200Response

editMessageText Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2690
2691
2692
2693
 
# File 'lib/telegram-bot/api/default_api.rb', line 2690

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

#edit_message_text_with_http_info(text, opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

editMessageText Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
 
# File 'lib/telegram-bot/api/default_api.rb', line 2707

def edit_message_text_with_http_info(text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.edit_message_text ...'
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling DefaultApi.edit_message_text"
  end
  # resource path
  local_var_path = '/editMessageText'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'text'] = text
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'entities'] = @api_client.build_collection_param(opts[:'entities'], :multi) if !opts[:'entities'].nil?
  query_params[:'link_preview_options'] = opts[:'link_preview_options'] if !opts[:'link_preview_options'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.edit_message_text",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#edit_message_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#export_chat_invite_link(chat_id, opts = {}) ⇒ ExportChatInviteLink200Response

exportChatInviteLink Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Parameters:

Returns:



2768
2769
2770
2771
 
# File 'lib/telegram-bot/api/default_api.rb', line 2768

def export_chat_invite_link(chat_id, opts = {})
  data, _status_code, _headers = export_chat_invite_link_with_http_info(chat_id, opts)
  data
end

#export_chat_invite_link_with_http_info(chat_id, opts = {}) ⇒ Array<(ExportChatInviteLink200Response, Integer, Hash)>

exportChatInviteLink Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Parameters:

Returns:



2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
 
# File 'lib/telegram-bot/api/default_api.rb', line 2778

def export_chat_invite_link_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.export_chat_invite_link ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.export_chat_invite_link"
  end
  # resource path
  local_var_path = '/exportChatInviteLink'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ExportChatInviteLink200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.export_chat_invite_link",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#export_chat_invite_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

forwardMessage Use this method to forward messages of any kind. Service messages and messages with protected content can’t be forwarded. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)

Returns:



2837
2838
2839
2840
 
# File 'lib/telegram-bot/api/default_api.rb', line 2837

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

#forward_message_with_http_info(chat_id, from_chat_id, message_id, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

forwardMessage Use this method to forward messages of any kind. Service messages and messages with protected content can&#39;t be forwarded. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
 
# File 'lib/telegram-bot/api/default_api.rb', line 2852

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'from_chat_id'] = from_chat_id
  query_params[:'message_id'] = message_id
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.forward_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#forward_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#forward_messages(chat_id, from_chat_id, message_ids, opts = {}) ⇒ ForwardMessages200Response

forwardMessages Use this method to forward multiple messages of any kind. If some of the specified messages can’t be found or forwarded, they are skipped. Service messages and messages with protected content can’t be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)

Returns:



2924
2925
2926
2927
 
# File 'lib/telegram-bot/api/default_api.rb', line 2924

def forward_messages(chat_id, from_chat_id, message_ids, opts = {})
  data, _status_code, _headers = forward_messages_with_http_info(chat_id, from_chat_id, message_ids, opts)
  data
end

#forward_messages_with_http_info(chat_id, from_chat_id, message_ids, opts = {}) ⇒ Array<(ForwardMessages200Response, Integer, Hash)>

forwardMessages Use this method to forward multiple messages of any kind. If some of the specified messages can&#39;t be found or forwarded, they are skipped. Service messages and messages with protected content can&#39;t be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.

Parameters:

Options Hash (opts):

  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)

Returns:

  • (Array<(ForwardMessages200Response, Integer, Hash)>) —

    ForwardMessages200Response data, response status code and response headers



2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
 
# File 'lib/telegram-bot/api/default_api.rb', line 2939

def forward_messages_with_http_info(chat_id, from_chat_id, message_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.forward_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.forward_messages"
  end
  # verify the required parameter 'from_chat_id' is set
  if @api_client.config.client_side_validation && from_chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'from_chat_id' when calling DefaultApi.forward_messages"
  end
  # verify the required parameter 'message_ids' is set
  if @api_client.config.client_side_validation && message_ids.nil?
    fail ArgumentError, "Missing the required parameter 'message_ids' when calling DefaultApi.forward_messages"
  end
  # resource path
  local_var_path = '/forwardMessages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'from_chat_id'] = from_chat_id
  query_params[:'message_ids'] = @api_client.build_collection_param(message_ids, :multi)
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ForwardMessages200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.forward_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#forward_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_business_connection(business_connection_id, opts = {}) ⇒ GetBusinessConnection200Response

getBusinessConnection Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Parameters:

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

    the optional parameters

Returns:



3006
3007
3008
3009
 
# File 'lib/telegram-bot/api/default_api.rb', line 3006

def get_business_connection(business_connection_id, opts = {})
  data, _status_code, _headers = get_business_connection_with_http_info(business_connection_id, opts)
  data
end

#get_business_connection_with_http_info(business_connection_id, opts = {}) ⇒ Array<(GetBusinessConnection200Response, Integer, Hash)>

getBusinessConnection Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

Parameters:

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

    the optional parameters

Returns:



3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
 
# File 'lib/telegram-bot/api/default_api.rb', line 3016

def get_business_connection_with_http_info(business_connection_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_business_connection ...'
  end
  # verify the required parameter 'business_connection_id' is set
  if @api_client.config.client_side_validation && business_connection_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_connection_id' when calling DefaultApi.get_business_connection"
  end
  # resource path
  local_var_path = '/getBusinessConnection'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'business_connection_id'] = business_connection_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetBusinessConnection200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_business_connection",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_business_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chat(chat_id, opts = {}) ⇒ GetChat200Response

getChat Use this method to get up to date information about the chat. Returns a Chat object on success.

Parameters:

Returns:



3070
3071
3072
3073
 
# File 'lib/telegram-bot/api/default_api.rb', line 3070

def get_chat(chat_id, opts = {})
  data, _status_code, _headers = get_chat_with_http_info(chat_id, opts)
  data
end

#get_chat_administrators(chat_id, opts = {}) ⇒ GetChatAdministrators200Response

getChatAdministrators Use this method to get a list of administrators in a chat, which aren’t bots. Returns an Array of ChatMember objects.

Parameters:

Returns:



3134
3135
3136
3137
 
# File 'lib/telegram-bot/api/default_api.rb', line 3134

def get_chat_administrators(chat_id, opts = {})
  data, _status_code, _headers = get_chat_administrators_with_http_info(chat_id, opts)
  data
end

#get_chat_administrators_with_http_info(chat_id, opts = {}) ⇒ Array<(GetChatAdministrators200Response, Integer, Hash)>

getChatAdministrators Use this method to get a list of administrators in a chat, which aren&#39;t bots. Returns an Array of ChatMember objects.

Parameters:

Returns:



3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
 
# File 'lib/telegram-bot/api/default_api.rb', line 3144

def get_chat_administrators_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_chat_administrators ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.get_chat_administrators"
  end
  # resource path
  local_var_path = '/getChatAdministrators'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetChatAdministrators200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_chat_administrators",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_chat_administrators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chat_member(chat_id, user_id, opts = {}) ⇒ GetChatMember200Response

getChatMember Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

Parameters:

Returns:



3199
3200
3201
3202
 
# File 'lib/telegram-bot/api/default_api.rb', line 3199

def get_chat_member(chat_id, user_id, opts = {})
  data, _status_code, _headers = get_chat_member_with_http_info(chat_id, user_id, opts)
  data
end

#get_chat_member_count(chat_id, opts = {}) ⇒ GetChatMemberCount200Response

getChatMemberCount Use this method to get the number of members in a chat. Returns Int on success.

Parameters:

Returns:



3269
3270
3271
3272
 
# File 'lib/telegram-bot/api/default_api.rb', line 3269

def get_chat_member_count(chat_id, opts = {})
  data, _status_code, _headers = get_chat_member_count_with_http_info(chat_id, opts)
  data
end

#get_chat_member_count_with_http_info(chat_id, opts = {}) ⇒ Array<(GetChatMemberCount200Response, Integer, Hash)>

getChatMemberCount Use this method to get the number of members in a chat. Returns Int on success.

Parameters:

Returns:



3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
 
# File 'lib/telegram-bot/api/default_api.rb', line 3279

def get_chat_member_count_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_chat_member_count ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.get_chat_member_count"
  end
  # resource path
  local_var_path = '/getChatMemberCount'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetChatMemberCount200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_chat_member_count",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_chat_member_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chat_member_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(GetChatMember200Response, Integer, Hash)>

getChatMember Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

Parameters:

Returns:

  • (Array<(GetChatMember200Response, Integer, Hash)>) —

    GetChatMember200Response data, response status code and response headers



3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
 
# File 'lib/telegram-bot/api/default_api.rb', line 3210

def get_chat_member_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_chat_member ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.get_chat_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_chat_member"
  end
  # resource path
  local_var_path = '/getChatMember'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetChatMember200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_chat_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_chat_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chat_menu_button(opts = {}) ⇒ GetChatMenuButton200Response

getChatMenuButton Use this method to get the current value of the bot’s menu button in a private chat, or the default menu button. Returns MenuButton on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)

Returns:



3333
3334
3335
3336
 
# File 'lib/telegram-bot/api/default_api.rb', line 3333

def get_chat_menu_button(opts = {})
  data, _status_code, _headers = get_chat_menu_button_with_http_info(opts)
  data
end

#get_chat_menu_button_with_http_info(opts = {}) ⇒ Array<(GetChatMenuButton200Response, Integer, Hash)>

getChatMenuButton Use this method to get the current value of the bot&#39;s menu button in a private chat, or the default menu button. Returns MenuButton on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)

Returns:



3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
 
# File 'lib/telegram-bot/api/default_api.rb', line 3343

def get_chat_menu_button_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_chat_menu_button ...'
  end
  # resource path
  local_var_path = '/getChatMenuButton'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetChatMenuButton200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_chat_menu_button",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_chat_menu_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_chat_with_http_info(chat_id, opts = {}) ⇒ Array<(GetChat200Response, Integer, Hash)>

getChat Use this method to get up to date information about the chat. Returns a Chat object on success.

Parameters:

Returns:

  • (Array<(GetChat200Response, Integer, Hash)>) —

    GetChat200Response data, response status code and response headers



3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
 
# File 'lib/telegram-bot/api/default_api.rb', line 3080

def get_chat_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_chat ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.get_chat"
  end
  # resource path
  local_var_path = '/getChat'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetChat200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_chat",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_custom_emoji_stickers(custom_emoji_ids, opts = {}) ⇒ GetForumTopicIconStickers200Response

getCustomEmojiStickers Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Parameters:

  • custom_emoji_ids (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3393
3394
3395
3396
 
# File 'lib/telegram-bot/api/default_api.rb', line 3393

def get_custom_emoji_stickers(custom_emoji_ids, opts = {})
  data, _status_code, _headers = get_custom_emoji_stickers_with_http_info(custom_emoji_ids, opts)
  data
end

#get_custom_emoji_stickers_with_http_info(custom_emoji_ids, opts = {}) ⇒ Array<(GetForumTopicIconStickers200Response, Integer, Hash)>

getCustomEmojiStickers Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Parameters:

  • custom_emoji_ids (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
 
# File 'lib/telegram-bot/api/default_api.rb', line 3403

def get_custom_emoji_stickers_with_http_info(custom_emoji_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_custom_emoji_stickers ...'
  end
  # verify the required parameter 'custom_emoji_ids' is set
  if @api_client.config.client_side_validation && custom_emoji_ids.nil?
    fail ArgumentError, "Missing the required parameter 'custom_emoji_ids' when calling DefaultApi.get_custom_emoji_stickers"
  end
  # resource path
  local_var_path = '/getCustomEmojiStickers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'custom_emoji_ids'] = @api_client.build_collection_param(custom_emoji_ids, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetForumTopicIconStickers200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_custom_emoji_stickers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_custom_emoji_stickers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_file(file_id, opts = {}) ⇒ GetFile200Response

getFile Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. Note: This function may not preserve the original file name and MIME type. You should save the file’s MIME type and name (if available) when the File object is received.

Parameters:

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

    the optional parameters

Returns:



3457
3458
3459
3460
 
# File 'lib/telegram-bot/api/default_api.rb', line 3457

def get_file(file_id, opts = {})
  data, _status_code, _headers = get_file_with_http_info(file_id, opts)
  data
end

#get_file_with_http_info(file_id, opts = {}) ⇒ Array<(GetFile200Response, Integer, Hash)>

getFile Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link api.telegram.org/file/bot&lt;token&gt;/&lt;file_path&gt;, where &lt;file_path&gt; is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. Note: This function may not preserve the original file name and MIME type. You should save the file&#39;s MIME type and name (if available) when the File object is received.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetFile200Response, Integer, Hash)>) —

    GetFile200Response data, response status code and response headers



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
 
# File 'lib/telegram-bot/api/default_api.rb', line 3467

def get_file_with_http_info(file_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_file ...'
  end
  # verify the required parameter 'file_id' is set
  if @api_client.config.client_side_validation && file_id.nil?
    fail ArgumentError, "Missing the required parameter 'file_id' when calling DefaultApi.get_file"
  end
  # resource path
  local_var_path = '/getFile'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'file_id'] = file_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFile200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_forum_topic_icon_stickers(opts = {}) ⇒ GetForumTopicIconStickers200Response

getForumTopicIconStickers Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Parameters:

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

    the optional parameters

Returns:



3520
3521
3522
3523
 
# File 'lib/telegram-bot/api/default_api.rb', line 3520

def get_forum_topic_icon_stickers(opts = {})
  data, _status_code, _headers = get_forum_topic_icon_stickers_with_http_info(opts)
  data
end

#get_forum_topic_icon_stickers_with_http_info(opts = {}) ⇒ Array<(GetForumTopicIconStickers200Response, Integer, Hash)>

getForumTopicIconStickers Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Parameters:

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

    the optional parameters

Returns:



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
 
# File 'lib/telegram-bot/api/default_api.rb', line 3529

def get_forum_topic_icon_stickers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_forum_topic_icon_stickers ...'
  end
  # resource path
  local_var_path = '/getForumTopicIconStickers'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetForumTopicIconStickers200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_forum_topic_icon_stickers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_forum_topic_icon_stickers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_game_high_scores(user_id, opts = {}) ⇒ GetGameHighScores200Response

getGameHighScores Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)
  • :message_id (Integer)
  • :inline_message_id (String)

Returns:



3581
3582
3583
3584
 
# File 'lib/telegram-bot/api/default_api.rb', line 3581

def get_game_high_scores(user_id, opts = {})
  data, _status_code, _headers = get_game_high_scores_with_http_info(user_id, opts)
  data
end

#get_game_high_scores_with_http_info(user_id, opts = {}) ⇒ Array<(GetGameHighScores200Response, Integer, Hash)>

getGameHighScores Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)
  • :message_id (Integer)
  • :inline_message_id (String)

Returns:



3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
 
# File 'lib/telegram-bot/api/default_api.rb', line 3594

def get_game_high_scores_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_game_high_scores ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_game_high_scores"
  end
  # resource path
  local_var_path = '/getGameHighScores'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetGameHighScores200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_game_high_scores",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_game_high_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_me(opts = {}) ⇒ GetMe200Response

getMe A simple method for testing your bot’s authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Parameters:

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

    the optional parameters

Returns:



3650
3651
3652
3653
 
# File 'lib/telegram-bot/api/default_api.rb', line 3650

def get_me(opts = {})
  data, _status_code, _headers = get_me_with_http_info(opts)
  data
end

#get_me_with_http_info(opts = {}) ⇒ Array<(GetMe200Response, Integer, Hash)>

getMe A simple method for testing your bot&#39;s authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetMe200Response, Integer, Hash)>) —

    GetMe200Response data, response status code and response headers



3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
 
# File 'lib/telegram-bot/api/default_api.rb', line 3659

def get_me_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_me ...'
  end
  # resource path
  local_var_path = '/getMe'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMe200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_me",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_my_commands(opts = {}) ⇒ GetMyCommands200Response

getMyCommands Use this method to get the current list of the bot’s commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren’t set, an empty list is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:



3709
3710
3711
3712
 
# File 'lib/telegram-bot/api/default_api.rb', line 3709

def get_my_commands(opts = {})
  data, _status_code, _headers = get_my_commands_with_http_info(opts)
  data
end

#get_my_commands_with_http_info(opts = {}) ⇒ Array<(GetMyCommands200Response, Integer, Hash)>

getMyCommands Use this method to get the current list of the bot&#39;s commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren&#39;t set, an empty list is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:

  • (Array<(GetMyCommands200Response, Integer, Hash)>) —

    GetMyCommands200Response data, response status code and response headers



3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
 
# File 'lib/telegram-bot/api/default_api.rb', line 3720

def get_my_commands_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_my_commands ...'
  end
  # resource path
  local_var_path = '/getMyCommands'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMyCommands200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_my_commands",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_my_commands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_my_default_administrator_rights(opts = {}) ⇒ GetMyDefaultAdministratorRights200Response

getMyDefaultAdministratorRights Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_channels (Boolean)

Returns:



3771
3772
3773
3774
 
# File 'lib/telegram-bot/api/default_api.rb', line 3771

def get_my_default_administrator_rights(opts = {})
  data, _status_code, _headers = get_my_default_administrator_rights_with_http_info(opts)
  data
end

#get_my_default_administrator_rights_with_http_info(opts = {}) ⇒ Array<(GetMyDefaultAdministratorRights200Response, Integer, Hash)>

getMyDefaultAdministratorRights Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :for_channels (Boolean)

Returns:



3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
 
# File 'lib/telegram-bot/api/default_api.rb', line 3781

def get_my_default_administrator_rights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_my_default_administrator_rights ...'
  end
  # resource path
  local_var_path = '/getMyDefaultAdministratorRights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'for_channels'] = opts[:'for_channels'] if !opts[:'for_channels'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMyDefaultAdministratorRights200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_my_default_administrator_rights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_my_default_administrator_rights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_my_description(opts = {}) ⇒ GetMyDescription200Response

getMyDescription Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:



3831
3832
3833
3834
 
# File 'lib/telegram-bot/api/default_api.rb', line 3831

def get_my_description(opts = {})
  data, _status_code, _headers = get_my_description_with_http_info(opts)
  data
end

#get_my_description_with_http_info(opts = {}) ⇒ Array<(GetMyDescription200Response, Integer, Hash)>

getMyDescription Use this method to get the current bot description for the given user language. Returns BotDescription on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:

  • (Array<(GetMyDescription200Response, Integer, Hash)>) —

    GetMyDescription200Response data, response status code and response headers



3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
 
# File 'lib/telegram-bot/api/default_api.rb', line 3841

def get_my_description_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_my_description ...'
  end
  # resource path
  local_var_path = '/getMyDescription'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMyDescription200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_my_description",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_my_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_my_name(opts = {}) ⇒ GetMyName200Response

getMyName Use this method to get the current bot name for the given user language. Returns BotName on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:



3891
3892
3893
3894
 
# File 'lib/telegram-bot/api/default_api.rb', line 3891

def get_my_name(opts = {})
  data, _status_code, _headers = get_my_name_with_http_info(opts)
  data
end

#get_my_name_with_http_info(opts = {}) ⇒ Array<(GetMyName200Response, Integer, Hash)>

getMyName Use this method to get the current bot name for the given user language. Returns BotName on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:

  • (Array<(GetMyName200Response, Integer, Hash)>) —

    GetMyName200Response data, response status code and response headers



3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
 
# File 'lib/telegram-bot/api/default_api.rb', line 3901

def get_my_name_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_my_name ...'
  end
  # resource path
  local_var_path = '/getMyName'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMyName200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_my_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_my_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_my_short_description(opts = {}) ⇒ GetMyShortDescription200Response

getMyShortDescription Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:



3951
3952
3953
3954
 
# File 'lib/telegram-bot/api/default_api.rb', line 3951

def get_my_short_description(opts = {})
  data, _status_code, _headers = get_my_short_description_with_http_info(opts)
  data
end

#get_my_short_description_with_http_info(opts = {}) ⇒ Array<(GetMyShortDescription200Response, Integer, Hash)>

getMyShortDescription Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language_code (String)

Returns:



3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
 
# File 'lib/telegram-bot/api/default_api.rb', line 3961

def get_my_short_description_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_my_short_description ...'
  end
  # resource path
  local_var_path = '/getMyShortDescription'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMyShortDescription200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_my_short_description",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_my_short_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sticker_set(name, opts = {}) ⇒ GetStickerSet200Response

getStickerSet Use this method to get a sticker set. On success, a StickerSet object is returned.

Parameters:

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

    the optional parameters

Returns:



4011
4012
4013
4014
 
# File 'lib/telegram-bot/api/default_api.rb', line 4011

def get_sticker_set(name, opts = {})
  data, _status_code, _headers = get_sticker_set_with_http_info(name, opts)
  data
end

#get_sticker_set_with_http_info(name, opts = {}) ⇒ Array<(GetStickerSet200Response, Integer, Hash)>

getStickerSet Use this method to get a sticker set. On success, a StickerSet object is returned.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetStickerSet200Response, Integer, Hash)>) —

    GetStickerSet200Response data, response status code and response headers



4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
 
# File 'lib/telegram-bot/api/default_api.rb', line 4021

def get_sticker_set_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_sticker_set ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.get_sticker_set"
  end
  # resource path
  local_var_path = '/getStickerSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetStickerSet200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_sticker_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_sticker_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_updates(opts = {}) ⇒ GetUpdates200Response

getUpdates Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer)
  • :limit (Integer)
  • :timeout (Integer)
  • :allowed_updates (Array<String>)

Returns:



4078
4079
4080
4081
 
# File 'lib/telegram-bot/api/default_api.rb', line 4078

def get_updates(opts = {})
  data, _status_code, _headers = get_updates_with_http_info(opts)
  data
end

#get_updates_with_http_info(opts = {}) ⇒ Array<(GetUpdates200Response, Integer, Hash)>

getUpdates Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer)
  • :limit (Integer)
  • :timeout (Integer)
  • :allowed_updates (Array<String>)

Returns:

  • (Array<(GetUpdates200Response, Integer, Hash)>) —

    GetUpdates200Response data, response status code and response headers



4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
 
# File 'lib/telegram-bot/api/default_api.rb', line 4091

def get_updates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_updates ...'
  end
  # resource path
  local_var_path = '/getUpdates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'allowed_updates'] = @api_client.build_collection_param(opts[:'allowed_updates'], :multi) if !opts[:'allowed_updates'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUpdates200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_updates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_chat_boosts(chat_id, user_id, opts = {}) ⇒ GetUserChatBoosts200Response

getUserChatBoosts Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Parameters:

Returns:



4145
4146
4147
4148
 
# File 'lib/telegram-bot/api/default_api.rb', line 4145

def get_user_chat_boosts(chat_id, user_id, opts = {})
  data, _status_code, _headers = get_user_chat_boosts_with_http_info(chat_id, user_id, opts)
  data
end

#get_user_chat_boosts_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(GetUserChatBoosts200Response, Integer, Hash)>

getUserChatBoosts Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

Parameters:

Returns:



4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
 
# File 'lib/telegram-bot/api/default_api.rb', line 4156

def get_user_chat_boosts_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_user_chat_boosts ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.get_user_chat_boosts"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_user_chat_boosts"
  end
  # resource path
  local_var_path = '/getUserChatBoosts'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUserChatBoosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_user_chat_boosts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_user_chat_boosts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_profile_photos(user_id, opts = {}) ⇒ GetUserProfilePhotos200Response

getUserProfilePhotos Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer)
  • :limit (Integer)

Returns:



4217
4218
4219
4220
 
# File 'lib/telegram-bot/api/default_api.rb', line 4217

def (user_id, opts = {})
  data, _status_code, _headers = (user_id, opts)
  data
end

#get_user_profile_photos_with_http_info(user_id, opts = {}) ⇒ Array<(GetUserProfilePhotos200Response, Integer, Hash)>

getUserProfilePhotos Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer)
  • :limit (Integer)

Returns:



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
 
# File 'lib/telegram-bot/api/default_api.rb', line 4229

def (user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_user_profile_photos ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.get_user_profile_photos"
  end
  # resource path
  local_var_path = '/getUserProfilePhotos'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetUserProfilePhotos200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_user_profile_photos",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_user_profile_photos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_info(opts = {}) ⇒ GetWebhookInfo200Response

getWebhookInfo Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Parameters:

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

    the optional parameters

Returns:



4284
4285
4286
4287
 
# File 'lib/telegram-bot/api/default_api.rb', line 4284

def get_webhook_info(opts = {})
  data, _status_code, _headers = get_webhook_info_with_http_info(opts)
  data
end

#get_webhook_info_with_http_info(opts = {}) ⇒ Array<(GetWebhookInfo200Response, Integer, Hash)>

getWebhookInfo Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(GetWebhookInfo200Response, Integer, Hash)>) —

    GetWebhookInfo200Response data, response status code and response headers



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
 
# File 'lib/telegram-bot/api/default_api.rb', line 4293

def get_webhook_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_webhook_info ...'
  end
  # resource path
  local_var_path = '/getWebhookInfo'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetWebhookInfo200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.get_webhook_info",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_webhook_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#hide_general_forum_topic(chat_id, opts = {}) ⇒ SetWebhook200Response

hideGeneralForumTopic Use this method to hide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Parameters:

Returns:



4342
4343
4344
4345
 
# File 'lib/telegram-bot/api/default_api.rb', line 4342

def hide_general_forum_topic(chat_id, opts = {})
  data, _status_code, _headers = hide_general_forum_topic_with_http_info(chat_id, opts)
  data
end

#hide_general_forum_topic_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

hideGeneralForumTopic Use this method to hide the &#39;General&#39; topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
 
# File 'lib/telegram-bot/api/default_api.rb', line 4352

def hide_general_forum_topic_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.hide_general_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.hide_general_forum_topic"
  end
  # resource path
  local_var_path = '/hideGeneralForumTopic'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.hide_general_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#hide_general_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#leave_chat(chat_id, opts = {}) ⇒ SetWebhook200Response

leaveChat Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Parameters:

Returns:



4406
4407
4408
4409
 
# File 'lib/telegram-bot/api/default_api.rb', line 4406

def leave_chat(chat_id, opts = {})
  data, _status_code, _headers = leave_chat_with_http_info(chat_id, opts)
  data
end

#leave_chat_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

leaveChat Use this method for your bot to leave a group, supergroup or channel. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
 
# File 'lib/telegram-bot/api/default_api.rb', line 4416

def leave_chat_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.leave_chat ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.leave_chat"
  end
  # resource path
  local_var_path = '/leaveChat'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.leave_chat",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#leave_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#log_out(opts = {}) ⇒ SetWebhook200Response

logOut Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Parameters:

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

    the optional parameters

Returns:



4469
4470
4471
4472
 
# File 'lib/telegram-bot/api/default_api.rb', line 4469

def log_out(opts = {})
  data, _status_code, _headers = log_out_with_http_info(opts)
  data
end

#log_out_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

logOut Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
 
# File 'lib/telegram-bot/api/default_api.rb', line 4478

def log_out_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.log_out ...'
  end
  # resource path
  local_var_path = '/logOut'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.log_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#log_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pin_chat_message(chat_id, message_id, opts = {}) ⇒ SetWebhook200Response

pinChatMessage Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :disable_notification (Boolean)

Returns:



4529
4530
4531
4532
 
# File 'lib/telegram-bot/api/default_api.rb', line 4529

def pin_chat_message(chat_id, message_id, opts = {})
  data, _status_code, _headers = pin_chat_message_with_http_info(chat_id, message_id, opts)
  data
end

#pin_chat_message_with_http_info(chat_id, message_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

pinChatMessage Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the &#39;can_pin_messages&#39; administrator right in a supergroup or &#39;can_edit_messages&#39; administrator right in a channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :disable_notification (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
 
# File 'lib/telegram-bot/api/default_api.rb', line 4541

def pin_chat_message_with_http_info(chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.pin_chat_message ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.pin_chat_message"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling DefaultApi.pin_chat_message"
  end
  # resource path
  local_var_path = '/pinChatMessage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_id'] = message_id
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.pin_chat_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#pin_chat_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#promote_chat_member(chat_id, user_id, opts = {}) ⇒ SetWebhook200Response

promoteChatMember Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Parameters:

Options Hash (opts):

  • :is_anonymous (Boolean)
  • :can_manage_chat (Boolean)
  • :can_delete_messages (Boolean)
  • :can_manage_video_chats (Boolean)
  • :can_restrict_members (Boolean)
  • :can_promote_members (Boolean)
  • :can_change_info (Boolean)
  • :can_invite_users (Boolean)
  • :can_post_stories (Boolean)
  • :can_edit_stories (Boolean)
  • :can_delete_stories (Boolean)
  • :can_post_messages (Boolean)
  • :can_edit_messages (Boolean)
  • :can_pin_messages (Boolean)
  • :can_manage_topics (Boolean)

Returns:



4617
4618
4619
4620
 
# File 'lib/telegram-bot/api/default_api.rb', line 4617

def promote_chat_member(chat_id, user_id, opts = {})
  data, _status_code, _headers = promote_chat_member_with_http_info(chat_id, user_id, opts)
  data
end

#promote_chat_member_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

promoteChatMember Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.

Parameters:

Options Hash (opts):

  • :is_anonymous (Boolean)
  • :can_manage_chat (Boolean)
  • :can_delete_messages (Boolean)
  • :can_manage_video_chats (Boolean)
  • :can_restrict_members (Boolean)
  • :can_promote_members (Boolean)
  • :can_change_info (Boolean)
  • :can_invite_users (Boolean)
  • :can_post_stories (Boolean)
  • :can_edit_stories (Boolean)
  • :can_delete_stories (Boolean)
  • :can_post_messages (Boolean)
  • :can_edit_messages (Boolean)
  • :can_pin_messages (Boolean)
  • :can_manage_topics (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
 
# File 'lib/telegram-bot/api/default_api.rb', line 4643

def promote_chat_member_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.promote_chat_member ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.promote_chat_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.promote_chat_member"
  end
  # resource path
  local_var_path = '/promoteChatMember'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id
  query_params[:'is_anonymous'] = opts[:'is_anonymous'] if !opts[:'is_anonymous'].nil?
  query_params[:'can_manage_chat'] = opts[:'can_manage_chat'] if !opts[:'can_manage_chat'].nil?
  query_params[:'can_delete_messages'] = opts[:'can_delete_messages'] if !opts[:'can_delete_messages'].nil?
  query_params[:'can_manage_video_chats'] = opts[:'can_manage_video_chats'] if !opts[:'can_manage_video_chats'].nil?
  query_params[:'can_restrict_members'] = opts[:'can_restrict_members'] if !opts[:'can_restrict_members'].nil?
  query_params[:'can_promote_members'] = opts[:'can_promote_members'] if !opts[:'can_promote_members'].nil?
  query_params[:'can_change_info'] = opts[:'can_change_info'] if !opts[:'can_change_info'].nil?
  query_params[:'can_invite_users'] = opts[:'can_invite_users'] if !opts[:'can_invite_users'].nil?
  query_params[:'can_post_stories'] = opts[:'can_post_stories'] if !opts[:'can_post_stories'].nil?
  query_params[:'can_edit_stories'] = opts[:'can_edit_stories'] if !opts[:'can_edit_stories'].nil?
  query_params[:'can_delete_stories'] = opts[:'can_delete_stories'] if !opts[:'can_delete_stories'].nil?
  query_params[:'can_post_messages'] = opts[:'can_post_messages'] if !opts[:'can_post_messages'].nil?
  query_params[:'can_edit_messages'] = opts[:'can_edit_messages'] if !opts[:'can_edit_messages'].nil?
  query_params[:'can_pin_messages'] = opts[:'can_pin_messages'] if !opts[:'can_pin_messages'].nil?
  query_params[:'can_manage_topics'] = opts[:'can_manage_topics'] if !opts[:'can_manage_topics'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.promote_chat_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#promote_chat_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reopen_forum_topic(chat_id, message_thread_id, opts = {}) ⇒ SetWebhook200Response

reopenForumTopic Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Returns:



4718
4719
4720
4721
 
# File 'lib/telegram-bot/api/default_api.rb', line 4718

def reopen_forum_topic(chat_id, message_thread_id, opts = {})
  data, _status_code, _headers = reopen_forum_topic_with_http_info(chat_id, message_thread_id, opts)
  data
end

#reopen_forum_topic_with_http_info(chat_id, message_thread_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

reopenForumTopic Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
 
# File 'lib/telegram-bot/api/default_api.rb', line 4729

def reopen_forum_topic_with_http_info(chat_id, message_thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.reopen_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.reopen_forum_topic"
  end
  # verify the required parameter 'message_thread_id' is set
  if @api_client.config.client_side_validation && message_thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_thread_id' when calling DefaultApi.reopen_forum_topic"
  end
  # resource path
  local_var_path = '/reopenForumTopic'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_thread_id'] = message_thread_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.reopen_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#reopen_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reopen_general_forum_topic(chat_id, opts = {}) ⇒ SetWebhook200Response

reopenGeneralForumTopic Use this method to reopen a closed ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Parameters:

Returns:



4788
4789
4790
4791
 
# File 'lib/telegram-bot/api/default_api.rb', line 4788

def reopen_general_forum_topic(chat_id, opts = {})
  data, _status_code, _headers = reopen_general_forum_topic_with_http_info(chat_id, opts)
  data
end

#reopen_general_forum_topic_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

reopenGeneralForumTopic Use this method to reopen a closed &#39;General&#39; topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
 
# File 'lib/telegram-bot/api/default_api.rb', line 4798

def reopen_general_forum_topic_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.reopen_general_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.reopen_general_forum_topic"
  end
  # resource path
  local_var_path = '/reopenGeneralForumTopic'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.reopen_general_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#reopen_general_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_sticker_in_set(user_id, name, old_sticker, sticker, opts = {}) ⇒ SetWebhook200Response

replaceStickerInSet Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • old_sticker (String)
  • sticker (InputSticker)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4855
4856
4857
4858
 
# File 'lib/telegram-bot/api/default_api.rb', line 4855

def replace_sticker_in_set(user_id, name, old_sticker, sticker, opts = {})
  data, _status_code, _headers = replace_sticker_in_set_with_http_info(user_id, name, old_sticker, sticker, opts)
  data
end

#replace_sticker_in_set_with_http_info(user_id, name, old_sticker, sticker, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

replaceStickerInSet Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

Parameters:

  • user_id (Integer)
  • name (String)
  • old_sticker (String)
  • sticker (InputSticker)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
 
# File 'lib/telegram-bot/api/default_api.rb', line 4868

def replace_sticker_in_set_with_http_info(user_id, name, old_sticker, sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.replace_sticker_in_set ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.replace_sticker_in_set"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.replace_sticker_in_set"
  end
  # verify the required parameter 'old_sticker' is set
  if @api_client.config.client_side_validation && old_sticker.nil?
    fail ArgumentError, "Missing the required parameter 'old_sticker' when calling DefaultApi.replace_sticker_in_set"
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.replace_sticker_in_set"
  end
  # resource path
  local_var_path = '/replaceStickerInSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'name'] = name
  query_params[:'old_sticker'] = old_sticker
  query_params[:'sticker'] = sticker

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.replace_sticker_in_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#replace_sticker_in_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#restrict_chat_member(chat_id, user_id, permissions, opts = {}) ⇒ SetWebhook200Response

restrictChatMember Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Parameters:

Options Hash (opts):

  • :use_independent_chat_permissions (Boolean)
  • :until_date (Integer)

Returns:



4941
4942
4943
4944
 
# File 'lib/telegram-bot/api/default_api.rb', line 4941

def restrict_chat_member(chat_id, user_id, permissions, opts = {})
  data, _status_code, _headers = restrict_chat_member_with_http_info(chat_id, user_id, permissions, opts)
  data
end

#restrict_chat_member_with_http_info(chat_id, user_id, permissions, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

restrictChatMember Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.

Parameters:

Options Hash (opts):

  • :use_independent_chat_permissions (Boolean)
  • :until_date (Integer)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
 
# File 'lib/telegram-bot/api/default_api.rb', line 4955

def restrict_chat_member_with_http_info(chat_id, user_id, permissions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.restrict_chat_member ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.restrict_chat_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.restrict_chat_member"
  end
  # verify the required parameter 'permissions' is set
  if @api_client.config.client_side_validation && permissions.nil?
    fail ArgumentError, "Missing the required parameter 'permissions' when calling DefaultApi.restrict_chat_member"
  end
  # resource path
  local_var_path = '/restrictChatMember'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id
  query_params[:'permissions'] = permissions
  query_params[:'use_independent_chat_permissions'] = opts[:'use_independent_chat_permissions'] if !opts[:'use_independent_chat_permissions'].nil?
  query_params[:'until_date'] = opts[:'until_date'] if !opts[:'until_date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.restrict_chat_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#restrict_chat_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_chat_invite_link(chat_id, invite_link, opts = {}) ⇒ CreateChatInviteLink200Response

revokeChatInviteLink Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Parameters:

Returns:



5022
5023
5024
5025
 
# File 'lib/telegram-bot/api/default_api.rb', line 5022

def revoke_chat_invite_link(chat_id, invite_link, opts = {})
  data, _status_code, _headers = revoke_chat_invite_link_with_http_info(chat_id, invite_link, opts)
  data
end

#revoke_chat_invite_link_with_http_info(chat_id, invite_link, opts = {}) ⇒ Array<(CreateChatInviteLink200Response, Integer, Hash)>

revokeChatInviteLink Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

Parameters:

Returns:



5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
 
# File 'lib/telegram-bot/api/default_api.rb', line 5033

def revoke_chat_invite_link_with_http_info(chat_id, invite_link, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.revoke_chat_invite_link ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.revoke_chat_invite_link"
  end
  # verify the required parameter 'invite_link' is set
  if @api_client.config.client_side_validation && invite_link.nil?
    fail ArgumentError, "Missing the required parameter 'invite_link' when calling DefaultApi.revoke_chat_invite_link"
  end
  # resource path
  local_var_path = '/revokeChatInviteLink'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'invite_link'] = invite_link

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateChatInviteLink200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.revoke_chat_invite_link",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#revoke_chat_invite_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_animation(chat_id, animation, opts = {}) ⇒ SendMessage200Response

sendAnimation Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

Returns:



5107
5108
5109
5110
 
# File 'lib/telegram-bot/api/default_api.rb', line 5107

def send_animation(chat_id, animation, opts = {})
  data, _status_code, _headers = send_animation_with_http_info(chat_id, animation, opts)
  data
end

#send_animation_with_http_info(chat_id, animation, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendAnimation Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
 
# File 'lib/telegram-bot/api/default_api.rb', line 5132

def send_animation_with_http_info(chat_id, animation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_animation ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_animation"
  end
  # verify the required parameter 'animation' is set
  if @api_client.config.client_side_validation && animation.nil?
    fail ArgumentError, "Missing the required parameter 'animation' when calling DefaultApi.send_animation"
  end
  # resource path
  local_var_path = '/sendAnimation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'animation'] = animation
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'has_spoiler'] = opts[:'has_spoiler'] if !opts[:'has_spoiler'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_animation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_animation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_audio(chat_id, audio, opts = {}) ⇒ SendMessage200Response

sendAudio Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.

Parameters:

Options Hash (opts):

Returns:



5219
5220
5221
5222
 
# File 'lib/telegram-bot/api/default_api.rb', line 5219

def send_audio(chat_id, audio, opts = {})
  data, _status_code, _headers = send_audio_with_http_info(chat_id, audio, opts)
  data
end

#send_audio_with_http_info(chat_id, audio, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendAudio Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
 
# File 'lib/telegram-bot/api/default_api.rb', line 5243

def send_audio_with_http_info(chat_id, audio, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_audio ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_audio"
  end
  # verify the required parameter 'audio' is set
  if @api_client.config.client_side_validation && audio.nil?
    fail ArgumentError, "Missing the required parameter 'audio' when calling DefaultApi.send_audio"
  end
  # resource path
  local_var_path = '/sendAudio'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'audio'] = audio
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
  query_params[:'performer'] = opts[:'performer'] if !opts[:'performer'].nil?
  query_params[:'title'] = opts[:'title'] if !opts[:'title'].nil?
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_audio",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_chat_action(chat_id, action, opts = {}) ⇒ SetWebhook200Response

sendChatAction Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)

Returns:



5318
5319
5320
5321
 
# File 'lib/telegram-bot/api/default_api.rb', line 5318

def send_chat_action(chat_id, action, opts = {})
  data, _status_code, _headers = send_chat_action_with_http_info(chat_id, action, opts)
  data
end

#send_chat_action_with_http_info(chat_id, action, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

sendChatAction Use this method when you need to tell the user that something is happening on the bot&#39;s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success. We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
 
# File 'lib/telegram-bot/api/default_api.rb', line 5331

def send_chat_action_with_http_info(chat_id, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_chat_action ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_chat_action"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling DefaultApi.send_chat_action"
  end
  # resource path
  local_var_path = '/sendChatAction'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'action'] = action
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_chat_action",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_chat_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_contact(chat_id, phone_number, first_name, opts = {}) ⇒ SendMessage200Response

sendContact Use this method to send phone contacts. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • phone_number (String)
  • first_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :last_name (String)
  • :vcard (String)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



5402
5403
5404
5405
 
# File 'lib/telegram-bot/api/default_api.rb', line 5402

def send_contact(chat_id, phone_number, first_name, opts = {})
  data, _status_code, _headers = send_contact_with_http_info(chat_id, phone_number, first_name, opts)
  data
end

#send_contact_with_http_info(chat_id, phone_number, first_name, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendContact Use this method to send phone contacts. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • phone_number (String)
  • first_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :last_name (String)
  • :vcard (String)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
 
# File 'lib/telegram-bot/api/default_api.rb', line 5422

def send_contact_with_http_info(chat_id, phone_number, first_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_contact ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_contact"
  end
  # verify the required parameter 'phone_number' is set
  if @api_client.config.client_side_validation && phone_number.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number' when calling DefaultApi.send_contact"
  end
  # verify the required parameter 'first_name' is set
  if @api_client.config.client_side_validation && first_name.nil?
    fail ArgumentError, "Missing the required parameter 'first_name' when calling DefaultApi.send_contact"
  end
  # resource path
  local_var_path = '/sendContact'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'phone_number'] = phone_number
  query_params[:'first_name'] = first_name
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'last_name'] = opts[:'last_name'] if !opts[:'last_name'].nil?
  query_params[:'vcard'] = opts[:'vcard'] if !opts[:'vcard'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_contact",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_dice(chat_id, opts = {}) ⇒ SendMessage200Response

sendDice Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:



5501
5502
5503
5504
 
# File 'lib/telegram-bot/api/default_api.rb', line 5501

def send_dice(chat_id, opts = {})
  data, _status_code, _headers = send_dice_with_http_info(chat_id, opts)
  data
end

#send_dice_with_http_info(chat_id, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendDice Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
 
# File 'lib/telegram-bot/api/default_api.rb', line 5518

def send_dice_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_dice ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_dice"
  end
  # resource path
  local_var_path = '/sendDice'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'emoji'] = opts[:'emoji'] if !opts[:'emoji'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_dice",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_dice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_document(chat_id, document, opts = {}) ⇒ SendMessage200Response

sendDocument Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

Returns:



5591
5592
5593
5594
 
# File 'lib/telegram-bot/api/default_api.rb', line 5591

def send_document(chat_id, document, opts = {})
  data, _status_code, _headers = send_document_with_http_info(chat_id, document, opts)
  data
end

#send_document_with_http_info(chat_id, document, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendDocument Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
 
# File 'lib/telegram-bot/api/default_api.rb', line 5613

def send_document_with_http_info(chat_id, document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_document ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_document"
  end
  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling DefaultApi.send_document"
  end
  # resource path
  local_var_path = '/sendDocument'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'document'] = document
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'disable_content_type_detection'] = opts[:'disable_content_type_detection'] if !opts[:'disable_content_type_detection'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_document",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_game(chat_id, game_short_name, opts = {}) ⇒ SendMessage200Response

sendGame Use this method to send a game. On success, the sent Message is returned.

Parameters:

  • chat_id (Integer)
  • game_short_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (InlineKeyboardMarkup)

Returns:



5690
5691
5692
5693
 
# File 'lib/telegram-bot/api/default_api.rb', line 5690

def send_game(chat_id, game_short_name, opts = {})
  data, _status_code, _headers = send_game_with_http_info(chat_id, game_short_name, opts)
  data
end

#send_game_with_http_info(chat_id, game_short_name, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendGame Use this method to send a game. On success, the sent Message is returned.

Parameters:

  • chat_id (Integer)
  • game_short_name (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (InlineKeyboardMarkup)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
 
# File 'lib/telegram-bot/api/default_api.rb', line 5707

def send_game_with_http_info(chat_id, game_short_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_game ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_game"
  end
  # verify the required parameter 'game_short_name' is set
  if @api_client.config.client_side_validation && game_short_name.nil?
    fail ArgumentError, "Missing the required parameter 'game_short_name' when calling DefaultApi.send_game"
  end
  # resource path
  local_var_path = '/sendGame'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'game_short_name'] = game_short_name
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_game",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_game\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_invoice(chat_id, title, description, payload, provider_token, currency, prices, opts = {}) ⇒ SendMessage200Response

sendInvoice Use this method to send invoices. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • title (String)
  • description (String)
  • payload (String)
  • provider_token (String)
  • currency (String)
  • prices (Array<LabeledPrice>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_thread_id (Integer)
  • :max_tip_amount (Integer)
  • :suggested_tip_amounts (Array<Integer>)
  • :start_parameter (String)
  • :provider_data (String)
  • :photo_url (String)
  • :photo_size (Integer)
  • :photo_width (Integer)
  • :photo_height (Integer)
  • :need_name (Boolean)
  • :need_phone_number (Boolean)
  • :need_email (Boolean)
  • :need_shipping_address (Boolean)
  • :send_phone_number_to_provider (Boolean)
  • :send_email_to_provider (Boolean)
  • :is_flexible (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (InlineKeyboardMarkup)

Returns:



5798
5799
5800
5801
 
# File 'lib/telegram-bot/api/default_api.rb', line 5798

def send_invoice(chat_id, title, description, payload, provider_token, currency, prices, opts = {})
  data, _status_code, _headers = send_invoice_with_http_info(chat_id, title, description, payload, provider_token, currency, prices, opts)
  data
end

#send_invoice_with_http_info(chat_id, title, description, payload, provider_token, currency, prices, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendInvoice Use this method to send invoices. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • title (String)
  • description (String)
  • payload (String)
  • provider_token (String)
  • currency (String)
  • prices (Array<LabeledPrice>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_thread_id (Integer)
  • :max_tip_amount (Integer)
  • :suggested_tip_amounts (Array<Integer>)
  • :start_parameter (String)
  • :provider_data (String)
  • :photo_url (String)
  • :photo_size (Integer)
  • :photo_width (Integer)
  • :photo_height (Integer)
  • :need_name (Boolean)
  • :need_phone_number (Boolean)
  • :need_email (Boolean)
  • :need_shipping_address (Boolean)
  • :send_phone_number_to_provider (Boolean)
  • :send_email_to_provider (Boolean)
  • :is_flexible (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (InlineKeyboardMarkup)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
 
# File 'lib/telegram-bot/api/default_api.rb', line 5834

def send_invoice_with_http_info(chat_id, title, description, payload, provider_token, currency, prices, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_invoice ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'description' is set
  if @api_client.config.client_side_validation && description.nil?
    fail ArgumentError, "Missing the required parameter 'description' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'payload' is set
  if @api_client.config.client_side_validation && payload.nil?
    fail ArgumentError, "Missing the required parameter 'payload' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'provider_token' is set
  if @api_client.config.client_side_validation && provider_token.nil?
    fail ArgumentError, "Missing the required parameter 'provider_token' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'currency' is set
  if @api_client.config.client_side_validation && currency.nil?
    fail ArgumentError, "Missing the required parameter 'currency' when calling DefaultApi.send_invoice"
  end
  # verify the required parameter 'prices' is set
  if @api_client.config.client_side_validation && prices.nil?
    fail ArgumentError, "Missing the required parameter 'prices' when calling DefaultApi.send_invoice"
  end
  # resource path
  local_var_path = '/sendInvoice'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'title'] = title
  query_params[:'description'] = description
  query_params[:'payload'] = payload
  query_params[:'provider_token'] = provider_token
  query_params[:'currency'] = currency
  query_params[:'prices'] = @api_client.build_collection_param(prices, :multi)
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'max_tip_amount'] = opts[:'max_tip_amount'] if !opts[:'max_tip_amount'].nil?
  query_params[:'suggested_tip_amounts'] = @api_client.build_collection_param(opts[:'suggested_tip_amounts'], :multi) if !opts[:'suggested_tip_amounts'].nil?
  query_params[:'start_parameter'] = opts[:'start_parameter'] if !opts[:'start_parameter'].nil?
  query_params[:'provider_data'] = opts[:'provider_data'] if !opts[:'provider_data'].nil?
  query_params[:'photo_url'] = opts[:'photo_url'] if !opts[:'photo_url'].nil?
  query_params[:'photo_size'] = opts[:'photo_size'] if !opts[:'photo_size'].nil?
  query_params[:'photo_width'] = opts[:'photo_width'] if !opts[:'photo_width'].nil?
  query_params[:'photo_height'] = opts[:'photo_height'] if !opts[:'photo_height'].nil?
  query_params[:'need_name'] = opts[:'need_name'] if !opts[:'need_name'].nil?
  query_params[:'need_phone_number'] = opts[:'need_phone_number'] if !opts[:'need_phone_number'].nil?
  query_params[:'need_email'] = opts[:'need_email'] if !opts[:'need_email'].nil?
  query_params[:'need_shipping_address'] = opts[:'need_shipping_address'] if !opts[:'need_shipping_address'].nil?
  query_params[:'send_phone_number_to_provider'] = opts[:'send_phone_number_to_provider'] if !opts[:'send_phone_number_to_provider'].nil?
  query_params[:'send_email_to_provider'] = opts[:'send_email_to_provider'] if !opts[:'send_email_to_provider'].nil?
  query_params[:'is_flexible'] = opts[:'is_flexible'] if !opts[:'is_flexible'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_invoice",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_location(chat_id, latitude, longitude, opts = {}) ⇒ SendMessage200Response

sendLocation Use this method to send point on the map. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :horizontal_accuracy (Float)
  • :live_period (Integer)
  • :heading (Integer)
  • :proximity_alert_radius (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



5950
5951
5952
5953
 
# File 'lib/telegram-bot/api/default_api.rb', line 5950

def send_location(chat_id, latitude, longitude, opts = {})
  data, _status_code, _headers = send_location_with_http_info(chat_id, latitude, longitude, opts)
  data
end

#send_location_with_http_info(chat_id, latitude, longitude, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendLocation Use this method to send point on the map. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :horizontal_accuracy (Float)
  • :live_period (Integer)
  • :heading (Integer)
  • :proximity_alert_radius (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
 
# File 'lib/telegram-bot/api/default_api.rb', line 5972

def send_location_with_http_info(chat_id, latitude, longitude, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_location ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_location"
  end
  # verify the required parameter 'latitude' is set
  if @api_client.config.client_side_validation && latitude.nil?
    fail ArgumentError, "Missing the required parameter 'latitude' when calling DefaultApi.send_location"
  end
  # verify the required parameter 'longitude' is set
  if @api_client.config.client_side_validation && longitude.nil?
    fail ArgumentError, "Missing the required parameter 'longitude' when calling DefaultApi.send_location"
  end
  # resource path
  local_var_path = '/sendLocation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'latitude'] = latitude
  query_params[:'longitude'] = longitude
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'horizontal_accuracy'] = opts[:'horizontal_accuracy'] if !opts[:'horizontal_accuracy'].nil?
  query_params[:'live_period'] = opts[:'live_period'] if !opts[:'live_period'].nil?
  query_params[:'heading'] = opts[:'heading'] if !opts[:'heading'].nil?
  query_params[:'proximity_alert_radius'] = opts[:'proximity_alert_radius'] if !opts[:'proximity_alert_radius'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_location",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_media_group(chat_id, media, opts = {}) ⇒ SendMediaGroup200Response

sendMediaGroup Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)

Returns:



6052
6053
6054
6055
 
# File 'lib/telegram-bot/api/default_api.rb', line 6052

def send_media_group(chat_id, media, opts = {})
  data, _status_code, _headers = send_media_group_with_http_info(chat_id, media, opts)
  data
end

#send_media_group_with_http_info(chat_id, media, opts = {}) ⇒ Array<(SendMediaGroup200Response, Integer, Hash)>

sendMediaGroup Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)

Returns:

  • (Array<(SendMediaGroup200Response, Integer, Hash)>) —

    SendMediaGroup200Response data, response status code and response headers



6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
 
# File 'lib/telegram-bot/api/default_api.rb', line 6068

def send_media_group_with_http_info(chat_id, media, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_media_group ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_media_group"
  end
  # verify the required parameter 'media' is set
  if @api_client.config.client_side_validation && media.nil?
    fail ArgumentError, "Missing the required parameter 'media' when calling DefaultApi.send_media_group"
  end
  # resource path
  local_var_path = '/sendMediaGroup'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'media'] = media
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMediaGroup200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_media_group",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_media_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_message(chat_id, text, opts = {}) ⇒ SendMessage200Response

sendMessage Use this method to send text messages. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:



6142
6143
6144
6145
 
# File 'lib/telegram-bot/api/default_api.rb', line 6142

def send_message(chat_id, text, opts = {})
  data, _status_code, _headers = send_message_with_http_info(chat_id, text, opts)
  data
end

#send_message_with_http_info(chat_id, text, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendMessage Use this method to send text messages. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
 
# File 'lib/telegram-bot/api/default_api.rb', line 6162

def send_message_with_http_info(chat_id, text, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_message ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_message"
  end
  # verify the required parameter 'text' is set
  if @api_client.config.client_side_validation && text.nil?
    fail ArgumentError, "Missing the required parameter 'text' when calling DefaultApi.send_message"
  end
  # resource path
  local_var_path = '/sendMessage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'text'] = text
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'entities'] = @api_client.build_collection_param(opts[:'entities'], :multi) if !opts[:'entities'].nil?
  query_params[:'link_preview_options'] = opts[:'link_preview_options'] if !opts[:'link_preview_options'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_photo(chat_id, photo, opts = {}) ⇒ SendMessage200Response

sendPhoto Use this method to send photos. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :has_spoiler (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



6241
6242
6243
6244
 
# File 'lib/telegram-bot/api/default_api.rb', line 6241

def send_photo(chat_id, photo, opts = {})
  data, _status_code, _headers = send_photo_with_http_info(chat_id, photo, opts)
  data
end

#send_photo_with_http_info(chat_id, photo, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendPhoto Use this method to send photos. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :has_spoiler (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
 
# File 'lib/telegram-bot/api/default_api.rb', line 6262

def send_photo_with_http_info(chat_id, photo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_photo ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_photo"
  end
  # verify the required parameter 'photo' is set
  if @api_client.config.client_side_validation && photo.nil?
    fail ArgumentError, "Missing the required parameter 'photo' when calling DefaultApi.send_photo"
  end
  # resource path
  local_var_path = '/sendPhoto'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'photo'] = photo
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'has_spoiler'] = opts[:'has_spoiler'] if !opts[:'has_spoiler'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_photo",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_poll(chat_id, question, options, opts = {}) ⇒ SendMessage200Response

sendPoll Use this method to send a native poll. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • question (String)
  • options (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :is_anonymous (Boolean)
  • :type (String)
  • :allows_multiple_answers (Boolean)
  • :correct_option_id (Integer)
  • :explanation (String)
  • :explanation_parse_mode (String)
  • :explanation_entities (Array<MessageEntity>)
  • :open_period (Integer)
  • :close_date (Integer)
  • :is_closed (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



6349
6350
6351
6352
 
# File 'lib/telegram-bot/api/default_api.rb', line 6349

def send_poll(chat_id, question, options, opts = {})
  data, _status_code, _headers = send_poll_with_http_info(chat_id, question, options, opts)
  data
end

#send_poll_with_http_info(chat_id, question, options, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendPoll Use this method to send a native poll. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • question (String)
  • options (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :is_anonymous (Boolean)
  • :type (String)
  • :allows_multiple_answers (Boolean)
  • :correct_option_id (Integer)
  • :explanation (String)
  • :explanation_parse_mode (String)
  • :explanation_entities (Array<MessageEntity>)
  • :open_period (Integer)
  • :close_date (Integer)
  • :is_closed (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
 
# File 'lib/telegram-bot/api/default_api.rb', line 6377

def send_poll_with_http_info(chat_id, question, options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_poll ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_poll"
  end
  # verify the required parameter 'question' is set
  if @api_client.config.client_side_validation && question.nil?
    fail ArgumentError, "Missing the required parameter 'question' when calling DefaultApi.send_poll"
  end
  # verify the required parameter 'options' is set
  if @api_client.config.client_side_validation && options.nil?
    fail ArgumentError, "Missing the required parameter 'options' when calling DefaultApi.send_poll"
  end
  # resource path
  local_var_path = '/sendPoll'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'question'] = question
  query_params[:'options'] = @api_client.build_collection_param(options, :multi)
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'is_anonymous'] = opts[:'is_anonymous'] if !opts[:'is_anonymous'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'allows_multiple_answers'] = opts[:'allows_multiple_answers'] if !opts[:'allows_multiple_answers'].nil?
  query_params[:'correct_option_id'] = opts[:'correct_option_id'] if !opts[:'correct_option_id'].nil?
  query_params[:'explanation'] = opts[:'explanation'] if !opts[:'explanation'].nil?
  query_params[:'explanation_parse_mode'] = opts[:'explanation_parse_mode'] if !opts[:'explanation_parse_mode'].nil?
  query_params[:'explanation_entities'] = @api_client.build_collection_param(opts[:'explanation_entities'], :multi) if !opts[:'explanation_entities'].nil?
  query_params[:'open_period'] = opts[:'open_period'] if !opts[:'open_period'].nil?
  query_params[:'close_date'] = opts[:'close_date'] if !opts[:'close_date'].nil?
  query_params[:'is_closed'] = opts[:'is_closed'] if !opts[:'is_closed'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_poll",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_poll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_sticker(chat_id, sticker, opts = {}) ⇒ SendMessage200Response

sendSticker Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:



6465
6466
6467
6468
 
# File 'lib/telegram-bot/api/default_api.rb', line 6465

def send_sticker(chat_id, sticker, opts = {})
  data, _status_code, _headers = send_sticker_with_http_info(chat_id, sticker, opts)
  data
end

#send_sticker_with_http_info(chat_id, sticker, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendSticker Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
 
# File 'lib/telegram-bot/api/default_api.rb', line 6483

def send_sticker_with_http_info(chat_id, sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_sticker ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_sticker"
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.send_sticker"
  end
  # resource path
  local_var_path = '/sendSticker'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'sticker'] = sticker
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'emoji'] = opts[:'emoji'] if !opts[:'emoji'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_sticker",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_sticker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_venue(chat_id, latitude, longitude, title, address, opts = {}) ⇒ SendMessage200Response

sendVenue Use this method to send information about a venue. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • latitude (Float)
  • longitude (Float)
  • title (String)
  • address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :foursquare_id (String)
  • :foursquare_type (String)
  • :google_place_id (String)
  • :google_place_type (String)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



6563
6564
6565
6566
 
# File 'lib/telegram-bot/api/default_api.rb', line 6563

def send_venue(chat_id, latitude, longitude, title, address, opts = {})
  data, _status_code, _headers = send_venue_with_http_info(chat_id, latitude, longitude, title, address, opts)
  data
end

#send_venue_with_http_info(chat_id, latitude, longitude, title, address, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendVenue Use this method to send information about a venue. On success, the sent Message is returned.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • latitude (Float)
  • longitude (Float)
  • title (String)
  • address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :foursquare_id (String)
  • :foursquare_type (String)
  • :google_place_id (String)
  • :google_place_type (String)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
 
# File 'lib/telegram-bot/api/default_api.rb', line 6587

def send_venue_with_http_info(chat_id, latitude, longitude, title, address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_venue ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_venue"
  end
  # verify the required parameter 'latitude' is set
  if @api_client.config.client_side_validation && latitude.nil?
    fail ArgumentError, "Missing the required parameter 'latitude' when calling DefaultApi.send_venue"
  end
  # verify the required parameter 'longitude' is set
  if @api_client.config.client_side_validation && longitude.nil?
    fail ArgumentError, "Missing the required parameter 'longitude' when calling DefaultApi.send_venue"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.send_venue"
  end
  # verify the required parameter 'address' is set
  if @api_client.config.client_side_validation && address.nil?
    fail ArgumentError, "Missing the required parameter 'address' when calling DefaultApi.send_venue"
  end
  # resource path
  local_var_path = '/sendVenue'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'latitude'] = latitude
  query_params[:'longitude'] = longitude
  query_params[:'title'] = title
  query_params[:'address'] = address
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'foursquare_id'] = opts[:'foursquare_id'] if !opts[:'foursquare_id'].nil?
  query_params[:'foursquare_type'] = opts[:'foursquare_type'] if !opts[:'foursquare_type'].nil?
  query_params[:'google_place_id'] = opts[:'google_place_id'] if !opts[:'google_place_id'].nil?
  query_params[:'google_place_type'] = opts[:'google_place_type'] if !opts[:'google_place_type'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_venue",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_venue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_video(chat_id, video, opts = {}) ⇒ SendMessage200Response

sendVideo Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :duration (Integer)
  • :width (Integer)
  • :height (Integer)
  • :thumbnail (Hash<String, SendPhotoPhotoParameterValue>)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :has_spoiler (Boolean)
  • :supports_streaming (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



6687
6688
6689
6690
 
# File 'lib/telegram-bot/api/default_api.rb', line 6687

def send_video(chat_id, video, opts = {})
  data, _status_code, _headers = send_video_with_http_info(chat_id, video, opts)
  data
end

#send_video_note(chat_id, video_note, opts = {}) ⇒ SendMessage200Response

sendVideoNote As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:



6797
6798
6799
6800
 
# File 'lib/telegram-bot/api/default_api.rb', line 6797

def send_video_note(chat_id, video_note, opts = {})
  data, _status_code, _headers = send_video_note_with_http_info(chat_id, video_note, opts)
  data
end

#send_video_note_with_http_info(chat_id, video_note, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendVideoNote As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
 
# File 'lib/telegram-bot/api/default_api.rb', line 6817

def send_video_note_with_http_info(chat_id, video_note, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_video_note ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_video_note"
  end
  # verify the required parameter 'video_note' is set
  if @api_client.config.client_side_validation && video_note.nil?
    fail ArgumentError, "Missing the required parameter 'video_note' when calling DefaultApi.send_video_note"
  end
  # resource path
  local_var_path = '/sendVideoNote'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'video_note'] = video_note
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
  query_params[:'length'] = opts[:'length'] if !opts[:'length'].nil?
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_video_note",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_video_note\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_video_with_http_info(chat_id, video, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendVideo Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :duration (Integer)
  • :width (Integer)
  • :height (Integer)
  • :thumbnail (Hash<String, SendPhotoPhotoParameterValue>)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :has_spoiler (Boolean)
  • :supports_streaming (Boolean)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
 
# File 'lib/telegram-bot/api/default_api.rb', line 6713

def send_video_with_http_info(chat_id, video, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_video ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_video"
  end
  # verify the required parameter 'video' is set
  if @api_client.config.client_side_validation && video.nil?
    fail ArgumentError, "Missing the required parameter 'video' when calling DefaultApi.send_video"
  end
  # resource path
  local_var_path = '/sendVideo'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'video'] = video
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
  query_params[:'width'] = opts[:'width'] if !opts[:'width'].nil?
  query_params[:'height'] = opts[:'height'] if !opts[:'height'].nil?
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'has_spoiler'] = opts[:'has_spoiler'] if !opts[:'has_spoiler'].nil?
  query_params[:'supports_streaming'] = opts[:'supports_streaming'] if !opts[:'supports_streaming'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_voice(chat_id, voice, opts = {}) ⇒ SendMessage200Response

sendVoice Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :duration (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:



6896
6897
6898
6899
 
# File 'lib/telegram-bot/api/default_api.rb', line 6896

def send_voice(chat_id, voice, opts = {})
  data, _status_code, _headers = send_voice_with_http_info(chat_id, voice, opts)
  data
end

#send_voice_with_http_info(chat_id, voice, opts = {}) ⇒ Array<(SendMessage200Response, Integer, Hash)>

sendVoice Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

Parameters:

Options Hash (opts):

  • :business_connection_id (String)
  • :message_thread_id (Integer)
  • :caption (String)
  • :parse_mode (String)
  • :caption_entities (Array<MessageEntity>)
  • :duration (Integer)
  • :disable_notification (Boolean)
  • :protect_content (Boolean)
  • :reply_parameters (ReplyParameters)
  • :reply_markup (Hash<String, SendMessageReplyMarkupParameterValue>)

Returns:

  • (Array<(SendMessage200Response, Integer, Hash)>) —

    SendMessage200Response data, response status code and response headers



6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
 
# File 'lib/telegram-bot/api/default_api.rb', line 6917

def send_voice_with_http_info(chat_id, voice, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.send_voice ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.send_voice"
  end
  # verify the required parameter 'voice' is set
  if @api_client.config.client_side_validation && voice.nil?
    fail ArgumentError, "Missing the required parameter 'voice' when calling DefaultApi.send_voice"
  end
  # resource path
  local_var_path = '/sendVoice'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'voice'] = voice
  query_params[:'business_connection_id'] = opts[:'business_connection_id'] if !opts[:'business_connection_id'].nil?
  query_params[:'message_thread_id'] = opts[:'message_thread_id'] if !opts[:'message_thread_id'].nil?
  query_params[:'caption'] = opts[:'caption'] if !opts[:'caption'].nil?
  query_params[:'parse_mode'] = opts[:'parse_mode'] if !opts[:'parse_mode'].nil?
  query_params[:'caption_entities'] = @api_client.build_collection_param(opts[:'caption_entities'], :multi) if !opts[:'caption_entities'].nil?
  query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
  query_params[:'disable_notification'] = opts[:'disable_notification'] if !opts[:'disable_notification'].nil?
  query_params[:'protect_content'] = opts[:'protect_content'] if !opts[:'protect_content'].nil?
  query_params[:'reply_parameters'] = opts[:'reply_parameters'] if !opts[:'reply_parameters'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SendMessage200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.send_voice",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#send_voice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_administrator_custom_title(chat_id, user_id, custom_title, opts = {}) ⇒ SetWebhook200Response

setChatAdministratorCustomTitle Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • user_id (Integer)
  • custom_title (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6988
6989
6990
6991
 
# File 'lib/telegram-bot/api/default_api.rb', line 6988

def set_chat_administrator_custom_title(chat_id, user_id, custom_title, opts = {})
  data, _status_code, _headers = set_chat_administrator_custom_title_with_http_info(chat_id, user_id, custom_title, opts)
  data
end

#set_chat_administrator_custom_title_with_http_info(chat_id, user_id, custom_title, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatAdministratorCustomTitle Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Parameters:

  • chat_id (Hash<String, SendMessageChatIdParameterValue>)
  • user_id (Integer)
  • custom_title (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
 
# File 'lib/telegram-bot/api/default_api.rb', line 7000

def set_chat_administrator_custom_title_with_http_info(chat_id, user_id, custom_title, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_administrator_custom_title ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_administrator_custom_title"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.set_chat_administrator_custom_title"
  end
  # verify the required parameter 'custom_title' is set
  if @api_client.config.client_side_validation && custom_title.nil?
    fail ArgumentError, "Missing the required parameter 'custom_title' when calling DefaultApi.set_chat_administrator_custom_title"
  end
  # resource path
  local_var_path = '/setChatAdministratorCustomTitle'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id
  query_params[:'custom_title'] = custom_title

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_administrator_custom_title",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_administrator_custom_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_description(chat_id, opts = {}) ⇒ SetWebhook200Response

setChatDescription Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :description (String)

Returns:



7065
7066
7067
7068
 
# File 'lib/telegram-bot/api/default_api.rb', line 7065

def set_chat_description(chat_id, opts = {})
  data, _status_code, _headers = set_chat_description_with_http_info(chat_id, opts)
  data
end

#set_chat_description_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatDescription Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :description (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
 
# File 'lib/telegram-bot/api/default_api.rb', line 7076

def set_chat_description_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_description ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_description"
  end
  # resource path
  local_var_path = '/setChatDescription'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_description",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_menu_button(opts = {}) ⇒ SetWebhook200Response

setChatMenuButton Use this method to change the bot’s menu button in a private chat, or the default menu button. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)
  • :menu_button (Object)

Returns:



7132
7133
7134
7135
 
# File 'lib/telegram-bot/api/default_api.rb', line 7132

def set_chat_menu_button(opts = {})
  data, _status_code, _headers = set_chat_menu_button_with_http_info(opts)
  data
end

#set_chat_menu_button_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatMenuButton Use this method to change the bot&#39;s menu button in a private chat, or the default menu button. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :chat_id (Integer)
  • :menu_button (Object)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
 
# File 'lib/telegram-bot/api/default_api.rb', line 7143

def set_chat_menu_button_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_menu_button ...'
  end
  # resource path
  local_var_path = '/setChatMenuButton'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'menu_button'] = opts[:'menu_button'] if !opts[:'menu_button'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_menu_button",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_menu_button\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_permissions(chat_id, permissions, opts = {}) ⇒ SetWebhook200Response

setChatPermissions Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :use_independent_chat_permissions (Boolean)

Returns:



7196
7197
7198
7199
 
# File 'lib/telegram-bot/api/default_api.rb', line 7196

def set_chat_permissions(chat_id, permissions, opts = {})
  data, _status_code, _headers = set_chat_permissions_with_http_info(chat_id, permissions, opts)
  data
end

#set_chat_permissions_with_http_info(chat_id, permissions, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatPermissions Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.

Parameters:

Options Hash (opts):

  • :use_independent_chat_permissions (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
 
# File 'lib/telegram-bot/api/default_api.rb', line 7208

def set_chat_permissions_with_http_info(chat_id, permissions, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_permissions ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_permissions"
  end
  # verify the required parameter 'permissions' is set
  if @api_client.config.client_side_validation && permissions.nil?
    fail ArgumentError, "Missing the required parameter 'permissions' when calling DefaultApi.set_chat_permissions"
  end
  # resource path
  local_var_path = '/setChatPermissions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'permissions'] = permissions
  query_params[:'use_independent_chat_permissions'] = opts[:'use_independent_chat_permissions'] if !opts[:'use_independent_chat_permissions'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_permissions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_photo(chat_id, photo, opts = {}) ⇒ SetWebhook200Response

setChatPhoto Use this method to set a new profile photo for the chat. Photos can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:



7269
7270
7271
7272
 
# File 'lib/telegram-bot/api/default_api.rb', line 7269

def set_chat_photo(chat_id, photo, opts = {})
  data, _status_code, _headers = set_chat_photo_with_http_info(chat_id, photo, opts)
  data
end

#set_chat_photo_with_http_info(chat_id, photo, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatPhoto Use this method to set a new profile photo for the chat. Photos can&#39;t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
 
# File 'lib/telegram-bot/api/default_api.rb', line 7280

def set_chat_photo_with_http_info(chat_id, photo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_photo ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_photo"
  end
  # verify the required parameter 'photo' is set
  if @api_client.config.client_side_validation && photo.nil?
    fail ArgumentError, "Missing the required parameter 'photo' when calling DefaultApi.set_chat_photo"
  end
  # resource path
  local_var_path = '/setChatPhoto'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'photo'] = photo

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_photo",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_sticker_set(chat_id, sticker_set_name, opts = {}) ⇒ SetWebhook200Response

setChatStickerSet Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters:

Returns:



7340
7341
7342
7343
 
# File 'lib/telegram-bot/api/default_api.rb', line 7340

def set_chat_sticker_set(chat_id, sticker_set_name, opts = {})
  data, _status_code, _headers = set_chat_sticker_set_with_http_info(chat_id, sticker_set_name, opts)
  data
end

#set_chat_sticker_set_with_http_info(chat_id, sticker_set_name, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatStickerSet Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
 
# File 'lib/telegram-bot/api/default_api.rb', line 7351

def set_chat_sticker_set_with_http_info(chat_id, sticker_set_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_sticker_set ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_sticker_set"
  end
  # verify the required parameter 'sticker_set_name' is set
  if @api_client.config.client_side_validation && sticker_set_name.nil?
    fail ArgumentError, "Missing the required parameter 'sticker_set_name' when calling DefaultApi.set_chat_sticker_set"
  end
  # resource path
  local_var_path = '/setChatStickerSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'sticker_set_name'] = sticker_set_name

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_sticker_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_sticker_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_chat_title(chat_id, title, opts = {}) ⇒ SetWebhook200Response

setChatTitle Use this method to change the title of a chat. Titles can’t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:



7411
7412
7413
7414
 
# File 'lib/telegram-bot/api/default_api.rb', line 7411

def set_chat_title(chat_id, title, opts = {})
  data, _status_code, _headers = set_chat_title_with_http_info(chat_id, title, opts)
  data
end

#set_chat_title_with_http_info(chat_id, title, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setChatTitle Use this method to change the title of a chat. Titles can&#39;t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
 
# File 'lib/telegram-bot/api/default_api.rb', line 7422

def set_chat_title_with_http_info(chat_id, title, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_chat_title ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_chat_title"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.set_chat_title"
  end
  # resource path
  local_var_path = '/setChatTitle'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'title'] = title

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_chat_title",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_chat_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_custom_emoji_sticker_set_thumbnail(name, opts = {}) ⇒ SetWebhook200Response

setCustomEmojiStickerSetThumbnail Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :custom_emoji_id (String)

Returns:



7482
7483
7484
7485
 
# File 'lib/telegram-bot/api/default_api.rb', line 7482

def set_custom_emoji_sticker_set_thumbnail(name, opts = {})
  data, _status_code, _headers = set_custom_emoji_sticker_set_thumbnail_with_http_info(name, opts)
  data
end

#set_custom_emoji_sticker_set_thumbnail_with_http_info(name, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setCustomEmojiStickerSetThumbnail Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :custom_emoji_id (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
 
# File 'lib/telegram-bot/api/default_api.rb', line 7493

def set_custom_emoji_sticker_set_thumbnail_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_custom_emoji_sticker_set_thumbnail ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.set_custom_emoji_sticker_set_thumbnail"
  end
  # resource path
  local_var_path = '/setCustomEmojiStickerSetThumbnail'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'custom_emoji_id'] = opts[:'custom_emoji_id'] if !opts[:'custom_emoji_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_custom_emoji_sticker_set_thumbnail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_custom_emoji_sticker_set_thumbnail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_game_score(user_id, score, opts = {}) ⇒ EditMessageText200Response

setGameScore Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user’s current score in the chat and force is False.

Parameters:

  • user_id (Integer)
  • score (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force (Boolean)
  • :disable_edit_message (Boolean)
  • :chat_id (Integer)
  • :message_id (Integer)
  • :inline_message_id (String)

Returns:



7554
7555
7556
7557
 
# File 'lib/telegram-bot/api/default_api.rb', line 7554

def set_game_score(user_id, score, opts = {})
  data, _status_code, _headers = set_game_score_with_http_info(user_id, score, opts)
  data
end

#set_game_score_with_http_info(user_id, score, opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

setGameScore Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user&#39;s current score in the chat and force is False.

Parameters:

  • user_id (Integer)
  • score (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :force (Boolean)
  • :disable_edit_message (Boolean)
  • :chat_id (Integer)
  • :message_id (Integer)
  • :inline_message_id (String)

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
 
# File 'lib/telegram-bot/api/default_api.rb', line 7570

def set_game_score_with_http_info(user_id, score, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_game_score ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.set_game_score"
  end
  # verify the required parameter 'score' is set
  if @api_client.config.client_side_validation && score.nil?
    fail ArgumentError, "Missing the required parameter 'score' when calling DefaultApi.set_game_score"
  end
  # resource path
  local_var_path = '/setGameScore'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'score'] = score
  query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
  query_params[:'disable_edit_message'] = opts[:'disable_edit_message'] if !opts[:'disable_edit_message'].nil?
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_game_score",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_game_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_message_reaction(chat_id, message_id, opts = {}) ⇒ SetWebhook200Response

setMessageReaction Use this method to change the chosen reactions on a message. Service messages can’t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :reaction (Array<Object>)
  • :is_big (Boolean)

Returns:



7637
7638
7639
7640
 
# File 'lib/telegram-bot/api/default_api.rb', line 7637

def set_message_reaction(chat_id, message_id, opts = {})
  data, _status_code, _headers = set_message_reaction_with_http_info(chat_id, message_id, opts)
  data
end

#set_message_reaction_with_http_info(chat_id, message_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMessageReaction Use this method to change the chosen reactions on a message. Service messages can&#39;t be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :reaction (Array<Object>)
  • :is_big (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
 
# File 'lib/telegram-bot/api/default_api.rb', line 7650

def set_message_reaction_with_http_info(chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_message_reaction ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.set_message_reaction"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling DefaultApi.set_message_reaction"
  end
  # resource path
  local_var_path = '/setMessageReaction'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_id'] = message_id
  query_params[:'reaction'] = @api_client.build_collection_param(opts[:'reaction'], :multi) if !opts[:'reaction'].nil?
  query_params[:'is_big'] = opts[:'is_big'] if !opts[:'is_big'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_message_reaction",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_message_reaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_my_commands(commands, opts = {}) ⇒ SetWebhook200Response

setMyCommands Use this method to change the list of the bot’s commands. See this manual for more details about bot commands. Returns True on success.

Parameters:

  • commands (Array<BotCommand>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:



7713
7714
7715
7716
 
# File 'lib/telegram-bot/api/default_api.rb', line 7713

def set_my_commands(commands, opts = {})
  data, _status_code, _headers = set_my_commands_with_http_info(commands, opts)
  data
end

#set_my_commands_with_http_info(commands, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMyCommands Use this method to change the list of the bot&#39;s commands. See this manual for more details about bot commands. Returns True on success.

Parameters:

  • commands (Array<BotCommand>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :scope (Object)
  • :language_code (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
 
# File 'lib/telegram-bot/api/default_api.rb', line 7725

def set_my_commands_with_http_info(commands, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_my_commands ...'
  end
  # verify the required parameter 'commands' is set
  if @api_client.config.client_side_validation && commands.nil?
    fail ArgumentError, "Missing the required parameter 'commands' when calling DefaultApi.set_my_commands"
  end
  # resource path
  local_var_path = '/setMyCommands'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'commands'] = @api_client.build_collection_param(commands, :multi)
  query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_my_commands",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_my_commands\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_my_default_administrator_rights(opts = {}) ⇒ SetWebhook200Response

setMyDefaultAdministratorRights Use this method to change the default administrator rights requested by the bot when it’s added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



7782
7783
7784
7785
 
# File 'lib/telegram-bot/api/default_api.rb', line 7782

def set_my_default_administrator_rights(opts = {})
  data, _status_code, _headers = set_my_default_administrator_rights_with_http_info(opts)
  data
end

#set_my_default_administrator_rights_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMyDefaultAdministratorRights Use this method to change the default administrator rights requested by the bot when it&#39;s added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
 
# File 'lib/telegram-bot/api/default_api.rb', line 7793

def set_my_default_administrator_rights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_my_default_administrator_rights ...'
  end
  # resource path
  local_var_path = '/setMyDefaultAdministratorRights'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'rights'] = opts[:'rights'] if !opts[:'rights'].nil?
  query_params[:'for_channels'] = opts[:'for_channels'] if !opts[:'for_channels'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_my_default_administrator_rights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_my_default_administrator_rights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_my_description(opts = {}) ⇒ SetWebhook200Response

setMyDescription Use this method to change the bot’s description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :language_code (String)

Returns:



7845
7846
7847
7848
 
# File 'lib/telegram-bot/api/default_api.rb', line 7845

def set_my_description(opts = {})
  data, _status_code, _headers = set_my_description_with_http_info(opts)
  data
end

#set_my_description_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMyDescription Use this method to change the bot&#39;s description, which is shown in the chat with the bot if the chat is empty. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :description (String)
  • :language_code (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
 
# File 'lib/telegram-bot/api/default_api.rb', line 7856

def set_my_description_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_my_description ...'
  end
  # resource path
  local_var_path = '/setMyDescription'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_my_description",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_my_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_my_name(opts = {}) ⇒ SetWebhook200Response

setMyName Use this method to change the bot’s name. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :language_code (String)

Returns:



7908
7909
7910
7911
 
# File 'lib/telegram-bot/api/default_api.rb', line 7908

def set_my_name(opts = {})
  data, _status_code, _headers = set_my_name_with_http_info(opts)
  data
end

#set_my_name_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMyName Use this method to change the bot&#39;s name. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :language_code (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
 
# File 'lib/telegram-bot/api/default_api.rb', line 7919

def set_my_name_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_my_name ...'
  end
  # resource path
  local_var_path = '/setMyName'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_my_name",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_my_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_my_short_description(opts = {}) ⇒ SetWebhook200Response

setMyShortDescription Use this method to change the bot’s short description, which is shown on the bot’s profile page and is sent together with the link when users share the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :short_description (String)
  • :language_code (String)

Returns:



7971
7972
7973
7974
 
# File 'lib/telegram-bot/api/default_api.rb', line 7971

def set_my_short_description(opts = {})
  data, _status_code, _headers = set_my_short_description_with_http_info(opts)
  data
end

#set_my_short_description_with_http_info(opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setMyShortDescription Use this method to change the bot&#39;s short description, which is shown on the bot&#39;s profile page and is sent together with the link when users share the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :short_description (String)
  • :language_code (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
 
# File 'lib/telegram-bot/api/default_api.rb', line 7982

def set_my_short_description_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_my_short_description ...'
  end
  # resource path
  local_var_path = '/setMyShortDescription'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'short_description'] = opts[:'short_description'] if !opts[:'short_description'].nil?
  query_params[:'language_code'] = opts[:'language_code'] if !opts[:'language_code'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_my_short_description",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_my_short_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_passport_data_errors(user_id, errors, opts = {}) ⇒ SetWebhook200Response

setPassportDataErrors Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn’t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Parameters:

  • user_id (Integer)
  • errors (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8034
8035
8036
8037
 
# File 'lib/telegram-bot/api/default_api.rb', line 8034

def set_passport_data_errors(user_id, errors, opts = {})
  data, _status_code, _headers = set_passport_data_errors_with_http_info(user_id, errors, opts)
  data
end

#set_passport_data_errors_with_http_info(user_id, errors, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setPassportDataErrors Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success. Use this if the data submitted by the user doesn&#39;t satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

Parameters:

  • user_id (Integer)
  • errors (Array<Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
 
# File 'lib/telegram-bot/api/default_api.rb', line 8045

def set_passport_data_errors_with_http_info(user_id, errors, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_passport_data_errors ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.set_passport_data_errors"
  end
  # verify the required parameter 'errors' is set
  if @api_client.config.client_side_validation && errors.nil?
    fail ArgumentError, "Missing the required parameter 'errors' when calling DefaultApi.set_passport_data_errors"
  end
  # resource path
  local_var_path = '/setPassportDataErrors'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'errors'] = @api_client.build_collection_param(errors, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_passport_data_errors",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_passport_data_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_emoji_list(sticker, emoji_list, opts = {}) ⇒ SetWebhook200Response

setStickerEmojiList Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters:

  • sticker (String)
  • emoji_list (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8105
8106
8107
8108
 
# File 'lib/telegram-bot/api/default_api.rb', line 8105

def set_sticker_emoji_list(sticker, emoji_list, opts = {})
  data, _status_code, _headers = set_sticker_emoji_list_with_http_info(sticker, emoji_list, opts)
  data
end

#set_sticker_emoji_list_with_http_info(sticker, emoji_list, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerEmojiList Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters:

  • sticker (String)
  • emoji_list (Array<String>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
 
# File 'lib/telegram-bot/api/default_api.rb', line 8116

def set_sticker_emoji_list_with_http_info(sticker, emoji_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_emoji_list ...'
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.set_sticker_emoji_list"
  end
  # verify the required parameter 'emoji_list' is set
  if @api_client.config.client_side_validation && emoji_list.nil?
    fail ArgumentError, "Missing the required parameter 'emoji_list' when calling DefaultApi.set_sticker_emoji_list"
  end
  # resource path
  local_var_path = '/setStickerEmojiList'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sticker'] = sticker
  query_params[:'emoji_list'] = @api_client.build_collection_param(emoji_list, :multi)

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_emoji_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_emoji_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_keywords(sticker, opts = {}) ⇒ SetWebhook200Response

setStickerKeywords Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :keywords (Array<String>)

Returns:



8176
8177
8178
8179
 
# File 'lib/telegram-bot/api/default_api.rb', line 8176

def set_sticker_keywords(sticker, opts = {})
  data, _status_code, _headers = set_sticker_keywords_with_http_info(sticker, opts)
  data
end

#set_sticker_keywords_with_http_info(sticker, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerKeywords Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :keywords (Array<String>)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
 
# File 'lib/telegram-bot/api/default_api.rb', line 8187

def set_sticker_keywords_with_http_info(sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_keywords ...'
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.set_sticker_keywords"
  end
  # resource path
  local_var_path = '/setStickerKeywords'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sticker'] = sticker
  query_params[:'keywords'] = @api_client.build_collection_param(opts[:'keywords'], :multi) if !opts[:'keywords'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_keywords",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_keywords\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_mask_position(sticker, opts = {}) ⇒ SetWebhook200Response

setStickerMaskPosition Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8243
8244
8245
8246
 
# File 'lib/telegram-bot/api/default_api.rb', line 8243

def set_sticker_mask_position(sticker, opts = {})
  data, _status_code, _headers = set_sticker_mask_position_with_http_info(sticker, opts)
  data
end

#set_sticker_mask_position_with_http_info(sticker, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerMaskPosition Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
 
# File 'lib/telegram-bot/api/default_api.rb', line 8254

def set_sticker_mask_position_with_http_info(sticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_mask_position ...'
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.set_sticker_mask_position"
  end
  # resource path
  local_var_path = '/setStickerMaskPosition'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sticker'] = sticker
  query_params[:'mask_position'] = opts[:'mask_position'] if !opts[:'mask_position'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_mask_position",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_mask_position\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_position_in_set(sticker, position, opts = {}) ⇒ SetWebhook200Response

setStickerPositionInSet Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Parameters:

  • sticker (String)
  • position (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8310
8311
8312
8313
 
# File 'lib/telegram-bot/api/default_api.rb', line 8310

def set_sticker_position_in_set(sticker, position, opts = {})
  data, _status_code, _headers = set_sticker_position_in_set_with_http_info(sticker, position, opts)
  data
end

#set_sticker_position_in_set_with_http_info(sticker, position, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerPositionInSet Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Parameters:

  • sticker (String)
  • position (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
 
# File 'lib/telegram-bot/api/default_api.rb', line 8321

def set_sticker_position_in_set_with_http_info(sticker, position, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_position_in_set ...'
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.set_sticker_position_in_set"
  end
  # verify the required parameter 'position' is set
  if @api_client.config.client_side_validation && position.nil?
    fail ArgumentError, "Missing the required parameter 'position' when calling DefaultApi.set_sticker_position_in_set"
  end
  # resource path
  local_var_path = '/setStickerPositionInSet'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'sticker'] = sticker
  query_params[:'position'] = position

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_position_in_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_position_in_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_set_thumbnail(name, user_id, format, opts = {}) ⇒ SetWebhook200Response

setStickerSetThumbnail Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Parameters:

  • name (String)
  • user_id (Integer)
  • format (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



8383
8384
8385
8386
 
# File 'lib/telegram-bot/api/default_api.rb', line 8383

def set_sticker_set_thumbnail(name, user_id, format, opts = {})
  data, _status_code, _headers = set_sticker_set_thumbnail_with_http_info(name, user_id, format, opts)
  data
end

#set_sticker_set_thumbnail_with_http_info(name, user_id, format, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerSetThumbnail Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Parameters:

  • name (String)
  • user_id (Integer)
  • format (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
 
# File 'lib/telegram-bot/api/default_api.rb', line 8396

def set_sticker_set_thumbnail_with_http_info(name, user_id, format, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_set_thumbnail ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.set_sticker_set_thumbnail"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.set_sticker_set_thumbnail"
  end
  # verify the required parameter 'format' is set
  if @api_client.config.client_side_validation && format.nil?
    fail ArgumentError, "Missing the required parameter 'format' when calling DefaultApi.set_sticker_set_thumbnail"
  end
  # resource path
  local_var_path = '/setStickerSetThumbnail'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'user_id'] = user_id
  query_params[:'format'] = format
  query_params[:'thumbnail'] = opts[:'thumbnail'] if !opts[:'thumbnail'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_set_thumbnail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_set_thumbnail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_sticker_set_title(name, title, opts = {}) ⇒ SetWebhook200Response

setStickerSetTitle Use this method to set the title of a created sticker set. Returns True on success.

Parameters:

  • name (String)
  • title (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8462
8463
8464
8465
 
# File 'lib/telegram-bot/api/default_api.rb', line 8462

def set_sticker_set_title(name, title, opts = {})
  data, _status_code, _headers = set_sticker_set_title_with_http_info(name, title, opts)
  data
end

#set_sticker_set_title_with_http_info(name, title, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setStickerSetTitle Use this method to set the title of a created sticker set. Returns True on success.

Parameters:

  • name (String)
  • title (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
 
# File 'lib/telegram-bot/api/default_api.rb', line 8473

def set_sticker_set_title_with_http_info(name, title, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_sticker_set_title ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling DefaultApi.set_sticker_set_title"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DefaultApi.set_sticker_set_title"
  end
  # resource path
  local_var_path = '/setStickerSetTitle'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'title'] = title

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_sticker_set_title",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_sticker_set_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_webhook(url, opts = {}) ⇒ SetWebhook200Response

setWebhook Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you’d like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :certificate (Object)
  • :ip_address (String)
  • :max_connections (Integer)
  • :allowed_updates (Array<String>)
  • :drop_pending_updates (Boolean)
  • :secret_token (String)

Returns:



8538
8539
8540
8541
 
# File 'lib/telegram-bot/api/default_api.rb', line 8538

def set_webhook(url, opts = {})
  data, _status_code, _headers = set_webhook_with_http_info(url, opts)
  data
end

#set_webhook_with_http_info(url, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

setWebhook Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you&#39;d like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header &quot;X-Telegram-Bot-Api-Secret-Token&quot; with the secret token as content.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :certificate (Object)
  • :ip_address (String)
  • :max_connections (Integer)
  • :allowed_updates (Array<String>)
  • :drop_pending_updates (Boolean)
  • :secret_token (String)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
 
# File 'lib/telegram-bot/api/default_api.rb', line 8554

def set_webhook_with_http_info(url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.set_webhook ...'
  end
  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling DefaultApi.set_webhook"
  end
  # resource path
  local_var_path = '/setWebhook'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'url'] = url
  query_params[:'certificate'] = opts[:'certificate'] if !opts[:'certificate'].nil?
  query_params[:'ip_address'] = opts[:'ip_address'] if !opts[:'ip_address'].nil?
  query_params[:'max_connections'] = opts[:'max_connections'] if !opts[:'max_connections'].nil?
  query_params[:'allowed_updates'] = @api_client.build_collection_param(opts[:'allowed_updates'], :multi) if !opts[:'allowed_updates'].nil?
  query_params[:'drop_pending_updates'] = opts[:'drop_pending_updates'] if !opts[:'drop_pending_updates'].nil?
  query_params[:'secret_token'] = opts[:'secret_token'] if !opts[:'secret_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.set_webhook",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#set_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop_message_live_location(opts = {}) ⇒ EditMessageText200Response

stopMessageLiveLocation Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



8617
8618
8619
8620
 
# File 'lib/telegram-bot/api/default_api.rb', line 8617

def stop_message_live_location(opts = {})
  data, _status_code, _headers = stop_message_live_location_with_http_info(opts)
  data
end

#stop_message_live_location_with_http_info(opts = {}) ⇒ Array<(EditMessageText200Response, Integer, Hash)>

stopMessageLiveLocation Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(EditMessageText200Response, Integer, Hash)>) —

    EditMessageText200Response data, response status code and response headers



8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
 
# File 'lib/telegram-bot/api/default_api.rb', line 8630

def stop_message_live_location_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.stop_message_live_location ...'
  end
  # resource path
  local_var_path = '/stopMessageLiveLocation'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = opts[:'chat_id'] if !opts[:'chat_id'].nil?
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'inline_message_id'] = opts[:'inline_message_id'] if !opts[:'inline_message_id'].nil?
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EditMessageText200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.stop_message_live_location",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#stop_message_live_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#stop_poll(chat_id, message_id, opts = {}) ⇒ StopPoll200Response

stopPoll Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

Parameters:

Options Hash (opts):

Returns:



8685
8686
8687
8688
 
# File 'lib/telegram-bot/api/default_api.rb', line 8685

def stop_poll(chat_id, message_id, opts = {})
  data, _status_code, _headers = stop_poll_with_http_info(chat_id, message_id, opts)
  data
end

#stop_poll_with_http_info(chat_id, message_id, opts = {}) ⇒ Array<(StopPoll200Response, Integer, Hash)>

stopPoll Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

Parameters:

Options Hash (opts):

Returns:

  • (Array<(StopPoll200Response, Integer, Hash)>) —

    StopPoll200Response data, response status code and response headers



8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
 
# File 'lib/telegram-bot/api/default_api.rb', line 8697

def stop_poll_with_http_info(chat_id, message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.stop_poll ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.stop_poll"
  end
  # verify the required parameter 'message_id' is set
  if @api_client.config.client_side_validation && message_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_id' when calling DefaultApi.stop_poll"
  end
  # resource path
  local_var_path = '/stopPoll'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_id'] = message_id
  query_params[:'reply_markup'] = opts[:'reply_markup'] if !opts[:'reply_markup'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StopPoll200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.stop_poll",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#stop_poll\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unban_chat_member(chat_id, user_id, opts = {}) ⇒ SetWebhook200Response

unbanChatMember Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don’t want this, use the parameter only_if_banned. Returns True on success.

Parameters:

Options Hash (opts):

  • :only_if_banned (Boolean)

Returns:



8759
8760
8761
8762
 
# File 'lib/telegram-bot/api/default_api.rb', line 8759

def unban_chat_member(chat_id, user_id, opts = {})
  data, _status_code, _headers = unban_chat_member_with_http_info(chat_id, user_id, opts)
  data
end

#unban_chat_member_with_http_info(chat_id, user_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unbanChatMember Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don&#39;t want this, use the parameter only_if_banned. Returns True on success.

Parameters:

Options Hash (opts):

  • :only_if_banned (Boolean)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
 
# File 'lib/telegram-bot/api/default_api.rb', line 8771

def unban_chat_member_with_http_info(chat_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unban_chat_member ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unban_chat_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.unban_chat_member"
  end
  # resource path
  local_var_path = '/unbanChatMember'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'user_id'] = user_id
  query_params[:'only_if_banned'] = opts[:'only_if_banned'] if !opts[:'only_if_banned'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unban_chat_member",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unban_chat_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unban_chat_sender_chat(chat_id, sender_chat_id, opts = {}) ⇒ SetWebhook200Response

unbanChatSenderChat Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:



8832
8833
8834
8835
 
# File 'lib/telegram-bot/api/default_api.rb', line 8832

def unban_chat_sender_chat(chat_id, sender_chat_id, opts = {})
  data, _status_code, _headers = unban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts)
  data
end

#unban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unbanChatSenderChat Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
 
# File 'lib/telegram-bot/api/default_api.rb', line 8843

def unban_chat_sender_chat_with_http_info(chat_id, sender_chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unban_chat_sender_chat ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unban_chat_sender_chat"
  end
  # verify the required parameter 'sender_chat_id' is set
  if @api_client.config.client_side_validation && sender_chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'sender_chat_id' when calling DefaultApi.unban_chat_sender_chat"
  end
  # resource path
  local_var_path = '/unbanChatSenderChat'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'sender_chat_id'] = sender_chat_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unban_chat_sender_chat",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unban_chat_sender_chat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unhide_general_forum_topic(chat_id, opts = {}) ⇒ SetWebhook200Response

unhideGeneralForumTopic Use this method to unhide the ‘General’ topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:



8902
8903
8904
8905
 
# File 'lib/telegram-bot/api/default_api.rb', line 8902

def unhide_general_forum_topic(chat_id, opts = {})
  data, _status_code, _headers = unhide_general_forum_topic_with_http_info(chat_id, opts)
  data
end

#unhide_general_forum_topic_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unhideGeneralForumTopic Use this method to unhide the &#39;General&#39; topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
 
# File 'lib/telegram-bot/api/default_api.rb', line 8912

def unhide_general_forum_topic_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unhide_general_forum_topic ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unhide_general_forum_topic"
  end
  # resource path
  local_var_path = '/unhideGeneralForumTopic'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unhide_general_forum_topic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unhide_general_forum_topic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin_all_chat_messages(chat_id, opts = {}) ⇒ SetWebhook200Response

unpinAllChatMessages Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Parameters:

Returns:



8966
8967
8968
8969
 
# File 'lib/telegram-bot/api/default_api.rb', line 8966

def unpin_all_chat_messages(chat_id, opts = {})
  data, _status_code, _headers = unpin_all_chat_messages_with_http_info(chat_id, opts)
  data
end

#unpin_all_chat_messages_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unpinAllChatMessages Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the &#39;can_pin_messages&#39; administrator right in a supergroup or &#39;can_edit_messages&#39; administrator right in a channel. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
 
# File 'lib/telegram-bot/api/default_api.rb', line 8976

def unpin_all_chat_messages_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unpin_all_chat_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unpin_all_chat_messages"
  end
  # resource path
  local_var_path = '/unpinAllChatMessages'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unpin_all_chat_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unpin_all_chat_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin_all_forum_topic_messages(chat_id, message_thread_id, opts = {}) ⇒ SetWebhook200Response

unpinAllForumTopicMessages Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters:

Returns:



9031
9032
9033
9034
 
# File 'lib/telegram-bot/api/default_api.rb', line 9031

def unpin_all_forum_topic_messages(chat_id, message_thread_id, opts = {})
  data, _status_code, _headers = unpin_all_forum_topic_messages_with_http_info(chat_id, message_thread_id, opts)
  data
end

#unpin_all_forum_topic_messages_with_http_info(chat_id, message_thread_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unpinAllForumTopicMessages Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
 
# File 'lib/telegram-bot/api/default_api.rb', line 9042

def unpin_all_forum_topic_messages_with_http_info(chat_id, message_thread_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unpin_all_forum_topic_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unpin_all_forum_topic_messages"
  end
  # verify the required parameter 'message_thread_id' is set
  if @api_client.config.client_side_validation && message_thread_id.nil?
    fail ArgumentError, "Missing the required parameter 'message_thread_id' when calling DefaultApi.unpin_all_forum_topic_messages"
  end
  # resource path
  local_var_path = '/unpinAllForumTopicMessages'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_thread_id'] = message_thread_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unpin_all_forum_topic_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unpin_all_forum_topic_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin_all_general_forum_topic_messages(chat_id, opts = {}) ⇒ SetWebhook200Response

unpinAllGeneralForumTopicMessages Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters:

Returns:



9101
9102
9103
9104
 
# File 'lib/telegram-bot/api/default_api.rb', line 9101

def unpin_all_general_forum_topic_messages(chat_id, opts = {})
  data, _status_code, _headers = unpin_all_general_forum_topic_messages_with_http_info(chat_id, opts)
  data
end

#unpin_all_general_forum_topic_messages_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unpinAllGeneralForumTopicMessages Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Parameters:

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
 
# File 'lib/telegram-bot/api/default_api.rb', line 9111

def unpin_all_general_forum_topic_messages_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unpin_all_general_forum_topic_messages ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unpin_all_general_forum_topic_messages"
  end
  # resource path
  local_var_path = '/unpinAllGeneralForumTopicMessages'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unpin_all_general_forum_topic_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unpin_all_general_forum_topic_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin_chat_message(chat_id, opts = {}) ⇒ SetWebhook200Response

unpinChatMessage Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ administrator right in a supergroup or ‘can_edit_messages’ administrator right in a channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :message_id (Integer)

Returns:



9166
9167
9168
9169
 
# File 'lib/telegram-bot/api/default_api.rb', line 9166

def unpin_chat_message(chat_id, opts = {})
  data, _status_code, _headers = unpin_chat_message_with_http_info(chat_id, opts)
  data
end

#unpin_chat_message_with_http_info(chat_id, opts = {}) ⇒ Array<(SetWebhook200Response, Integer, Hash)>

unpinChatMessage Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the &#39;can_pin_messages&#39; administrator right in a supergroup or &#39;can_edit_messages&#39; administrator right in a channel. Returns True on success.

Parameters:

Options Hash (opts):

  • :message_id (Integer)

Returns:

  • (Array<(SetWebhook200Response, Integer, Hash)>) —

    SetWebhook200Response data, response status code and response headers



9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
 
# File 'lib/telegram-bot/api/default_api.rb', line 9177

def unpin_chat_message_with_http_info(chat_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.unpin_chat_message ...'
  end
  # verify the required parameter 'chat_id' is set
  if @api_client.config.client_side_validation && chat_id.nil?
    fail ArgumentError, "Missing the required parameter 'chat_id' when calling DefaultApi.unpin_chat_message"
  end
  # resource path
  local_var_path = '/unpinChatMessage'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'chat_id'] = chat_id
  query_params[:'message_id'] = opts[:'message_id'] if !opts[:'message_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SetWebhook200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.unpin_chat_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#unpin_chat_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_sticker_file(user_id, sticker, sticker_format, opts = {}) ⇒ GetFile200Response

uploadStickerFile Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.

Parameters:

  • user_id (Integer)
  • sticker (Object)
  • sticker_format (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9234
9235
9236
9237
 
# File 'lib/telegram-bot/api/default_api.rb', line 9234

def upload_sticker_file(user_id, sticker, sticker_format, opts = {})
  data, _status_code, _headers = upload_sticker_file_with_http_info(user_id, sticker, sticker_format, opts)
  data
end

#upload_sticker_file_with_http_info(user_id, sticker, sticker_format, opts = {}) ⇒ Array<(GetFile200Response, Integer, Hash)>

uploadStickerFile Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.

Parameters:

  • user_id (Integer)
  • sticker (Object)
  • sticker_format (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetFile200Response, Integer, Hash)>) —

    GetFile200Response data, response status code and response headers



9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
 
# File 'lib/telegram-bot/api/default_api.rb', line 9246

def upload_sticker_file_with_http_info(user_id, sticker, sticker_format, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.upload_sticker_file ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling DefaultApi.upload_sticker_file"
  end
  # verify the required parameter 'sticker' is set
  if @api_client.config.client_side_validation && sticker.nil?
    fail ArgumentError, "Missing the required parameter 'sticker' when calling DefaultApi.upload_sticker_file"
  end
  # verify the required parameter 'sticker_format' is set
  if @api_client.config.client_side_validation && sticker_format.nil?
    fail ArgumentError, "Missing the required parameter 'sticker_format' when calling DefaultApi.upload_sticker_file"
  end
  # resource path
  local_var_path = '/uploadStickerFile'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_id'] = user_id
  query_params[:'sticker'] = sticker
  query_params[:'sticker_format'] = sticker_format

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetFile200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"DefaultApi.upload_sticker_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#upload_sticker_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end