Class: OpenapiClient::UserAttributesApi
- Inherits:
-
Object
- Object
- OpenapiClient::UserAttributesApi
- Defined in:
- lib/openapi_client/api/user_attributes_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_user_attribute(proj_id, env_id, resource_attribute_create, opts = {}) ⇒ ResourceAttributeRead
Create User Attribute Creates a new attribute for the User resource.
-
#create_user_attribute_with_http_info(proj_id, env_id, resource_attribute_create, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Create User Attribute Creates a new attribute for the User resource.
-
#delete_user_attribute(proj_id, env_id, attribute_id, opts = {}) ⇒ nil
Delete User Attribute Deletes the attribute and all its related data.
-
#delete_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete User Attribute Deletes the attribute and all its related data.
-
#get_user_attribute(proj_id, env_id, attribute_id, opts = {}) ⇒ ResourceAttributeRead
Get User Attribute Gets a single attribute defined on the User resource, if such attribute exists.
-
#get_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Get User Attribute Gets a single attribute defined on the User resource, if such attribute exists.
-
#initialize(api_client = ApiClient.default) ⇒ UserAttributesApi
constructor
A new instance of UserAttributesApi.
-
#list_user_attributes(proj_id, env_id, opts = {}) ⇒ Array<ResourceAttributeRead>
List User Attributes Lists all the attributes defined on the User resource.
-
#list_user_attributes_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(Array<ResourceAttributeRead>, Integer, Hash)>
List User Attributes Lists all the attributes defined on the User resource.
-
#update_user_attribute(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) ⇒ ResourceAttributeRead
Update User Attribute Partially updates the attribute defined on the User resource.
-
#update_user_attribute_with_http_info(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Update User Attribute Partially updates the attribute defined on the User resource.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ UserAttributesApi
Returns a new instance of UserAttributesApi.
19 20 21 |
# File 'lib/openapi_client/api/user_attributes_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/openapi_client/api/user_attributes_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_user_attribute(proj_id, env_id, resource_attribute_create, opts = {}) ⇒ ResourceAttributeRead
Create User Attribute Creates a new attribute for the User resource.
30 31 32 33 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 30 def create_user_attribute(proj_id, env_id, resource_attribute_create, opts = {}) data, _status_code, _headers = create_user_attribute_with_http_info(proj_id, env_id, resource_attribute_create, opts) data end |
#create_user_attribute_with_http_info(proj_id, env_id, resource_attribute_create, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Create User Attribute Creates a new attribute for the User resource.
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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 43 def create_user_attribute_with_http_info(proj_id, env_id, resource_attribute_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserAttributesApi.create_user_attribute ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling UserAttributesApi.create_user_attribute" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling UserAttributesApi.create_user_attribute" end # verify the required parameter 'resource_attribute_create' is set if @api_client.config.client_side_validation && resource_attribute_create.nil? fail ArgumentError, "Missing the required parameter 'resource_attribute_create' when calling UserAttributesApi.create_user_attribute" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/users/attributes'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil? # 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' content_type = @api_client.select_header_content_type(['application/json']) 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(resource_attribute_create) # return_type return_type = opts[:debug_return_type] || 'ResourceAttributeRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"UserAttributesApi.create_user_attribute", :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: UserAttributesApi#create_user_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_user_attribute(proj_id, env_id, attribute_id, opts = {}) ⇒ nil
Delete User Attribute Deletes the attribute and all its related data. Note: If the attribute is used by policies, removing it will cause the attribute to evaluate as ‘undefined`.
115 116 117 118 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 115 def delete_user_attribute(proj_id, env_id, attribute_id, opts = {}) delete_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts) nil end |
#delete_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete User Attribute Deletes the attribute and all its related data. Note: If the attribute is used by policies, removing it will cause the attribute to evaluate as `undefined`.
130 131 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 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 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 130 def delete_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserAttributesApi.delete_user_attribute ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling UserAttributesApi.delete_user_attribute" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling UserAttributesApi.delete_user_attribute" end # verify the required parameter 'attribute_id' is set if @api_client.config.client_side_validation && attribute_id.nil? fail ArgumentError, "Missing the required parameter 'attribute_id' when calling UserAttributesApi.delete_user_attribute" end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UserAttributesApi.delete_user_attribute, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UserAttributesApi.delete_user_attribute, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UserAttributesApi.delete_user_attribute, must be greater than or equal to 1.' end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'attribute_id' + '}', CGI.escape(attribute_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # 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] || ['HTTPBearer'] = opts.merge( :operation => :"UserAttributesApi.delete_user_attribute", :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: UserAttributesApi#delete_user_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_user_attribute(proj_id, env_id, attribute_id, opts = {}) ⇒ ResourceAttributeRead
Get User Attribute Gets a single attribute defined on the User resource, if such attribute exists.
209 210 211 212 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 209 def get_user_attribute(proj_id, env_id, attribute_id, opts = {}) data, _status_code, _headers = get_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts) data end |
#get_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Get User Attribute Gets a single attribute defined on the User resource, if such attribute exists.
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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 222 def get_user_attribute_with_http_info(proj_id, env_id, attribute_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserAttributesApi.get_user_attribute ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling UserAttributesApi.get_user_attribute" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling UserAttributesApi.get_user_attribute" end # verify the required parameter 'attribute_id' is set if @api_client.config.client_side_validation && attribute_id.nil? fail ArgumentError, "Missing the required parameter 'attribute_id' when calling UserAttributesApi.get_user_attribute" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'attribute_id' + '}', CGI.escape(attribute_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil? # 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] || 'ResourceAttributeRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"UserAttributesApi.get_user_attribute", :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: UserAttributesApi#get_user_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_user_attributes(proj_id, env_id, opts = {}) ⇒ Array<ResourceAttributeRead>
List User Attributes Lists all the attributes defined on the User resource.
288 289 290 291 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 288 def list_user_attributes(proj_id, env_id, opts = {}) data, _status_code, _headers = list_user_attributes_with_http_info(proj_id, env_id, opts) data end |
#list_user_attributes_with_http_info(proj_id, env_id, opts = {}) ⇒ Array<(Array<ResourceAttributeRead>, Integer, Hash)>
List User Attributes Lists all the attributes defined on the User resource.
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 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 302 def list_user_attributes_with_http_info(proj_id, env_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserAttributesApi.list_user_attributes ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling UserAttributesApi.list_user_attributes" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling UserAttributesApi.list_user_attributes" end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UserAttributesApi.list_user_attributes, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UserAttributesApi.list_user_attributes, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling UserAttributesApi.list_user_attributes, must be greater than or equal to 1.' end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/users/attributes'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # 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] || 'Array<ResourceAttributeRead>' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"UserAttributesApi.list_user_attributes", :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: UserAttributesApi#list_user_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_user_attribute(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) ⇒ ResourceAttributeRead
Update User Attribute Partially updates the attribute defined on the User resource. Fields that will be provided will be completely overwritten.
378 379 380 381 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 378 def update_user_attribute(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) data, _status_code, _headers = update_user_attribute_with_http_info(proj_id, env_id, attribute_id, resource_attribute_update, opts) data end |
#update_user_attribute_with_http_info(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) ⇒ Array<(ResourceAttributeRead, Integer, Hash)>
Update User Attribute Partially updates the attribute defined on the User resource. Fields that will be provided will be completely overwritten.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/openapi_client/api/user_attributes_api.rb', line 392 def update_user_attribute_with_http_info(proj_id, env_id, attribute_id, resource_attribute_update, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserAttributesApi.update_user_attribute ...' end # verify the required parameter 'proj_id' is set if @api_client.config.client_side_validation && proj_id.nil? fail ArgumentError, "Missing the required parameter 'proj_id' when calling UserAttributesApi.update_user_attribute" end # verify the required parameter 'env_id' is set if @api_client.config.client_side_validation && env_id.nil? fail ArgumentError, "Missing the required parameter 'env_id' when calling UserAttributesApi.update_user_attribute" end # verify the required parameter 'attribute_id' is set if @api_client.config.client_side_validation && attribute_id.nil? fail ArgumentError, "Missing the required parameter 'attribute_id' when calling UserAttributesApi.update_user_attribute" end # verify the required parameter 'resource_attribute_update' is set if @api_client.config.client_side_validation && resource_attribute_update.nil? fail ArgumentError, "Missing the required parameter 'resource_attribute_update' when calling UserAttributesApi.update_user_attribute" end # resource path local_var_path = '/v2/schema/{proj_id}/{env_id}/users/attributes/{attribute_id}'.sub('{' + 'proj_id' + '}', CGI.escape(proj_id.to_s)).sub('{' + 'env_id' + '}', CGI.escape(env_id.to_s)).sub('{' + 'attribute_id' + '}', CGI.escape(attribute_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil? # 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' content_type = @api_client.select_header_content_type(['application/json']) 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(resource_attribute_update) # return_type return_type = opts[:debug_return_type] || 'ResourceAttributeRead' # auth_names auth_names = opts[:debug_auth_names] || ['HTTPBearer'] = opts.merge( :operation => :"UserAttributesApi.update_user_attribute", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserAttributesApi#update_user_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |