twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/service2.rb

@@ -0,0 +1,350 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Service2 Model.
+  class Service2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the Service resource.
+    # @return [String]
+    attr_accessor :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 name that appears in the body of your verification messages. It can be
+    # up to 30 characters long and can include letters, numbers, spaces, dashes,
+    # underscores. Phone numbers, special characters or links are NOT allowed.
+    # It cannot contain more than 4 (consecutive or non-consecutive) digits.
+    # **This value should not contain PII.**
+    # @return [String]
+    attr_accessor :friendly_name
+
+    # The length of the verification code to generate.
+    # @return [Integer]
+    attr_accessor :code_length
+
+    # Whether to perform a lookup with each verification started and return info
+    # about the phone number.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :lookup_enabled
+
+    # Whether to pass PSD2 transaction parameters when starting a verification.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :psd2_enabled
+
+    # Whether to skip sending SMS verifications to landlines. Requires
+    # `lookup_enabled`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_sms_to_landlines
+
+    # Whether to ask the user to press a number before delivering the verify
+    # code in a phone call.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :dtmf_input_required
+
+    # The name of an alternative text-to-speech service to use in phone calls.
+    # Applies only to TTS languages.
+    # @return [String]
+    attr_accessor :tts_name
+
+    # Whether to add a security warning at the end of an SMS verification body.
+    # Disabled by default and applies only to SMS. Example SMS body: `Your
+    # AppName verification code is: 1234. Don’t share this code with anyone; our
+    # employees will never ask for the code`
+    # @return [TrueClass | FalseClass]
+    attr_accessor :do_not_share_warning_enabled
+
+    # Whether to allow sending verifications with a custom code instead of a
+    # randomly generated one.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :custom_code_enabled
+
+    # Configurations for the Push factors (channel) created under this Service.
+    # @return [Object]
+    attr_accessor :push
+
+    # Configurations for the TOTP factors (channel) created under this Service.
+    # @return [Object]
+    attr_accessor :totp
+
+    # Configurations for the TOTP factors (channel) created under this Service.
+    # @return [String]
+    attr_accessor :default_template_sid
+
+    # Configurations for the TOTP factors (channel) created under this Service.
+    # @return [Object]
+    attr_accessor :whatsapp
+
+    # Configurations for the TOTP factors (channel) created under this Service.
+    # @return [Object]
+    attr_accessor :passkeys
+
+    # Whether to allow verifications from the service to reach the stream-events
+    # sinks if configured
+    # @return [TrueClass | FalseClass]
+    attr_accessor :verify_event_subscription_enabled
+
+    # 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 absolute URL of the resource.
+    # @return [String]
+    attr_accessor :url
+
+    # The URLs of related resources.
+    # @return [Object]
+    attr_accessor :links
+
+    # 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['code_length'] = 'code_length'
+      @_hash['lookup_enabled'] = 'lookup_enabled'
+      @_hash['psd2_enabled'] = 'psd2_enabled'
+      @_hash['skip_sms_to_landlines'] = 'skip_sms_to_landlines'
+      @_hash['dtmf_input_required'] = 'dtmf_input_required'
+      @_hash['tts_name'] = 'tts_name'
+      @_hash['do_not_share_warning_enabled'] = 'do_not_share_warning_enabled'
+      @_hash['custom_code_enabled'] = 'custom_code_enabled'
+      @_hash['push'] = 'push'
+      @_hash['totp'] = 'totp'
+      @_hash['default_template_sid'] = 'default_template_sid'
+      @_hash['whatsapp'] = 'whatsapp'
+      @_hash['passkeys'] = 'passkeys'
+      @_hash['verify_event_subscription_enabled'] =
+        'verify_event_subscription_enabled'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        friendly_name
+        code_length
+        lookup_enabled
+        psd2_enabled
+        skip_sms_to_landlines
+        dtmf_input_required
+        tts_name
+        do_not_share_warning_enabled
+        custom_code_enabled
+        push
+        totp
+        default_template_sid
+        whatsapp
+        passkeys
+        verify_event_subscription_enabled
+        date_created
+        date_updated
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        friendly_name
+        lookup_enabled
+        psd2_enabled
+        skip_sms_to_landlines
+        dtmf_input_required
+        tts_name
+        do_not_share_warning_enabled
+        custom_code_enabled
+        push
+        totp
+        default_template_sid
+        whatsapp
+        passkeys
+        verify_event_subscription_enabled
+        date_created
+        date_updated
+        url
+        links
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, friendly_name: SKIP,
+                   code_length: 0, lookup_enabled: SKIP, psd2_enabled: SKIP,
+                   skip_sms_to_landlines: SKIP, dtmf_input_required: SKIP,
+                   tts_name: SKIP, do_not_share_warning_enabled: SKIP,
+                   custom_code_enabled: SKIP, push: SKIP, totp: SKIP,
+                   default_template_sid: SKIP, whatsapp: SKIP, passkeys: SKIP,
+                   verify_event_subscription_enabled: SKIP, date_created: SKIP,
+                   date_updated: SKIP, url: SKIP, links: 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
+      @code_length = code_length unless code_length == SKIP
+      @lookup_enabled = lookup_enabled unless lookup_enabled == SKIP
+      @psd2_enabled = psd2_enabled unless psd2_enabled == SKIP
+      @skip_sms_to_landlines = skip_sms_to_landlines unless skip_sms_to_landlines == SKIP
+      @dtmf_input_required = dtmf_input_required unless dtmf_input_required == SKIP
+      @tts_name = tts_name unless tts_name == SKIP
+      unless do_not_share_warning_enabled == SKIP
+        @do_not_share_warning_enabled =
+          do_not_share_warning_enabled
+      end
+      @custom_code_enabled = custom_code_enabled unless custom_code_enabled == SKIP
+      @push = push unless push == SKIP
+      @totp = totp unless totp == SKIP
+      @default_template_sid = default_template_sid unless default_template_sid == SKIP
+      @whatsapp = whatsapp unless whatsapp == SKIP
+      @passkeys = passkeys unless passkeys == SKIP
+      unless verify_event_subscription_enabled == SKIP
+        @verify_event_subscription_enabled =
+          verify_event_subscription_enabled
+      end
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @url = url unless url == SKIP
+      @links = links unless links == 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
+      code_length = hash['code_length'] ||= 0
+      lookup_enabled =
+        hash.key?('lookup_enabled') ? hash['lookup_enabled'] : SKIP
+      psd2_enabled = hash.key?('psd2_enabled') ? hash['psd2_enabled'] : SKIP
+      skip_sms_to_landlines =
+        hash.key?('skip_sms_to_landlines') ? hash['skip_sms_to_landlines'] : SKIP
+      dtmf_input_required =
+        hash.key?('dtmf_input_required') ? hash['dtmf_input_required'] : SKIP
+      tts_name = hash.key?('tts_name') ? hash['tts_name'] : SKIP
+      do_not_share_warning_enabled =
+        hash.key?('do_not_share_warning_enabled') ? hash['do_not_share_warning_enabled'] : SKIP
+      custom_code_enabled =
+        hash.key?('custom_code_enabled') ? hash['custom_code_enabled'] : SKIP
+      push = hash.key?('push') ? hash['push'] : SKIP
+      totp = hash.key?('totp') ? hash['totp'] : SKIP
+      default_template_sid =
+        hash.key?('default_template_sid') ? hash['default_template_sid'] : SKIP
+      whatsapp = hash.key?('whatsapp') ? hash['whatsapp'] : SKIP
+      passkeys = hash.key?('passkeys') ? hash['passkeys'] : SKIP
+      verify_event_subscription_enabled =
+        hash.key?('verify_event_subscription_enabled') ? hash['verify_event_subscription_enabled'] : 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
+      links = hash.key?('links') ? hash['links'] : 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.
+      Service2.new(sid: sid,
+                   account_sid: account_sid,
+                   friendly_name: friendly_name,
+                   code_length: code_length,
+                   lookup_enabled: lookup_enabled,
+                   psd2_enabled: psd2_enabled,
+                   skip_sms_to_landlines: skip_sms_to_landlines,
+                   dtmf_input_required: dtmf_input_required,
+                   tts_name: tts_name,
+                   do_not_share_warning_enabled: do_not_share_warning_enabled,
+                   custom_code_enabled: custom_code_enabled,
+                   push: push,
+                   totp: totp,
+                   default_template_sid: default_template_sid,
+                   whatsapp: whatsapp,
+                   passkeys: passkeys,
+                   verify_event_subscription_enabled: verify_event_subscription_enabled,
+                   date_created: date_created,
+                   date_updated: date_updated,
+                   url: url,
+                   links: links,
+                   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}, friendly_name:"\
+      " #{@friendly_name}, code_length: #{@code_length}, lookup_enabled: #{@lookup_enabled},"\
+      " psd2_enabled: #{@psd2_enabled}, skip_sms_to_landlines: #{@skip_sms_to_landlines},"\
+      " dtmf_input_required: #{@dtmf_input_required}, tts_name: #{@tts_name},"\
+      " do_not_share_warning_enabled: #{@do_not_share_warning_enabled}, custom_code_enabled:"\
+      " #{@custom_code_enabled}, push: #{@push}, totp: #{@totp}, default_template_sid:"\
+      " #{@default_template_sid}, whatsapp: #{@whatsapp}, passkeys: #{@passkeys},"\
+      " verify_event_subscription_enabled: #{@verify_event_subscription_enabled}, date_created:"\
+      " #{@date_created}, date_updated: #{@date_updated}, url: #{@url}, links: #{@links},"\
+      " 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}, code_length: #{@code_length.inspect}, lookup_enabled:"\
+      " #{@lookup_enabled.inspect}, psd2_enabled: #{@psd2_enabled.inspect}, skip_sms_to_landlines:"\
+      " #{@skip_sms_to_landlines.inspect}, dtmf_input_required: #{@dtmf_input_required.inspect},"\
+      " tts_name: #{@tts_name.inspect}, do_not_share_warning_enabled:"\
+      " #{@do_not_share_warning_enabled.inspect}, custom_code_enabled:"\
+      " #{@custom_code_enabled.inspect}, push: #{@push.inspect}, totp: #{@totp.inspect},"\
+      " default_template_sid: #{@default_template_sid.inspect}, whatsapp: #{@whatsapp.inspect},"\
+      " passkeys: #{@passkeys.inspect}, verify_event_subscription_enabled:"\
+      " #{@verify_event_subscription_enabled.inspect}, date_created: #{@date_created.inspect},"\
+      " date_updated: #{@date_updated.inspect}, url: #{@url.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/service_binding.rb

@@ -0,0 +1,226 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # ServiceBinding Model.
+  class ServiceBinding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A 34 character string that uniquely identifies this resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The unique ID of the
+    # [Account](https://www.twilio.com/docs/iam/api/account) responsible for
+    # this binding.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource)
+    # the Binding resource is associated with.
+    # @return [String]
+    attr_accessor :chat_service_sid
+
+    # The SID of the
+    # [Credential](https://www.twilio.com/docs/conversations/api/credential-reso
+    # urce) for the binding. See [push notification
+    # configuration](https://www.twilio.com/docs/chat/push-notification-configur
+    # ation) for more info.
+    # @return [String]
+    attr_accessor :credential_sid
+
+    # The date that this resource was created.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # The date that this resource was last updated.
+    # @return [DateTime]
+    attr_accessor :date_updated
+
+    # The unique endpoint identifier for the Binding. The format of this value
+    # depends on the `binding_type`.
+    # @return [String]
+    attr_accessor :endpoint
+
+    # The application-defined string that uniquely identifies the [Conversation
+    # User](https://www.twilio.com/docs/conversations/api/user-resource) within
+    # the [Conversation
+    # Service](https://www.twilio.com/docs/conversations/api/service-resource).
+    # See [access
+    # tokens](https://www.twilio.com/docs/conversations/create-tokens) for more
+    # info.
+    # @return [String]
+    attr_accessor :identity
+
+    # The push technology to use for the Binding. Can be: `apn`, `gcm`, `fcm`,
+    # or `twilsock`.  See [push notification
+    # configuration](https://www.twilio.com/docs/chat/push-notification-configur
+    # ation) for more info.
+    # @return [ServiceBindingBindingType]
+    attr_accessor :binding_type
+
+    # The [Conversation message
+    # types](https://www.twilio.com/docs/chat/push-notification-configuration#pu
+    # sh-types) the binding is subscribed to.
+    # @return [Array[String]]
+    attr_accessor :message_types
+
+    # An absolute API resource URL for this binding.
+    # @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['chat_service_sid'] = 'chat_service_sid'
+      @_hash['credential_sid'] = 'credential_sid'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['endpoint'] = 'endpoint'
+      @_hash['identity'] = 'identity'
+      @_hash['binding_type'] = 'binding_type'
+      @_hash['message_types'] = 'message_types'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        chat_service_sid
+        credential_sid
+        date_created
+        date_updated
+        endpoint
+        identity
+        binding_type
+        message_types
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        chat_service_sid
+        credential_sid
+        date_created
+        date_updated
+        endpoint
+        identity
+        message_types
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, chat_service_sid: SKIP,
+                   credential_sid: SKIP, date_created: SKIP, date_updated: SKIP,
+                   endpoint: SKIP, identity: SKIP, binding_type: SKIP,
+                   message_types: 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
+      @chat_service_sid = chat_service_sid unless chat_service_sid == SKIP
+      @credential_sid = credential_sid unless credential_sid == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @endpoint = endpoint unless endpoint == SKIP
+      @identity = identity unless identity == SKIP
+      @binding_type = binding_type unless binding_type == SKIP
+      @message_types = message_types unless message_types == 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
+      chat_service_sid =
+        hash.key?('chat_service_sid') ? hash['chat_service_sid'] : SKIP
+      credential_sid =
+        hash.key?('credential_sid') ? hash['credential_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
+      endpoint = hash.key?('endpoint') ? hash['endpoint'] : SKIP
+      identity = hash.key?('identity') ? hash['identity'] : SKIP
+      binding_type = hash.key?('binding_type') ? hash['binding_type'] : SKIP
+      message_types = hash.key?('message_types') ? hash['message_types'] : 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.
+      ServiceBinding.new(sid: sid,
+                         account_sid: account_sid,
+                         chat_service_sid: chat_service_sid,
+                         credential_sid: credential_sid,
+                         date_created: date_created,
+                         date_updated: date_updated,
+                         endpoint: endpoint,
+                         identity: identity,
+                         binding_type: binding_type,
+                         message_types: message_types,
+                         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}, chat_service_sid:"\
+      " #{@chat_service_sid}, credential_sid: #{@credential_sid}, date_created: #{@date_created},"\
+      " date_updated: #{@date_updated}, endpoint: #{@endpoint}, identity: #{@identity},"\
+      " binding_type: #{@binding_type}, message_types: #{@message_types}, 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},"\
+      " chat_service_sid: #{@chat_service_sid.inspect}, credential_sid:"\
+      " #{@credential_sid.inspect}, date_created: #{@date_created.inspect}, date_updated:"\
+      " #{@date_updated.inspect}, endpoint: #{@endpoint.inspect}, identity: #{@identity.inspect},"\
+      " binding_type: #{@binding_type.inspect}, message_types: #{@message_types.inspect}, url:"\
+      " #{@url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/service_binding_binding_type.rb

@@ -0,0 +1,47 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The push technology to use for the Binding. Can be: `apn`, `gcm`, `fcm`, or
+  # `twilsock`.  See [push notification
+  # configuration](https://www.twilio.com/docs/chat/push-notification-configurat
+  # ion) for more info.
+  class ServiceBindingBindingType
+    SERVICE_BINDING_BINDING_TYPE = [
+      # TODO: Write general description for APN
+      APN = 'apn'.freeze,
+
+      # TODO: Write general description for GCM
+      GCM = 'gcm'.freeze,
+
+      # TODO: Write general description for FCM
+      FCM = 'fcm'.freeze,
+
+      # TODO: Write general description for TWILSOCK
+      TWILSOCK = 'twilsock'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_BINDING_BINDING_TYPE.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 'gcm' then GCM
+      when 'fcm' then FCM
+      when 'twilsock' then TWILSOCK
+      else
+        default_value
+      end
+    end
+  end
+end