turnkey_client 0.0.15 → 0.0.17

data/lib/turnkey_client/models/email_auth_customization_params.rb

@@ -0,0 +1,255 @@
+=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 EmailAuthCustomizationParams
+    # The name of the application. This field is required and will be used in email notifications if an email template is not provided.
+    attr_accessor :app_name
+
+    # A URL pointing to a logo in PNG format. Note this logo will be resized to fit into 340px x 124px.
+    attr_accessor :logo_url
+
+    # A template for the URL to be used in a magic link button, e.g. `https://dapp.xyz/%s`. The auth bundle will be interpolated into the `%s`.
+    attr_accessor :magic_link_template
+
+    # JSON object containing key/value pairs to be used with custom templates.
+    attr_accessor :template_variables
+
+    # Unique identifier for a given Email Template. If not specified, the default is the most recent Email Template.
+    attr_accessor :template_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'app_name' => :'appName',
+        :'logo_url' => :'logoUrl',
+        :'magic_link_template' => :'magicLinkTemplate',
+        :'template_variables' => :'templateVariables',
+        :'template_id' => :'templateId'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'app_name' => :'Object',
+        :'logo_url' => :'Object',
+        :'magic_link_template' => :'Object',
+        :'template_variables' => :'Object',
+        :'template_id' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'logo_url',
+        :'magic_link_template',
+        :'template_variables',
+        :'template_id'
+      ])
+    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::EmailAuthCustomizationParams` 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::EmailAuthCustomizationParams`. 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?(:'app_name')
+        self.app_name = attributes[:'app_name']
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      end
+
+      if attributes.key?(:'magic_link_template')
+        self.magic_link_template = attributes[:'magic_link_template']
+      end
+
+      if attributes.key?(:'template_variables')
+        self.template_variables = attributes[:'template_variables']
+      end
+
+      if attributes.key?(:'template_id')
+        self.template_id = attributes[:'template_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
+      if @app_name.nil?
+        invalid_properties.push('invalid value for "app_name", app_name 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 @app_name.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 &&
+          app_name == o.app_name &&
+          logo_url == o.logo_url &&
+          magic_link_template == o.magic_link_template &&
+          template_variables == o.template_variables &&
+          template_id == o.template_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
+      [app_name, logo_url, magic_link_template, template_variables, template_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)
+      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/email_auth_intent_v3.rb

@@ -0,0 +1,306 @@
+=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 EmailAuthIntentV3
+    # Email of the authenticating user.
+    attr_accessor :email
+
+    # Client-side public key generated by the user, to which the email auth bundle (credentials) will be encrypted.
+    attr_accessor :target_public_key
+
+    # Optional human-readable name for an API Key. If none provided, default to Email Auth - <Timestamp>
+    attr_accessor :api_key_name
+
+    # 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
+
+    attr_accessor :email_customization
+
+    # Invalidate all other previously generated Email Auth API keys
+    attr_accessor :invalidate_existing
+
+    # Optional custom email address from which to send the email
+    attr_accessor :send_from_email_address
+
+    # Optional custom sender name for use with sendFromEmailAddress; if left empty, will default to 'Notifications'
+    attr_accessor :send_from_email_sender_name
+
+    # Optional custom email address to use as reply-to
+    attr_accessor :reply_to_email_address
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'target_public_key' => :'targetPublicKey',
+        :'api_key_name' => :'apiKeyName',
+        :'expiration_seconds' => :'expirationSeconds',
+        :'email_customization' => :'emailCustomization',
+        :'invalidate_existing' => :'invalidateExisting',
+        :'send_from_email_address' => :'sendFromEmailAddress',
+        :'send_from_email_sender_name' => :'sendFromEmailSenderName',
+        :'reply_to_email_address' => :'replyToEmailAddress'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'email' => :'Object',
+        :'target_public_key' => :'Object',
+        :'api_key_name' => :'Object',
+        :'expiration_seconds' => :'Object',
+        :'email_customization' => :'Object',
+        :'invalidate_existing' => :'Object',
+        :'send_from_email_address' => :'Object',
+        :'send_from_email_sender_name' => :'Object',
+        :'reply_to_email_address' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'api_key_name',
+        :'expiration_seconds',
+        :'invalidate_existing',
+        :'send_from_email_address',
+        :'send_from_email_sender_name',
+        :'reply_to_email_address'
+      ])
+    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::EmailAuthIntentV3` 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::EmailAuthIntentV3`. 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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'target_public_key')
+        self.target_public_key = attributes[:'target_public_key']
+      end
+
+      if attributes.key?(:'api_key_name')
+        self.api_key_name = attributes[:'api_key_name']
+      end
+
+      if attributes.key?(:'expiration_seconds')
+        self.expiration_seconds = attributes[:'expiration_seconds']
+      end
+
+      if attributes.key?(:'email_customization')
+        self.email_customization = attributes[:'email_customization']
+      end
+
+      if attributes.key?(:'invalidate_existing')
+        self.invalidate_existing = attributes[:'invalidate_existing']
+      end
+
+      if attributes.key?(:'send_from_email_address')
+        self.send_from_email_address = attributes[:'send_from_email_address']
+      end
+
+      if attributes.key?(:'send_from_email_sender_name')
+        self.send_from_email_sender_name = attributes[:'send_from_email_sender_name']
+      end
+
+      if attributes.key?(:'reply_to_email_address')
+        self.reply_to_email_address = attributes[:'reply_to_email_address']
+      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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @target_public_key.nil?
+        invalid_properties.push('invalid value for "target_public_key", target_public_key cannot be nil.')
+      end
+
+      if @email_customization.nil?
+        invalid_properties.push('invalid value for "email_customization", email_customization 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 @email.nil?
+      return false if @target_public_key.nil?
+      return false if @email_customization.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 &&
+          email == o.email &&
+          target_public_key == o.target_public_key &&
+          api_key_name == o.api_key_name &&
+          expiration_seconds == o.expiration_seconds &&
+          email_customization == o.email_customization &&
+          invalidate_existing == o.invalidate_existing &&
+          send_from_email_address == o.send_from_email_address &&
+          send_from_email_sender_name == o.send_from_email_sender_name &&
+          reply_to_email_address == o.reply_to_email_address
+    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
+      [email, target_public_key, api_key_name, expiration_seconds, email_customization, invalidate_existing, send_from_email_address, send_from_email_sender_name, reply_to_email_address].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/email_auth_request.rb

@@ -22,6 +22,8 @@ module TurnkeyClient
 
     attr_accessor :parameters
 
+    attr_accessor :generate_app_proofs
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,7 +52,8 @@ module TurnkeyClient
         :'type' => :'type',
         :'timestamp_ms' => :'timestampMs',
         :'organization_id' => :'organizationId',
-        :'parameters' => :'parameters'
+        :'parameters' => :'parameters',
+        :'generate_app_proofs' => :'generateAppProofs'
       }
     end
 
