smplkit 1.0.16 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99035d7c61e862475d8e1d5ee5db3fab24c59d14d2ef409cf46d89354c1203fa
-  data.tar.gz: b4d498de8b004ffa1b1546cdee62101779764e999fa0dea1a7fea542441ddd59
+  metadata.gz: 22da5481c89c52426de98fac54b278a253202a6a3f28aa1e7a03eac0372ec790
+  data.tar.gz: '0190db86b79b56f478cab2c0c3814e48e5d7e48917afc6925ca42948277f7afe'
 SHA512:
-  metadata.gz: 82ff49d99ff687b5362c5588dc493655b1cc3308f93e1da8fd80ee0eb1a75c0537c382c78a7f75105d04b7adc652ad25d252e4ae6bd987edeb75b67cf07a482c
-  data.tar.gz: aa729bcdf21317113547e7db5debb143592bb263f34c38a29a6aba94caa02a93a0f7591ac6fa85bcc3a952f9b0312cf131d289af4580ac2b55f8e1fa38d68206
+  metadata.gz: 538c86b5c363d0e38f21e1c4b009a1cdec528ebc3b6bc9dba353bc5e6ea22f91613dfe15980b044bf4aec91e3c8bfa3d3282875b0889141842bbcb9264743371
+  data.tar.gz: 6ca828d6c3f0b111ca911328a4a7116dfbe4e5b8807b4a7aa56e9bc2f0a4088ae69f655c16b9d64d2307ed8aa6f4030b3baf34f63eff627ddbd6a21fc0672313

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/default_api.rb

