Class: Notifo::PingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/ping_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PingApi

Returns a new instance of PingApi.



16
17
18
 
# File 'lib/notifo/api/ping_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/notifo/api/ping_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#ping_get_info(opts = {}) ⇒ InfoDto

Get some info about the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/notifo/api/ping_api.rb', line 23

def ping_get_info(opts = {})
  data, _status_code, _headers = ping_get_info_with_http_info(opts)
  data
end

#ping_get_info_with_http_info(opts = {}) ⇒ Array<(InfoDto, Integer, Hash)>

Get some info about the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:

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

    InfoDto data, response status code and response headers



32
33
34
35
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
 
# File 'lib/notifo/api/ping_api.rb', line 32

def ping_get_info_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PingApi.ping_get_info ...'
  end
  # resource path
  local_var_path = '/api/info'

  # 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[:body] 

  return_type = opts[:return_type] || 'InfoDto' 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PingApi#ping_get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ping_get_old_ping(opts = {}) ⇒ nil

Get ping status of the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


73
74
75
76
 
# File 'lib/notifo/api/ping_api.rb', line 73

def ping_get_old_ping(opts = {})
  ping_get_old_ping_with_http_info(opts)
  nil
end

#ping_get_old_ping_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get ping status of the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/notifo/api/ping_api.rb', line 82

def ping_get_old_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PingApi.ping_get_old_ping ...'
  end
  # resource path
  local_var_path = '/ping'

  # 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PingApi#ping_get_old_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ping_get_ping(opts = {}) ⇒ nil

Get ping status of the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


123
124
125
126
 
# File 'lib/notifo/api/ping_api.rb', line 123

def ping_get_ping(opts = {})
  ping_get_ping_with_http_info(opts)
  nil
end

#ping_get_ping_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get ping status of the API. Can be used to test, if the Squidex API is alive and responding.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/notifo/api/ping_api.rb', line 132

def ping_get_ping_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PingApi.ping_get_ping ...'
  end
  # resource path
  local_var_path = '/api/ping'

  # 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PingApi#ping_get_ping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end