xbim_identity 2.0.1 → 2.0.2

data/lib/xbim_identity/api/users_api.rb

@@ -1,382 +0,0 @@
-=begin
-#Xbim Flex Identity API 2.0
-
-#Communication centralised around construction data
-
-The version of the OpenAPI document: 2.0
-Contact: info@xbim.net
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
-
-=end
-
-require 'cgi'
-
-module XbimIdentity
-  class UsersApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get Users
-    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ODataUserList</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
-    # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
-    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
-    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
-    # @return [ODataUserList]
-    def id20_users_get(opts = {})
-      data, _status_code, _headers = id20_users_get_with_http_info(opts)
-      data
-    end
-
-    # Get Users
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataUserList&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
-    # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
-    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
-    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
-    # @return [Array<(ODataUserList, Integer, Hash)>] ODataUserList data, response status code and response headers
-    def id20_users_get_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_get ...'
-      end
-      # resource path
-      local_var_path = '/id/2.0/Users'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
-      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
-      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
-      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
-      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].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] || 'ODataUserList'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"UsersApi.id20_users_get",
-        :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#id20_users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Gets the specified User by their key
-    # <span style='font-size: 17px;'>Summary:</span>Gets the specified User by their key.<br/>Return Type: <b>User</b><br/><br/>
-    # @param external_id [String] Optional external login ID. This can be used as an alternative key by master users
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [User]
-    def id20_users_get_by_external_id_external_idexternal_id_get(external_id, opts = {})
-      data, _status_code, _headers = id20_users_get_by_external_id_external_idexternal_id_get_with_http_info(external_id, opts)
-      data
-    end
-
-    # Gets the specified User by their key
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the specified User by their key.&lt;br/&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param external_id [String] Optional external login ID. This can be used as an alternative key by master users
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
-    def id20_users_get_by_external_id_external_idexternal_id_get_with_http_info(external_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_get_by_external_id_external_idexternal_id_get ...'
-      end
-      # resource path
-      local_var_path = "/id/2.0/Users/GetByExternalId(externalId='{externalId}')".sub('{' + 'externalId' + '}', CGI.escape(external_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].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] || 'User'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"UsersApi.id20_users_get_by_external_id_external_idexternal_id_get",
-        :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#id20_users_get_by_external_id_external_idexternal_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Post Users
-    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>User</b><br/><br/>
-    # @param user_create [UserCreate] User to be created
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [User]
-    def id20_users_post(user_create, opts = {})
-      data, _status_code, _headers = id20_users_post_with_http_info(user_create, opts)
-      data
-    end
-
-    # Post Users
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param user_create [UserCreate] User to be created
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
-    def id20_users_post_with_http_info(user_create, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_post ...'
-      end
-      # verify the required parameter 'user_create' is set
-      if @api_client.config.client_side_validation && user_create.nil?
-        fail ArgumentError, "Missing the required parameter 'user_create' when calling UsersApi.id20_users_post"
-      end
-      # resource path
-      local_var_path = '/id/2.0/Users'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].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', 'application/xml', 'text/json', '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_create)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'User'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"UsersApi.id20_users_post",
-        :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#id20_users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Gets or creates the user based on the external identity. Only usable by master users.   User.ExternalIdentity is required for this call.
-    # <span style='font-size: 17px;'>Summary:</span>Gets or creates the user based on the external identity. Only usable by master users.   User.ExternalIdentity is required for this call..<br/>Return Type: <b>User</b><br/><br/>
-    # @param user_create [UserCreate] User to get or create based on the User.ExternalIdentity
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [User]
-    def id20_users_put(user_create, opts = {})
-      data, _status_code, _headers = id20_users_put_with_http_info(user_create, opts)
-      data
-    end
-
-    # Gets or creates the user based on the external identity. Only usable by master users.   User.ExternalIdentity is required for this call.
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets or creates the user based on the external identity. Only usable by master users.   User.ExternalIdentity is required for this call..&lt;br/&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param user_create [UserCreate] User to get or create based on the User.ExternalIdentity
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
-    def id20_users_put_with_http_info(user_create, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_put ...'
-      end
-      # verify the required parameter 'user_create' is set
-      if @api_client.config.client_side_validation && user_create.nil?
-        fail ArgumentError, "Missing the required parameter 'user_create' when calling UsersApi.id20_users_put"
-      end
-      # resource path
-      local_var_path = '/id/2.0/Users'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].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', 'application/xml', 'text/json', '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_create)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'User'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"UsersApi.id20_users_put",
-        :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, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UsersApi#id20_users_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Gets the specified User by their key
-    # <span style='font-size: 17px;'>Summary:</span>Gets the specified User by their key.<br/>Return Type: <b>User</b><br/><br/>
-    # @param user_id [String] The key.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [User]
-    def id20_users_user_id_get(user_id, opts = {})
-      data, _status_code, _headers = id20_users_user_id_get_with_http_info(user_id, opts)
-      data
-    end
-
-    # Gets the specified User by their key
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the specified User by their key.&lt;br/&gt;Return Type: &lt;b&gt;User&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param user_id [String] The key.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
-    # @option opts [String] :select Limits the properties returned in the result.
-    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
-    def id20_users_user_id_get_with_http_info(user_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.id20_users_user_id_get ...'
-      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.id20_users_user_id_get"
-      end
-      # resource path
-      local_var_path = '/id/2.0/Users({userId})'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].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] || 'User'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"UsersApi.id20_users_user_id_get",
-        :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#id20_users_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end