turnkey_client 0.0.13 → 0.0.14

data/lib/turnkey_client/models/invitation_params.rb

@@ -18,7 +18,7 @@ module TurnkeyClient
     # The email address of the intended Invitation recipient.
     attr_accessor :receiver_user_email
 
-    # A list of tags assigned to the Invitation recipient.
+    # A list of tags assigned to the Invitation recipient. This field, if not needed, should be an empty array in your request body.
     attr_accessor :receiver_user_tags
 
     attr_accessor :access_type

data/lib/turnkey_client/models/list_private_key_tags_request.rb

@@ -12,7 +12,7 @@ require 'date'
 
 module TurnkeyClient
   class ListPrivateKeyTagsRequest
-    # Unique identifier for a given Organization.
+    # Unique identifier for a given organization.
     attr_accessor :organization_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/turnkey_client/models/list_private_key_tags_response.rb

@@ -12,7 +12,7 @@ require 'date'
 
 module TurnkeyClient
   class ListPrivateKeyTagsResponse
-    # A list of Private Key Tags
+    # A list of private key tags.
     attr_accessor :private_key_tags
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/turnkey_client/models/list_user_tags_request.rb

@@ -12,7 +12,7 @@ require 'date'
 
 module TurnkeyClient
   class ListUserTagsRequest
-    # Unique identifier for a given Organization.
+    # Unique identifier for a given organization.
     attr_accessor :organization_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/turnkey_client/models/list_user_tags_response.rb

@@ -12,7 +12,7 @@ require 'date'
 
 module TurnkeyClient
   class ListUserTagsResponse
-    # A list of User Tags
+    # A list of user tags.
     attr_accessor :user_tags
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/turnkey_client/models/oauth_intent.rb

@@ -21,16 +21,20 @@ module TurnkeyClient
     # Optional human-readable name for an API Key. If none provided, default to Oauth - <Timestamp>
     attr_accessor :api_key_name
 
-    # Expiration window (in seconds) indicating how long the API key is valid. If not provided, a default of 15 minutes will be used.
+    # Expiration window (in seconds) indicating how long the API key is valid for. If not provided, a default of 15 minutes will be used.
     attr_accessor :expiration_seconds
 
+    # Invalidate all other previously generated Oauth API keys
+    attr_accessor :invalidate_existing
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'oidc_token' => :'oidcToken',
         :'target_public_key' => :'targetPublicKey',
         :'api_key_name' => :'apiKeyName',
-        :'expiration_seconds' => :'expirationSeconds'
+        :'expiration_seconds' => :'expirationSeconds',
+        :'invalidate_existing' => :'invalidateExisting'
       }
     end
 
@@ -40,13 +44,17 @@ module TurnkeyClient
         :'oidc_token' => :'Object',
         :'target_public_key' => :'Object',
         :'api_key_name' => :'Object',
-        :'expiration_seconds' => :'Object'
+        :'expiration_seconds' => :'Object',
+        :'invalidate_existing' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'api_key_name',
+        :'expiration_seconds',
+        :'invalidate_existing'
       ])
     end
   
@@ -80,6 +88,10 @@ module TurnkeyClient
       if attributes.key?(:'expiration_seconds')
         self.expiration_seconds = attributes[:'expiration_seconds']
       end
+
+      if attributes.key?(:'invalidate_existing')
+        self.invalidate_existing = attributes[:'invalidate_existing']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -113,7 +125,8 @@ module TurnkeyClient
           oidc_token == o.oidc_token &&
           target_public_key == o.target_public_key &&
           api_key_name == o.api_key_name &&
-          expiration_seconds == o.expiration_seconds
+          expiration_seconds == o.expiration_seconds &&
+          invalidate_existing == o.invalidate_existing
     end
 
     # @see the `==` method
@@ -125,7 +138,7 @@ module TurnkeyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [oidc_token, target_public_key, api_key_name, expiration_seconds].hash
+      [oidc_token, target_public_key, api_key_name, expiration_seconds, invalidate_existing].hash
     end
 
     # Builds the object from hash

data/lib/turnkey_client/models/oauth_login_intent.rb

