twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/v2_form.rb

@@ -0,0 +1,112 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # V2Form Model.
+  class V2Form < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Type of this Form. Currently only `form-push` is supported.
+    # @return [FormEnumFormTypes]
+    attr_accessor :form_type
+
+    # Object that contains the available forms for this type. This available
+    # forms are given in the standard [JSON Schema](https://json-schema.org/)
+    # format
+    # @return [Object]
+    attr_accessor :forms
+
+    # Additional information for the available forms for this type. E.g. The
+    # separator string used for `binding` in a Factor push.
+    # @return [Object]
+    attr_accessor :form_meta
+
+    # The URL to access the forms for this type.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['form_type'] = 'form_type'
+      @_hash['forms'] = 'forms'
+      @_hash['form_meta'] = 'form_meta'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        form_type
+        forms
+        form_meta
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        forms
+        form_meta
+        url
+      ]
+    end
+
+    def initialize(form_type: SKIP, forms: SKIP, form_meta: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @form_type = form_type unless form_type == SKIP
+      @forms = forms unless forms == SKIP
+      @form_meta = form_meta unless form_meta == 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.
+      form_type = hash.key?('form_type') ? hash['form_type'] : SKIP
+      forms = hash.key?('forms') ? hash['forms'] : SKIP
+      form_meta = hash.key?('form_meta') ? hash['form_meta'] : 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.
+      V2Form.new(form_type: form_type,
+                 forms: forms,
+                 form_meta: form_meta,
+                 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} form_type: #{@form_type}, forms: #{@forms}, form_meta: #{@form_meta}, 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} form_type: #{@form_type.inspect}, forms: #{@forms.inspect}, form_meta:"\
+      " #{@form_meta.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification.rb

@@ -0,0 +1,262 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Verification Model.
+  class Verification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the Verification 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 Verification 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 used. One of:
+    # [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`,
+    # `call`, `sna`, or `rcs`.
+    # @return [VerificationEnumChannel]
+    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
+
+    # Information about the phone number being verified.
+    # @return [Object]
+    attr_accessor :lookup
+
+    # 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
+
+    # An array of verification attempt objects containing the channel attempted
+    # and the channel-specific transaction SID.
+    # @return [Array[Object]]
+    attr_accessor :send_code_attempts
+
+    # The date and time in GMT when the resource was created specified in [RFC
+    # 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date and time in GMT when the resource was last updated specified in
+    # [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The set of fields used for a silent network auth (`sna`) verification.
+    # Contains a single field with the URL to be invoked to verify the phone
+    # number.
+    # @return [Object]
+    attr_accessor :sna
+
+    # The absolute URL of the Verification 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['to'] = 'to'
+      @_hash['channel'] = 'channel'
+      @_hash['status'] = 'status'
+      @_hash['valid'] = 'valid'
+      @_hash['lookup'] = 'lookup'
+      @_hash['amount'] = 'amount'
+      @_hash['payee'] = 'payee'
+      @_hash['send_code_attempts'] = 'send_code_attempts'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['sna'] = 'sna'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        service_sid
+        account_sid
+        to
+        channel
+        status
+        valid
+        lookup
+        amount
+        payee
+        send_code_attempts
+        date_created
+        date_updated
+        sna
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        service_sid
+        account_sid
+        to
+        status
+        valid
+        lookup
+        amount
+        payee
+        send_code_attempts
+        date_created
+        date_updated
+        sna
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, service_sid: SKIP, account_sid: SKIP, to: SKIP,
+                   channel: SKIP, status: SKIP, valid: SKIP, lookup: SKIP,
+                   amount: SKIP, payee: SKIP, send_code_attempts: SKIP,
+                   date_created: SKIP, date_updated: SKIP, sna: 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
+      @to = to unless to == SKIP
+      @channel = channel unless channel == SKIP
+      @status = status unless status == SKIP
+      @valid = valid unless valid == SKIP
+      @lookup = lookup unless lookup == SKIP
+      @amount = amount unless amount == SKIP
+      @payee = payee unless payee == SKIP
+      @send_code_attempts = send_code_attempts unless send_code_attempts == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @sna = sna unless sna == 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
+      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
+      lookup = hash.key?('lookup') ? hash['lookup'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      payee = hash.key?('payee') ? hash['payee'] : SKIP
+      send_code_attempts =
+        hash.key?('send_code_attempts') ? hash['send_code_attempts'] : 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 = hash.key?('sna') ? hash['sna'] : 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.
+      Verification.new(sid: sid,
+                       service_sid: service_sid,
+                       account_sid: account_sid,
+                       to: to,
+                       channel: channel,
+                       status: status,
+                       valid: valid,
+                       lookup: lookup,
+                       amount: amount,
+                       payee: payee,
+                       send_code_attempts: send_code_attempts,
+                       date_created: date_created,
+                       date_updated: date_updated,
+                       sna: sna,
+                       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},"\
+      " to: #{@to}, channel: #{@channel}, status: #{@status}, valid: #{@valid}, lookup:"\
+      " #{@lookup}, amount: #{@amount}, payee: #{@payee}, send_code_attempts:"\
+      " #{@send_code_attempts}, date_created: #{@date_created}, date_updated: #{@date_updated},"\
+      " sna: #{@sna}, 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}, to: #{@to.inspect}, channel: #{@channel.inspect}, status:"\
+      " #{@status.inspect}, valid: #{@valid.inspect}, lookup: #{@lookup.inspect}, amount:"\
+      " #{@amount.inspect}, payee: #{@payee.inspect}, send_code_attempts:"\
+      " #{@send_code_attempts.inspect}, date_created: #{@date_created.inspect}, date_updated:"\
+      " #{@date_updated.inspect}, sna: #{@sna.inspect}, url: #{@url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempt.rb

@@ -0,0 +1,219 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # VerificationAttempt Model.
+  class VerificationAttempt < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID that uniquely identifies the verification attempt resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Verification resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the [Service](https://www.twilio.com/docs/verify/api/service)
+    # used to generate the attempt.
+    # @return [String]
+    attr_accessor :service_sid
+
+    # The SID of the
+    # [Verification](https://www.twilio.com/docs/verify/api/verification) that
+    # generated the attempt.
+    # @return [String]
+    attr_accessor :verification_sid
+
+    # The date that this Attempt was created, given in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date that this Attempt was updated, given in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # 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`.
+    # @return [VerificationAttemptEnumConversionStatus]
+    attr_accessor :conversion_status
+
+    # A string specifying the communication channel used for the verification
+    # attempt.
+    # @return [VerificationAttemptEnumChannels]
+    attr_accessor :channel
+
+    # An object containing the charge for this verification attempt related to
+    # the channel costs and the currency used. The costs related to the
+    # succeeded verifications are not included. May not be immediately
+    # available. More information on pricing is available
+    # [here](https://www.twilio.com/en-us/verify/pricing).
+    # @return [Object]
+    attr_accessor :price
+
+    # An object containing the channel specific information for an attempt.
+    # @return [Object]
+    attr_accessor :channel_data
+
+    # An object containing the channel specific information for an attempt.
+    # @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['verification_sid'] = 'verification_sid'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['conversion_status'] = 'conversion_status'
+      @_hash['channel'] = 'channel'
+      @_hash['price'] = 'price'
+      @_hash['channel_data'] = 'channel_data'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        service_sid
+        verification_sid
+        date_created
+        date_updated
+        conversion_status
+        channel
+        price
+        channel_data
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        service_sid
+        verification_sid
+        date_created
+        date_updated
+        price
+        channel_data
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, service_sid: SKIP,
+                   verification_sid: SKIP, date_created: SKIP,
+                   date_updated: SKIP, conversion_status: SKIP, channel: SKIP,
+                   price: SKIP, channel_data: 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
+      @verification_sid = verification_sid unless verification_sid == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @conversion_status = conversion_status unless conversion_status == SKIP
+      @channel = channel unless channel == SKIP
+      @price = price unless price == SKIP
+      @channel_data = channel_data unless channel_data == 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
+      verification_sid =
+        hash.key?('verification_sid') ? hash['verification_sid'] : 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
+      conversion_status =
+        hash.key?('conversion_status') ? hash['conversion_status'] : SKIP
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      channel_data = hash.key?('channel_data') ? hash['channel_data'] : 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.
+      VerificationAttempt.new(sid: sid,
+                              account_sid: account_sid,
+                              service_sid: service_sid,
+                              verification_sid: verification_sid,
+                              date_created: date_created,
+                              date_updated: date_updated,
+                              conversion_status: conversion_status,
+                              channel: channel,
+                              price: price,
+                              channel_data: channel_data,
+                              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},"\
+      " verification_sid: #{@verification_sid}, date_created: #{@date_created}, date_updated:"\
+      " #{@date_updated}, conversion_status: #{@conversion_status}, channel: #{@channel}, price:"\
+      " #{@price}, channel_data: #{@channel_data}, 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}, verification_sid: #{@verification_sid.inspect}, date_created:"\
+      " #{@date_created.inspect}, date_updated: #{@date_updated.inspect}, conversion_status:"\
+      " #{@conversion_status.inspect}, channel: #{@channel.inspect}, price: #{@price.inspect},"\
+      " channel_data: #{@channel_data.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempt_enum_attempt_status.rb

@@ -0,0 +1,40 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationAttemptEnumAttemptStatus.
+  class VerificationAttemptEnumAttemptStatus
+    VERIFICATION_ATTEMPT_ENUM_ATTEMPT_STATUS = [
+      # TODO: Write general description for CONFIRMED
+      CONFIRMED = 'confirmed'.freeze,
+
+      # TODO: Write general description for UNCONFIRMED
+      UNCONFIRMED = 'unconfirmed'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPT_ENUM_ATTEMPT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CONFIRMED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'confirmed' then CONFIRMED
+      when 'unconfirmed' then UNCONFIRMED
+      when 'expired' then EXPIRED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/verification_attempt_enum_call_status.rb

@@ -0,0 +1,60 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # VerificationAttemptEnumCallStatus.
+  class VerificationAttemptEnumCallStatus
+    VERIFICATION_ATTEMPT_ENUM_CALL_STATUS = [
+      # TODO: Write general description for QUEUED
+      QUEUED = 'queued'.freeze,
+
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'in-progress'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'completed'.freeze,
+
+      # TODO: Write general description for BUSY
+      BUSY = 'busy'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for NOANSWER
+      NOANSWER = 'no-answer'.freeze,
+
+      # TODO: Write general description for RINGING
+      RINGING = 'ringing'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      VERIFICATION_ATTEMPT_ENUM_CALL_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 'inprogress' then INPROGRESS
+      when 'completed' then COMPLETED
+      when 'busy' then BUSY
+      when 'failed' then FAILED
+      when 'noanswer' then NOANSWER
+      when 'ringing' then RINGING
+      when 'canceled' then CANCELED
+      else
+        default_value
+      end
+    end
+  end
+end