xbim_aim 2.0.0

data/lib/xbim_aim/api/stats_api.rb

@@ -0,0 +1,170 @@
+=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 StatsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Lists the plan allowances and current consumpttion for a tenant's app
+    # <span style='font-size: 17px;'>Summary:</span>Lists the plan allowances and current consumpttion for a tenant's app.<br/>Return Type: <b></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 [Hash] opts the optional parameters
+    # @return [Hash<String, IMeteredResource>]
+    def stats_metered_resources(tenant_id, region, opts = {})
+      data, _status_code, _headers = stats_metered_resources_with_http_info(tenant_id, region, opts)
+      data
+    end
+
+    # Lists the plan allowances and current consumpttion for a tenant&#39;s app
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Lists the plan allowances and current consumpttion for a tenant&#39;s app.&lt;br/&gt;Return Type: &lt;b&gt;&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 [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, IMeteredResource>, Integer, Hash)>] Hash<String, IMeteredResource> data, response status code and response headers
+    def stats_metered_resources_with_http_info(tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatsApi.stats_metered_resources ...'
+      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 StatsApi.stats_metered_resources"
+      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 StatsApi.stats_metered_resources"
+      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}/stats/planAllowances'.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, IMeteredResource>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"StatsApi.stats_metered_resources",
+        :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: StatsApi#stats_metered_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Provides details of the permitted rate limits for tenant's app and user
+    # <span style='font-size: 17px;'>Summary:</span>Provides details of the permitted rate limits for tenant's app and user.<br/>Return Type: <b></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 [Hash] opts the optional parameters
+    # @return [Hash<String, QuotaStatus>]
+    def stats_rate_limits(tenant_id, region, opts = {})
+      data, _status_code, _headers = stats_rate_limits_with_http_info(tenant_id, region, opts)
+      data
+    end
+
+    # Provides details of the permitted rate limits for tenant&#39;s app and user
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Provides details of the permitted rate limits for tenant&#39;s app and user.&lt;br/&gt;Return Type: &lt;b&gt;&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 [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, QuotaStatus>, Integer, Hash)>] Hash<String, QuotaStatus> data, response status code and response headers
+    def stats_rate_limits_with_http_info(tenant_id, region, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StatsApi.stats_rate_limits ...'
+      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 StatsApi.stats_rate_limits"
+      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 StatsApi.stats_rate_limits"
+      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}/stats/rateLimits'.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, QuotaStatus>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"StatsApi.stats_rate_limits",
+        :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: StatsApi#stats_rate_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end