twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/binding.rb

@@ -0,0 +1,269 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Binding Model.
+  class Binding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the Binding resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Binding resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # The SID of the
+    # [Service](https://www.twilio.com/docs/notify/api/service-resource) the
+    # resource is associated with.
+    # @return [String]
+    attr_accessor :service_sid
+
+    # The SID of the
+    # [Credential](https://www.twilio.com/docs/notify/api/credential-resource)
+    # resource to be used to send notifications to this Binding. If present,
+    # this overrides the Credential specified in the Service resource.
+    # Applicable only to `apn`, `fcm`, and `gcm` type Bindings.
+    # @return [String]
+    attr_accessor :credential_sid
+
+    # 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 protocol version to use to send the notification. This defaults to the
+    # value of `default_xxxx_notification_protocol_version` in the
+    # [Service](https://www.twilio.com/docs/notify/api/service-resource) for the
+    # protocol. The current version is `"3"` for `apn`, `fcm`, and `gcm` type
+    # Bindings. The parameter is not applicable to `sms` and
+    # `facebook-messenger` type Bindings as the data format is fixed.
+    # @return [String]
+    attr_accessor :notification_protocol_version
+
+    # Deprecated.
+    # @return [String]
+    attr_accessor :endpoint
+
+    # The `identity` value that uniquely identifies the resource's
+    # [User](https://www.twilio.com/docs/chat/rest/user-resource) within the
+    # [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to
+    # 20 Bindings can be created for the same Identity in a given Service.
+    # @return [String]
+    attr_accessor :identity
+
+    # The transport technology to use for the Binding. Can be: `apn`, `fcm`,
+    # `gcm`, `sms`, or `facebook-messenger`.
+    # @return [String]
+    attr_accessor :binding_type
+
+    # The channel-specific address. For APNS, the device token. For FCM and GCM,
+    # the registration token. For SMS, a phone number in E.164 format. For
+    # Facebook Messenger, the Messenger ID of the user or a phone number in
+    # E.164 format.
+    # @return [String]
+    attr_accessor :address
+
+    # The list of tags associated with this Binding. Tags can be used to select
+    # the Bindings to use when sending a notification. Maximum 20 tags are
+    # allowed.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # The absolute URL of the Binding 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['service_sid'] = 'service_sid'
+      @_hash['credential_sid'] = 'credential_sid'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['notification_protocol_version'] =
+        'notification_protocol_version'
+      @_hash['endpoint'] = 'endpoint'
+      @_hash['identity'] = 'identity'
+      @_hash['binding_type'] = 'binding_type'
+      @_hash['address'] = 'address'
+      @_hash['tags'] = 'tags'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        service_sid
+        credential_sid
+        date_created
+        date_updated
+        notification_protocol_version
+        endpoint
+        identity
+        binding_type
+        address
+        tags
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        service_sid
+        credential_sid
+        date_created
+        date_updated
+        notification_protocol_version
+        endpoint
+        identity
+        binding_type
+        address
+        tags
+        url
+        links
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, service_sid: SKIP,
+                   credential_sid: SKIP, date_created: SKIP, date_updated: SKIP,
+                   notification_protocol_version: SKIP, endpoint: SKIP,
+                   identity: SKIP, binding_type: SKIP, address: SKIP,
+                   tags: 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
+      @service_sid = service_sid unless 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
+      unless notification_protocol_version == SKIP
+        @notification_protocol_version =
+          notification_protocol_version
+      end
+      @endpoint = endpoint unless endpoint == SKIP
+      @identity = identity unless identity == SKIP
+      @binding_type = binding_type unless binding_type == SKIP
+      @address = address unless address == SKIP
+      @tags = tags unless tags == 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
+      service_sid = hash.key?('service_sid') ? hash['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
+      notification_protocol_version =
+        hash.key?('notification_protocol_version') ? hash['notification_protocol_version'] : SKIP
+      endpoint = hash.key?('endpoint') ? hash['endpoint'] : SKIP
+      identity = hash.key?('identity') ? hash['identity'] : SKIP
+      binding_type = hash.key?('binding_type') ? hash['binding_type'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      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.
+      Binding.new(sid: sid,
+                  account_sid: account_sid,
+                  service_sid: service_sid,
+                  credential_sid: credential_sid,
+                  date_created: date_created,
+                  date_updated: date_updated,
+                  notification_protocol_version: notification_protocol_version,
+                  endpoint: endpoint,
+                  identity: identity,
+                  binding_type: binding_type,
+                  address: address,
+                  tags: tags,
+                  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}, service_sid: #{@service_sid},"\
+      " credential_sid: #{@credential_sid}, date_created: #{@date_created}, date_updated:"\
+      " #{@date_updated}, notification_protocol_version: #{@notification_protocol_version},"\
+      " endpoint: #{@endpoint}, identity: #{@identity}, binding_type: #{@binding_type}, address:"\
+      " #{@address}, tags: #{@tags}, 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}, service_sid:"\
+      " #{@service_sid.inspect}, credential_sid: #{@credential_sid.inspect}, date_created:"\
+      " #{@date_created.inspect}, date_updated: #{@date_updated.inspect},"\
+      " notification_protocol_version: #{@notification_protocol_version.inspect}, endpoint:"\
+      " #{@endpoint.inspect}, identity: #{@identity.inspect}, binding_type:"\
+      " #{@binding_type.inspect}, address: #{@address.inspect}, tags: #{@tags.inspect}, url:"\
+      " #{@url.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/binding_binding_type.rb

@@ -0,0 +1,53 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # The transport technology to use for the Binding. Can be: `apn`, `fcm`,
+  # `gcm`, `sms`, or `facebook-messenger`.
+  class BindingBindingType
+    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 SMS
+      SMS = 'sms'.freeze,
+
+      # TODO: Write general description for FCM
+      FCM = 'fcm'.freeze,
+
+      # TODO: Write general description for FACEBOOKMESSENGER
+      FACEBOOKMESSENGER = 'facebook-messenger'.freeze,
+
+      # TODO: Write general description for ALEXA
+      ALEXA = 'alexa'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      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 'sms' then SMS
+      when 'fcm' then FCM
+      when 'facebookmessenger' then FACEBOOKMESSENGER
+      when 'alexa' then ALEXA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/twilio_ap_is/models/bucket.rb

@@ -0,0 +1,186 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Bucket Model.
+  class Bucket < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A 34 character string that uniquely identifies this Bucket.
+    # @return [String]
+    attr_accessor :sid
+
+    # The Twilio-provided string that uniquely identifies the Rate Limit
+    # resource.
+    # @return [String]
+    attr_accessor :rate_limit_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 Rate Limit resource.
+    # @return [String]
+    attr_accessor :account_sid
+
+    # Maximum number of requests permitted in during the interval.
+    # @return [Integer]
+    attr_accessor :max
+
+    # Number of seconds that the rate limit will be enforced over.
+    # @return [Integer]
+    attr_accessor :interval
+
+    # 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 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['rate_limit_sid'] = 'rate_limit_sid'
+      @_hash['service_sid'] = 'service_sid'
+      @_hash['account_sid'] = 'account_sid'
+      @_hash['max'] = 'max'
+      @_hash['interval'] = 'interval'
+      @_hash['date_created'] = 'date_created'
+      @_hash['date_updated'] = 'date_updated'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        rate_limit_sid
+        service_sid
+        account_sid
+        max
+        interval
+        date_created
+        date_updated
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        rate_limit_sid
+        service_sid
+        account_sid
+        date_created
+        date_updated
+        url
+      ]
+    end
+
+    def initialize(sid: SKIP, rate_limit_sid: SKIP, service_sid: SKIP,
+                   account_sid: SKIP, max: 0, interval: 0, date_created: SKIP,
+                   date_updated: SKIP, url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @sid = sid unless sid == SKIP
+      @rate_limit_sid = rate_limit_sid unless rate_limit_sid == SKIP
+      @service_sid = service_sid unless service_sid == SKIP
+      @account_sid = account_sid unless account_sid == SKIP
+      @max = max unless max == SKIP
+      @interval = interval unless interval == SKIP
+      @date_created = date_created unless date_created == SKIP
+      @date_updated = date_updated unless date_updated == SKIP
+      @url = url unless url == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sid = hash.key?('sid') ? hash['sid'] : SKIP
+      rate_limit_sid =
+        hash.key?('rate_limit_sid') ? hash['rate_limit_sid'] : SKIP
+      service_sid = hash.key?('service_sid') ? hash['service_sid'] : SKIP
+      account_sid = hash.key?('account_sid') ? hash['account_sid'] : SKIP
+      max = hash['max'] ||= 0
+      interval = hash['interval'] ||= 0
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      date_updated = if hash.key?('date_updated')
+                       (DateTimeHelper.from_rfc3339(hash['date_updated']) if hash['date_updated'])
+                     else
+                       SKIP
+                     end
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Bucket.new(sid: sid,
+                 rate_limit_sid: rate_limit_sid,
+                 service_sid: service_sid,
+                 account_sid: account_sid,
+                 max: max,
+                 interval: interval,
+                 date_created: date_created,
+                 date_updated: date_updated,
+                 url: url,
+                 additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    end
+
+    def to_custom_date_updated
+      DateTimeHelper.to_rfc3339(date_updated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid}, rate_limit_sid: #{@rate_limit_sid}, service_sid:"\
+      " #{@service_sid}, account_sid: #{@account_sid}, max: #{@max}, interval: #{@interval},"\
+      " date_created: #{@date_created}, date_updated: #{@date_updated}, url: #{@url},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sid: #{@sid.inspect}, rate_limit_sid: #{@rate_limit_sid.inspect},"\
+      " service_sid: #{@service_sid.inspect}, account_sid: #{@account_sid.inspect}, max:"\
+      " #{@max.inspect}, interval: #{@interval.inspect}, date_created: #{@date_created.inspect},"\
+      " date_updated: #{@date_updated.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/bulk_consents.rb

@@ -0,0 +1,83 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # BulkConsents Model.
+  class BulkConsents < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of objects where each object represents the result of processing a
+    # `correlation_id`. Each object contains the following fields:
+    # `correlation_id`, a unique 32-character UUID that maps the response to the
+    # original request; `error_code`, an integer where 0 indicates success and
+    # any non-zero value represents an error; and `error_messages`, an array of
+    # strings describing specific validation errors encountered. If the request
+    # is successful, the error_messages array will be empty.
+    # @return [Object]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        items
+      ]
+    end
+
+    def initialize(items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @items = items unless items == 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.
+      items = hash.key?('items') ? hash['items'] : 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.
+      BulkConsents.new(items: items,
+                       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} items: #{@items}, 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} items: #{@items.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/bulk_contacts.rb

@@ -0,0 +1,83 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module TwilioApIs
+  # BulkContacts Model.
+  class BulkContacts < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of objects where each object represents the result of processing a
+    # `correlation_id`. Each object contains the following fields:
+    # `correlation_id`, a unique 32-character UUID that maps the response to the
+    # original request; `error_code`, an integer where 0 indicates success and
+    # any non-zero value represents an error; and `error_messages`, an array of
+    # strings describing specific validation errors encountered. If the request
+    # is successful, the error_messages array will be empty.
+    # @return [Object]
+    attr_accessor :items
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        items
+      ]
+    end
+
+    def initialize(items: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @items = items unless items == 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.
+      items = hash.key?('items') ? hash['items'] : 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.
+      BulkContacts.new(items: items,
+                       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} items: #{@items}, 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} items: #{@items.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end