twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/notify/v1/service/notification.rb

@@ -20,12 +20,14 @@ module Twilio
                 class ServiceContext < InstanceContext
 
                      class NotificationList < ListResource
+                
                     ##
                     # Initialize the NotificationList
                     # @param [Version] version Version that contains the resource
                     # @return [NotificationList] NotificationList
                     def initialize(version, service_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Notifications"
@@ -42,7 +44,7 @@ module Twilio
                     # @param [Object] data 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.
                     # @param [Object] apn 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/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.
                     # @param [Object] gcm The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.  This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. 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. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
-                    # @param [Object] sms 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/send-messages) 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.
+                    # @param [Object] sms 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/quickstart) 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.
                     # @param [Object] facebook_messenger Deprecated.
                     # @param [Object] fcm 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-server-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.
                     # @param [Array[String]] segment The Segment resource is deprecated. Use the `tag` parameter, instead.
@@ -53,24 +55,24 @@ module Twilio
                     # @param [Array[String]] tag A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel.
                     # @return [NotificationInstance] Created NotificationInstance
                     def create(
-                        body: :unset, 
-                        priority: :unset, 
-                        ttl: :unset, 
-                        title: :unset, 
-                        sound: :unset, 
-                        action: :unset, 
-                        data: :unset, 
-                        apn: :unset, 
-                        gcm: :unset, 
-                        sms: :unset, 
-                        facebook_messenger: :unset, 
-                        fcm: :unset, 
-                        segment: :unset, 
-                        alexa: :unset, 
-                        to_binding: :unset, 
-                        delivery_callback_url: :unset, 
-                        identity: :unset, 
-                        tag: :unset
+                      body: :unset, 
+                      priority: :unset, 
+                      ttl: :unset, 
+                      title: :unset, 
+                      sound: :unset, 
+                      action: :unset, 
+                      data: :unset, 
+                      apn: :unset, 
+                      gcm: :unset, 
+                      sms: :unset, 
+                      facebook_messenger: :unset, 
+                      fcm: :unset, 
+                      segment: :unset, 
+                      alexa: :unset, 
+                      to_binding: :unset, 
+                      delivery_callback_url: :unset, 
+                      identity: :unset, 
+                      tag: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -94,7 +96,13 @@ module Twilio
                             'Tag' => Twilio.serialize_list(tag) { |e| e },
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         NotificationInstance.new(
                             @version,
                             payload,
@@ -102,6 +110,89 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the NotificationInstanceMetadata
+                    # @param [String] body 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.
+                    # @param [Priority] priority 
+                    # @param [String] ttl 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.
+                    # @param [String] title 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.
+                    # @param [String] sound 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.
+                    # @param [String] action 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.
+                    # @param [Object] data 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.
+                    # @param [Object] apn 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/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.
+                    # @param [Object] gcm The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings.  This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. 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. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
+                    # @param [Object] sms 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/quickstart) 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.
+                    # @param [Object] facebook_messenger Deprecated.
+                    # @param [Object] fcm 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-server-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.
+                    # @param [Array[String]] segment The Segment resource is deprecated. Use the `tag` parameter, instead.
+                    # @param [Object] alexa Deprecated.
+                    # @param [Array[String]] to_binding The destination address specified as a JSON string.  Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers.
+                    # @param [String] delivery_callback_url URL to send webhooks.
+                    # @param [Array[String]] identity The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list.
+                    # @param [Array[String]] tag A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel.
+                    # @return [NotificationInstance] Created NotificationInstance
+                    def create_with_metadata(
+                      body: :unset, 
+                      priority: :unset, 
+                      ttl: :unset, 
+                      title: :unset, 
+                      sound: :unset, 
+                      action: :unset, 
+                      data: :unset, 
+                      apn: :unset, 
+                      gcm: :unset, 
+                      sms: :unset, 
+                      facebook_messenger: :unset, 
+                      fcm: :unset, 
+                      segment: :unset, 
+                      alexa: :unset, 
+                      to_binding: :unset, 
+                      delivery_callback_url: :unset, 
+                      identity: :unset, 
+                      tag: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Body' => body,
+                            'Priority' => priority,
+                            'Ttl' => ttl,
+                            'Title' => title,
+                            'Sound' => sound,
+                            'Action' => action,
+                            'Data' => Twilio.serialize_object(data),
+                            'Apn' => Twilio.serialize_object(apn),
+                            'Gcm' => Twilio.serialize_object(gcm),
+                            'Sms' => Twilio.serialize_object(sms),
+                            'FacebookMessenger' => Twilio.serialize_object(facebook_messenger),
+                            'Fcm' => Twilio.serialize_object(fcm),
+                            'Segment' => Twilio.serialize_list(segment) { |e| e },
+                            'Alexa' => Twilio.serialize_object(alexa),
+                            'ToBinding' => Twilio.serialize_list(to_binding) { |e| e },
+                            'DeliveryCallbackUrl' => delivery_callback_url,
+                            'Identity' => Twilio.serialize_list(identity) { |e| e },
+                            'Tag' => Twilio.serialize_list(tag) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        notification_instance = NotificationInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        NotificationInstanceMetadata.new(
+                            @version,
+                            notification_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -120,6 +211,7 @@ module Twilio
                     # @return [NotificationPage] NotificationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -139,6 +231,66 @@ module Twilio
                         '<Twilio.Notify.V1.NotificationPage>'
                     end
                 end
+
+                class NotificationPageMetadata < PageMetadata
+                    attr_reader :notification_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @notification_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @notification_page << NotificationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @notification_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Notify::V1PageMetadata>';
+                    end
+                end
+                class NotificationListResponse < InstanceListResource
+
+                    # @param [Array<NotificationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @notification = data_list.map do |data|
+                        NotificationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def notification
+                        @notification
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class NotificationInstance < InstanceResource
                     ##
                     # Initialize the NotificationInstance
@@ -152,6 +304,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],