@@ -0,0 +1,248 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+require 'date'
+
+module TurnkeyClient
+  class OauthLoginIntent
+    # Base64 encoded OIDC token
+    attr_accessor :oidc_token
+
+    # Client-side public key generated by the user, which will be conditionally added to org data based on the validity of the oidc token associated with this request
+    attr_accessor :public_key
+
+    # Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.
+    attr_accessor :expiration_seconds
+
+    # Invalidate all other previously generated Login API keys
+    attr_accessor :invalidate_existing
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'oidc_token' => :'oidcToken',
+        :'public_key' => :'publicKey',
+        :'expiration_seconds' => :'expirationSeconds',
+        :'invalidate_existing' => :'invalidateExisting'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'oidc_token' => :'Object',
+        :'public_key' => :'Object',
+        :'expiration_seconds' => :'Object',
+        :'invalidate_existing' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expiration_seconds',
+        :'invalidate_existing'
+      ])
+    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 `TurnkeyClient::OauthLoginIntent` 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 `TurnkeyClient::OauthLoginIntent`. 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?(:'oidc_token')
+        self.oidc_token = attributes[:'oidc_token']
+      end
+
+      if attributes.key?(:'public_key')
+        self.public_key = attributes[:'public_key']
+      end
+
+      if attributes.key?(:'expiration_seconds')
+        self.expiration_seconds = attributes[:'expiration_seconds']
+      end
+
+      if attributes.key?(:'invalidate_existing')
+        self.invalidate_existing = attributes[:'invalidate_existing']
+      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
+      if @oidc_token.nil?
+        invalid_properties.push('invalid value for "oidc_token", oidc_token cannot be nil.')
+      end
+
+      if @public_key.nil?
+        invalid_properties.push('invalid value for "public_key", public_key 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?
+      return false if @oidc_token.nil?
+      return false if @public_key.nil?
+      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 &&
+          oidc_token == o.oidc_token &&
+          public_key == o.public_key &&
+          expiration_seconds == o.expiration_seconds &&
+          invalidate_existing == o.invalidate_existing
+    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
+      [oidc_token, public_key, expiration_seconds, invalidate_existing].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        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 :DateTime
+        DateTime.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
+        TurnkeyClient.const_get(type).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/lib/turnkey_client/models/oauth_login_request.rb

@@ -0,0 +1,288 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+require 'date'
+
+module TurnkeyClient
+  class OauthLoginRequest
+    attr_accessor :type
+
+    # Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
+    attr_accessor :timestamp_ms
+
+    # Unique identifier for a given Organization.
+    attr_accessor :organization_id
+
+    attr_accessor :parameters
+
+    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
+      {
+        :'type' => :'type',
+        :'timestamp_ms' => :'timestampMs',
+        :'organization_id' => :'organizationId',
+        :'parameters' => :'parameters'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'Object',
+        :'timestamp_ms' => :'Object',
+        :'organization_id' => :'Object',
+        :'parameters' => :'Object'
+      }
+    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 `TurnkeyClient::OauthLoginRequest` 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 `TurnkeyClient::OauthLoginRequest`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'timestamp_ms')
+        self.timestamp_ms = attributes[:'timestamp_ms']
+      end
+
+      if attributes.key?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      end
+
+      if attributes.key?(:'parameters')
+        self.parameters = attributes[:'parameters']
+      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
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @timestamp_ms.nil?
+        invalid_properties.push('invalid value for "timestamp_ms", timestamp_ms cannot be nil.')
+      end
+
+      if @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      if @parameters.nil?
+        invalid_properties.push('invalid value for "parameters", parameters 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?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_OAUTH_LOGIN'])
+      return false unless type_validator.valid?(@type)
+      return false if @timestamp_ms.nil?
+      return false if @organization_id.nil?
+      return false if @parameters.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_OAUTH_LOGIN'])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          type == o.type &&
+          timestamp_ms == o.timestamp_ms &&
+          organization_id == o.organization_id &&
+          parameters == o.parameters
+    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
+      [type, timestamp_ms, organization_id, parameters].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        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 :DateTime
+        DateTime.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
+        TurnkeyClient.const_get(type).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