smplkit 3.0.63 → 3.0.65

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

@@ -0,0 +1,165 @@
+=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 single-resource response envelope for an SSO domain.
+  class SSODomainResponse < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'SSODomainResource'
+      }
+    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::SSODomainResponse` 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::SSODomainResponse`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data
+    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
+      [data].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/subscription_change_projection.rb

@@ -19,10 +19,10 @@ module SmplkitGeneratedClient::App
     # Product key affected by this change.
     attr_accessor :product
 
-    # Current plan for this product, or `FREE` if it is being added.
+    # Current plan for this product, or `free` if it is being added.
     attr_accessor :from_plan
 
-    # Plan the product will be on after the change. `FREE` indicates the enrollment will be dropped.
+    # Plan the product will be on after the change. `free` indicates the enrollment will be dropped.
     attr_accessor :to_plan
 
     # Monthly cost in cents of this enrollment after the change. `0` when the enrollment will be dropped.

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

@@ -19,7 +19,7 @@ module SmplkitGeneratedClient::App
     # Product key (e.g. `audit`, `config`, `flags`, `logging`).
     attr_accessor :product
 
-    # Target plan for this product. Must be a paid plan such as `STANDARD` or `PRO`; the free plan is implicit when a product is not listed.
+    # Target plan for this product. Must be a paid plan such as `standard` or `pro`; the free plan is implicit when a product is not listed.
     attr_accessor :plan
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -22,13 +22,13 @@ module SmplkitGeneratedClient::App
     # Product key (e.g. `audit`, `config`, `flags`, `logging`).
     attr_accessor :product
 
-    # Current plan for this product (e.g. `STANDARD`, `PRO`).
+    # Current plan for this product (e.g. `standard`, `pro`).
     attr_accessor :plan
 
     # Monthly list price for this enrollment, in cents. This value is locked at the time the enrollment was created or last had its plan changed; subsequent changes to the public price list do not affect this enrollment until the customer themselves changes their plan.
     attr_accessor :price_monthly_cents
 
-    # When a plan change is scheduled for the end of the current billing period, this is the plan that will take effect. Otherwise `null`. The value `FREE` indicates the enrollment will be dropped.
+    # When a plan change is scheduled for the end of the current billing period, this is the plan that will take effect. Otherwise `null`. The value `free` indicates the enrollment will be dropped.
     attr_accessor :pending_plan_change
 
     # ISO-8601 timestamp at which the pending plan change takes effect. Matches the subscription's `current_period_end`.

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

@@ -109,6 +109,15 @@ require 'smplkit_app_client/models/product'
 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/sso_connection'
+require 'smplkit_app_client/models/sso_connection_request'
+require 'smplkit_app_client/models/sso_connection_resource'
+require 'smplkit_app_client/models/sso_connection_response'
+require 'smplkit_app_client/models/sso_domain'
+require 'smplkit_app_client/models/sso_domain_list_response'
+require 'smplkit_app_client/models/sso_domain_request'
+require 'smplkit_app_client/models/sso_domain_resource'
+require 'smplkit_app_client/models/sso_domain_response'
 require 'smplkit_app_client/models/service'
 require 'smplkit_app_client/models/service_create_request'
 require 'smplkit_app_client/models/service_create_resource'
@@ -155,6 +164,7 @@ require 'smplkit_app_client/api/invitations_api'
 require 'smplkit_app_client/api/metrics_api'
 require 'smplkit_app_client/api/plans_api'
 require 'smplkit_app_client/api/products_api'
+require 'smplkit_app_client/api/sso_api'
 require 'smplkit_app_client/api/services_api'
 require 'smplkit_app_client/api/subscription_api'
 require 'smplkit_app_client/api/users_api'

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

