Class: Pescheck::OAuthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pescheck-client/api/o_auth_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OAuthApi

Returns a new instance of OAuthApi.



19
20
21
 
# File 'lib/pescheck-client/api/o_auth_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/pescheck-client/api/o_auth_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_o_auth_application2(o_auth_application, opts = {}) ⇒ OAuthApplicationResponse

Create OAuth application for API access

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 26

def create_o_auth_application2(o_auth_application, opts = {})
  data, _status_code, _headers = create_o_auth_application2_with_http_info(o_auth_application, opts)
  data
end

#create_o_auth_application2_with_http_info(o_auth_application, opts = {}) ⇒ Array<(OAuthApplicationResponse, Integer, Hash)>

Create OAuth application for API access

Parameters:

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

    the optional parameters

Returns:

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

    OAuthApplicationResponse data, response status code and response headers



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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 35

def create_o_auth_application2_with_http_info(o_auth_application, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApi.create_o_auth_application2 ...'
  end
  # verify the required parameter 'o_auth_application' is set
  if @api_client.config.client_side_validation && o_auth_application.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth_application' when calling OAuthApi.create_o_auth_application2"
  end
  # resource path
  local_var_path = '/api/v2/oauth/applications/'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_application)

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

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

  new_options = opts.merge(
    :operation => :"OAuthApi.create_o_auth_application2",
    :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: OAuthApi#create_o_auth_application2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_o_auth_application2(application_id, opts = {}) ⇒ nil

Delete an OAuth application

Parameters:

  • application_id (String) —

    Application ID to delete

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 92

def delete_o_auth_application2(application_id, opts = {})
  delete_o_auth_application2_with_http_info(application_id, opts)
  nil
end

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

Delete an OAuth application

Parameters:

  • application_id (String) —

    Application ID to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
141
142
143
144
145
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 101

def delete_o_auth_application2_with_http_info(application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApi.delete_o_auth_application2 ...'
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling OAuthApi.delete_o_auth_application2"
  end
  # resource path
  local_var_path = '/api/v2/oauth/applications/{application_id}/'.sub('{application_id}', CGI.escape(application_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OAuthApi.delete_o_auth_application2",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#delete_o_auth_application2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_o_auth_applications2(opts = {}) ⇒ Array<OAuthApplicationResponse>

List OAuth applications for the organization

Parameters:

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 150

def list_o_auth_applications2(opts = {})
  data, _status_code, _headers = list_o_auth_applications2_with_http_info(opts)
  data
end

#list_o_auth_applications2_with_http_info(opts = {}) ⇒ Array<(Array<OAuthApplicationResponse>, Integer, Hash)>

List OAuth applications for the organization

Parameters:

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

    the optional parameters

Returns:



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
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/pescheck-client/api/o_auth_api.rb', line 158

def list_o_auth_applications2_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OAuthApi.list_o_auth_applications2 ...'
  end
  # resource path
  local_var_path = '/api/v2/oauth/applications/list/'

  # 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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<OAuthApplicationResponse>'

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

  new_options = opts.merge(
    :operation => :"OAuthApi.list_o_auth_applications2",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OAuthApi#list_o_auth_applications2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end