seatschart 0.1.0

data/lib/seatschart/api/usage_api.rb

@@ -0,0 +1,540 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'cgi'
+
+module SeatsChart
+  class UsageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Request monitoring per rate-limit lane
+    # Peak requests per minute and 429 counts per lane for the last 10 minutes, hour, 24 hours or 7 days. The **sales lane** carries the buyer path (seat map reads, manifest/geometry/state, the live stream, holds, renewals, best-available, releases, quotes, confirmations); the **api lane** carries everything else (reports, events, charts, workspaces, webhooks, keys), so reporting bursts never starve sales. Counters are written by the rate limiter in its existing Redis call (no extra round trip); minute data is kept 25 hours, hourly peaks 8 days. 10m/1h: one bucket per minute; 24h: 15-minute buckets (peak minute); 7d: hourly buckets. Dashboard session (any role) or an API key with the `reports` scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range Time range (default `1h`).
+    # @return [GetApiMonitoringRequests200Response]
+    def get_api_monitoring_requests(opts = {})
+      data, _status_code, _headers = get_api_monitoring_requests_with_http_info(opts)
+      data
+    end
+
+    # Request monitoring per rate-limit lane
+    # Peak requests per minute and 429 counts per lane for the last 10 minutes, hour, 24 hours or 7 days. The **sales lane** carries the buyer path (seat map reads, manifest/geometry/state, the live stream, holds, renewals, best-available, releases, quotes, confirmations); the **api lane** carries everything else (reports, events, charts, workspaces, webhooks, keys), so reporting bursts never starve sales. Counters are written by the rate limiter in its existing Redis call (no extra round trip); minute data is kept 25 hours, hourly peaks 8 days. 10m/1h: one bucket per minute; 24h: 15-minute buckets (peak minute); 7d: hourly buckets. Dashboard session (any role) or an API key with the `reports` scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range Time range (default `1h`).
+    # @return [Array<(GetApiMonitoringRequests200Response, Integer, Hash)>] GetApiMonitoringRequests200Response data, response status code and response headers
+    def get_api_monitoring_requests_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_monitoring_requests ...'
+      end
+      allowable_values = ["10m", "1h", "24h", "7d"]
+      if @api_client.config.client_side_validation && opts[:'range'] && !allowable_values.include?(opts[:'range'])
+        fail ArgumentError, "invalid value for \"range\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/monitoring/requests'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetApiMonitoringRequests200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_monitoring_requests",
+        :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: UsageApi#get_api_monitoring_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Monthly usage: used objects, charts and events
+    # Test (sandbox) workspaces (`isTest: true`) are never metered and have no limits (`limit: null`). `usedObjects.count` is the number of distinct objects booked in the UTC calendar month (seats.io-style billing unit): every seat that became booked counts once per month however often it is retried, released and re-booked; each sold general-admission place counts as one. Holds, test events and replays never count. `history` has exactly 12 months ending at `month` (zero-filled); `byEvent` lists the top 100 events of the month. `charts`/`events` are current totals against the plan limits. Dashboard JWT (any role) or an API key with the `reports` scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [nil]
+    def get_api_usage(opts = {})
+      get_api_usage_with_http_info(opts)
+      nil
+    end
+
+    # Monthly usage: used objects, charts and events
+    # Test (sandbox) workspaces (&#x60;isTest: true&#x60;) are never metered and have no limits (&#x60;limit: null&#x60;). &#x60;usedObjects.count&#x60; is the number of distinct objects booked in the UTC calendar month (seats.io-style billing unit): every seat that became booked counts once per month however often it is retried, released and re-booked; each sold general-admission place counts as one. Holds, test events and replays never count. &#x60;history&#x60; has exactly 12 months ending at &#x60;month&#x60; (zero-filled); &#x60;byEvent&#x60; lists the top 100 events of the month. &#x60;charts&#x60;/&#x60;events&#x60; are current totals against the plan limits. Dashboard JWT (any role) or an API key with the &#x60;reports&#x60; scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage ...'
+      end
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'month'].nil? && opts[:'month'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"month\"]' when calling UsageApi.get_api_usage, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'month'] = opts[:'month'] if !opts[:'month'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage",
+        :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: UsageApi#get_api_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Monthly used objects per chart and event
+    # Breakdown of `usedObjects` (see GET /usage) by chart, each with its events (most used first). Events are grouped under their current chart; deleted events or events without a chart are listed under `chartId: null`. Read from the metering table (no counters on the booking path). Dashboard JWT (any role) or an API key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [nil]
+    def get_api_usage_charts(opts = {})
+      get_api_usage_charts_with_http_info(opts)
+      nil
+    end
+
+    # Monthly used objects per chart and event
+    # Breakdown of &#x60;usedObjects&#x60; (see GET /usage) by chart, each with its events (most used first). Events are grouped under their current chart; deleted events or events without a chart are listed under &#x60;chartId: null&#x60;. Read from the metering table (no counters on the booking path). Dashboard JWT (any role) or an API key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_charts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage_charts ...'
+      end
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'month'].nil? && opts[:'month'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"month\"]' when calling UsageApi.get_api_usage_charts, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage/charts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'month'] = opts[:'month'] if !opts[:'month'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage_charts",
+        :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: UsageApi#get_api_usage_charts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Monthly used objects per event (paginated)
+    # Every event with used objects in the month, most used first (ties by event id): `items: [{ eventId, eventKey, eventName, chartId, usedObjects }]` (`eventName: null` for deleted events), `eventCount` and the month total `usedObjects`. `limit` 1..100 (default 50); pass `nextCursor` as `cursor` for the next page. Unlike `byEvent` of GET /usage (top 100) this lists every event. Closed months are immutable and their per-event totals are cached by the API. Dashboard JWT (any role) or an API key with the `reports` scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @option opts [Float] :limit Page size (1..100, default 50).
+    # @option opts [String] :cursor Opaque &#x60;nextCursor&#x60; of the previous page.
+    # @return [nil]
+    def get_api_usage_events(opts = {})
+      get_api_usage_events_with_http_info(opts)
+      nil
+    end
+
+    # Monthly used objects per event (paginated)
+    # Every event with used objects in the month, most used first (ties by event id): &#x60;items: [{ eventId, eventKey, eventName, chartId, usedObjects }]&#x60; (&#x60;eventName: null&#x60; for deleted events), &#x60;eventCount&#x60; and the month total &#x60;usedObjects&#x60;. &#x60;limit&#x60; 1..100 (default 50); pass &#x60;nextCursor&#x60; as &#x60;cursor&#x60; for the next page. Unlike &#x60;byEvent&#x60; of GET /usage (top 100) this lists every event. Closed months are immutable and their per-event totals are cached by the API. Dashboard JWT (any role) or an API key with the &#x60;reports&#x60; scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @option opts [Float] :limit Page size (1..100, default 50).
+    # @option opts [String] :cursor Opaque &#x60;nextCursor&#x60; of the previous page.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage_events ...'
+      end
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'month'].nil? && opts[:'month'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"month\"]' when calling UsageApi.get_api_usage_events, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UsageApi.get_api_usage_events, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UsageApi.get_api_usage_events, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length > 512
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling UsageApi.get_api_usage_events, the character length must be smaller than or equal to 512.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling UsageApi.get_api_usage_events, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"cursor\"]' when calling UsageApi.get_api_usage_events, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage/events'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'month'] = opts[:'month'] if !opts[:'month'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage_events",
+        :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: UsageApi#get_api_usage_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Monthly used objects of one event (paginated)
+    # Total `usedObjects` of the event in the month, `objectCount` (metered objects) and one page of the metered objects (`objectKey`: seat id, or `ga:<receiptId>` with `units` places; `firstUsedAt` with microseconds), newest first. `limit` 1..1000 (default 1000); pass `nextCursor` as `cursor` for the next page (`null` on the last page; `truncated` is true when more pages follow). Keyset pagination over the primary-key range of the event and month. Works for deleted events that were metered. Dashboard JWT (any role) or an API key with the `reports` scope.
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @option opts [Float] :limit Page size (1..1000, default 1000).
+    # @option opts [String] :cursor Opaque &#x60;nextCursor&#x60; of the previous page.
+    # @return [nil]
+    def get_api_usage_events_by_event_id(event_id, opts = {})
+      get_api_usage_events_by_event_id_with_http_info(event_id, opts)
+      nil
+    end
+
+    # Monthly used objects of one event (paginated)
+    # Total &#x60;usedObjects&#x60; of the event in the month, &#x60;objectCount&#x60; (metered objects) and one page of the metered objects (&#x60;objectKey&#x60;: seat id, or &#x60;ga:&lt;receiptId&gt;&#x60; with &#x60;units&#x60; places; &#x60;firstUsedAt&#x60; with microseconds), newest first. &#x60;limit&#x60; 1..1000 (default 1000); pass &#x60;nextCursor&#x60; as &#x60;cursor&#x60; for the next page (&#x60;null&#x60; on the last page; &#x60;truncated&#x60; is true when more pages follow). Keyset pagination over the primary-key range of the event and month. Works for deleted events that were metered. Dashboard JWT (any role) or an API key with the &#x60;reports&#x60; scope.
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @option opts [Float] :limit Page size (1..1000, default 1000).
+    # @option opts [String] :cursor Opaque &#x60;nextCursor&#x60; of the previous page.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_events_by_event_id_with_http_info(event_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage_events_by_event_id ...'
+      end
+      # verify the required parameter 'event_id' is set
+      if @api_client.config.client_side_validation && event_id.nil?
+        fail ArgumentError, "Missing the required parameter 'event_id' when calling UsageApi.get_api_usage_events_by_event_id"
+      end
+      if @api_client.config.client_side_validation && event_id.to_s.length > 36
+        fail ArgumentError, 'invalid value for "event_id" when calling UsageApi.get_api_usage_events_by_event_id, the character length must be smaller than or equal to 36.'
+      end
+
+      if @api_client.config.client_side_validation && event_id.to_s.length < 36
+        fail ArgumentError, 'invalid value for "event_id" when calling UsageApi.get_api_usage_events_by_event_id, the character length must be great than or equal to 36.'
+      end
+
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'month'].nil? && opts[:'month'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"month\"]' when calling UsageApi.get_api_usage_events_by_event_id, must conform to the pattern #{pattern}."
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UsageApi.get_api_usage_events_by_event_id, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UsageApi.get_api_usage_events_by_event_id, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length > 512
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling UsageApi.get_api_usage_events_by_event_id, the character length must be smaller than or equal to 512.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling UsageApi.get_api_usage_events_by_event_id, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]+$/)
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"cursor\"]' when calling UsageApi.get_api_usage_events_by_event_id, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage/events/{eventId}'.sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'month'] = opts[:'month'] if !opts[:'month'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage_events_by_event_id",
+        :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: UsageApi#get_api_usage_events_by_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Used objects per month over a range
+    # Monthly used objects from `from` to `to` inclusive (oldest first, zero-filled), at most 120 months (400 otherwise), plus the range total. One grouped read over the primary-key range `(tenant_id, month)`; closed months are immutable and cached by the API. Dashboard JWT (any role) or an API key with the `reports` scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from First month &#x60;YYYY-MM&#x60; (default: 11 months before &#x60;to&#x60;).
+    # @option opts [String] :to Last month &#x60;YYYY-MM&#x60; (default: current month; not in the future).
+    # @return [nil]
+    def get_api_usage_history(opts = {})
+      get_api_usage_history_with_http_info(opts)
+      nil
+    end
+
+    # Used objects per month over a range
+    # Monthly used objects from &#x60;from&#x60; to &#x60;to&#x60; inclusive (oldest first, zero-filled), at most 120 months (400 otherwise), plus the range total. One grouped read over the primary-key range &#x60;(tenant_id, month)&#x60;; closed months are immutable and cached by the API. Dashboard JWT (any role) or an API key with the &#x60;reports&#x60; scope.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :from First month &#x60;YYYY-MM&#x60; (default: 11 months before &#x60;to&#x60;).
+    # @option opts [String] :to Last month &#x60;YYYY-MM&#x60; (default: current month; not in the future).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage_history ...'
+      end
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'from'].nil? && opts[:'from'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"from\"]' when calling UsageApi.get_api_usage_history, must conform to the pattern #{pattern}."
+      end
+
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'to'].nil? && opts[:'to'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"to\"]' when calling UsageApi.get_api_usage_history, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage/history'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage_history",
+        :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: UsageApi#get_api_usage_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Monthly used objects across my workspaces (admin view)
+    # Every workspace the caller administers (role admin), with its plan, status and used objects of the month against the plan limit (`null` for test workspaces, which are never metered), plus the total. Dashboard session, or a **workspace admin API key** (the admin it is bound to); other API keys: 403 `ERR_PARTNER_SCOPE`. One grouped read of the metering table.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [nil]
+    def get_api_usage_workspaces(opts = {})
+      get_api_usage_workspaces_with_http_info(opts)
+      nil
+    end
+
+    # Monthly used objects across my workspaces (admin view)
+    # Every workspace the caller administers (role admin), with its plan, status and used objects of the month against the plan limit (&#x60;null&#x60; for test workspaces, which are never metered), plus the total. Dashboard session, or a **workspace admin API key** (the admin it is bound to); other API keys: 403 &#x60;ERR_PARTNER_SCOPE&#x60;. One grouped read of the metering table.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :month UTC calendar month &#x60;YYYY-MM&#x60; (default: current month).
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_usage_workspaces_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsageApi.get_api_usage_workspaces ...'
+      end
+      pattern = Regexp.new(/^\d{4}-\d{2}$/)
+      if @api_client.config.client_side_validation && !opts[:'month'].nil? && opts[:'month'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"month\"]' when calling UsageApi.get_api_usage_workspaces, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/usage/workspaces'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'month'] = opts[:'month'] if !opts[:'month'].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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"UsageApi.get_api_usage_workspaces",
+        :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: UsageApi#get_api_usage_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end