smplkit 1.0.19 → 1.0.21

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_request.rb

@@ -0,0 +1,273 @@
+=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 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Audit
+  # Plain-JSON body for the test_forwarder execute action.  Mirrors the encrypted ``ForwarderHttp`` shape with one addition — ``timeout_ms``, capped server-side.
+  class TestForwarderRequest < ApiModelBase
+    attr_accessor :method
+
+    attr_accessor :url
+
+    attr_accessor :headers
+
+    attr_accessor :body
+
+    attr_accessor :success_status
+
+    attr_accessor :timeout_ms
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'method' => :'method',
+        :'url' => :'url',
+        :'headers' => :'headers',
+        :'body' => :'body',
+        :'success_status' => :'success_status',
+        :'timeout_ms' => :'timeout_ms'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'method' => :'String',
+        :'url' => :'String',
+        :'headers' => :'Array<HttpHeader>',
+        :'body' => :'String',
+        :'success_status' => :'SuccessStatus',
+        :'timeout_ms' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'body',
+        :'timeout_ms'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::TestForwarderRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::TestForwarderRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      else
+        self.method = 'POST'
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'headers')
+        if (value = attributes[:'headers']).is_a?(Array)
+          self.headers = value
+        end
+      end
+
+      if attributes.key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.key?(:'success_status')
+        self.success_status = attributes[:'success_status']
+      end
+
+      if attributes.key?(:'timeout_ms')
+        self.timeout_ms = attributes[:'timeout_ms']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @url.to_s.length > 2048
+        invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 2048.')
+      end
+
+      if @url.to_s.length < 1
+        invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
+      end
+
+      if !@body.nil? && @body.to_s.length > 65536
+        invalid_properties.push('invalid value for "body", the character length must be smaller than or equal to 65536.')
+      end
+
+      if !@timeout_ms.nil? && @timeout_ms > 30000
+        invalid_properties.push('invalid value for "timeout_ms", must be smaller than or equal to 30000.')
+      end
+
+      if !@timeout_ms.nil? && @timeout_ms < 1
+        invalid_properties.push('invalid value for "timeout_ms", must be greater than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @url.nil?
+      return false if @url.to_s.length > 2048
+      return false if @url.to_s.length < 1
+      return false if !@body.nil? && @body.to_s.length > 65536
+      return false if !@timeout_ms.nil? && @timeout_ms > 30000
+      return false if !@timeout_ms.nil? && @timeout_ms < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      if url.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 2048.'
+      end
+
+      if url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "url", the character length must be greater than or equal to 1.'
+      end
+
+      @url = url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] body Value to be assigned
+    def body=(body)
+      if !body.nil? && body.to_s.length > 65536
+        fail ArgumentError, 'invalid value for "body", the character length must be smaller than or equal to 65536.'
+      end
+
+      @body = body
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] timeout_ms Value to be assigned
+    def timeout_ms=(timeout_ms)
+      if !timeout_ms.nil? && timeout_ms > 30000
+        fail ArgumentError, 'invalid value for "timeout_ms", must be smaller than or equal to 30000.'
+      end
+
+      if !timeout_ms.nil? && timeout_ms < 1
+        fail ArgumentError, 'invalid value for "timeout_ms", must be greater than or equal to 1.'
+      end
+
+      @timeout_ms = timeout_ms
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          method == o.method &&
+          url == o.url &&
+          headers == o.headers &&
+          body == o.body &&
+          success_status == o.success_status &&
+          timeout_ms == o.timeout_ms
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [method, url, headers, body, success_status, timeout_ms].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/test_forwarder_response.rb

@@ -0,0 +1,220 @@
+=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 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Audit
+  # Plain-JSON response body. Headers are echoed back unredacted because the caller already supplied them — the response is for the caller, not persisted into the delivery log.
+  class TestForwarderResponse < ApiModelBase
+    attr_accessor :succeeded
+
+    attr_accessor :response_status
+
+    attr_accessor :response_headers
+
+    attr_accessor :response_body
+
+    attr_accessor :latency_ms
+
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'succeeded' => :'succeeded',
+        :'response_status' => :'response_status',
+        :'response_headers' => :'response_headers',
+        :'response_body' => :'response_body',
+        :'latency_ms' => :'latency_ms',
+        :'error' => :'error'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'succeeded' => :'Boolean',
+        :'response_status' => :'Integer',
+        :'response_headers' => :'Hash<String, String>',
+        :'response_body' => :'String',
+        :'latency_ms' => :'Integer',
+        :'error' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'response_status',
+        :'response_body',
+        :'latency_ms',
+        :'error'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::TestForwarderResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::TestForwarderResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'succeeded')
+        self.succeeded = attributes[:'succeeded']
+      else
+        self.succeeded = nil
+      end
+
+      if attributes.key?(:'response_status')
+        self.response_status = attributes[:'response_status']
+      else
+        self.response_status = nil
+      end
+
+      if attributes.key?(:'response_headers')
+        if (value = attributes[:'response_headers']).is_a?(Hash)
+          self.response_headers = value
+        end
+      end
+
+      if attributes.key?(:'response_body')
+        self.response_body = attributes[:'response_body']
+      end
+
+      if attributes.key?(:'latency_ms')
+        self.latency_ms = attributes[:'latency_ms']
+      else
+        self.latency_ms = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @succeeded.nil?
+        invalid_properties.push('invalid value for "succeeded", succeeded cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @succeeded.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] succeeded Value to be assigned
+    def succeeded=(succeeded)
+      if succeeded.nil?
+        fail ArgumentError, 'succeeded cannot be nil'
+      end
+
+      @succeeded = succeeded
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          succeeded == o.succeeded &&
+          response_status == o.response_status &&
+          response_headers == o.response_headers &&
+          response_body == o.response_body &&
+          latency_ms == o.latency_ms &&
+          error == o.error
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [succeeded, response_status, response_headers, response_body, latency_ms, error].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

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

@@ -24,11 +24,29 @@ require 'smplkit_audit_client/models/event_list_meta'
 require 'smplkit_audit_client/models/event_list_response'
 require 'smplkit_audit_client/models/event_resource'
 require 'smplkit_audit_client/models/event_response'
+require 'smplkit_audit_client/models/forwarder'
+require 'smplkit_audit_client/models/forwarder_delivery'
+require 'smplkit_audit_client/models/forwarder_delivery_list_response'
+require 'smplkit_audit_client/models/forwarder_delivery_resource'
+require 'smplkit_audit_client/models/forwarder_delivery_response'
+require 'smplkit_audit_client/models/forwarder_http'
+require 'smplkit_audit_client/models/forwarder_list_links'
+require 'smplkit_audit_client/models/forwarder_list_meta'
+require 'smplkit_audit_client/models/forwarder_list_response'
+require 'smplkit_audit_client/models/forwarder_resource'
+require 'smplkit_audit_client/models/forwarder_response'
+require 'smplkit_audit_client/models/http_header'
+require 'smplkit_audit_client/models/retry_failed_deliveries_summary'
+require 'smplkit_audit_client/models/success_status'
+require 'smplkit_audit_client/models/test_forwarder_request'
+require 'smplkit_audit_client/models/test_forwarder_response'
 require 'smplkit_audit_client/models/usage_resource'
 require 'smplkit_audit_client/models/usage_response'
 
 # APIs
-require 'smplkit_audit_client/api/default_api'
+require 'smplkit_audit_client/api/events_api'
+require 'smplkit_audit_client/api/forwarders_api'
+require 'smplkit_audit_client/api/usage_api'
 
 module SmplkitGeneratedClient::Audit
   class << self

data/lib/smplkit/_generated/audit/spec/api/{default_api_spec.rb → events_api_spec.rb}

@@ -13,35 +13,22 @@ Generator version: 7.22.0
 require 'spec_helper'
 require 'json'
 
-# Unit tests for SmplkitGeneratedClient::Audit::DefaultApi
+# Unit tests for SmplkitGeneratedClient::Audit::EventsApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'DefaultApi' do
+describe 'EventsApi' do
   before do
     # run before each test
-    @api_instance = SmplkitGeneratedClient::Audit::DefaultApi.new
+    @api_instance = SmplkitGeneratedClient::Audit::EventsApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of DefaultApi' do
-    it 'should create an instance of DefaultApi' do
-      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Audit::DefaultApi)
-    end
-  end
-
-  # unit tests for create_event
-  # 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 
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :idempotency_key 
-  # @return [EventResponse]
-  describe 'create_event test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+  describe 'test an instance of EventsApi' do
+    it 'should create an instance of EventsApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::Audit::EventsApi)
     end
   end
 
@@ -76,13 +63,14 @@ describe 'DefaultApi' do
     end
   end
 
-  # unit tests for list_usage
-  # 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 
+  # unit tests for record_event
+  # Record 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 
   # @param [Hash] opts the optional parameters
-  # @return [UsageResponse]
-  describe 'list_usage test' do
+  # @option opts [String] :idempotency_key 
+  # @return [EventResponse]
+  describe 'record_event test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end