smplkit 3.0.54 → 3.0.56

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_create_resource.rb

@@ -0,0 +1,242 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+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::App
+  # JSON:API resource envelope for creating a service (id required).
+  class ServiceCreateResource < ApiModelBase
+    # Client-supplied resource id.
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :attributes
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'attributes' => :'attributes'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'type' => :'String',
+        :'attributes' => :'Service'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::App::ServiceCreateResource` 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::App::ServiceCreateResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      else
+        self.attributes = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes 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 @id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["service"])
+      return false unless type_validator.valid?(@type)
+      return false if @attributes.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["service"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attributes Value to be assigned
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'attributes cannot be nil'
+      end
+
+      @attributes = attributes
+    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 &&
+          id == o.id &&
+          type == o.type &&
+          attributes == o.attributes
+    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
+      [id, type, attributes].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/app/lib/smplkit_app_client/models/service_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # JSON:API request envelope for creating or updating a service.
+  # JSON:API request envelope for updating a service.
   class ServiceRequest < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_resource.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # JSON:API resource envelope for a service.  `id` must not be specified for create requests (the server assigns it).
+  # JSON:API resource envelope for a service.  The caller supplies ``id`` (the service's key) on create.
   class ServiceResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client.rb

@@ -59,6 +59,8 @@ require 'smplkit_app_client/models/email'
 require 'smplkit_app_client/models/email_resource'
 require 'smplkit_app_client/models/email_response'
 require 'smplkit_app_client/models/environment'
+require 'smplkit_app_client/models/environment_create_request'
+require 'smplkit_app_client/models/environment_create_resource'
 require 'smplkit_app_client/models/environment_list_response'
 require 'smplkit_app_client/models/environment_request'
 require 'smplkit_app_client/models/environment_resource'
@@ -108,6 +110,8 @@ require 'smplkit_app_client/models/product_list_response'
 require 'smplkit_app_client/models/product_resource'
 require 'smplkit_app_client/models/register_request'
 require 'smplkit_app_client/models/service'
+require 'smplkit_app_client/models/service_create_request'
+require 'smplkit_app_client/models/service_create_resource'
 require 'smplkit_app_client/models/service_list_response'
 require 'smplkit_app_client/models/service_request'
 require 'smplkit_app_client/models/service_resource'

data/lib/smplkit/_generated/app/spec/api/environments_api_spec.rb

@@ -35,7 +35,7 @@ describe 'EnvironmentsApi' do
   # unit tests for create_environment
   # Create Environment
   # Create a new environment. The caller provides the id (key) in the request body.
-  # @param environment_request 
+  # @param environment_create_request 
   # @param [Hash] opts the optional parameters
   # @return [EnvironmentResponse]
   describe 'create_environment test' do

data/lib/smplkit/_generated/app/spec/api/services_api_spec.rb

@@ -35,7 +35,7 @@ describe 'ServicesApi' do
   # unit tests for create_service
   # Create Service
   # Create a new service. The caller provides the id (key) in the request body.
-  # @param service_request 
+  # @param service_create_request 
   # @param [Hash] opts the optional parameters
   # @return [ServiceResponse]
   describe 'create_service test' do

data/lib/smplkit/_generated/app/spec/models/environment_create_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::EnvironmentCreateRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::EnvironmentCreateRequest do
+  #let(:instance) { SmplkitGeneratedClient::App::EnvironmentCreateRequest.new }
+
+  describe 'test an instance of EnvironmentCreateRequest' do
+    it 'should create an instance of EnvironmentCreateRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::EnvironmentCreateRequest)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/app/spec/models/environment_create_resource_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::EnvironmentCreateResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::EnvironmentCreateResource do
+  #let(:instance) { SmplkitGeneratedClient::App::EnvironmentCreateResource.new }
+
+  describe 'test an instance of EnvironmentCreateResource' do
+    it 'should create an instance of EnvironmentCreateResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::EnvironmentCreateResource)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["environment"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "attributes"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/app/spec/models/service_create_request_spec.rb

@@ -0,0 +1,36 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::ServiceCreateRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::ServiceCreateRequest do
+  #let(:instance) { SmplkitGeneratedClient::App::ServiceCreateRequest.new }
+
+  describe 'test an instance of ServiceCreateRequest' do
+    it 'should create an instance of ServiceCreateRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::ServiceCreateRequest)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/_generated/app/spec/models/service_create_resource_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::App::ServiceCreateResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::ServiceCreateResource do
+  #let(:instance) { SmplkitGeneratedClient::App::ServiceCreateResource.new }
+
+  describe 'test an instance of ServiceCreateResource' do
+    it 'should create an instance of ServiceCreateResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::ServiceCreateResource)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["service"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "attributes"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

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

@@ -20,27 +20,27 @@ module SmplkitGeneratedClient::Audit
       @api_client = api_client
     end
     # Create Forwarder
-    # Create a forwarder for this account.
-    # @param forwarder_request [ForwarderRequest] 
+    # Create a forwarder for this account.  The caller supplies the forwarder's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the forwarder.
+    # @param forwarder_create_request [ForwarderCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ForwarderResponse]
-    def create_forwarder(forwarder_request, opts = {})
-      data, _status_code, _headers = create_forwarder_with_http_info(forwarder_request, opts)
+    def create_forwarder(forwarder_create_request, opts = {})
+      data, _status_code, _headers = create_forwarder_with_http_info(forwarder_create_request, opts)
       data
     end
 
     # Create Forwarder
-    # Create a forwarder for this account.
-    # @param forwarder_request [ForwarderRequest] 
+    # Create a forwarder for this account.  The caller supplies the forwarder's key as `data.id`. Keys are unique within an account and immutable for the lifetime of the forwarder.
+    # @param forwarder_create_request [ForwarderCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ForwarderResponse, Integer, Hash)>] ForwarderResponse data, response status code and response headers
-    def create_forwarder_with_http_info(forwarder_request, opts = {})
+    def create_forwarder_with_http_info(forwarder_create_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ForwardersApi.create_forwarder ...'
       end
-      # verify the required parameter 'forwarder_request' is set
-      if @api_client.config.client_side_validation && forwarder_request.nil?
-        fail ArgumentError, "Missing the required parameter 'forwarder_request' when calling ForwardersApi.create_forwarder"
+      # verify the required parameter 'forwarder_create_request' is set
+      if @api_client.config.client_side_validation && forwarder_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'forwarder_create_request' when calling ForwardersApi.create_forwarder"
       end
       # resource path
       local_var_path = '/api/v1/forwarders'
@@ -62,7 +62,7 @@ module SmplkitGeneratedClient::Audit
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(forwarder_create_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'ForwarderResponse'
@@ -88,7 +88,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Delete Forwarder
-    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same name.
+    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same id.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -98,7 +98,7 @@ module SmplkitGeneratedClient::Audit
     end
 
     # Delete Forwarder
-    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same name.
+    # Delete a forwarder.  Past delivery log entries are retained. A new forwarder may be created later under the same id.
     # @param forwarder_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers