Class: VgsApiClient::AliasesApi
- Inherits:
-
Object
- Object
- VgsApiClient::AliasesApi
- Defined in:
- lib/vgs_api_client/api/aliases_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_aliases(opts = {}) ⇒ InlineResponse201
Create aliases Stores multiple values at once & returns their aliases.
-
#create_aliases_with_http_info(opts = {}) ⇒ Array<(InlineResponse201, Integer, Hash)>
Create aliases Stores multiple values at once & returns their aliases.
-
#delete_alias(_alias, opts = {}) ⇒ nil
Delete alias Removes a single alias.
-
#delete_alias_with_http_info(_alias, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete alias Removes a single alias.
-
#initialize(api_client = ApiClient.default) ⇒ AliasesApi
constructor
A new instance of AliasesApi.
-
#reveal_alias(_alias, opts = {}) ⇒ InlineResponse2001
Reveal single alias Retrieves a stored value along with its aliases.
-
#reveal_alias_with_http_info(_alias, opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>
Reveal single alias Retrieves a stored value along with its aliases.
-
#reveal_multiple_aliases(q, opts = {}) ⇒ InlineResponse200
Reveal multiple aliases Given a comma separated aliases string, retrieves all associated values stored in the vault.
-
#reveal_multiple_aliases_with_http_info(q, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Reveal multiple aliases Given a comma separated aliases string, retrieves all associated values stored in the vault.
-
#update_alias(_alias, opts = {}) ⇒ nil
Update data classifiers Apply new classifiers to the value that the specified alias is associated with.
-
#update_alias_with_http_info(_alias, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update data classifiers Apply new classifiers to the value that the specified alias is associated with.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AliasesApi
Returns a new instance of AliasesApi.
19 20 21 |
# File 'lib/vgs_api_client/api/aliases_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/vgs_api_client/api/aliases_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_aliases(opts = {}) ⇒ InlineResponse201
Create aliases Stores multiple values at once & returns their aliases. Alternatively, this endpoint may be used to associate additional (i.e. secondary) aliases with the same underlying data as the reference alias specified in the request body. NOTE: You cannot reference the same alias more than once in a single request.
27 28 29 30 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 27 def create_aliases(opts = {}) data, _status_code, _headers = create_aliases_with_http_info(opts) data end |
#create_aliases_with_http_info(opts = {}) ⇒ Array<(InlineResponse201, Integer, Hash)>
Create aliases Stores multiple values at once & returns their aliases. Alternatively, this endpoint may be used to associate additional (i.e. secondary) aliases with the same underlying data as the reference alias specified in the request body. NOTE: You cannot reference the same alias more than once in a single request.
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 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 37 def create_aliases_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasesApi.create_aliases ...' end # resource path local_var_path = '/aliases' # 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_aliases_request']) # return_type return_type = opts[:debug_return_type] || 'InlineResponse201' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AliasesApi.create_aliases", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasesApi#create_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_alias(_alias, opts = {}) ⇒ nil
Delete alias Removes a single alias.
88 89 90 91 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 88 def delete_alias(_alias, opts = {}) delete_alias_with_http_info(_alias, opts) nil end |
#delete_alias_with_http_info(_alias, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete alias Removes a single alias.
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 143 144 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 98 def delete_alias_with_http_info(_alias, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasesApi.delete_alias ...' end # verify the required parameter '_alias' is set if @api_client.config.client_side_validation && _alias.nil? fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.delete_alias" end # resource path local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s)) # 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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AliasesApi.delete_alias", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasesApi#delete_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reveal_alias(_alias, opts = {}) ⇒ InlineResponse2001
Reveal single alias Retrieves a stored value along with its aliases. NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [[email protected]]([email protected]).
151 152 153 154 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 151 def reveal_alias(_alias, opts = {}) data, _status_code, _headers = reveal_alias_with_http_info(_alias, opts) data end |
#reveal_alias_with_http_info(_alias, opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>
Reveal single alias Retrieves a stored value along with its aliases. NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [[email protected]]([email protected]).
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 201 202 203 204 205 206 207 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 161 def reveal_alias_with_http_info(_alias, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasesApi.reveal_alias ...' end # verify the required parameter '_alias' is set if @api_client.config.client_side_validation && _alias.nil? fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.reveal_alias" end # resource path local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s)) # 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InlineResponse2001' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AliasesApi.reveal_alias", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasesApi#reveal_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#reveal_multiple_aliases(q, opts = {}) ⇒ InlineResponse200
Reveal multiple aliases Given a comma separated aliases string, retrieves all associated values stored in the vault. NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [[email protected]]([email protected]).
214 215 216 217 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 214 def reveal_multiple_aliases(q, opts = {}) data, _status_code, _headers = reveal_multiple_aliases_with_http_info(q, opts) data end |
#reveal_multiple_aliases_with_http_info(q, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>
Reveal multiple aliases Given a comma separated aliases string, retrieves all associated values stored in the vault. NOTE: This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [[email protected]]([email protected]).
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 264 265 266 267 268 269 270 271 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 224 def reveal_multiple_aliases_with_http_info(q, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasesApi.reveal_multiple_aliases ...' end # verify the required parameter 'q' is set if @api_client.config.client_side_validation && q.nil? fail ArgumentError, "Missing the required parameter 'q' when calling AliasesApi.reveal_multiple_aliases" end # resource path local_var_path = '/aliases' # query parameters query_params = opts[:query_params] || {} query_params[:'q'] = q # 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'InlineResponse200' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AliasesApi.reveal_multiple_aliases", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasesApi#reveal_multiple_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_alias(_alias, opts = {}) ⇒ nil
Update data classifiers Apply new classifiers to the value that the specified alias is associated with.
279 280 281 282 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 279 def update_alias(_alias, opts = {}) update_alias_with_http_info(_alias, opts) nil end |
#update_alias_with_http_info(_alias, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Update data classifiers Apply new classifiers to the value that the specified alias is associated with.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/vgs_api_client/api/aliases_api.rb', line 290 def update_alias_with_http_info(_alias, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AliasesApi.update_alias ...' end # verify the required parameter '_alias' is set if @api_client.config.client_side_validation && _alias.nil? fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.update_alias" end # resource path local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s)) # 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']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_alias_request']) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AliasesApi.update_alias", :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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AliasesApi#update_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |