twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/event.rb

@@ -0,0 +1,270 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Event Model.
+  class Event < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Event resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the resource that triggered the event.
+    # @return [String]
+    attr_accessor :actor_sid
+
+    # The type of resource that triggered the event.
+    # @return [String]
+    attr_accessor :actor_type
+
+    # The absolute URL of the resource that triggered the event.
+    # @return [String]
+    attr_accessor :actor_url
+
+    # A description of the event.
+    # @return [String]
+    attr_accessor :description
+
+    # Data about the event. For more information, see [Event
+    # types](https://www.twilio.com/docs/taskrouter/api/event#event-types).
+    # @return [Object]
+    attr_accessor :event_data
+
+    # The time the event was sent, specified in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :event_date
+
+    # The time the event was sent in milliseconds.
+    # @return [Integer]
+    attr_accessor :event_date_ms
+
+    # The identifier for the event.
+    # @return [String]
+    attr_accessor :event_type
+
+    # The SID of the object the event is most relevant to, such as a TaskSid,
+    # ReservationSid, or a  WorkerSid.
+    # @return [String]
+    attr_accessor :resource_sid
+
+    # The type of object the event is most relevant to, such as a Task,
+    # Reservation, or a Worker).
+    # @return [String]
+    attr_accessor :resource_type
+
+    # The URL of the resource the event is most relevant to.
+    # @return [String]
+    attr_accessor :resource_url
+
+    # The unique string that we created to identify the Event resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # Where the Event originated.
+    # @return [String]
+    attr_accessor :source
+
+    # The IP from which the Event originated.
+    # @return [String]
+    attr_accessor :source_ip_address
+
+    # The absolute URL of the Event resource.
+    # @return [String]
+    attr_accessor :url
+
+    # The SID of the Workspace that contains the Event.
+    # @return [String]
+    attr_accessor :workspace_sid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['actor_sid'] = 'actor_sid'
+      @_hash['actor_type'] = 'actor_type'
+      @_hash['actor_url'] = 'actor_url'
+      @_hash['description'] = 'description'
+      @_hash['event_data'] = 'event_data'
+      @_hash['event_date'] = 'event_date'
+      @_hash['event_date_ms'] = 'event_date_ms'
+      @_hash['event_type'] = 'event_type'
+      @_hash['resource_sid'] = 'resource_sid'
+      @_hash['resource_type'] = 'resource_type'
+      @_hash['resource_url'] = 'resource_url'
+      @_hash['sid'] = 'sid'
+      @_hash['source'] = 'source'
+      @_hash['source_ip_address'] = 'source_ip_address'
+      @_hash['url'] = 'url'
+      @_hash['workspace_sid'] = 'workspace_sid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_sid
+        actor_sid
+        actor_type
+        actor_url
+        description
+        event_data
+        event_date
+        event_date_ms
+        event_type
+        resource_sid
+        resource_type
+        resource_url
+        sid
+        source
+        source_ip_address
+        url
+        workspace_sid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        account_sid
+        actor_sid
+        actor_type
+        actor_url
+        description
+        event_data
+        event_date
+        event_date_ms
+        event_type
+        resource_sid
+        resource_type
+        resource_url
+        sid
+        source
+        source_ip_address
+        url
+        workspace_sid
+      ]
+    end
+
+    def initialize(account_sid: SKIP, actor_sid: SKIP, actor_type: SKIP,
+                   actor_url: SKIP, description: SKIP, event_data: SKIP,
+                   event_date: SKIP, event_date_ms: SKIP, event_type: SKIP,
+                   resource_sid: SKIP, resource_type: SKIP, resource_url: SKIP,
+                   sid: SKIP, source: SKIP, source_ip_address: SKIP, url: SKIP,
+                   workspace_sid: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_sid = account_sid unless account_sid == SKIP
+      @actor_sid = actor_sid unless actor_sid == SKIP
+      @actor_type = actor_type unless actor_type == SKIP
+      @actor_url = actor_url unless actor_url == SKIP
+      @description = description unless description == SKIP
+      @event_data = event_data unless event_data == SKIP
+      @event_date = event_date unless event_date == SKIP
+      @event_date_ms = event_date_ms unless event_date_ms == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @resource_sid = resource_sid unless resource_sid == SKIP
+      @resource_type = resource_type unless resource_type == SKIP
+      @resource_url = resource_url unless resource_url == SKIP
+      @sid = sid unless sid == SKIP
+      @source = source unless source == SKIP
+      @source_ip_address = source_ip_address unless source_ip_address == SKIP
+      @url = url unless url == SKIP
+      @workspace_sid = workspace_sid unless workspace_sid == 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.
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      actor_sid = hash.key?('actor_sid') ? hash['actor_sid'] : SKIP
+      actor_type = hash.key?('actor_type') ? hash['actor_type'] : SKIP
+      actor_url = hash.key?('actor_url') ? hash['actor_url'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      event_data = hash.key?('event_data') ? hash['event_data'] : SKIP
+      event_date = if hash.key?('event_date')
+                     (DateTimeHelper.from_rfc3339(hash['event_date']) if hash['event_date'])
+                   else
+                     SKIP
+                   end
+      event_date_ms = hash.key?('event_date_ms') ? hash['event_date_ms'] : SKIP
+      event_type = hash.key?('event_type') ? hash['event_type'] : SKIP
+      resource_sid = hash.key?('resource_sid') ? hash['resource_sid'] : SKIP
+      resource_type = hash.key?('resource_type') ? hash['resource_type'] : SKIP
+      resource_url = hash.key?('resource_url') ? hash['resource_url'] : SKIP
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      source = hash.key?('source') ? hash['source'] : SKIP
+      source_ip_address =
+        hash.key?('source_ip_address') ? hash['source_ip_address'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      workspace_sid = hash.key?('workspace_sid') ? hash['workspace_sid'] : 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.
+      Event.new(account_sid: account_sid,
+                actor_sid: actor_sid,
+                actor_type: actor_type,
+                actor_url: actor_url,
+                description: description,
+                event_data: event_data,
+                event_date: event_date,
+                event_date_ms: event_date_ms,
+                event_type: event_type,
+                resource_sid: resource_sid,
+                resource_type: resource_type,
+                resource_url: resource_url,
+                sid: sid,
+                source: source,
+                source_ip_address: source_ip_address,
+                url: url,
+                workspace_sid: workspace_sid,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_event_date
+      DateTimeHelper.to_rfc3339(event_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_sid: #{@account_sid}, actor_sid: #{@actor_sid}, actor_type:"\
+      " #{@actor_type}, actor_url: #{@actor_url}, description: #{@description}, event_data:"\
+      " #{@event_data}, event_date: #{@event_date}, event_date_ms: #{@event_date_ms}, event_type:"\
+      " #{@event_type}, resource_sid: #{@resource_sid}, resource_type: #{@resource_type},"\
+      " resource_url: #{@resource_url}, sid: #{@sid}, source: #{@source}, source_ip_address:"\
+      " #{@source_ip_address}, url: #{@url}, workspace_sid: #{@workspace_sid},"\
+      " 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} account_sid: #{@account_sid.inspect}, actor_sid: #{@actor_sid.inspect},"\
+      " actor_type: #{@actor_type.inspect}, actor_url: #{@actor_url.inspect}, description:"\
+      " #{@description.inspect}, event_data: #{@event_data.inspect}, event_date:"\
+      " #{@event_date.inspect}, event_date_ms: #{@event_date_ms.inspect}, event_type:"\
+      " #{@event_type.inspect}, resource_sid: #{@resource_sid.inspect}, resource_type:"\
+      " #{@resource_type.inspect}, resource_url: #{@resource_url.inspect}, sid: #{@sid.inspect},"\
+      " source: #{@source.inspect}, source_ip_address: #{@source_ip_address.inspect}, url:"\
+      " #{@url.inspect}, workspace_sid: #{@workspace_sid.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/factor.rb

@@ -0,0 +1,235 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Factor Model.
+  class Factor < 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
+
+    # 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
+
+    # A human readable description of this resource, up to 64 characters. For a
+    # push factor, this can be the device's name.
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The Status of this Factor. One of `unverified` or `verified`.
+    # @return [FactorEnumFactorStatuses]
+    attr_accessor :status
+
+    # The Type of this Factor. Currently `push` and `totp` are supported.
+    # @return [FactorEnumFactorType]
+    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['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
+        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
+        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, 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
+      @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
+      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.
+      Factor.new(sid: sid,
+                 account_sid: account_sid,
+                 service_sid: service_sid,
+                 entity_sid: entity_sid,
+                 identity: identity,
+                 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}, 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}, 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/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 FactorEnumFactorStatuses
+    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?
+
+      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/factor_enum_factor_type.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 FactorEnumFactorType
+    FACTOR_ENUM_FACTOR_TYPE = [
+      # 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?
+
+      FACTOR_ENUM_FACTOR_TYPE.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/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
+  # FactorEnumNotificationPlatforms.
+  class FactorEnumNotificationPlatforms
+    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?
+
+      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/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
+  # FactorEnumTotpAlgorithms.
+  class FactorEnumTotpAlgorithms
+    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?
+
+      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/form_enum_form_types.rb

@@ -0,0 +1,26 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The Type of this Form. Currently only `form-push` is supported.
+  class FormEnumFormTypes
+    FORM_ENUM_FORM_TYPES = [
+      # TODO: Write general description for FORMPUSH
+      FORMPUSH = 'form-push'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FORM_ENUM_FORM_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = FORMPUSH)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end