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.



19
20
21
 
# File 'lib/teleswagger/api/updates_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/teleswagger/api/updates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_webhook(opts = {}) ⇒ ResponseBool

Parameters:

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

    the optional parameters

Returns:



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

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/teleswagger/api/updates_api.rb', line 36

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"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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):

  • :offset (Integer)
  • :limit (Integer)
  • :timeout (Integer)
  • :allowed_updates (Array<String>)

Returns:



81
82
83
84
 
# File 'lib/teleswagger/api/updates_api.rb', line 81

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):

  • :offset (Integer)
  • :limit (Integer)
  • :timeout (Integer)
  • :allowed_updates (Array<String>)

Returns:

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

    ResponseUpdate data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/teleswagger/api/updates_api.rb', line 95

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
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling UpdatesApi.get_updates"
  end
  if @api_client.config.client_side_validation && opts[:'allowed_updates'] && !opts[:'allowed_updates'].all?{|item| ['message', 'edited_message', 'channel_post', 'edited_channel_post', 'inline_query', 'chosen_inline_result', 'callback_query'].include?(item)}
    fail ArgumentError, 'invalid value for "allowed_updates", must include one of message, edited_message, channel_post, edited_channel_post, inline_query, chosen_inline_result, callback_query'
  end
  # resource path
  local_var_path = "/bot{token}/getUpdates".sub('{' + 'token' + '}', token.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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 => '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:



146
147
148
149
 
# File 'lib/teleswagger/api/updates_api.rb', line 146

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



155
156
157
158
159
160
161
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
 
# File 'lib/teleswagger/api/updates_api.rb', line 155

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"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = 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:



200
201
202
203
 
# File 'lib/teleswagger/api/updates_api.rb', line 200

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



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
258
259
260
261
262
263
 
# File 'lib/teleswagger/api/updates_api.rb', line 214

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
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling UpdatesApi.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 UpdatesApi.set_webhook"
  end
  if @api_client.config.client_side_validation && opts[:'allowed_updates'] && !opts[:'allowed_updates'].all?{|item| ['message', 'edited_message', 'channel_post', 'edited_channel_post', 'inline_query', 'chosen_inline_result', 'callback_query'].include?(item)}
    fail ArgumentError, 'invalid value for "allowed_updates", must include one of message, edited_message, channel_post, edited_channel_post, inline_query, chosen_inline_result, callback_query'
  end
  # resource path
  local_var_path = "/bot{token}/setWebhook".sub('{' + 'token' + '}', token.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # 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