Class: BudgeaClient::OIDCApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/oidc_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OIDCApi

Returns a new instance of OIDCApi.



19
20
21
 
# File 'lib/budgea_client/api/oidc_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/budgea_client/api/oidc_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#oidc_whitelist_id_whitelist_delete(id_whitelist, opts = {}) ⇒ OidcWhitelist

Delete the supplied authorized redirect uri

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



28
29
30
31
 
# File 'lib/budgea_client/api/oidc_api.rb', line 28

def oidc_whitelist_id_whitelist_delete(id_whitelist, opts = {})
  data, _status_code, _headers = oidc_whitelist_id_whitelist_delete_with_http_info(id_whitelist, opts)
  data
end

#oidc_whitelist_id_whitelist_delete_with_http_info(id_whitelist, opts = {}) ⇒ Array<(OidcWhitelist, Fixnum, Hash)>

Delete the supplied authorized redirect uri

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    OidcWhitelist data, response status code and response headers



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
 
# File 'lib/budgea_client/api/oidc_api.rb', line 39

def oidc_whitelist_id_whitelist_delete_with_http_info(id_whitelist, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OIDCApi.oidc_whitelist_id_whitelist_delete ...'
  end
  # verify the required parameter 'id_whitelist' is set
  if @api_client.config.client_side_validation && id_whitelist.nil?
    fail ArgumentError, "Missing the required parameter 'id_whitelist' when calling OIDCApi.oidc_whitelist_id_whitelist_delete"
  end
  # resource path
  local_var_path = '/oidc/whitelist/{id_whitelist}'.sub('{' + 'id_whitelist' + '}', id_whitelist.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts = {}) ⇒ OidcWhitelist

Edit a authorized redirect uri Edit the uri for the supplied authorized redirect uri.

Parameters:

  • id_whitelist
  • redirect_uri —

    new authorized redirect uri

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



86
87
88
89
 
# File 'lib/budgea_client/api/oidc_api.rb', line 86

def oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts = {})
  data, _status_code, _headers = oidc_whitelist_id_whitelist_post_with_http_info(id_whitelist, redirect_uri, opts)
  data
end

#oidc_whitelist_id_whitelist_post_with_http_info(id_whitelist, redirect_uri, opts = {}) ⇒ Array<(OidcWhitelist, Fixnum, Hash)>

Edit a authorized redirect uri Edit the uri for the supplied authorized redirect uri.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_whitelist
  • redirect_uri —

    new authorized redirect uri

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    OidcWhitelist data, response status code and response headers



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
141
142
 
# File 'lib/budgea_client/api/oidc_api.rb', line 98

def oidc_whitelist_id_whitelist_post_with_http_info(id_whitelist, redirect_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OIDCApi.oidc_whitelist_id_whitelist_post ...'
  end
  # verify the required parameter 'id_whitelist' is set
  if @api_client.config.client_side_validation && id_whitelist.nil?
    fail ArgumentError, "Missing the required parameter 'id_whitelist' when calling OIDCApi.oidc_whitelist_id_whitelist_post"
  end
  # verify the required parameter 'redirect_uri' is set
  if @api_client.config.client_side_validation && redirect_uri.nil?
    fail ArgumentError, "Missing the required parameter 'redirect_uri' when calling OIDCApi.oidc_whitelist_id_whitelist_post"
  end
  # resource path
  local_var_path = '/oidc/whitelist/{id_whitelist}'.sub('{' + 'id_whitelist' + '}', id_whitelist.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['redirect_uri'] = redirect_uri

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'OidcWhitelist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OIDCApi#oidc_whitelist_id_whitelist_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#oidc_whitelist_post(redirect_uri, opts = {}) ⇒ OidcWhitelist

Adds an authorized redirect uri It requires the authorized redirect uri to be created

Parameters:

  • redirect_uri —

    authorized redirect uri to be created

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



149
150
151
152
 
# File 'lib/budgea_client/api/oidc_api.rb', line 149

def oidc_whitelist_post(redirect_uri, opts = {})
  data, _status_code, _headers = oidc_whitelist_post_with_http_info(redirect_uri, opts)
  data
end

#oidc_whitelist_post_with_http_info(redirect_uri, opts = {}) ⇒ Array<(OidcWhitelist, Fixnum, Hash)>

Adds an authorized redirect uri It requires the authorized redirect uri to be created&lt;br&gt;&lt;br&gt;

Parameters:

  • redirect_uri —

    authorized redirect uri to be created

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    OidcWhitelist data, response status code and response headers



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/budgea_client/api/oidc_api.rb', line 160

def oidc_whitelist_post_with_http_info(redirect_uri, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OIDCApi.oidc_whitelist_post ...'
  end
  # verify the required parameter 'redirect_uri' is set
  if @api_client.config.client_side_validation && redirect_uri.nil?
    fail ArgumentError, "Missing the required parameter 'redirect_uri' when calling OIDCApi.oidc_whitelist_post"
  end
  # resource path
  local_var_path = '/oidc/whitelist'

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['redirect_uri'] = redirect_uri

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  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 => 'OidcWhitelist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OIDCApi#oidc_whitelist_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end