Class: XbimAim::WexbimApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_aim/api/wexbim_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WexbimApi

Returns a new instance of WexbimApi.



19
20
21
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#wexbim_get_complete(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


30
31
32
33
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 30

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

#wexbim_get_complete_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 43

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

#wexbim_get_components(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


118
119
120
121
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 118

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

#wexbim_get_components_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 131

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

#wexbim_get_dynamic(asset_id, model_id, included, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer) —

    The id of asset the model belongs to

  • model_id (Integer) —

    The id of the model

  • included (Array<String>) —

    The IFC types to include (hierarchical)

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :excluded (Array<String>) —

    The IFC types to exclude (hierarchical)

Returns:

  • (File) 


208
209
210
211
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 208

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

#wexbim_get_dynamic_with_http_info(asset_id, model_id, included, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer) —

    The id of asset the model belongs to

  • model_id (Integer) —

    The id of the model

  • included (Array<String>) —

    The IFC types to include (hierarchical)

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :excluded (Array<String>) —

    The IFC types to exclude (hierarchical)

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 223

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

#wexbim_get_envelope(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer) —

    The asset identifier.

  • model_id (Integer) —

    The model identifier.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


308
309
310
311
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 308

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

#wexbim_get_envelope_cut(asset_id, model_id, bottom, top, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • bottom (Float)
  • top (Float)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


398
399
400
401
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 398

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

#wexbim_get_envelope_cut_with_http_info(asset_id, model_id, bottom, top, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • bottom (Float)
  • top (Float)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 413

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

#wexbim_get_envelope_free_cut(asset_id, model_id, planes, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • planes (Array<Float>)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


499
500
501
502
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 499

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

#wexbim_get_envelope_free_cut_with_http_info(asset_id, model_id, planes, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • planes (Array<Float>)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 513

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

#wexbim_get_envelope_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer) —

    The asset identifier.

  • model_id (Integer) —

    The model identifier.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 321

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

#wexbim_get_site(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer) —

    The asset identifier.

  • model_id (Integer) —

    The model identifier.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


593
594
595
596
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 593

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

#wexbim_get_site_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer) —

    The asset identifier.

  • model_id (Integer) —

    The model identifier.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 606

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

#wexbim_get_spatial_structure(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer) —

    Asset ID

  • model_id (Integer) —

    Model ID

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


681
682
683
684
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 681

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

#wexbim_get_spatial_structure_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer) —

    Asset ID

  • model_id (Integer) —

    Model ID

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 694

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

#wexbim_get_windows_and_doors(asset_id, model_id, tenant_id, region, opts = {}) ⇒ File

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: string<br/><br/>

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


769
770
771
772
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 769

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

#wexbim_get_windows_and_doors_with_http_info(asset_id, model_id, tenant_id, region, opts = {}) ⇒ Array<(File, Integer, Hash)>

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;

Parameters:

  • asset_id (Integer)
  • model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/xbim_aim/api/wexbim_api.rb', line 782

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