twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/new_factor.rb

@@ -0,0 +1,277 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # NewFactor Model.
+  class NewFactor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A 34 character string that uniquely identifies this Factor.
+    # @return [String]
+    attr_accessor :sid
+
+    # The unique SID identifier of the Account.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The unique SID identifier of the Service.
+    # @return [String]
+    attr_accessor :service_sid
+
+    # The unique SID identifier of the Entity.
+    # @return [String]
+    attr_accessor :entity_sid
+
+    # Customer unique identity for the Entity owner of the Factor. This
+    # identifier should be immutable, not PII, length between 8 and 64
+    # characters, and generated by your external system, such as your user's
+    # UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric
+    # characters.
+    # @return [String]
+    attr_accessor :identity
+
+    # Contains the `factor_type` specific secret and metadata.
+    # For push, this is `binding.public_key` and `binding.alg`.
+    # For totp, this is `binding.secret` and `binding.uri`. The `binding.uri`
+    # property is generated following the [google authenticator key URI
+    # format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+    # ), and `Factor.friendly_name` is used for the “accountname” value and
+    # `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer`
+    # value.
+    # The Binding property is ONLY returned upon Factor creation.
+    # @return [Object]
+    attr_accessor :binding
+
+    # Contains the `factor_type` specific secret and metadata.
+    # For push, this is `binding.public_key` and `binding.alg`.
+    # For totp, this is `binding.secret` and `binding.uri`. The `binding.uri`
+    # property is generated following the [google authenticator key URI
+    # format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format
+    # ), and `Factor.friendly_name` is used for the “accountname” value and
+    # `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer`
+    # value.
+    # The Binding property is ONLY returned upon Factor creation.
+    # @return [Object]
+    attr_accessor :options
+
+    # The date that this Factor was created, given in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date that this Factor was updated, given in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The friendly name of this Factor. This can be any string up to 64
+    # characters, meant for humans to distinguish between Factors.
+    # For `factor_type` `push`, this could be a device name.
+    # For `factor_type` `totp`, this value is used as the “account name” in
+    # constructing the `binding.uri` property.
+    # At the same time, we recommend avoiding providing PII.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The Status of this Factor. One of `unverified` or `verified`.
+    # @return [NewFactorEnumFactorStatuses]
+    attr_accessor :status
+
+    # The Type of this Factor. Currently `push` and `totp` are supported.
+    # @return [NewFactorEnumFactorTypes]
+    attr_accessor :factor_type
+
+    # An object that contains configurations specific to a `factor_type`.
+    # @return [Object]
+    attr_accessor :config
+
+    # Custom metadata associated with the factor. This is added by the
+    # Device/SDK directly to allow for the inclusion of device information. It
+    # must be a stringified JSON with only strings values eg. `{"os":
+    # "Android"}`. Can be up to 1024 characters in length.
+    # @return [Object]
+    attr_accessor :metadata
+
+    # The URL of this resource.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sid'] = 'sid'
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['service_sid'] = 'service_sid'
+      @_hash['entity_sid'] = 'entity_sid'
+      @_hash['identity'] = 'identity'
+      @_hash['binding'] = 'binding'
+      @_hash['options'] = 'options'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['status'] = 'status'
+      @_hash['factor_type'] = 'factor_type'
+      @_hash['config'] = 'config'
+      @_hash['metadata'] = 'metadata'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        service_sid
+        entity_sid
+        identity
+        binding
+        options
+        date_created
+        date_updated
+        friendly_name
+        status
+        factor_type
+        config
+        metadata
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        service_sid
+        entity_sid
+        identity
+        binding
+        options
+        date_created
+        date_updated
+        friendly_name
+        config
+        metadata
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, service_sid: SKIP,
+                   entity_sid: SKIP, identity: SKIP, binding: SKIP,
+                   options: SKIP, date_created: SKIP, date_updated: SKIP,
+                   friendly_name: SKIP, status: SKIP, factor_type: SKIP,
+                   config: SKIP, metadata: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @sid = sid unless sid == SKIP
+      @account_sid = account_sid unless account_sid == SKIP
+      @service_sid = service_sid unless service_sid == SKIP
+      @entity_sid = entity_sid unless entity_sid == SKIP
+      @identity = identity unless identity == SKIP
+      @binding = binding unless binding == SKIP
+      @options = options unless options == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @status = status unless status == SKIP
+      @factor_type = factor_type unless factor_type == SKIP
+      @config = config unless config == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      service_sid = hash.key?('service_sid') ? hash['service_sid'] : SKIP
+      entity_sid = hash.key?('entity_sid') ? hash['entity_sid'] : SKIP
+      identity = hash.key?('identity') ? hash['identity'] : SKIP
+      binding = hash.key?('binding') ? hash['binding'] : SKIP
+      options = hash.key?('options') ? hash['options'] : SKIP
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      date_updated = if hash.key?('date_updated')
+                       (DateTimeHelper.from_rfc3339(hash['date_updated']) if hash['date_updated'])
+                     else
+                       SKIP
+                     end
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      factor_type = hash.key?('factor_type') ? hash['factor_type'] : SKIP
+      config = hash.key?('config') ? hash['config'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      NewFactor.new(sid: sid,
+                    account_sid: account_sid,
+                    service_sid: service_sid,
+                    entity_sid: entity_sid,
+                    identity: identity,
+                    binding: binding,
+                    options: options,
+                    date_created: date_created,
+                    date_updated: date_updated,
+                    friendly_name: friendly_name,
+                    status: status,
+                    factor_type: factor_type,
+                    config: config,
+                    metadata: metadata,
+                    url: url,
+                    additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    end
+
+    def to_custom_date_updated
+      DateTimeHelper.to_rfc3339(date_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid}, account_sid: #{@account_sid}, service_sid: #{@service_sid},"\
+      " entity_sid: #{@entity_sid}, identity: #{@identity}, binding: #{@binding}, options:"\
+      " #{@options}, date_created: #{@date_created}, date_updated: #{@date_updated},"\
+      " friendly_name: #{@friendly_name}, status: #{@status}, factor_type: #{@factor_type},"\
+      " config: #{@config}, metadata: #{@metadata}, url: #{@url}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid.inspect}, account_sid: #{@account_sid.inspect}, service_sid:"\
+      " #{@service_sid.inspect}, entity_sid: #{@entity_sid.inspect}, identity:"\
+      " #{@identity.inspect}, binding: #{@binding.inspect}, options: #{@options.inspect},"\
+      " date_created: #{@date_created.inspect}, date_updated: #{@date_updated.inspect},"\
+      " friendly_name: #{@friendly_name.inspect}, status: #{@status.inspect}, factor_type:"\
+      " #{@factor_type.inspect}, config: #{@config.inspect}, metadata: #{@metadata.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/new_factor_enum_factor_statuses.rb

@@ -0,0 +1,36 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The Status of this Factor. One of `unverified` or `verified`.
+  class NewFactorEnumFactorStatuses
+    NEW_FACTOR_ENUM_FACTOR_STATUSES = [
+      # TODO: Write general description for UNVERIFIED
+      UNVERIFIED = 'unverified'.freeze,
+
+      # TODO: Write general description for VERIFIED
+      VERIFIED = 'verified'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NEW_FACTOR_ENUM_FACTOR_STATUSES.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNVERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unverified' then UNVERIFIED
+      when 'verified' then VERIFIED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/new_factor_enum_factor_types.rb

@@ -0,0 +1,40 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The Type of this Factor. Currently `push` and `totp` are supported.
+  class NewFactorEnumFactorTypes
+    NEW_FACTOR_ENUM_FACTOR_TYPES = [
+      # TODO: Write general description for PUSH
+      PUSH = 'push'.freeze,
+
+      # TODO: Write general description for TOTP
+      TOTP = 'totp'.freeze,
+
+      # TODO: Write general description for PASSKEYS
+      PASSKEYS = 'passkeys'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NEW_FACTOR_ENUM_FACTOR_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = PUSH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'push' then PUSH
+      when 'totp' then TOTP
+      when 'passkeys' then PASSKEYS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/new_factor_enum_notification_platforms.rb

@@ -0,0 +1,40 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # NewFactorEnumNotificationPlatforms.
+  class NewFactorEnumNotificationPlatforms
+    NEW_FACTOR_ENUM_NOTIFICATION_PLATFORMS = [
+      # TODO: Write general description for APN
+      APN = 'apn'.freeze,
+
+      # TODO: Write general description for FCM
+      FCM = 'fcm'.freeze,
+
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NEW_FACTOR_ENUM_NOTIFICATION_PLATFORMS.include?(value)
+    end
+
+    def self.from_value(value, default_value = APN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'apn' then APN
+      when 'fcm' then FCM
+      when 'none' then NONE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/new_factor_enum_totp_algorithms.rb

@@ -0,0 +1,40 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # NewFactorEnumTotpAlgorithms.
+  class NewFactorEnumTotpAlgorithms
+    NEW_FACTOR_ENUM_TOTP_ALGORITHMS = [
+      # TODO: Write general description for SHA1
+      SHA1 = 'sha1'.freeze,
+
+      # TODO: Write general description for SHA256
+      SHA256 = 'sha256'.freeze,
+
+      # TODO: Write general description for SHA512
+      SHA512 = 'sha512'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NEW_FACTOR_ENUM_TOTP_ALGORITHMS.include?(value)
+    end
+
+    def self.from_value(value, default_value = SHA1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sha1' then SHA1
+      when 'sha256' then SHA256
+      when 'sha512' then SHA512
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/notif_priority.rb

@@ -0,0 +1,43 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The priority of the notification. Can be: `low` or `high` and the default is
+  # `high`. A value of `low` optimizes the client app's battery consumption;
+  # however, notifications may be delivered with unspecified delay. For FCM and
+  # GCM, `low` priority is the same as `Normal` priority. For APNS `low`
+  # priority is the same as `5`. A value of `high` sends the notification
+  # immediately, and can wake up a sleeping device. For FCM and GCM, `high` is
+  # the same as `High` priority. For APNS, `high` is a priority `10`. SMS does
+  # not support this property.
+  class NotifPriority
+    NOTIF_PRIORITY = [
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze,
+
+      # TODO: Write general description for LOW
+      LOW = 'low'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NOTIF_PRIORITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = HIGH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'high' then HIGH
+      when 'low' then LOW
+      else
+        default_value
+      end
+    end
+  end
+end