twilio-api-sdk 1.0.0

data/lib/twilio_ap_is/models/notification.rb

@@ -0,0 +1,363 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Notification Model.
+  class Notification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique string that we created to identify the Notification resource.
+    # @return [String]
+    attr_accessor :sid
+
+    # The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
+    # created the Notification 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 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 list of `identity` values of the Users to notify. We will attempt to
+    # deliver notifications only to Bindings with an identity in this list.
+    # @return [Array[String]]
+    attr_accessor :identities
+
+    # The tags that select the Bindings to notify. Notifications will be
+    # attempted only to Bindings that have all of the tags listed in this
+    # property.
+    # @return [Array[String]]
+    attr_accessor :tags
+
+    # The list of Segments to notify. The
+    # [Segment](https://www.twilio.com/docs/notify/api/segment-resource)
+    # resource is deprecated. Use the `tags` property, instead.
+    # @return [Array[String]]
+    attr_accessor :segments
+
+    # The priority of the notification. Can be: `low` or `high` and the default
+    # is `high`. A value of `low` optimizes the client app's battery
+    # consumption; however, notifications may be delivered with unspecified
+    # delay. For FCM and GCM, `low` priority is the same as `Normal` priority.
+    # For APNS `low` priority is the same as `5`. A value of `high` sends the
+    # notification immediately, and can wake up a sleeping device. For FCM and
+    # GCM, `high` is the same as `High` priority. For APNS, `high` is a priority
+    # `10`. SMS does not support this property.
+    # @return [NotifPriority]
+    attr_accessor :priority
+
+    # How long, in seconds, the notification is valid. Can be an integer between
+    # 0 and 2,419,200, which is 4 weeks, the default and the maximum supported
+    # time to live (TTL). Delivery should be attempted if the device is offline
+    # until the TTL elapses. Zero means that the notification delivery is
+    # attempted immediately, only once, and is not stored for future delivery.
+    # SMS does not support this property.
+    # @return [Integer]
+    attr_accessor :ttl
+
+    # The notification title. For FCM and GCM, this translates to the
+    # `data.twi_title` value. For APNS, this translates to the `aps.alert.title`
+    # value. SMS does not support this property. This field is not visible on
+    # iOS phones and tablets but appears on Apple Watch and Android devices.
+    # @return [String]
+    attr_accessor :title
+
+    # The notification text. For FCM and GCM, translates to `data.twi_body`. For
+    # APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS
+    # requires either this `body` value, or `media_urls` attribute defined in
+    # the `sms` parameter of the notification.
+    # @return [String]
+    attr_accessor :body
+
+    # The name of the sound to be played for the notification. For FCM and GCM,
+    # this Translates to `data.twi_sound`.  For APNS, this translates to
+    # `aps.sound`.  SMS does not support this property.
+    # @return [String]
+    attr_accessor :sound
+
+    # The actions to display for the notification. For APNS, translates to the
+    # `aps.category` value. For GCM, translates to the `data.twi_action` value.
+    # For SMS, this parameter is not supported and is omitted from deliveries to
+    # those channels.
+    # @return [String]
+    attr_accessor :action
+
+    # The custom key-value pairs of the notification's payload. For FCM and GCM,
+    # this value translates to `data` in the FCM and GCM payloads. FCM and GCM
+    # [reserve certain
+    # keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref)
+    # that cannot be used in those channels. For APNS, attributes of `data` are
+    # inserted into the APNS payload as custom properties outside of the `aps`
+    # dictionary. In all channels, we reserve keys that start with `twi_` for
+    # future use. Custom keys that start with `twi_` are not allowed and are
+    # rejected as 400 Bad request with no delivery attempted. For SMS, this
+    # parameter is not supported and is omitted from deliveries to those
+    # channels.
+    # @return [Object]
+    attr_accessor :data
+
+    # The APNS-specific payload that overrides corresponding attributes in the
+    # generic payload for APNS Bindings. This property maps to the APNS
+    # `Payload` item, therefore the `aps` key must be used to change standard
+    # attributes. Adds custom key-value pairs to the root of the dictionary. See
+    # the [APNS
+    # documentation](https://developer.apple.com/library/content/documentation/N
+    # etworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.h
+    # tml) for more details. We reserve keys that start with `twi_` for future
+    # use. Custom keys that start with `twi_` are not allowed.
+    # @return [Object]
+    attr_accessor :apn
+
+    # The GCM-specific payload that overrides corresponding attributes in the
+    # generic payload for GCM Bindings.  This property maps to the root JSON
+    # dictionary. Target parameters `to`, `registration_ids`, and
+    # `notification_key` are not allowed. We reserve keys that start with `twi_`
+    # for future use. Custom keys that start with `twi_` are not allowed.
+    # @return [Object]
+    attr_accessor :gcm
+
+    # The FCM-specific payload that overrides corresponding attributes in the
+    # generic payload for FCM Bindings. This property maps to the root JSON
+    # dictionary. See the [FCM
+    # documentation](https://firebase.google.com/docs/cloud-messaging/http-serve
+    # r-ref#downstream) for more details. Target parameters `to`,
+    # `registration_ids`, `condition`, and `notification_key` are not allowed in
+    # this parameter. We reserve keys that start with `twi_` for future use.
+    # Custom keys that start with `twi_` are not allowed. FCM also [reserves
+    # certain
+    # keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref),
+    # which cannot be used in that channel.
+    # @return [Object]
+    attr_accessor :fcm
+
+    # The SMS-specific payload that overrides corresponding attributes in the
+    # generic payload for SMS Bindings.  Each attribute in this value maps to
+    # the corresponding `form` parameter of the Twilio
+    # [Message](https://www.twilio.com/docs/sms/api/message-resource) resource.
+    # These parameters of the Message resource are supported in snake case
+    # format: `body`, `media_urls`, `status_callback`, and `max_price`.  The
+    # `status_callback` parameter overrides the corresponding parameter in the
+    # messaging service, if configured. The `media_urls` property expects a JSON
+    # array.
+    # @return [Object]
+    attr_accessor :sms
+
+    # Deprecated.
+    # @return [Object]
+    attr_accessor :facebook_messenger
+
+    # Deprecated.
+    # @return [Object]
+    attr_accessor :alexa
+
+    # 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['date_created'] = 'date_created'
+      @_hash['identities'] = 'identities'
+      @_hash['tags'] = 'tags'
+      @_hash['segments'] = 'segments'
+      @_hash['priority'] = 'priority'
+      @_hash['ttl'] = 'ttl'
+      @_hash['title'] = 'title'
+      @_hash['body'] = 'body'
+      @_hash['sound'] = 'sound'
+      @_hash['action'] = 'action'
+      @_hash['data'] = 'data'
+      @_hash['apn'] = 'apn'
+      @_hash['gcm'] = 'gcm'
+      @_hash['fcm'] = 'fcm'
+      @_hash['sms'] = 'sms'
+      @_hash['facebook_messenger'] = 'facebook_messenger'
+      @_hash['alexa'] = 'alexa'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        service_sid
+        date_created
+        identities
+        tags
+        segments
+        priority
+        ttl
+        title
+        body
+        sound
+        action
+        data
+        apn
+        gcm
+        fcm
+        sms
+        facebook_messenger
+        alexa
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        service_sid
+        date_created
+        identities
+        tags
+        segments
+        title
+        body
+        sound
+        action
+        data
+        apn
+        gcm
+        fcm
+        sms
+        facebook_messenger
+        alexa
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, service_sid: SKIP,
+                   date_created: SKIP, identities: SKIP, tags: SKIP,
+                   segments: SKIP, priority: SKIP, ttl: 0, title: SKIP,
+                   body: SKIP, sound: SKIP, action: SKIP, data: SKIP, apn: SKIP,
+                   gcm: SKIP, fcm: SKIP, sms: SKIP, facebook_messenger: SKIP,
+                   alexa: 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
+      @date_created = date_created unless date_created == SKIP
+      @identities = identities unless identities == SKIP
+      @tags = tags unless tags == SKIP
+      @segments = segments unless segments == SKIP
+      @priority = priority unless priority == SKIP
+      @ttl = ttl unless ttl == SKIP
+      @title = title unless title == SKIP
+      @body = body unless body == SKIP
+      @sound = sound unless sound == SKIP
+      @action = action unless action == SKIP
+      @data = data unless data == SKIP
+      @apn = apn unless apn == SKIP
+      @gcm = gcm unless gcm == SKIP
+      @fcm = fcm unless fcm == SKIP
+      @sms = sms unless sms == SKIP
+      @facebook_messenger = facebook_messenger unless facebook_messenger == SKIP
+      @alexa = alexa unless alexa == 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
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+      identities = hash.key?('identities') ? hash['identities'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      segments = hash.key?('segments') ? hash['segments'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      ttl = hash['ttl'] ||= 0
+      title = hash.key?('title') ? hash['title'] : SKIP
+      body = hash.key?('body') ? hash['body'] : SKIP
+      sound = hash.key?('sound') ? hash['sound'] : SKIP
+      action = hash.key?('action') ? hash['action'] : SKIP
+      data = hash.key?('data') ? hash['data'] : SKIP
+      apn = hash.key?('apn') ? hash['apn'] : SKIP
+      gcm = hash.key?('gcm') ? hash['gcm'] : SKIP
+      fcm = hash.key?('fcm') ? hash['fcm'] : SKIP
+      sms = hash.key?('sms') ? hash['sms'] : SKIP
+      facebook_messenger =
+        hash.key?('facebook_messenger') ? hash['facebook_messenger'] : SKIP
+      alexa = hash.key?('alexa') ? hash['alexa'] : 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.
+      Notification.new(sid: sid,
+                       account_sid: account_sid,
+                       service_sid: service_sid,
+                       date_created: date_created,
+                       identities: identities,
+                       tags: tags,
+                       segments: segments,
+                       priority: priority,
+                       ttl: ttl,
+                       title: title,
+                       body: body,
+                       sound: sound,
+                       action: action,
+                       data: data,
+                       apn: apn,
+                       gcm: gcm,
+                       fcm: fcm,
+                       sms: sms,
+                       facebook_messenger: facebook_messenger,
+                       alexa: alexa,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    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},"\
+      " date_created: #{@date_created}, identities: #{@identities}, tags: #{@tags}, segments:"\
+      " #{@segments}, priority: #{@priority}, ttl: #{@ttl}, title: #{@title}, body: #{@body},"\
+      " sound: #{@sound}, action: #{@action}, data: #{@data}, apn: #{@apn}, gcm: #{@gcm}, fcm:"\
+      " #{@fcm}, sms: #{@sms}, facebook_messenger: #{@facebook_messenger}, alexa: #{@alexa},"\
+      " 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}, date_created: #{@date_created.inspect}, identities:"\
+      " #{@identities.inspect}, tags: #{@tags.inspect}, segments: #{@segments.inspect}, priority:"\
+      " #{@priority.inspect}, ttl: #{@ttl.inspect}, title: #{@title.inspect}, body:"\
+      " #{@body.inspect}, sound: #{@sound.inspect}, action: #{@action.inspect}, data:"\
+      " #{@data.inspect}, apn: #{@apn.inspect}, gcm: #{@gcm.inspect}, fcm: #{@fcm.inspect}, sms:"\
+      " #{@sms.inspect}, facebook_messenger: #{@facebook_messenger.inspect}, alexa:"\
+      " #{@alexa.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/twilio_ap_is/models/notification1.rb

@@ -0,0 +1,181 @@
+# twilio_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module TwilioApIs
+  # Notification1 Model.
+  class Notification1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A 34 character string that uniquely identifies this Notification.
+    # @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 Challenge. 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 unique SID identifier of the Challenge.
+    # @return [String]
+    attr_accessor :challenge_sid
+
+    # The priority of the notification. For `push` Challenges it's always `high`
+    # which sends the notification immediately, and can wake up a sleeping
+    # device.
+    # @return [String]
+    attr_accessor :priority
+
+    # How long, in seconds, the notification is valid. Max: 5 minutes
+    # @return [Integer]
+    attr_accessor :ttl
+
+    # The date that this Notification was created, given in [ISO
+    # 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+    # @return [DateTime]
+    attr_accessor :date_created
+
+    # 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['challenge_sid'] = 'challenge_sid'
+      @_hash['priority'] = 'priority'
+      @_hash['ttl'] = 'ttl'
+      @_hash['date_created'] = 'date_created'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sid
+        account_sid
+        service_sid
+        entity_sid
+        identity
+        challenge_sid
+        priority
+        ttl
+        date_created
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        sid
+        account_sid
+        service_sid
+        entity_sid
+        identity
+        challenge_sid
+        priority
+        date_created
+      ]
+    end
+
+    def initialize(sid: SKIP, account_sid: SKIP, service_sid: SKIP,
+                   entity_sid: SKIP, identity: SKIP, challenge_sid: SKIP,
+                   priority: SKIP, ttl: 0, date_created: 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
+      @challenge_sid = challenge_sid unless challenge_sid == SKIP
+      @priority = priority unless priority == SKIP
+      @ttl = ttl unless ttl == SKIP
+      @date_created = date_created unless date_created == 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
+      challenge_sid = hash.key?('challenge_sid') ? hash['challenge_sid'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
+      ttl = hash['ttl'] ||= 0
+      date_created = if hash.key?('date_created')
+                       (DateTimeHelper.from_rfc3339(hash['date_created']) if hash['date_created'])
+                     else
+                       SKIP
+                     end
+
+      # 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.
+      Notification1.new(sid: sid,
+                        account_sid: account_sid,
+                        service_sid: service_sid,
+                        entity_sid: entity_sid,
+                        identity: identity,
+                        challenge_sid: challenge_sid,
+                        priority: priority,
+                        ttl: ttl,
+                        date_created: date_created,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_date_created
+      DateTimeHelper.to_rfc3339(date_created)
+    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}, challenge_sid: #{@challenge_sid},"\
+      " priority: #{@priority}, ttl: #{@ttl}, date_created: #{@date_created},"\
+      " 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}, challenge_sid: #{@challenge_sid.inspect}, priority:"\
+      " #{@priority.inspect}, ttl: #{@ttl.inspect}, date_created: #{@date_created.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end