twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/verification_attempt_enum_channels.rb

@@ -0,0 +1,49 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # A string specifying the communication channel used for the verification
+  # attempt.
+  class VerificationAttemptEnumChannels
+    VERIFICATION_ATTEMPT_ENUM_CHANNELS = [
+      # TODO: Write general description for SMS
+      SMS = 'sms'.freeze,
+
+      # TODO: Write general description for CALL
+      CALL = 'call'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'email'.freeze,
+
+      # TODO: Write general description for WHATSAPP
+      WHATSAPP = 'whatsapp'.freeze,
+
+      # TODO: Write general description for RBM
+      RBM = 'rbm'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPT_ENUM_CHANNELS.include?(value)
+    end
+
+    def self.from_value(value, default_value = SMS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sms' then SMS
+      when 'call' then CALL
+      when 'email' then EMAIL
+      when 'whatsapp' then WHATSAPP
+      when 'rbm' then RBM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempt_enum_conversion_status.rb

@@ -0,0 +1,38 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # A string specifying the conversion status of the verification. A conversion
+  # happens when the user is able to provide the correct code. Possible values
+  # are `CONVERTED` and `UNCONVERTED`.
+  class VerificationAttemptEnumConversionStatus
+    VERIFICATION_ATTEMPT_ENUM_CONVERSION_STATUS = [
+      # TODO: Write general description for CONVERTED
+      CONVERTED = 'converted'.freeze,
+
+      # TODO: Write general description for UNCONVERTED
+      UNCONVERTED = 'unconverted'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPT_ENUM_CONVERSION_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONVERTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'converted' then CONVERTED
+      when 'unconverted' then UNCONVERTED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempt_enum_message_status.rb

@@ -0,0 +1,80 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationAttemptEnumMessageStatus.
+  class VerificationAttemptEnumMessageStatus
+    VERIFICATION_ATTEMPT_ENUM_MESSAGE_STATUS = [
+      # TODO: Write general description for QUEUED
+      QUEUED = 'queued'.freeze,
+
+      # TODO: Write general description for SENDING
+      SENDING = 'sending'.freeze,
+
+      # TODO: Write general description for SENT
+      SENT = 'sent'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'delivered'.freeze,
+
+      # TODO: Write general description for UNDELIVERED
+      UNDELIVERED = 'undelivered'.freeze,
+
+      # TODO: Write general description for RECEIVING
+      RECEIVING = 'receiving'.freeze,
+
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'received'.freeze,
+
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'accepted'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'scheduled'.freeze,
+
+      # TODO: Write general description for READ
+      READ = 'read'.freeze,
+
+      # TODO: Write general description for PARTIALLY_DELIVERED
+      PARTIALLY_DELIVERED = 'partially_delivered'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPT_ENUM_MESSAGE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = QUEUED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'queued' then QUEUED
+      when 'sending' then SENDING
+      when 'sent' then SENT
+      when 'failed' then FAILED
+      when 'delivered' then DELIVERED
+      when 'undelivered' then UNDELIVERED
+      when 'receiving' then RECEIVING
+      when 'received' then RECEIVED
+      when 'accepted' then ACCEPTED
+      when 'scheduled' then SCHEDULED
+      when 'read' then READ
+      when 'partially_delivered' then PARTIALLY_DELIVERED
+      when 'canceled' then CANCELED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempts.rb

@@ -0,0 +1,129 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationAttempts Model.
+  class VerificationAttempts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total of attempts made according to the provided filters
+    # @return [Integer]
+    attr_accessor :total_attempts
+
+    # Total of  attempts made that were confirmed by the end user, according to
+    # the provided filters.
+    # @return [Integer]
+    attr_accessor :total_converted
+
+    # Total of attempts made that were not confirmed by the end user, according
+    # to the provided filters.
+    # @return [Integer]
+    attr_accessor :total_unconverted
+
+    # Percentage of the confirmed messages over the total, defined by
+    # (total_converted/total_attempts)*100.
+    # @return [String]
+    attr_accessor :conversion_rate_percentage
+
+    # Percentage of the confirmed messages over the total, defined by
+    # (total_converted/total_attempts)*100.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_attempts'] = 'total_attempts'
+      @_hash['total_converted'] = 'total_converted'
+      @_hash['total_unconverted'] = 'total_unconverted'
+      @_hash['conversion_rate_percentage'] = 'conversion_rate_percentage'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_attempts
+        total_converted
+        total_unconverted
+        conversion_rate_percentage
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        conversion_rate_percentage
+        url
+      ]
+    end
+
+    def initialize(total_attempts: 0, total_converted: 0, total_unconverted: 0,
+                   conversion_rate_percentage: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_attempts = total_attempts unless total_attempts == SKIP
+      @total_converted = total_converted unless total_converted == SKIP
+      @total_unconverted = total_unconverted unless total_unconverted == SKIP
+      unless conversion_rate_percentage == SKIP
+        @conversion_rate_percentage =
+          conversion_rate_percentage
+      end
+      @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.
+      total_attempts = hash['total_attempts'] ||= 0
+      total_converted = hash['total_converted'] ||= 0
+      total_unconverted = hash['total_unconverted'] ||= 0
+      conversion_rate_percentage =
+        hash.key?('conversion_rate_percentage') ? hash['conversion_rate_percentage'] : 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.
+      VerificationAttempts.new(total_attempts: total_attempts,
+                               total_converted: total_converted,
+                               total_unconverted: total_unconverted,
+                               conversion_rate_percentage: conversion_rate_percentage,
+                               url: url,
+                               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} total_attempts: #{@total_attempts}, total_converted: #{@total_converted},"\
+      " total_unconverted: #{@total_unconverted}, conversion_rate_percentage:"\
+      " #{@conversion_rate_percentage}, 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} total_attempts: #{@total_attempts.inspect}, total_converted:"\
+      " #{@total_converted.inspect}, total_unconverted: #{@total_unconverted.inspect},"\
+      " conversion_rate_percentage: #{@conversion_rate_percentage.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempts_summary_enum_channels.rb

@@ -0,0 +1,48 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationAttemptsSummaryEnumChannels.
+  class VerificationAttemptsSummaryEnumChannels
+    VERIFICATION_ATTEMPTS_SUMMARY_ENUM_CHANNELS = [
+      # TODO: Write general description for SMS
+      SMS = 'sms'.freeze,
+
+      # TODO: Write general description for CALL
+      CALL = 'call'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'email'.freeze,
+
+      # TODO: Write general description for WHATSAPP
+      WHATSAPP = 'whatsapp'.freeze,
+
+      # TODO: Write general description for RBM
+      RBM = 'rbm'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPTS_SUMMARY_ENUM_CHANNELS.include?(value)
+    end
+
+    def self.from_value(value, default_value = SMS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sms' then SMS
+      when 'call' then CALL
+      when 'email' then EMAIL
+      when 'whatsapp' then WHATSAPP
+      when 'rbm' then RBM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_check.rb

@@ -0,0 +1,231 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # VerificationCheck Model.
+  class VerificationCheck < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the VerificationCheck
+    # resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the [Service](https://www.twilio.com/docs/verify/api/service)
+    # the resource is associated with.
+    # @return [String]
+    attr_accessor :service_sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the VerificationCheck resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The phone number or [email](https://www.twilio.com/docs/verify/email)
+    # being verified. Phone numbers must be in [E.164
+    # format](https://www.twilio.com/docs/glossary/what-e164).
+    # @return [String]
+    attr_accessor :to
+
+    # The verification method to use. One of:
+    # [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`,
+    # `call`, or `sna`.
+    # @return [VerificationCheckEnumChannel]
+    attr_accessor :channel
+
+    # The status of the verification. Can be: `pending`, `approved`, `canceled`,
+    # `max_attempts_reached`, `deleted`, `failed` or `expired`.
+    # @return [String]
+    attr_accessor :status
+
+    # Use "status" instead. Legacy property indicating whether the verification
+    # was successful.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :valid
+
+    # The amount of the associated PSD2 compliant transaction. Requires the PSD2
+    # Service flag enabled.
+    # @return [String]
+    attr_accessor :amount
+
+    # The payee of the associated PSD2 compliant transaction. Requires the PSD2
+    # Service flag enabled.
+    # @return [String]
+    attr_accessor :payee
+
+    # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in
+    # GMT when the Verification Check resource was created.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in
+    # GMT when the Verification Check resource was last updated.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # List of error codes as a result of attempting a verification using the
+    # `sna` channel. The error codes are chronologically ordered, from the first
+    # attempt to the latest attempt. This will be an empty list if no errors
+    # occured or `null` if the last channel used wasn't `sna`.
+    # @return [Array[Object]]
+    attr_accessor :sna_attempts_error_codes
+
+    # 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['to'] = 'to'
+      @_hash['channel'] = 'channel'
+      @_hash['status'] = 'status'
+      @_hash['valid'] = 'valid'
+      @_hash['amount'] = 'amount'
+      @_hash['payee'] = 'payee'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['sna_attempts_error_codes'] = 'sna_attempts_error_codes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        service_sid
+        account_sid
+        to
+        channel
+        status
+        valid
+        amount
+        payee
+        date_created
+        date_updated
+        sna_attempts_error_codes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        service_sid
+        account_sid
+        to
+        status
+        valid
+        amount
+        payee
+        date_created
+        date_updated
+        sna_attempts_error_codes
+      ]
+    end
+
+    def initialize(sid: SKIP, service_sid: SKIP, account_sid: SKIP, to: SKIP,
+                   channel: SKIP, status: SKIP, valid: SKIP, amount: SKIP,
+                   payee: SKIP, date_created: SKIP, date_updated: SKIP,
+                   sna_attempts_error_codes: 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
+      @to = to unless to == SKIP
+      @channel = channel unless channel == SKIP
+      @status = status unless status == SKIP
+      @valid = valid unless valid == SKIP
+      @amount = amount unless amount == SKIP
+      @payee = payee unless payee == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @sna_attempts_error_codes = sna_attempts_error_codes unless sna_attempts_error_codes == 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
+      to = hash.key?('to') ? hash['to'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      valid = hash.key?('valid') ? hash['valid'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      payee = hash.key?('payee') ? hash['payee'] : 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
+      sna_attempts_error_codes =
+        hash.key?('sna_attempts_error_codes') ? hash['sna_attempts_error_codes'] : 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.
+      VerificationCheck.new(sid: sid,
+                            service_sid: service_sid,
+                            account_sid: account_sid,
+                            to: to,
+                            channel: channel,
+                            status: status,
+                            valid: valid,
+                            amount: amount,
+                            payee: payee,
+                            date_created: date_created,
+                            date_updated: date_updated,
+                            sna_attempts_error_codes: sna_attempts_error_codes,
+                            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},"\
+      " to: #{@to}, channel: #{@channel}, status: #{@status}, valid: #{@valid}, amount:"\
+      " #{@amount}, payee: #{@payee}, date_created: #{@date_created}, date_updated:"\
+      " #{@date_updated}, sna_attempts_error_codes: #{@sna_attempts_error_codes},"\
+      " 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}, to: #{@to.inspect}, channel: #{@channel.inspect}, status:"\
+      " #{@status.inspect}, valid: #{@valid.inspect}, amount: #{@amount.inspect}, payee:"\
+      " #{@payee.inspect}, date_created: #{@date_created.inspect}, date_updated:"\
+      " #{@date_updated.inspect}, sna_attempts_error_codes: #{@sna_attempts_error_codes.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_check_enum_channel.rb

@@ -0,0 +1,50 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The verification method to use. One of:
+  # [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`,
+  # `call`, or `sna`.
+  class VerificationCheckEnumChannel
+    VERIFICATION_CHECK_ENUM_CHANNEL = [
+      # TODO: Write general description for SMS
+      SMS = 'sms'.freeze,
+
+      # TODO: Write general description for CALL
+      CALL = 'call'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'email'.freeze,
+
+      # TODO: Write general description for WHATSAPP
+      WHATSAPP = 'whatsapp'.freeze,
+
+      # TODO: Write general description for SNA
+      SNA = 'sna'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_CHECK_ENUM_CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = SMS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sms' then SMS
+      when 'call' then CALL
+      when 'email' then EMAIL
+      when 'whatsapp' then WHATSAPP
+      when 'sna' then SNA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_enum_channel.rb

@@ -0,0 +1,50 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The verification method used. One of:
+  # [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`,
+  # `call`, `sna`, or `rcs`.
+  class VerificationEnumChannel
+    VERIFICATION_ENUM_CHANNEL = [
+      # TODO: Write general description for SMS
+      SMS = 'sms'.freeze,
+
+      # TODO: Write general description for CALL
+      CALL = 'call'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'email'.freeze,
+
+      # TODO: Write general description for WHATSAPP
+      WHATSAPP = 'whatsapp'.freeze,
+
+      # TODO: Write general description for SNA
+      SNA = 'sna'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ENUM_CHANNEL.include?(value)
+    end
+
+    def self.from_value(value, default_value = SMS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sms' then SMS
+      when 'call' then CALL
+      when 'email' then EMAIL
+      when 'whatsapp' then WHATSAPP
+      when 'sna' then SNA
+      else
+        default_value
+      end
+    end
+  end
+end