@@ -60,13 +63,15 @@ module TurnkeyClient
         :'type' => :'Object',
         :'timestamp_ms' => :'Object',
         :'organization_id' => :'Object',
-        :'parameters' => :'Object'
+        :'parameters' => :'Object',
+        :'generate_app_proofs' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'generate_app_proofs'
       ])
     end
   
@@ -100,6 +105,10 @@ module TurnkeyClient
       if attributes.key?(:'parameters')
         self.parameters = attributes[:'parameters']
       end
+
+      if attributes.key?(:'generate_app_proofs')
+        self.generate_app_proofs = attributes[:'generate_app_proofs']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -129,7 +138,7 @@ module TurnkeyClient
     # @return true if the model is valid
     def valid?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_EMAIL_AUTH_V2'])
+      type_validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_EMAIL_AUTH_V3'])
       return false unless type_validator.valid?(@type)
       return false if @timestamp_ms.nil?
       return false if @organization_id.nil?
@@ -140,7 +149,7 @@ module TurnkeyClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_EMAIL_AUTH_V2'])
+      validator = EnumAttributeValidator.new('Object', ['ACTIVITY_TYPE_EMAIL_AUTH_V3'])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
@@ -155,7 +164,8 @@ module TurnkeyClient
           type == o.type &&
           timestamp_ms == o.timestamp_ms &&
           organization_id == o.organization_id &&
-          parameters == o.parameters
+          parameters == o.parameters &&
+          generate_app_proofs == o.generate_app_proofs
     end
 
     # @see the `==` method
@@ -167,7 +177,7 @@ module TurnkeyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, timestamp_ms, organization_id, parameters].hash
+      [type, timestamp_ms, organization_id, parameters, generate_app_proofs].hash
     end
 
     # Builds the object from hash