kinde_sdk 1.6.6 → 1.7.0

data/kinde_api/lib/kinde_api/models/frontend/token_introspect.rb

@@ -0,0 +1,262 @@
+=begin
+#Kinde Account API
+
+# Provides endpoints to operate on an authenticated user.  ## Intro  ## How to use  1. Get a user access token - this can be obtained when a user signs in via the methods you've setup in Kinde (e.g. Google, passwordless, etc).  2. Call one of the endpoints below using the user access token in the Authorization header as a Bearer token. Typically, you can use the `getToken` command in the relevant SDK. 
+
+The version of the OpenAPI document: 1
+Contact: support@kinde.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KindeApi::Frontend
+  class TokenIntrospect
+    # Indicates the status of the token.
+    attr_accessor :active
+
+    # Array of intended token recipients.
+    attr_accessor :aud
+
+    # Identifier for the requesting client.
+    attr_accessor :client_id
+
+    # Token expiration timestamp.
+    attr_accessor :exp
+
+    # Token issuance timestamp.
+    attr_accessor :iat
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active' => :'active',
+        :'aud' => :'aud',
+        :'client_id' => :'client_id',
+        :'exp' => :'exp',
+        :'iat' => :'iat'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'active' => :'Boolean',
+        :'aud' => :'Array<String>',
+        :'client_id' => :'String',
+        :'exp' => :'Integer',
+        :'iat' => :'Integer'
+      }
+    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 `KindeApi::Frontend::TokenIntrospect` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KindeApi::Frontend::TokenIntrospect`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'active')
+        self.active = attributes[:'active']
+      end
+
+      if attributes.key?(:'aud')
+        if (value = attributes[:'aud']).is_a?(Array)
+          self.aud = value
+        end
+      end
+
+      if attributes.key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.key?(:'exp')
+        self.exp = attributes[:'exp']
+      end
+
+      if attributes.key?(:'iat')
+        self.iat = attributes[:'iat']
+      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
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          active == o.active &&
+          aud == o.aud &&
+          client_id == o.client_id &&
+          exp == o.exp &&
+          iat == o.iat
+    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
+      [active, aud, client_id, exp, iat].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = KindeFrontendApi.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/kinde_api/lib/kinde_api/models/frontend/user_profile_v2.rb

@@ -0,0 +1,323 @@
+=begin
+#Kinde Account API
+
+# Provides endpoints to operate on an authenticated user.  ## Intro  ## How to use  1. Get a user access token - this can be obtained when a user signs in via the methods you've setup in Kinde (e.g. Google, passwordless, etc).  2. Call one of the endpoints below using the user access token in the Authorization header as a Bearer token. Typically, you can use the `getToken` command in the relevant SDK. 
+
+The version of the OpenAPI document: 1
+Contact: support@kinde.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module KindeApi::Frontend
+  class UserProfileV2
+    # Unique ID of the user in Kinde.
+    attr_accessor :sub
+
+    # Value of the user's ID in a third-party system when the user is imported into Kinde.
+    attr_accessor :provided_id
+
+    # User's first and last name separated by a space.
+    attr_accessor :name
+
+    # User's first name.
+    attr_accessor :given_name
+
+    # User's last name.
+    attr_accessor :family_name
+
+    # Date the user was last updated at (In Unix time).
+    attr_accessor :updated_at
+
+    # User's email address if available.
+    attr_accessor :email
+
+    # Whether the user's email address has been verified.
+    attr_accessor :email_verified
+
+    # URL that point's to the user's picture or avatar
+    attr_accessor :picture
+
+    # User's preferred username.
+    attr_accessor :preferred_username
+
+    # Unique ID of the user in Kinde
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sub' => :'sub',
+        :'provided_id' => :'provided_id',
+        :'name' => :'name',
+        :'given_name' => :'given_name',
+        :'family_name' => :'family_name',
+        :'updated_at' => :'updated_at',
+        :'email' => :'email',
+        :'email_verified' => :'email_verified',
+        :'picture' => :'picture',
+        :'preferred_username' => :'preferred_username',
+        :'id' => :'id'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'sub' => :'String',
+        :'provided_id' => :'String',
+        :'name' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'updated_at' => :'Integer',
+        :'email' => :'String',
+        :'email_verified' => :'Boolean',
+        :'picture' => :'String',
+        :'preferred_username' => :'String',
+        :'id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'provided_id',
+        :'picture',
+        :'preferred_username',
+      ])
+    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 `KindeApi::Frontend::UserProfileV2` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `KindeApi::Frontend::UserProfileV2`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'sub')
+        self.sub = attributes[:'sub']
+      end
+
+      if attributes.key?(:'provided_id')
+        self.provided_id = attributes[:'provided_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'email_verified')
+        self.email_verified = attributes[:'email_verified']
+      end
+
+      if attributes.key?(:'picture')
+        self.picture = attributes[:'picture']
+      end
+
+      if attributes.key?(:'preferred_username')
+        self.preferred_username = attributes[:'preferred_username']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      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
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          sub == o.sub &&
+          provided_id == o.provided_id &&
+          name == o.name &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          updated_at == o.updated_at &&
+          email == o.email &&
+          email_verified == o.email_verified &&
+          picture == o.picture &&
+          preferred_username == o.preferred_username &&
+          id == o.id
+    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
+      [sub, provided_id, name, given_name, family_name, updated_at, email, email_verified, picture, preferred_username, id].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = KindeFrontendApi.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/kinde_api/lib/kinde_api.rb

@@ -257,6 +257,34 @@ KindeApi.autoload :TimezonesApi, 'kinde_api/api/timezones_api'
 KindeApi.autoload :UsersApi, 'kinde_api/api/users_api'
 KindeApi.autoload :WebhooksApi, 'kinde_api/api/webhooks_api'
 
+# Frontend APIs - Following PHP pattern
+module KindeApi
+  module Frontend
+    # Frontend API classes
+    autoload :BillingApi, 'kinde_api/api/frontend/billing_api'
+    autoload :FeatureFlagsApi, 'kinde_api/api/frontend/feature_flags_api'
+    autoload :OAuthApi, 'kinde_api/api/frontend/o_auth_api'
+    autoload :PermissionsApi, 'kinde_api/api/frontend/permissions_api'
+    autoload :PropertiesApi, 'kinde_api/api/frontend/properties_api'
+    autoload :RolesApi, 'kinde_api/api/frontend/roles_api'
+    autoload :SelfServePortalApi, 'kinde_api/api/frontend/self_serve_portal_api'
+    
+    # Frontend models
+    autoload :Error, 'kinde_api/models/frontend/error'
+    autoload :ErrorResponse, 'kinde_api/models/frontend/error_response'
+    autoload :GetEntitlementResponse, 'kinde_api/models/frontend/get_entitlement_response'
+    autoload :GetEntitlementsResponse, 'kinde_api/models/frontend/get_entitlements_response'
+    autoload :GetFeatureFlagsResponse, 'kinde_api/models/frontend/get_feature_flags_response'
+    autoload :GetUserPermissionsResponse, 'kinde_api/models/frontend/get_user_permissions_response'
+    autoload :GetUserPropertiesResponse, 'kinde_api/models/frontend/get_user_properties_response'
+    autoload :GetUserRolesResponse, 'kinde_api/models/frontend/get_user_roles_response'
+    autoload :PortalLink, 'kinde_api/models/frontend/portal_link'
+    autoload :TokenErrorResponse, 'kinde_api/models/frontend/token_error_response'
+    autoload :TokenIntrospect, 'kinde_api/models/frontend/token_introspect'
+    autoload :UserProfileV2, 'kinde_api/models/frontend/user_profile_v2'
+  end
+end
+
 module KindeApi
   class << self
     # Customize default settings for the SDK using block.

data/lib/kinde_sdk/client/entitlements.rb

@@ -0,0 +1,86 @@
+module KindeSdk
+    class Client
+      module Entitlements
+        # Get all entitlements for the authenticated user
+        # Matches the JavaScript SDK API: getEntitlements(options?)
+        #
+        # @param options [Hash] Options for retrieving entitlements
+        # @option options [Boolean] :force_api (false) If true, calls the API to get fresh entitlements,
+        #   otherwise uses existing getAllEntitlements method
+        # @return [Array] Array of entitlement objects
+        def get_entitlements(options = {})
+          # Entitlements are always fetched from API (they don't exist in tokens)
+          # The options parameter is kept for consistency with other methods
+          getAllEntitlements
+        end
+  
+        # Check if user has billing entitlements
+        # Matches the JavaScript SDK API: hasBillingEntitlements(params)
+        #
+        # @param billing_entitlements [Array<String>] Array of billing entitlement price names to check
+        # @param options [Hash] Options for retrieving entitlements
+        # @return [Boolean] True if user has all specified billing entitlements, false otherwise
+        def has_billing_entitlements?(billing_entitlements, options = {})
+          return true if billing_entitlements.nil? || billing_entitlements.empty?
+          
+          begin
+            entitlements = get_entitlements(options)
+            billing_entitlements_array = Array(billing_entitlements)
+            
+            # Extract price names from entitlements (billing entitlements use price_name)
+            entitlement_price_names = entitlements.map do |ent|
+              ent.respond_to?(:price_name) ? ent.price_name : ent['price_name']
+            end.compact
+            
+            billing_entitlements_array.all? { |price_name| entitlement_price_names.include?(price_name) }
+          rescue StandardError => e
+            log_error("Error checking billing entitlements: #{e.message}")
+            false
+          end
+        end
+  
+        # Check if user has feature entitlements
+        # 
+        # @param entitlement_keys [Array<String>] Array of entitlement feature keys to check
+        # @param options [Hash] Options for retrieving entitlements
+        # @return [Boolean] True if user has all specified entitlements, false otherwise
+        def has_entitlements?(entitlement_keys, options = {})
+          return true if entitlement_keys.nil? || entitlement_keys.empty?
+          
+          begin
+            entitlements = get_entitlements(options)
+            entitlement_keys_array = Array(entitlement_keys)
+            
+            # Extract feature keys from entitlements
+            entitlement_feature_keys = entitlements.map do |ent|
+              ent.respond_to?(:feature_key) ? ent.feature_key : ent['feature_key']
+            end.compact
+            
+            entitlement_keys_array.all? { |key| entitlement_feature_keys.include?(key) }
+          rescue StandardError => e
+            log_error("Error checking entitlements: #{e.message}")
+            false
+          end
+        end
+  
+        # JavaScript SDK compatible aliases
+        alias_method :hasBillingEntitlements, :has_billing_entitlements?
+        alias_method :hasEntitlements, :has_entitlements?
+  
+        private
+  
+        # Configurable logging that works with or without Rails
+        def log_error(message)
+          if defined?(Rails) && Rails.logger
+            Rails.logger.error(message)
+          elsif @logger
+            @logger.error(message)
+          elsif respond_to?(:logger) && logger
+            logger.error(message)
+          else
+            $stderr.puts "[KindeSdk] ERROR: #{message}"
+          end
+        end
+      end
+    end
+  end