twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/verification_enum_risk_check.rb

@@ -0,0 +1,39 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # Risk_check overrides Fraud Prevention measures like Fraud Guard, Geo
+  # Permissions etc per verification attempt basis, allowing Verify to block
+  # traffic considered fraudulent if enabled or bypass active protections if
+  # disabled. Can be: `enable`(default) or `disable`. For SMS channel only.
+  class VerificationEnumRiskCheck
+    VERIFICATION_ENUM_RISK_CHECK = [
+      # TODO: Write general description for ENABLE
+      ENABLE = 'enable'.freeze,
+
+      # TODO: Write general description for DISABLE
+      DISABLE = 'disable'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ENUM_RISK_CHECK.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enable' then ENABLE
+      when 'disable' then DISABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_enum_status.rb

@@ -0,0 +1,37 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The status of the verification. Can be: `pending`, `approved`, `canceled`,
+  # `max_attempts_reached`, `deleted`, `failed` or `expired`.
+  class VerificationEnumStatus
+    VERIFICATION_ENUM_STATUS = [
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'approved'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ENUM_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CANCELED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'canceled' then CANCELED
+      when 'approved' then APPROVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_template.rb

@@ -0,0 +1,126 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationTemplate Model.
+  class VerificationTemplate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A 34 character string that uniquely identifies a Verification Template.
+    # @return [String]
+    attr_accessor :sid
+
+    # The unique SID identifier of the Account.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # A descriptive string that you create to describe a Template. It can be up
+    # to 32 characters long.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # A list of channels that support the Template. Can include: sms, voice.
+    # @return [Array[String]]
+    attr_accessor :channels
+
+    # An object that contains the different translations of the template. Every
+    # translation is identified by the language short name and contains its
+    # respective information as the approval status, text and created/modified
+    # date.
+    # @return [Object]
+    attr_accessor :translations
+
+    # 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['friendly_name'] = 'friendly_name'
+      @_hash['channels'] = 'channels'
+      @_hash['translations'] = 'translations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        friendly_name
+        channels
+        translations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        friendly_name
+        channels
+        translations
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, friendly_name: SKIP,
+                   channels: SKIP, translations: 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
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @channels = channels unless channels == SKIP
+      @translations = translations unless translations == 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
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      channels = hash.key?('channels') ? hash['channels'] : SKIP
+      translations = hash.key?('translations') ? hash['translations'] : 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.
+      VerificationTemplate.new(sid: sid,
+                               account_sid: account_sid,
+                               friendly_name: friendly_name,
+                               channels: channels,
+                               translations: translations,
+                               additional_properties: additional_properties)
+    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}, friendly_name:"\
+      " #{@friendly_name}, channels: #{@channels}, translations: #{@translations},"\
+      " 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}, friendly_name:"\
+      " #{@friendly_name.inspect}, channels: #{@channels.inspect}, translations:"\
+      " #{@translations.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/webhook.rb

@@ -0,0 +1,222 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Webhook Model.
+  class Webhook < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the Webhook resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The unique SID identifier of the Service.
+    # @return [String]
+    attr_accessor :service_sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Service resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The string that you assigned to describe the webhook. **This value should
+    # not contain PII.**
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The array of events that this Webhook is subscribed to. Possible event
+    # types: `*, factor.deleted, factor.created, factor.verified,
+    # challenge.approved, challenge.denied`
+    # @return [Array[String]]
+    attr_accessor :event_types
+
+    # The webhook status. Default value is `enabled`. One of: `enabled` or
+    # `disabled`
+    # @return [WebhookEnumStatus]
+    attr_accessor :status
+
+    # The webhook version. Default value is `v2` which includes all the latest
+    # fields. Version `v1` is legacy and may be removed in the future.
+    # @return [WebhookEnumVersion]
+    attr_accessor :version
+
+    # The URL associated with this Webhook.
+    # @return [String]
+    attr_accessor :webhook_url
+
+    # The method to be used when calling the webhook's URL.
+    # @return [ConfigurationWebhookMethod]
+    attr_accessor :webhook_method
+
+    # The date and time in GMT when the resource was created specified in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date and time in GMT when the resource was last updated specified in
+    # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The absolute URL of the Webhook 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['service_sid'] = 'service_sid'
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['friendly_name'] = 'friendly_name'
+      @_hash['event_types'] = 'event_types'
+      @_hash['status'] = 'status'
+      @_hash['version'] = 'version'
+      @_hash['webhook_url'] = 'webhook_url'
+      @_hash['webhook_method'] = 'webhook_method'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        service_sid
+        account_sid
+        friendly_name
+        event_types
+        status
+        version
+        webhook_url
+        webhook_method
+        date_created
+        date_updated
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        service_sid
+        account_sid
+        friendly_name
+        event_types
+        webhook_url
+        date_created
+        date_updated
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, service_sid: SKIP, account_sid: SKIP,
+                   friendly_name: SKIP, event_types: SKIP, status: SKIP,
+                   version: SKIP, webhook_url: SKIP, webhook_method: SKIP,
+                   date_created: SKIP, date_updated: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @sid = sid unless sid == SKIP
+      @service_sid = service_sid unless service_sid == SKIP
+      @account_sid = account_sid unless account_sid == SKIP
+      @friendly_name = friendly_name unless friendly_name == SKIP
+      @event_types = event_types unless event_types == SKIP
+      @status = status unless status == SKIP
+      @version = version unless version == SKIP
+      @webhook_url = webhook_url unless webhook_url == SKIP
+      @webhook_method = webhook_method unless webhook_method == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == 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
+      service_sid = hash.key?('service_sid') ? hash['service_sid'] : SKIP
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      friendly_name = hash.key?('friendly_name') ? hash['friendly_name'] : SKIP
+      event_types = hash.key?('event_types') ? hash['event_types'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+      webhook_url = hash.key?('webhook_url') ? hash['webhook_url'] : SKIP
+      webhook_method =
+        hash.key?('webhook_method') ? hash['webhook_method'] : 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
+      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.
+      Webhook.new(sid: sid,
+                  service_sid: service_sid,
+                  account_sid: account_sid,
+                  friendly_name: friendly_name,
+                  event_types: event_types,
+                  status: status,
+                  version: version,
+                  webhook_url: webhook_url,
+                  webhook_method: webhook_method,
+                  date_created: date_created,
+                  date_updated: date_updated,
+                  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}, service_sid: #{@service_sid}, account_sid: #{@account_sid},"\
+      " friendly_name: #{@friendly_name}, event_types: #{@event_types}, status: #{@status},"\
+      " version: #{@version}, webhook_url: #{@webhook_url}, webhook_method: #{@webhook_method},"\
+      " date_created: #{@date_created}, date_updated: #{@date_updated}, 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}, service_sid: #{@service_sid.inspect}, account_sid:"\
+      " #{@account_sid.inspect}, friendly_name: #{@friendly_name.inspect}, event_types:"\
+      " #{@event_types.inspect}, status: #{@status.inspect}, version: #{@version.inspect},"\
+      " webhook_url: #{@webhook_url.inspect}, webhook_method: #{@webhook_method.inspect},"\
+      " date_created: #{@date_created.inspect}, date_updated: #{@date_updated.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/webhook_enum_status.rb

@@ -0,0 +1,37 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The webhook status. Default value is `enabled`. One of: `enabled` or
+  # `disabled`
+  class WebhookEnumStatus
+    WEBHOOK_ENUM_STATUS = [
+      # TODO: Write general description for ENABLED
+      ENABLED = 'enabled'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'disabled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_ENUM_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENABLED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enabled' then ENABLED
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/webhook_enum_version.rb

@@ -0,0 +1,37 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The webhook version. Default value is `v2` which includes all the latest
+  # fields. Version `v1` is legacy and may be removed in the future.
+  class WebhookEnumVersion
+    WEBHOOK_ENUM_VERSION = [
+      # TODO: Write general description for V1
+      V1 = 'v1'.freeze,
+
+      # TODO: Write general description for V2
+      V2 = 'v2'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEBHOOK_ENUM_VERSION.include?(value)
+    end
+
+    def self.from_value(value, default_value = V1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'v1' then V1
+      when 'v2' then V2
+      else
+        default_value
+      end
+    end
+  end
+end