@@ -0,0 +1,305 @@
+=begin
+#smplkit Audit API
+
+#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module SmplkitGeneratedClient::Audit
+  class DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Event
+    # Record an audit event for the authenticated account.  Returns ``201 Created`` on first write, ``200 OK`` if the request was a duplicate (matched by ``Idempotency-Key`` or auto-derived key).  Customers may not emit events whose ``resource_type`` starts with ``smpl.`` — that namespace is reserved for smplkit-emitted events about platform resources.
+    # @param event_response [EventResponse] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 
+    # @return [EventResponse]
+    def create_event(event_response, opts = {})
+      data, _status_code, _headers = create_event_with_http_info(event_response, opts)
+      data
+    end
+
+    # Create Event
+    # Record an audit event for the authenticated account.  Returns ``201 Created`` on first write, ``200 OK`` if the request was a duplicate (matched by ``Idempotency-Key`` or auto-derived key).  Customers may not emit events whose ``resource_type`` starts with ``smpl.`` — that namespace is reserved for smplkit-emitted events about platform resources.
+    # @param event_response [EventResponse] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key 
+    # @return [Array<(EventResponse, Integer, Hash)>] EventResponse data, response status code and response headers
+    def create_event_with_http_info(event_response, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.create_event ...'
+      end
+      # verify the required parameter 'event_response' is set
+      if @api_client.config.client_side_validation && event_response.nil?
+        fail ArgumentError, "Missing the required parameter 'event_response' when calling DefaultApi.create_event"
+      end
+      # resource path
+      local_var_path = '/api/v1/events'
+
+      # 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/vnd.api+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(event_response)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EventResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.create_event",
+        :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: DefaultApi#create_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Event
+    # Retrieve a single audit event by id.  Returns 404 if no event with that id exists in the caller's account — RLS enforces tenant isolation; this endpoint never leaks the existence of another tenant's event.
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EventResponse]
+    def get_event(event_id, opts = {})
+      data, _status_code, _headers = get_event_with_http_info(event_id, opts)
+      data
+    end
+
+    # Get Event
+    # Retrieve a single audit event by id.  Returns 404 if no event with that id exists in the caller&#39;s account — RLS enforces tenant isolation; this endpoint never leaks the existence of another tenant&#39;s event.
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EventResponse, Integer, Hash)>] EventResponse data, response status code and response headers
+    def get_event_with_http_info(event_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.get_event ...'
+      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 DefaultApi.get_event"
+      end
+      # resource path
+      local_var_path = '/api/v1/events/{event_id}'.sub('{event_id}', CGI.escape(event_id.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/vnd.api+json']) 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] || 'EventResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.get_event",
+        :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: DefaultApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Events
+    # List audit events for the authenticated account.  Default sort is ``-created_at``; cursor pagination via ``page[after]`` (the opaque cursor returned in ``links.next``). Filters are exact-match except ``filter[occurred_at]`` which uses the platform's range notation (``[2026-01-01T00:00:00Z,*)``).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_occurred_at 
+    # @option opts [String] :filter_actor_type 
+    # @option opts [String] :filter_actor_id 
+    # @option opts [String] :filter_action 
+    # @option opts [String] :filter_resource_type 
+    # @option opts [String] :filter_resource_id 
+    # @option opts [Integer] :page_size 
+    # @option opts [String] :page_after 
+    # @return [EventListResponse]
+    def list_events(opts = {})
+      data, _status_code, _headers = list_events_with_http_info(opts)
+      data
+    end
+
+    # List Events
+    # List audit events for the authenticated account.  Default sort is &#x60;&#x60;-created_at&#x60;&#x60;; cursor pagination via &#x60;&#x60;page[after]&#x60;&#x60; (the opaque cursor returned in &#x60;&#x60;links.next&#x60;&#x60;). Filters are exact-match except &#x60;&#x60;filter[occurred_at]&#x60;&#x60; which uses the platform&#39;s range notation (&#x60;&#x60;[2026-01-01T00:00:00Z,*)&#x60;&#x60;).
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter_occurred_at 
+    # @option opts [String] :filter_actor_type 
+    # @option opts [String] :filter_actor_id 
+    # @option opts [String] :filter_action 
+    # @option opts [String] :filter_resource_type 
+    # @option opts [String] :filter_resource_id 
+    # @option opts [Integer] :page_size 
+    # @option opts [String] :page_after 
+    # @return [Array<(EventListResponse, Integer, Hash)>] EventListResponse data, response status code and response headers
+    def list_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.list_events ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling DefaultApi.list_events, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/v1/events'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[occurred_at]'] = opts[:'filter_occurred_at'] if !opts[:'filter_occurred_at'].nil?
+      query_params[:'filter[actor_type]'] = opts[:'filter_actor_type'] if !opts[:'filter_actor_type'].nil?
+      query_params[:'filter[actor_id]'] = opts[:'filter_actor_id'] if !opts[:'filter_actor_id'].nil?
+      query_params[:'filter[action]'] = opts[:'filter_action'] if !opts[:'filter_action'].nil?
+      query_params[:'filter[resource_type]'] = opts[:'filter_resource_type'] if !opts[:'filter_resource_type'].nil?
+      query_params[:'filter[resource_id]'] = opts[:'filter_resource_id'] if !opts[:'filter_resource_id'].nil?
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) 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] || 'EventListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.list_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: DefaultApi#list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Usage
+    # Current-period usage and quota for the audit product.  Only ``filter[period]=current`` is supported; historical usage is a follow-up.
+    # @param filter_period [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [UsageResponse]
+    def list_usage(filter_period, opts = {})
+      data, _status_code, _headers = list_usage_with_http_info(filter_period, opts)
+      data
+    end
+
+    # List Usage
+    # Current-period usage and quota for the audit product.  Only &#x60;&#x60;filter[period]&#x3D;current&#x60;&#x60; is supported; historical usage is a follow-up.
+    # @param filter_period [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UsageResponse, Integer, Hash)>] UsageResponse data, response status code and response headers
+    def list_usage_with_http_info(filter_period, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.list_usage ...'
+      end
+      # verify the required parameter 'filter_period' is set
+      if @api_client.config.client_side_validation && filter_period.nil?
+        fail ArgumentError, "Missing the required parameter 'filter_period' when calling DefaultApi.list_usage"
+      end
+      # resource path
+      local_var_path = '/api/v1/usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[period]'] = filter_period
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) 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] || 'UsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.list_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: DefaultApi#list_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end