xbim_aim 2.0.0

data/lib/xbim_aim/api/components_api.rb

@@ -0,0 +1,803 @@
+=begin
+#XBIM Flex API v2
+
+#This is the XBIM Flex Swagger service where you can explore the REST API for the platform.
+
+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 XbimAim
+  class ComponentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Adds a new document to a model entity
+    # <span style='font-size: 17px;'>Summary:</span>Adds a new document to a model entity.<br/>Return Type: <b>Document</b><br/><br/>
+    # @param asset_model_id [Integer] The model Id
+    # @param entity_id [Integer] The unique identifier for the target entity (Entity Label)
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param document [DocumentCreate] A document to create
+    # @param [Hash] opts the optional parameters
+    # @return [Document]
+    def components_add_document_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, document, opts = {})
+      data, _status_code, _headers = components_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts)
+      data
+    end
+
+    # Adds a new document to a model entity
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds a new document to a model entity.&lt;br/&gt;Return Type: &lt;b&gt;Document&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_model_id [Integer] The model Id
+    # @param entity_id [Integer] The unique identifier for the target entity (Entity Label)
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param document [DocumentCreate] A document to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Document, Integer, Hash)>] Document data, response status code and response headers
+    def components_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid ...'
+      end
+      # verify the required parameter 'asset_model_id' is set
+      if @api_client.config.client_side_validation && asset_model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'entity_id' is set
+      if @api_client.config.client_side_validation && entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'entity_id' when calling ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'document' is set
+      if @api_client.config.client_side_validation && document.nil?
+        fail ArgumentError, "Missing the required parameter 'document' when calling ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.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(document)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Document'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid",
+        :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: ComponentsApi#components_add_document_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Components as of by date and tenantid
+    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ODataListResponseOfEntity</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 date [Time] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [ODataListResponseOfEntity]
+    def components_as_of_by_date_and_tenantid(date, tenant_id, region, opts = {})
+      data, _status_code, _headers = components_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts)
+      data
+    end
+
+    # Get Components as of by date and tenantid
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataListResponseOfEntity&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 date [Time] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [Array<(ODataListResponseOfEntity, Integer, Hash)>] ODataListResponseOfEntity data, response status code and response headers
+    def components_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_as_of_by_date_and_tenantid ...'
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling ComponentsApi.components_as_of_by_date_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_as_of_by_date_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_as_of_by_date_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components/AsOf(date={date})'.sub('{' + 'date' + '}', CGI.escape(date.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # 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', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataListResponseOfEntity'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_as_of_by_date_and_tenantid",
+        :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: ComponentsApi#components_as_of_by_date_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the Spaces this Component is placed in, based on Footprint data
+    # <span style='font-size: 17px;'>Summary:</span>Gets the Spaces this Component is placed in, based on Footprint data.<br/>Returns the Spaces where the component is wholly contained in the volume<br />              This is a derived value based on the component geometry              being wholly within the spatial footprint, and wholly within the Z-axis range of the space.<br />              A 'tolerance' can be provided to extend or reduce the buffer included at the boundaries              of the component<br />.<br/>Return Type: <b>ODataListResponseOfSpace</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 asset_model_id [Integer] The assetModel ID of the Component
+    # @param entity_id [Integer] The ID of the Component entity
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @option opts [Float] :tolerance Tolerance in millimeters. Can be negative. Default: 10mm (default to 10.0)
+    # @option opts [Boolean] :in_same_asset Limit the results to spaces in the same Asset (default to true)
+    # @return [ODataListResponseOfSpace]
+    def components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the Spaces this Component is placed in, based on Footprint data
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the Spaces this Component is placed in, based on Footprint data.&lt;br/&gt;Returns the Spaces where the component is wholly contained in the volume&lt;br /&gt;              This is a derived value based on the component geometry              being wholly within the spatial footprint, and wholly within the Z-axis range of the space.&lt;br /&gt;              A &#39;tolerance&#39; can be provided to extend or reduce the buffer included at the boundaries              of the component&lt;br /&gt;.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfSpace&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 asset_model_id [Integer] The assetModel ID of the Component
+    # @param entity_id [Integer] The ID of the Component entity
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @option opts [Float] :tolerance Tolerance in millimeters. Can be negative. Default: 10mm
+    # @option opts [Boolean] :in_same_asset Limit the results to spaces in the same Asset
+    # @return [Array<(ODataListResponseOfSpace, Integer, Hash)>] ODataListResponseOfSpace data, response status code and response headers
+    def components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid ...'
+      end
+      # verify the required parameter 'asset_model_id' is set
+      if @api_client.config.client_side_validation && asset_model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'entity_id' is set
+      if @api_client.config.client_side_validation && entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'entity_id' when calling ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId})/ContainingSpaces'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # 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?
+      query_params[:'tolerance'] = opts[:'tolerance'] if !opts[:'tolerance'].nil?
+      query_params[:'inSameAsset'] = opts[:'in_same_asset'] if !opts[:'in_same_asset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataListResponseOfSpace'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid",
+        :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: ComponentsApi#components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the Properties available on this Model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the Properties available on this Model.<br/>Return Type: <b>ODataListResponseOfAttributeDefinition</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 asset_id [Integer] The unique key for the asset
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [ODataListResponseOfAttributeDefinition]
+    def components_get_available_properties_by_assetid_and_tenantid(asset_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = components_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the Properties available on this Model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the Properties available on this Model.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfAttributeDefinition&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 asset_id [Integer] The unique key for the asset
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [Array<(ODataListResponseOfAttributeDefinition, Integer, Hash)>] ODataListResponseOfAttributeDefinition data, response status code and response headers
+    def components_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_get_available_properties_by_assetid_and_tenantid ...'
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling ComponentsApi.components_get_available_properties_by_assetid_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_get_available_properties_by_assetid_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_get_available_properties_by_assetid_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components/GetAvailableProperties(assetId={assetId})'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # 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', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataListResponseOfAttributeDefinition'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_get_available_properties_by_assetid_and_tenantid",
+        :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: ComponentsApi#components_get_available_properties_by_assetid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the EntitySet Components
+    # <span style='font-size: 17px;'>Summary:</span>Returns the EntitySet Components.<br/>Return Type: <b>ODataListResponseOfComponent</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 tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [ODataListResponseOfComponent]
+    def components_get_by_tenantid(tenant_id, region, opts = {})
+      data, _status_code, _headers = components_get_by_tenantid_with_http_info(tenant_id, region, opts)
+      data
+    end
+
+    # Returns the EntitySet Components
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Components.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfComponent&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 tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [Array<(ODataListResponseOfComponent, Integer, Hash)>] ODataListResponseOfComponent data, response status code and response headers
+    def components_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_get_by_tenantid ...'
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_get_by_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_get_by_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # 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', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataListResponseOfComponent'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_get_by_tenantid",
+        :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: ComponentsApi#components_get_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Components single entity by assetmodelid, entityid and tenantid
+    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Component</b><br/><br/>
+    # @param asset_model_id [Integer] 
+    # @param entity_id [Integer] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @return [Component]
+    def components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts)
+      data
+    end
+
+    # Get Components single entity by assetmodelid, entityid and tenantid
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Component&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_model_id [Integer] 
+    # @param entity_id [Integer] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @return [Array<(Component, Integer, Hash)>] Component data, response status code and response headers
+    def components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid ...'
+      end
+      # verify the required parameter 'asset_model_id' is set
+      if @api_client.config.client_side_validation && asset_model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'entity_id' is set
+      if @api_client.config.client_side_validation && entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'entity_id' when calling ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components(AssetModelId={assetModelId}, EntityId={entityId})'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.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', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Component'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid",
+        :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: ComponentsApi#components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Edit an existing component
+    # <span style='font-size: 17px;'>Summary:</span>Edit an existing component.<br/>Return Type: <b>Entity</b><br/><br/>
+    # @param asset_model_id [Integer] 
+    # @param entity_id [Integer] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param patch [ComponentEdit] 
+    # @param [Hash] opts the optional parameters
+    # @return [Entity]
+    def components_patch_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
+      data, _status_code, _headers = components_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts)
+      data
+    end
+
+    # Edit an existing component
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Edit an existing component.&lt;br/&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_model_id [Integer] 
+    # @param entity_id [Integer] 
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param patch [ComponentEdit] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Entity, Integer, Hash)>] Entity data, response status code and response headers
+    def components_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid ...'
+      end
+      # verify the required parameter 'asset_model_id' is set
+      if @api_client.config.client_side_validation && asset_model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'entity_id' is set
+      if @api_client.config.client_side_validation && entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'entity_id' when calling ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'patch' is set
+      if @api_client.config.client_side_validation && patch.nil?
+        fail ArgumentError, "Missing the required parameter 'patch' when calling ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components(AssetModelId={AssetModelId}, EntityId={EntityId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'EntityId' + '}', CGI.escape(entity_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.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(patch)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Entity'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid",
+        :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: ComponentsApi#components_patch_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Adds a new Component to a model
+    # <span style='font-size: 17px;'>Summary:</span>Adds a new Component to a model.<br/>Return Type: <b>Component</b><br/><br/>
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param component [ComponentCreate] The entity to post
+    # @param [Hash] opts the optional parameters
+    # @return [Component]
+    def components_post_by_tenantid(tenant_id, region, component, opts = {})
+      data, _status_code, _headers = components_post_by_tenantid_with_http_info(tenant_id, region, component, opts)
+      data
+    end
+
+    # Adds a new Component to a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds a new Component to a model.&lt;br/&gt;Return Type: &lt;b&gt;Component&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param component [ComponentCreate] The entity to post
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Component, Integer, Hash)>] Component data, response status code and response headers
+    def components_post_by_tenantid_with_http_info(tenant_id, region, component, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ComponentsApi.components_post_by_tenantid ...'
+      end
+      # verify the required parameter 'tenant_id' is set
+      if @api_client.config.client_side_validation && tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ComponentsApi.components_post_by_tenantid"
+      end
+      # verify the required parameter 'region' is set
+      if @api_client.config.client_side_validation && region.nil?
+        fail ArgumentError, "Missing the required parameter 'region' when calling ComponentsApi.components_post_by_tenantid"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'component' is set
+      if @api_client.config.client_side_validation && component.nil?
+        fail ArgumentError, "Missing the required parameter 'component' when calling ComponentsApi.components_post_by_tenantid"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/Components'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.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(component)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Component'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ComponentsApi.components_post_by_tenantid",
+        :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: ComponentsApi#components_post_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end