korona-cloud-client 1.0.13 → 1.0.15

data/lib/korona-cloud-client/api/users_api.rb

@@ -0,0 +1,539 @@
+=begin
+#KORONA.cloud API v3
+
+#Our api provides access to our cloud services
+
+The version of the OpenAPI document: 3.1.64
+Contact: support@combase.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'cgi'
+
+module KoronaCloudClient
+  class UsersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # adds a batch of new users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] an array of new users
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead
+    # @option opts [String] :write_mode DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields
+    # @return [Array<AddOrUpdateResult>]
+    def add_users(korona_account_id, user, opts = {})
+      data, _status_code, _headers = add_users_with_http_info(korona_account_id, user, opts)
+      data
+    end
+
+    # adds a batch of new users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] an array of new users
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :upsert when set to true, updates the object instead of generating a already-exists-error; deprecated, use writeMode ADD_OR_UPDATE instead
+    # @option opts [String] :write_mode DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def add_users_with_http_info(korona_account_id, user, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.add_users ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.add_users"
+      end
+      # verify the required parameter 'user' is set
+      if @api_client.config.client_side_validation && user.nil?
+        fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.add_users"
+      end
+      allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"]
+      if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode'])
+        fail ArgumentError, "invalid value for \"write_mode\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?
+      query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].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(user)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.add_users",
+        :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: UsersApi#add_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # deletes the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_user(korona_account_id, user_id, opts = {})
+      delete_user_with_http_info(korona_account_id, user_id, opts)
+      nil
+    end
+
+    # deletes the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_user_with_http_info(korona_account_id, user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.delete_user ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.delete_user"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users/{userId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.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']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.delete_user",
+        :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: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # deletes a batch of users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] array of existing users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddOrUpdateResult>]
+    def delete_users(korona_account_id, user, opts = {})
+      data, _status_code, _headers = delete_users_with_http_info(korona_account_id, user, opts)
+      data
+    end
+
+    # deletes a batch of users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] array of existing users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def delete_users_with_http_info(korona_account_id, user, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.delete_users ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.delete_users"
+      end
+      # verify the required parameter 'user' is set
+      if @api_client.config.client_side_validation && user.nil?
+        fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.delete_users"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.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'
+      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(user)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.delete_users",
+        :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: UsersApi#delete_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # returns the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [User]
+    def get_user(korona_account_id, user_id, opts = {})
+      data, _status_code, _headers = get_user_with_http_info(korona_account_id, user_id, opts)
+      data
+    end
+
+    # returns the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def get_user_with_http_info(korona_account_id, user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.get_user ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.get_user"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users/{userId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.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] || 'User'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.get_user",
+        :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: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # lists all users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page number of the page to fetch
+    # @option opts [Integer] :size amount of objects to return per page
+    # @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5)
+    # @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned
+    # @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false)
+    # @option opts [String] :number number of the related object
+    # @return [ResultListUser]
+    def get_users(korona_account_id, opts = {})
+      data, _status_code, _headers = get_users_with_http_info(korona_account_id, opts)
+      data
+    end
+
+    # lists all users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page number of the page to fetch
+    # @option opts [Integer] :size amount of objects to return per page
+    # @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5)
+    # @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned
+    # @option opts [Boolean] :include_deleted indicates deleted objects should be loaded or not (default: false)
+    # @option opts [String] :number number of the related object
+    # @return [Array<(ResultListUser, Integer, Hash)>] ResultListUser data, response status code and response headers
+    def get_users_with_http_info(korona_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.get_users ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.get_users"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
+      query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
+      query_params[:'number'] = opts[:'number'] if !opts[:'number'].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] || 'ResultListUser'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.get_users",
+        :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: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # updates the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param user [User] the properties to update of the user
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_user(korona_account_id, user_id, user, opts = {})
+      update_user_with_http_info(korona_account_id, user_id, user, opts)
+      nil
+    end
+
+    # updates the single user
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user_id [String] id of the related object (important: id should match the uuid-format)
+    # @param user [User] the properties to update of the user
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def update_user_with_http_info(korona_account_id, user_id, user, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.update_user ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.update_user"
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.update_user"
+      end
+      # verify the required parameter 'user' is set
+      if @api_client.config.client_side_validation && user.nil?
+        fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.update_user"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users/{userId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.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'
+      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(user)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.update_user",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # updates a batch of users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] array of existing users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddOrUpdateResult>]
+    def update_users(korona_account_id, user, opts = {})
+      data, _status_code, _headers = update_users_with_http_info(korona_account_id, user, opts)
+      data
+    end
+
+    # updates a batch of users
+    # @param korona_account_id [String] account id of the KORONA.cloud account
+    # @param user [Array<User>] array of existing users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddOrUpdateResult>, Integer, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
+    def update_users_with_http_info(korona_account_id, user, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.update_users ...'
+      end
+      # verify the required parameter 'korona_account_id' is set
+      if @api_client.config.client_side_validation && korona_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling UsersApi.update_users"
+      end
+      # verify the required parameter 'user' is set
+      if @api_client.config.client_side_validation && user.nil?
+        fail ArgumentError, "Missing the required parameter 'user' when calling UsersApi.update_users"
+      end
+      # resource path
+      local_var_path = '/accounts/{koronaAccountId}/users'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.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'
+      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(user)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.update_users",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#update_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end