xbim_aim 2.0.1 → 2.0.2

data/lib/xbim_aim/api/schedules_api.rb

@@ -1,404 +0,0 @@
-=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 SchedulesApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get Schedules schedule by tenantid
-    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>Schedule</b><br/><br/>
-    # @param asset_model_id [Integer] 
-    # @param schedule_name [String] 
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @return [Schedule]
-    def schedules_get_schedule_by_tenantid(asset_model_id, schedule_name, tenant_id, region, opts = {})
-      data, _status_code, _headers = schedules_get_schedule_by_tenantid_with_http_info(asset_model_id, schedule_name, tenant_id, region, opts)
-      data
-    end
-
-    # Get Schedules schedule by tenantid
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Schedule&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param asset_model_id [Integer] 
-    # @param schedule_name [String] 
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @return [Array<(Schedule, Integer, Hash)>] Schedule data, response status code and response headers
-    def schedules_get_schedule_by_tenantid_with_http_info(asset_model_id, schedule_name, tenant_id, region, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SchedulesApi.schedules_get_schedule_by_tenantid ...'
-      end
-      # verify the required parameter 'asset_model_id' is set
-      if @api_client.config.client_side_validation && asset_model_id.nil?
-        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling SchedulesApi.schedules_get_schedule_by_tenantid"
-      end
-      # verify the required parameter 'schedule_name' is set
-      if @api_client.config.client_side_validation && schedule_name.nil?
-        fail ArgumentError, "Missing the required parameter 'schedule_name' when calling SchedulesApi.schedules_get_schedule_by_tenantid"
-      end
-      # verify the required parameter 'tenant_id' is set
-      if @api_client.config.client_side_validation && tenant_id.nil?
-        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling SchedulesApi.schedules_get_schedule_by_tenantid"
-      end
-      # verify the required parameter 'region' is set
-      if @api_client.config.client_side_validation && region.nil?
-        fail ArgumentError, "Missing the required parameter 'region' when calling SchedulesApi.schedules_get_schedule_by_tenantid"
-      end
-      # verify enum value
-      allowable_values = ["UK", "WestEurope", "Sandbox"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(region)
-        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/{region}/aim/2.0/{tenantId}/Schedules({AssetModelId},{ScheduleName})'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'assetModelId'] = asset_model_id
-      query_params[:'scheduleName'] = schedule_name
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Schedule'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"SchedulesApi.schedules_get_schedule_by_tenantid",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SchedulesApi#schedules_get_schedule_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get Schedules schedule rows by assetmodelid, schedulename and tenantid
-    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b>ODataListResponseOfRow</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
-    # @param asset_model_id [Integer] 
-    # @param schedule_name [String] 
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :filter Filters the results, based on a Boolean condition.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @option opts [String] :orderby Sorts the results.
-    # @option opts [Integer] :top Returns only the first n results.
-    # @option opts [Integer] :skip Skips the first n results.
-    # @option opts [Boolean] :count Includes a count of the matching results in the response.
-    # @return [ODataListResponseOfRow]
-    def schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid(asset_model_id, schedule_name, tenant_id, region, opts = {})
-      data, _status_code, _headers = schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid_with_http_info(asset_model_id, schedule_name, tenant_id, region, opts)
-      data
-    end
-
-    # Get Schedules schedule rows by assetmodelid, schedulename and tenantid
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataListResponseOfRow&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
-    # @param asset_model_id [Integer] 
-    # @param schedule_name [String] 
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :filter Filters the results, based on a Boolean condition.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @option opts [String] :orderby Sorts the results.
-    # @option opts [Integer] :top Returns only the first n results.
-    # @option opts [Integer] :skip Skips the first n results.
-    # @option opts [Boolean] :count Includes a count of the matching results in the response.
-    # @return [Array<(ODataListResponseOfRow, Integer, Hash)>] ODataListResponseOfRow data, response status code and response headers
-    def schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid_with_http_info(asset_model_id, schedule_name, tenant_id, region, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid ...'
-      end
-      # verify the required parameter 'asset_model_id' is set
-      if @api_client.config.client_side_validation && asset_model_id.nil?
-        fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid"
-      end
-      # verify the required parameter 'schedule_name' is set
-      if @api_client.config.client_side_validation && schedule_name.nil?
-        fail ArgumentError, "Missing the required parameter 'schedule_name' when calling SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid"
-      end
-      # verify the required parameter 'tenant_id' is set
-      if @api_client.config.client_side_validation && tenant_id.nil?
-        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid"
-      end
-      # verify the required parameter 'region' is set
-      if @api_client.config.client_side_validation && region.nil?
-        fail ArgumentError, "Missing the required parameter 'region' when calling SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid"
-      end
-      # verify enum value
-      allowable_values = ["UK", "WestEurope", "Sandbox"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(region)
-        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = "/{region}/aim/2.0/{tenantId}/Schedules({assetModelId},'{scheduleName}')/Rows".sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'scheduleName' + '}', CGI.escape(schedule_name.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
-      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
-      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
-      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
-      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'ODataListResponseOfRow'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"SchedulesApi.schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SchedulesApi#schedules_get_schedule_rows_by_assetmodelid_and_schedulename_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Returns the EntitySet Schedules
-    # <span style='font-size: 17px;'>Summary:</span>Returns the EntitySet Schedules.<br/>Return Type: <b>ODataListResponseOfSchedule</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :filter Filters the results, based on a Boolean condition.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @option opts [String] :orderby Sorts the results.
-    # @option opts [Integer] :top Returns only the first n results.
-    # @option opts [Integer] :skip Skips the first n results.
-    # @option opts [Boolean] :count Includes a count of the matching results in the response.
-    # @return [ODataListResponseOfSchedule]
-    def schedules_get_schedules_by_tenantid(tenant_id, region, opts = {})
-      data, _status_code, _headers = schedules_get_schedules_by_tenantid_with_http_info(tenant_id, region, opts)
-      data
-    end
-
-    # Returns the EntitySet Schedules
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Schedules.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfSchedule&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
-    # @param tenant_id [String] The unique Tenant ID (UUID or Identifier string)
-    # @param region [String] The data center region the data resides in
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand Expands related entities inline.
-    # @option opts [String] :filter Filters the results, based on a Boolean condition.
-    # @option opts [String] :select Selects which properties to include in the response.
-    # @option opts [String] :orderby Sorts the results.
-    # @option opts [Integer] :top Returns only the first n results.
-    # @option opts [Integer] :skip Skips the first n results.
-    # @option opts [Boolean] :count Includes a count of the matching results in the response.
-    # @return [Array<(ODataListResponseOfSchedule, Integer, Hash)>] ODataListResponseOfSchedule data, response status code and response headers
-    def schedules_get_schedules_by_tenantid_with_http_info(tenant_id, region, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SchedulesApi.schedules_get_schedules_by_tenantid ...'
-      end
-      # verify the required parameter 'tenant_id' is set
-      if @api_client.config.client_side_validation && tenant_id.nil?
-        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling SchedulesApi.schedules_get_schedules_by_tenantid"
-      end
-      # verify the required parameter 'region' is set
-      if @api_client.config.client_side_validation && region.nil?
-        fail ArgumentError, "Missing the required parameter 'region' when calling SchedulesApi.schedules_get_schedules_by_tenantid"
-      end
-      # verify enum value
-      allowable_values = ["UK", "WestEurope", "Sandbox"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(region)
-        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/{region}/aim/2.0/{tenantId}/Schedules'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
-      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
-      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
-      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
-      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
-      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
-      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'ODataListResponseOfSchedule'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"SchedulesApi.schedules_get_schedules_by_tenantid",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SchedulesApi#schedules_get_schedules_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Post Schedules import schedule by modelid, schedule and tenantid
-    # <span style='font-size: 17px;'>Summary:</span>Return Type: <b></b><br/><br/>
-    # @param model_id [Integer] 
-    # @param schedule [String] 
-    # @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 [Object]
-    def schedules_import_schedule_by_modelid_and_schedule_and_tenantid(model_id, schedule, tenant_id, region, opts = {})
-      data, _status_code, _headers = schedules_import_schedule_by_modelid_and_schedule_and_tenantid_with_http_info(model_id, schedule, tenant_id, region, opts)
-      data
-    end
-
-    # Post Schedules import schedule by modelid, schedule and tenantid
-    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
-    # @param model_id [Integer] 
-    # @param schedule [String] 
-    # @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<(Object, Integer, Hash)>] Object data, response status code and response headers
-    def schedules_import_schedule_by_modelid_and_schedule_and_tenantid_with_http_info(model_id, schedule, tenant_id, region, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid ...'
-      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 SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid"
-      end
-      # verify the required parameter 'schedule' is set
-      if @api_client.config.client_side_validation && schedule.nil?
-        fail ArgumentError, "Missing the required parameter 'schedule' when calling SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid"
-      end
-      # verify the required parameter 'tenant_id' is set
-      if @api_client.config.client_side_validation && tenant_id.nil?
-        fail ArgumentError, "Missing the required parameter 'tenant_id' when calling SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid"
-      end
-      # verify the required parameter 'region' is set
-      if @api_client.config.client_side_validation && region.nil?
-        fail ArgumentError, "Missing the required parameter 'region' when calling SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid"
-      end
-      # verify enum value
-      allowable_values = ["UK", "WestEurope", "Sandbox"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(region)
-        fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = "/{region}/aim/2.0/{tenantId}/Schedules/Import(AssetModelId={modelId},ScheduleName='{schedule}')".sub('{' + 'modelId' + '}', CGI.escape(model_id.to_s)).sub('{' + 'schedule' + '}', CGI.escape(schedule.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Object'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['oauth2']
-
-      new_options = opts.merge(
-        :operation => :"SchedulesApi.schedules_import_schedule_by_modelid_and_schedule_and_tenantid",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: SchedulesApi#schedules_import_schedule_by_modelid_and_schedule_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end