xbim_aim 2.0.0

data/lib/xbim_aim/api/diagnostics_api.rb

@@ -0,0 +1,109 @@
+=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 DiagnosticsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns the EntitySet Diagnostics
+    # <span style='font-size: 17px;'>Summary:</span>Returns the EntitySet Diagnostics.<br/>Return Type: <b></b><br/><br/>
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [nil]
+    def diagnostics_get(region, opts = {})
+      diagnostics_get_with_http_info(region, opts)
+      nil
+    end
+
+    # Returns the EntitySet Diagnostics
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Diagnostics.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param region [String] The data center region the data resides in
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Expands related entities inline.
+    # @option opts [String] :filter Filters the results, based on a Boolean condition.
+    # @option opts [String] :select Selects which properties to include in the response.
+    # @option opts [String] :orderby Sorts the results.
+    # @option opts [Integer] :top Returns only the first n results.
+    # @option opts [Integer] :skip Skips the first n results.
+    # @option opts [Boolean] :count Includes a count of the matching results in the response.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def diagnostics_get_with_http_info(region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DiagnosticsApi.diagnostics_get ...'
+      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 DiagnosticsApi.diagnostics_get"
+      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/Diagnostics'.sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
+      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
+      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
+      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"DiagnosticsApi.diagnostics_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DiagnosticsApi#diagnostics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/xbim_aim/api/document_files_api.rb

@@ -0,0 +1,224 @@
+=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 DocumentFilesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Downloads binary file related to asset and model
+    # <span style='font-size: 17px;'>Summary:</span>Downloads binary file related to asset and model.<br/>Return Type: <b>string</b><br/><br/>
+    # @param asset_id [Integer] Asset ID
+    # @param model_id [Integer] Model ID
+    # @param file_id [String] File 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 document_files_get_file(asset_id, model_id, file_id, tenant_id, region, opts = {})
+      data, _status_code, _headers = document_files_get_file_with_http_info(asset_id, model_id, file_id, tenant_id, region, opts)
+      data
+    end
+
+    # Downloads binary file related to asset and model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Downloads binary file related to asset and model.&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 file_id [String] File 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 document_files_get_file_with_http_info(asset_id, model_id, file_id, tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentFilesApi.document_files_get_file ...'
+      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 DocumentFilesApi.document_files_get_file"
+      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 DocumentFilesApi.document_files_get_file"
+      end
+      # verify the required parameter 'file_id' is set
+      if @api_client.config.client_side_validation && file_id.nil?
+        fail ArgumentError, "Missing the required parameter 'file_id' when calling DocumentFilesApi.document_files_get_file"
+      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 DocumentFilesApi.document_files_get_file"
+      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 DocumentFilesApi.document_files_get_file"
+      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}/documentfiles/download/{assetId}/{modelId}/{fileId}'.sub('{' + 'assetId' + '}', CGI.escape(asset_id.to_s)).sub('{' + 'modelId' + '}', CGI.escape(model_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/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 => :"DocumentFilesApi.document_files_get_file",
+        :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: DocumentFilesApi#document_files_get_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Uploads a document file related to a specific model
+    # <span style='font-size: 17px;'>Summary:</span>Uploads a document file related to a specific model.<br/>The document will be associated with the asset and model provided in the Form data parameters.<br/>Return Type: <b>FileUploadResult</b><br/><br/>
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param file [File] An arbitrary document which will get associated to the model or its parts.
+    # @param document_name [String] The name of the Document
+    # @param asset_id [Integer] Asset which should contain the document
+    # @param model_id [Integer] Asset model which should contain the document
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id External identity of the document. This will be used for versioning.
+    # @return [FileUploadResult]
+    def document_files_upload_single_file(tenant_id, region, file, document_name, asset_id, model_id, opts = {})
+      data, _status_code, _headers = document_files_upload_single_file_with_http_info(tenant_id, region, file, document_name, asset_id, model_id, opts)
+      data
+    end
+
+    # Uploads a document file related to a specific model
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Uploads a document file related to a specific model.&lt;br/&gt;The document will be associated with the asset and model provided in the Form data parameters.&lt;br/&gt;Return Type: &lt;b&gt;FileUploadResult&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
+    # @param region [String] The data center region the data resides in
+    # @param file [File] An arbitrary document which will get associated to the model or its parts.
+    # @param document_name [String] The name of the Document
+    # @param asset_id [Integer] Asset which should contain the document
+    # @param model_id [Integer] Asset model which should contain the document
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :external_id External identity of the document. This will be used for versioning.
+    # @return [Array<(FileUploadResult, Integer, Hash)>] FileUploadResult data, response status code and response headers
+    def document_files_upload_single_file_with_http_info(tenant_id, region, file, document_name, asset_id, model_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentFilesApi.document_files_upload_single_file ...'
+      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 DocumentFilesApi.document_files_upload_single_file"
+      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 DocumentFilesApi.document_files_upload_single_file"
+      end
+      # verify enum value
+      allowable_values = ["UK", "WestEurope", "Sandbox"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(region)
+        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling DocumentFilesApi.document_files_upload_single_file"
+      end
+      # verify the required parameter 'document_name' is set
+      if @api_client.config.client_side_validation && document_name.nil?
+        fail ArgumentError, "Missing the required parameter 'document_name' when calling DocumentFilesApi.document_files_upload_single_file"
+      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 DocumentFilesApi.document_files_upload_single_file"
+      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 DocumentFilesApi.document_files_upload_single_file"
+      end
+      # resource path
+      local_var_path = '/{region}/aim/2.0/{tenantId}/documentfiles/upload'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['file'] = file
+      form_params['documentName'] = document_name
+      form_params['assetId'] = asset_id
+      form_params['modelId'] = model_id
+      form_params['externalId'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileUploadResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"DocumentFilesApi.document_files_upload_single_file",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DocumentFilesApi#document_files_upload_single_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end