Class: Teleswagger::UpdatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/teleswagger/api/updates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UpdatesApi

Returns a new instance of UpdatesApi.



30
31
32
 
# File 'lib/teleswagger/api/updates_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/teleswagger/api/updates_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#delete_webhook(opts = {}) ⇒ ResponseBool

Parameters:

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

    the optional parameters

Returns:



38
39
40
41
 
# File 'lib/teleswagger/api/updates_api.rb', line 38

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

#delete_webhook_with_http_info(opts = {}) ⇒ Array<(ResponseBool, Fixnum, Hash)>

Returns ResponseBool data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    ResponseBool data, response status code and response headers



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
 
# File 'lib/teleswagger/api/updates_api.rb', line 47

def delete_webhook_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UpdatesApi.delete_webhook ..."
  end
  # resource path
  local_var_path = "/bot{token}/deleteWebhook".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseBool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UpdatesApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_updates(token, opts = {}) ⇒ ResponseUpdate

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:



94
95
96
97
 
# File 'lib/teleswagger/api/updates_api.rb', line 94

def get_updates(token, opts = {})
  data, _status_code, _headers = get_updates_with_http_info(token, opts)
  return data
end

#get_updates_with_http_info(token, opts = {}) ⇒ Array<(ResponseUpdate, Fixnum, Hash)>

Returns ResponseUpdate data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ResponseUpdate data, response status code and response headers



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

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseUpdate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UpdatesApi#get_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_webhook_info(opts = {}) ⇒ WebhookInfo

Parameters:

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/teleswagger/api/updates_api.rb', line 153

def get_webhook_info(opts = {})
  data, _status_code, _headers = get_webhook_info_with_http_info(opts)
  return data
end

#get_webhook_info_with_http_info(opts = {}) ⇒ Array<(WebhookInfo, Fixnum, Hash)>

Returns WebhookInfo data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    WebhookInfo data, response status code and response headers



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/teleswagger/api/updates_api.rb', line 162

def get_webhook_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UpdatesApi.get_webhook_info ..."
  end
  # resource path
  local_var_path = "/bot{token}/getWebhookInfo".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WebhookInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UpdatesApi#get_webhook_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_webhook(token, url, opts = {}) ⇒ ResponseBool

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

  • :certificate (File)
  • :max_connections (Integer)
  • :allowed_updates (Array<String>)

Returns:



211
212
213
214
 
# File 'lib/teleswagger/api/updates_api.rb', line 211

def set_webhook(token, url, opts = {})
  data, _status_code, _headers = set_webhook_with_http_info(token, url, opts)
  return data
end

#set_webhook_with_http_info(token, url, opts = {}) ⇒ Array<(ResponseBool, Fixnum, Hash)>

Returns ResponseBool data, response status code and response headers.

Parameters:

  • token —

    bot&#39;s token to authorize the request

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

    the optional parameters

Options Hash (opts):

  • :certificate (File)
  • :max_connections (Integer)
  • :allowed_updates (Array<String>)

Returns:

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

    ResponseBool data, response status code and response headers



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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/teleswagger/api/updates_api.rb', line 225

def set_webhook_with_http_info(token, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UpdatesApi.set_webhook ..."
  end
  # verify the required parameter 'token' is set
  fail ArgumentError, "Missing the required parameter 'token' when calling UpdatesApi.set_webhook" if token.nil?
  # verify the required parameter 'url' is set
  fail ArgumentError, "Missing the required parameter 'url' when calling UpdatesApi.set_webhook" if url.nil?
  if opts[:'allowed_updates'] && !['message', 'edited_message', 'channel_post', 'edited_channel_post', 'inline_query', 'chosen_inline_result', 'callback_query', 'shipping_query', 'pre_checkout_query'].include?(opts[:'allowed_updates'])
    fail ArgumentError, 'invalid value for "allowed_updates", must be one of message, edited_message, channel_post, edited_channel_post, inline_query, chosen_inline_result, callback_query, shipping_query, pre_checkout_query'
  end
  # resource path
  local_var_path = "/bot{token}/setWebhook".sub('{format}','json').sub('{' + 'token' + '}', token.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  local_header_content_type = ['multipart/form-data']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["url"] = url
  form_params["certificate"] = opts[:'certificate'] if !opts[:'certificate'].nil?
  form_params["max_connections"] = opts[:'max_connections'] if !opts[:'max_connections'].nil?
  form_params["allowed_updates"] = @api_client.build_collection_param(opts[:'allowed_updates'], :multi) if !opts[:'allowed_updates'].nil?

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseBool')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UpdatesApi#set_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end