xbim_aim 2.0.0

data/lib/xbim_aim/api/wexbim_api.rb

@@ -0,0 +1,849 @@
+=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 WexbimApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Gets the pre-generated complete wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated complete wexbim geometry stream for a model.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [File]
+    def wexbim_get_complete(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_complete_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated complete wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated complete wexbim geometry stream for a model.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_complete_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_complete ...'
+      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 WexbimApi.wexbim_get_complete"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_complete"
+      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 WexbimApi.wexbim_get_complete"
+      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 WexbimApi.wexbim_get_complete"
+      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}/wexbim/complete'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_complete",
+        :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: WexbimApi#wexbim_get_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the pre-generated components wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated components wexbim geometry stream for a model.<br/>E.g. Fixtures / Furniture, mechnical, electrical and engineering. Excludes the Envelope and Doors, windows and spaces.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [File]
+    def wexbim_get_components(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_components_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated components wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated components wexbim geometry stream for a model.&lt;br/&gt;E.g. Fixtures / Furniture, mechnical, electrical and engineering. Excludes the Envelope and Doors, windows and spaces.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_components_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_components ...'
+      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 WexbimApi.wexbim_get_components"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_components"
+      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 WexbimApi.wexbim_get_components"
+      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 WexbimApi.wexbim_get_components"
+      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}/wexbim/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[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_components",
+        :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: WexbimApi#wexbim_get_components\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets a dynamically generated geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets a dynamically generated geometry stream for a model.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] The id of asset the model belongs to
+    # @param model_id [Integer] The id of the model
+    # @param included [Array<String>] The IFC types to include (hierarchical)
+    # @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 [Array<String>] :excluded The IFC types to exclude (hierarchical)
+    # @return [File]
+    def wexbim_get_dynamic(asset_id, model_id, included, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_dynamic_with_http_info(asset_id, model_id, included, tenant_id, region, opts)
+      data
+    end
+
+    # Gets a dynamically generated geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets a dynamically generated geometry stream for a model.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] The id of asset the model belongs to
+    # @param model_id [Integer] The id of the model
+    # @param included [Array<String>] The IFC types to include (hierarchical)
+    # @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 [Array<String>] :excluded The IFC types to exclude (hierarchical)
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_dynamic_with_http_info(asset_id, model_id, included, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_dynamic ...'
+      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 WexbimApi.wexbim_get_dynamic"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_dynamic"
+      end
+      # verify the required parameter 'included' is set
+      if @api_client.config.client_side_validation && included.nil?
+        fail ArgumentError, "Missing the required parameter 'included' when calling WexbimApi.wexbim_get_dynamic"
+      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 WexbimApi.wexbim_get_dynamic"
+      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 WexbimApi.wexbim_get_dynamic"
+      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
+      allowable_values = ["Product", "Element", "DistributionElement", "DistributionFlowElement", "DistributionChamberElement", "EnergyConversionDevice", "AirToAirHeatRecovery", "Boiler", "Burner", "Chiller", "Coil", "Condenser", "CooledBeam", "CoolingTower", "Engine", "EvaporativeCooler", "Evaporator", "HeatExchanger", "Humidifier", "TubeBundle", "UnitaryEquipment", "ElectricGenerator", "ElectricMotor", "MotorConnection", "SolarDevice", "Transformer", "FlowController", "ElectricDistributionPoint", "AirTerminalBox", "Damper", "FlowMeter", "Valve", "ElectricDistributionBoard", "ElectricTimeControl", "ProtectiveDevice", "SwitchingDevice", "FlowFitting", "DuctFitting", "PipeFitting", "CableCarrierFitting", "CableFitting", "JunctionBox", "FlowMovingDevice", "Compressor", "Fan", "Pump", "FlowSegment", "DuctSegment", "PipeSegment", "CableCarrierSegment", "CableSegment", "FlowStorageDevice", "Tank", "ElectricFlowStorageDevice", "FlowTerminal", "FireSuppressionTerminal", "SanitaryTerminal", "StackTerminal", "WasteTerminal", "AirTerminal", "MedicalDevice", "SpaceHeater", "AudioVisualAppliance", "CommunicationsAppliance", "ElectricAppliance", "Lamp", "LightFixture", "Outlet", "FlowTreatmentDevice", "Interceptor", "DuctSilencer", "Filter", "DistributionControlElement", "ProtectiveDeviceTrippingUnit", "Actuator", "Alarm", "Controller", "FlowInstrument", "Sensor", "UnitaryControlElement", "ElementComponent", "DiscreteAccessory", "Fastener", "MechanicalFastener", "ReinforcingElement", "ReinforcingBar", "ReinforcingMesh", "Tendon", "TendonAnchor", "BuildingElementPart", "VibrationIsolator", "FeatureElement", "FeatureElementSubtraction", "EdgeFeature", "ChamferEdgeFeature", "RoundedEdgeFeature", "OpeningElement", "OpeningStandardCase", "VoidingFeature", "FeatureElementAddition", "ProjectionElement", "SurfaceFeature", "BuildingElement", "BuildingElementComponent", "Footing", "Pile", "Beam", "BeamStandardCase", "Column", "ColumnStandardCase", "CurtainWall", "Door", "DoorStandardCase", "Member", "MemberStandardCase", "Plate", "PlateStandardCase", "Railing", "Ramp", "RampFlight", "Roof", "Slab", "SlabElementedCase", "SlabStandardCase", "Stair", "StairFlight", "Wall", "WallStandardCase", "WallElementedCase", "Window", "WindowStandardCase", "BuildingElementProxy", "Covering", "Chimney", "ShadingDevice", "ElementAssembly", "FurnishingElement", "Furniture", "SystemFurnitureElement", "TransportElement", "VirtualElement", "ElectricalElement", "EquipmentElement", "CivilElement", "GeographicElement", "Port", "DistributionPort", "Proxy", "StructuralActivity", "StructuralAction", "StructuralLinearAction", "StructuralLinearActionVarying", "StructuralPlanarAction", "StructuralPlanarActionVarying", "StructuralPointAction", "StructuralCurveAction", "StructuralSurfaceAction", "StructuralReaction", "StructuralPointReaction", "StructuralCurveReaction", "StructuralSurfaceReaction", "StructuralItem", "StructuralConnection", "StructuralCurveConnection", "StructuralPointConnection", "StructuralSurfaceConnection", "StructuralMember", "StructuralCurveMember", "StructuralCurveMemberVarying", "StructuralSurfaceMember", "StructuralSurfaceMemberVarying", "Annotation", "SpatialStructureElement", "Building", "BuildingStorey", "Site", "Space", "Grid", "SpatialElement", "ExternalSpatialStructureElement", "ExternalSpatialElement", "SpatialZone", "Person", "Document", "DoorStyle", "DoorType", "WallType"]
+      if @api_client.config.client_side_validation && opts[:'excluded'] && !opts[:'excluded'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"excluded\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/wexbim/dynamic'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+      query_params[:'included'] = @api_client.build_collection_param(included, :csv)
+      query_params[:'excluded'] = @api_client.build_collection_param(opts[:'excluded'], :csv) if !opts[:'excluded'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_dynamic",
+        :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: WexbimApi#wexbim_get_dynamic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the pre-generated building envelope wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated building envelope wexbim geometry stream for a model.<br/>E.g. The building fabric and external envelope.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] The asset identifier.
+    # @param model_id [Integer] The model identifier.
+    # @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
+    # @return [File]
+    def wexbim_get_envelope(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_envelope_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated building envelope wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated building envelope wexbim geometry stream for a model.&lt;br/&gt;E.g. The building fabric and external envelope.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] The asset identifier.
+    # @param model_id [Integer] The model identifier.
+    # @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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_envelope_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_envelope ...'
+      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 WexbimApi.wexbim_get_envelope"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_envelope"
+      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 WexbimApi.wexbim_get_envelope"
+      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 WexbimApi.wexbim_get_envelope"
+      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}/wexbim/envelope'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_envelope",
+        :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: WexbimApi#wexbim_get_envelope\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping.
+    # <span style='font-size: 17px;'>Summary:</span>Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping..<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] 
+    # @param model_id [Integer] 
+    # @param bottom [Float] 
+    # @param top [Float] 
+    # @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
+    # @return [File]
+    def wexbim_get_envelope_cut(asset_id, model_id, bottom, top, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_envelope_cut_with_http_info(asset_id, model_id, bottom, top, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping.
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the building envelope geometry cut plane. This can be used to cap the holes after clipping..&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] 
+    # @param model_id [Integer] 
+    # @param bottom [Float] 
+    # @param top [Float] 
+    # @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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_envelope_cut_with_http_info(asset_id, model_id, bottom, top, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_envelope_cut ...'
+      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 WexbimApi.wexbim_get_envelope_cut"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_envelope_cut"
+      end
+      # verify the required parameter 'bottom' is set
+      if @api_client.config.client_side_validation && bottom.nil?
+        fail ArgumentError, "Missing the required parameter 'bottom' when calling WexbimApi.wexbim_get_envelope_cut"
+      end
+      # verify the required parameter 'top' is set
+      if @api_client.config.client_side_validation && top.nil?
+        fail ArgumentError, "Missing the required parameter 'top' when calling WexbimApi.wexbim_get_envelope_cut"
+      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 WexbimApi.wexbim_get_envelope_cut"
+      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 WexbimApi.wexbim_get_envelope_cut"
+      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}/wexbim/envelopecut'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+      query_params[:'bottom'] = bottom
+      query_params[:'top'] = top
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_envelope_cut",
+        :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: WexbimApi#wexbim_get_envelope_cut\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the a cutplane across the envelope for up to 6 cut planes.
+    # <span style='font-size: 17px;'>Summary:</span>Gets the a cutplane across the envelope for up to 6 cut planes..<br/>Used to cap voids in the envelope when employing sections / section boxes.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] 
+    # @param model_id [Integer] 
+    # @param planes [Array<Float>] 
+    # @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
+    # @return [File]
+    def wexbim_get_envelope_free_cut(asset_id, model_id, planes, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_envelope_free_cut_with_http_info(asset_id, model_id, planes, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the a cutplane across the envelope for up to 6 cut planes.
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the a cutplane across the envelope for up to 6 cut planes..&lt;br/&gt;Used to cap voids in the envelope when employing sections / section boxes.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] 
+    # @param model_id [Integer] 
+    # @param planes [Array<Float>] 
+    # @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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_envelope_free_cut_with_http_info(asset_id, model_id, planes, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_envelope_free_cut ...'
+      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 WexbimApi.wexbim_get_envelope_free_cut"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_envelope_free_cut"
+      end
+      # verify the required parameter 'planes' is set
+      if @api_client.config.client_side_validation && planes.nil?
+        fail ArgumentError, "Missing the required parameter 'planes' when calling WexbimApi.wexbim_get_envelope_free_cut"
+      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 WexbimApi.wexbim_get_envelope_free_cut"
+      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 WexbimApi.wexbim_get_envelope_free_cut"
+      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}/wexbim/envelopefreecut'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+      query_params[:'planes'] = @api_client.build_collection_param(planes, :csv)
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_envelope_free_cut",
+        :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: WexbimApi#wexbim_get_envelope_free_cut\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the pre-generated Site wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated Site wexbim geometry stream for a model.<br/>E.g. The building fabric and external envelope.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] The asset identifier.
+    # @param model_id [Integer] The model identifier.
+    # @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
+    # @return [File]
+    def wexbim_get_site(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_site_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated Site wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated Site wexbim geometry stream for a model.&lt;br/&gt;E.g. The building fabric and external envelope.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] The asset identifier.
+    # @param model_id [Integer] The model identifier.
+    # @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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_site_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_site ...'
+      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 WexbimApi.wexbim_get_site"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_site"
+      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 WexbimApi.wexbim_get_site"
+      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 WexbimApi.wexbim_get_site"
+      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}/wexbim/site'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_site",
+        :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: WexbimApi#wexbim_get_site\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the pre-generated spatial wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated spatial wexbim geometry stream for a model.<br/>E.g. The Site, Zones, Spaces in a Facility.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] Asset ID
+    # @param model_id [Integer] Model ID
+    # @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
+    # @return [File]
+    def wexbim_get_spatial_structure(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_spatial_structure_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated spatial wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated spatial wexbim geometry stream for a model.&lt;br/&gt;E.g. The Site, Zones, Spaces in a Facility.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] Asset ID
+    # @param model_id [Integer] Model ID
+    # @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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_spatial_structure_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_spatial_structure ...'
+      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 WexbimApi.wexbim_get_spatial_structure"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_spatial_structure"
+      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 WexbimApi.wexbim_get_spatial_structure"
+      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 WexbimApi.wexbim_get_spatial_structure"
+      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}/wexbim/spatial'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_spatial_structure",
+        :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: WexbimApi#wexbim_get_spatial_structure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the pre-generated doors/windows wexbim geometry stream for a model
+    # <span style='font-size: 17px;'>Summary:</span>Gets the pre-generated doors/windows wexbim geometry stream for a model.<br/>E.g. The building fabric and external envelope.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [File]
+    def wexbim_get_windows_and_doors(asset_id, model_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = wexbim_get_windows_and_doors_with_http_info(asset_id, model_id, tenant_id, region, opts)
+      data
+    end
+
+    # Gets the pre-generated doors/windows wexbim geometry stream for a model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the pre-generated doors/windows wexbim geometry stream for a model.&lt;br/&gt;E.g. The building fabric and external envelope.&lt;br/&gt;Return Type: &lt;b&gt;string&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param asset_id [Integer] 
+    # @param model_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
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def wexbim_get_windows_and_doors_with_http_info(asset_id, model_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WexbimApi.wexbim_get_windows_and_doors ...'
+      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 WexbimApi.wexbim_get_windows_and_doors"
+      end
+      # verify the required parameter 'model_id' is set
+      if @api_client.config.client_side_validation && model_id.nil?
+        fail ArgumentError, "Missing the required parameter 'model_id' when calling WexbimApi.wexbim_get_windows_and_doors"
+      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 WexbimApi.wexbim_get_windows_and_doors"
+      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 WexbimApi.wexbim_get_windows_and_doors"
+      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}/wexbim/windowsdoors'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'assetId'] = asset_id
+      query_params[:'modelId'] = model_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"WexbimApi.wexbim_get_windows_and_doors",
+        :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: WexbimApi#wexbim_get_windows_and_doors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end