@@ -0,0 +1,117 @@
+=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'
+
+# Unit tests for SmplkitGeneratedClient::App::SSOApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SSOApi' do
+  before do
+    # run before each test
+    @api_instance = SmplkitGeneratedClient::App::SSOApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SSOApi' do
+    it 'should create an instance of SSOApi' do
+      expect(@api_instance).to be_instance_of(SmplkitGeneratedClient::App::SSOApi)
+    end
+  end
+
+  # unit tests for claim_sso_domain
+  # Claim SSO Domain
+  # Claim a domain for SSO routing. Idempotent — re-claiming a domain already held by the account is a no-op success. The response includes the DNS TXT token to publish.
+  # @param domain 
+  # @param sso_domain_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SSODomainResponse]
+  describe 'claim_sso_domain test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_sso_connection
+  # Delete SSO Connection
+  # Soft-delete the account's SSO connection. Domains are preserved.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_sso_connection test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_sso_connection
+  # Get SSO Connection
+  # Return the SSO connection for the current account, including computed Service Provider metadata. Returns `404` when no connection has been configured.
+  # @param [Hash] opts the optional parameters
+  # @return [SSOConnectionResponse]
+  describe 'get_sso_connection test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_sso_domains
+  # List SSO Domains
+  # List the domains claimed by the current account, including each row's verification status.
+  # @param [Hash] opts the optional parameters
+  # @return [SSODomainListResponse]
+  describe 'list_sso_domains test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_sso_connection
+  # Create or Replace SSO Connection
+  # Create-or-replace the account's SSO connection. The OIDC `client_secret` is write-only; supply it on first creation, omit on subsequent updates to retain the stored value.
+  # @param sso_connection_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SSOConnectionResponse]
+  describe 'put_sso_connection test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for release_sso_domain
+  # Release SSO Domain
+  # Release a previously-claimed SSO domain.
+  # @param domain 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'release_sso_domain test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for verify_sso_domain
+  # Verify SSO Domain
+  # Run the DNS TXT check for a claimed domain. Returns the updated resource on success. Returns `409` if a different account has already verified this domain. Returns `422` when the DNS TXT record has not yet been published or does not match the expected token.
+  # @param domain 
+  # @param [Hash] opts the optional parameters
+  # @return [SSODomainResponse]
+  describe 'verify_sso_domain test' 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/sso_connection_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::SSOConnectionRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::SSOConnectionRequest do
+  #let(:instance) { SmplkitGeneratedClient::App::SSOConnectionRequest.new }
+
+  describe 'test an instance of SSOConnectionRequest' do
+    it 'should create an instance of SSOConnectionRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::SSOConnectionRequest)
+    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/sso_connection_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::SSOConnectionResource
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::SSOConnectionResource do
+  #let(:instance) { SmplkitGeneratedClient::App::SSOConnectionResource.new }
+
+  describe 'test an instance of SSOConnectionResource' do
+    it 'should create an instance of SSOConnectionResource' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::SSOConnectionResource)
+    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', ["sso_connection"])
+      # 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/sso_connection_response_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::SSOConnectionResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::SSOConnectionResponse do
+  #let(:instance) { SmplkitGeneratedClient::App::SSOConnectionResponse.new }
+
+  describe 'test an instance of SSOConnectionResponse' do
+    it 'should create an instance of SSOConnectionResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::SSOConnectionResponse)
+    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/sso_connection_spec.rb

@@ -0,0 +1,138 @@
+=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::SSOConnection
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::SSOConnection do
+  #let(:instance) { SmplkitGeneratedClient::App::SSOConnection.new }
+
+  describe 'test an instance of SSOConnection' do
+    it 'should create an instance of SSOConnection' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::SSOConnection)
+    end
+  end
+
+  describe 'test attribute "protocol"' 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', ["saml", "oidc"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.protocol = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "oidc_issuer"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "oidc_client_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 "oidc_client_secret"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "saml_idp_entity_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 "saml_idp_sso_url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "saml_idp_slo_url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "saml_idp_x509_cert"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "default_role"' 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', ["OWNER", "ADMIN", "MEMBER", "VIEWER"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.default_role = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "group_role_mappings"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('Hash<String, String>', ["OWNER", "ADMIN", "MEMBER", "VIEWER"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.group_role_mappings = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "enforced"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sp_entity_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 "acs_url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "slo_url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "updated_at"' 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/sso_domain_list_response_spec.rb

@@ -0,0 +1,42 @@
+=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::SSODomainListResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::App::SSODomainListResponse do
+  #let(:instance) { SmplkitGeneratedClient::App::SSODomainListResponse.new }
+
+  describe 'test an instance of SSODomainListResponse' do
+    it 'should create an instance of SSODomainListResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::SSODomainListResponse)
+    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
+
+  describe 'test attribute "meta"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end