twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,459 +1,701 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Notify
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
 #
-# frozen_string_literal: true
-
-module Twilio
-  module REST
-    class Notify < Domain
-      class V1 < Version
-        class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class BindingList < ListResource
-            ##
-            # Initialize the BindingList
-            # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the
-            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource
-            #   is associated with.
-            # @return [BindingList] BindingList
-            def initialize(version, service_sid: nil)
-              super(version)
-
-              # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/Bindings"
-            end
-
-            ##
-            # Create the BindingInstance
-            # @param [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]. Up to 20
-            #   Bindings can be created for the same Identity in a given Service.
-            # @param [binding.BindingType] binding_type The transport technology to use for
-            #   the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
-            # @param [String] address 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.
-            # @param [Array[String]] tag A tag that can be used to select the Bindings to
-            #   notify. Repeat this parameter to specify more than one tag, up to a total of 20
-            #   tags.
-            # @param [String] notification_protocol_version The protocol version to use to
-            #   send the notification. This defaults to the value of
-            #   `default_xxxx_notification_protocol_version` for the protocol in the
-            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource]. 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.
-            # @param [String] credential_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. Applies to only
-            #   `apn`, `fcm`, and `gcm` type Bindings.
-            # @param [String] endpoint Deprecated.
-            # @return [BindingInstance] Created BindingInstance
-            def create(identity: nil, binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset)
-              data = Twilio::Values.of({
-                  'Identity' => identity,
-                  'BindingType' => binding_type,
-                  'Address' => address,
-                  'Tag' => Twilio.serialize_list(tag) { |e| e },
-                  'NotificationProtocolVersion' => notification_protocol_version,
-                  'CredentialSid' => credential_sid,
-                  'Endpoint' => endpoint,
-              })
-
-              payload = @version.create('POST', @uri, data: data)
-
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
-            end
-
-            ##
-            # Lists BindingInstance records from the API as a list.
-            # Unlike stream(), this operation is eager and will load `limit` records into
-            # memory before returning.
-            # @param [Date] start_date Only include usage that has occurred on or after this
-            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Date] end_date Only include usage that occurred on or before this date.
-            #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Array[String]] identity The
-            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
-            #   of the resources to read.
-            # @param [Array[String]] tag Only list Bindings that have all of the specified
-            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
-            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
-            # @param [Integer] limit Upper limit for the number of records to return. stream()
-            #    guarantees to never return more than limit.  Default is no limit
-            # @param [Integer] page_size Number of records to fetch per request, when
-            #    not set will use the default value of 50 records.  If no page_size is defined
-            #    but a limit is defined, stream() will attempt to read the limit with the most
-            #    efficient page size, i.e. min(limit, 1000)
-            # @return [Array] Array of up to limit results
-            def list(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, limit: nil, page_size: nil)
-              self.stream(
-                  start_date: start_date,
-                  end_date: end_date,
-                  identity: identity,
-                  tag: tag,
-                  limit: limit,
-                  page_size: page_size
-              ).entries
-            end
-
-            ##
-            # Streams BindingInstance records from the API as an Enumerable.
-            # This operation lazily loads records as efficiently as possible until the limit
-            # is reached.
-            # @param [Date] start_date Only include usage that has occurred on or after this
-            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Date] end_date Only include usage that occurred on or before this date.
-            #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Array[String]] identity The
-            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
-            #   of the resources to read.
-            # @param [Array[String]] tag Only list Bindings that have all of the specified
-            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
-            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
-            # @param [Integer] limit Upper limit for the number of records to return. stream()
-            #    guarantees to never return more than limit. Default is no limit.
-            # @param [Integer] page_size Number of records to fetch per request, when
-            #    not set will use the default value of 50 records. If no page_size is defined
-            #    but a limit is defined, stream() will attempt to read the limit with the most
-            #    efficient page size, i.e. min(limit, 1000)
-            # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, limit: nil, page_size: nil)
-              limits = @version.read_limits(limit, page_size)
-
-              page = self.page(
-                  start_date: start_date,
-                  end_date: end_date,
-                  identity: identity,
-                  tag: tag,
-                  page_size: limits[:page_size],
-              )
-
-              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
-            end
-
-            ##
-            # When passed a block, yields BindingInstance records from the API.
-            # This operation lazily loads records as efficiently as possible until the limit
-            # is reached.
-            def each
-              limits = @version.read_limits
-
-              page = self.page(page_size: limits[:page_size], )
-
-              @version.stream(page,
-                              limit: limits[:limit],
-                              page_limit: limits[:page_limit]).each {|x| yield x}
-            end
-
-            ##
-            # Retrieve a single page of BindingInstance records from the API.
-            # Request is executed immediately.
-            # @param [Date] start_date Only include usage that has occurred on or after this
-            #   date. Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Date] end_date Only include usage that occurred on or before this date.
-            #   Specify the date in GMT and format as `YYYY-MM-DD`.
-            # @param [Array[String]] identity The
-            #   {User}[https://www.twilio.com/docs/chat/rest/user-resource]'s `identity` value
-            #   of the resources to read.
-            # @param [Array[String]] tag Only list Bindings that have all of the specified
-            #   Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`,
-            #   `sms`, `facebook-messenger`. Up to 5 tags are allowed.
-            # @param [String] page_token PageToken provided by the API
-            # @param [Integer] page_number Page Number, this value is simply for client state
-            # @param [Integer] page_size Number of records to return, defaults to 50
-            # @return [Page] Page of BindingInstance
-            def page(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
-              params = Twilio::Values.of({
-                  'StartDate' => Twilio.serialize_iso8601_date(start_date),
-                  'EndDate' => Twilio.serialize_iso8601_date(end_date),
-                  'Identity' => Twilio.serialize_list(identity) { |e| e },
-                  'Tag' => Twilio.serialize_list(tag) { |e| e },
-                  'PageToken' => page_token,
-                  'Page' => page_number,
-                  'PageSize' => page_size,
-              })
-
-              response = @version.page('GET', @uri, params: params)
-
-              BindingPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Retrieve a single page of BindingInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of BindingInstance
-            def get_page(target_url)
-              response = @version.domain.request(
-                  'GET',
-                  target_url
-              )
-              BindingPage.new(@version, response, @solution)
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '#<Twilio.Notify.V1.BindingList>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class BindingPage < Page
-            ##
-            # Initialize the BindingPage
-            # @param [Version] version Version that contains the resource
-            # @param [Response] response Response from the API
-            # @param [Hash] solution Path solution for the resource
-            # @return [BindingPage] BindingPage
-            def initialize(version, response, solution)
-              super(version, response)
-
-              # Path Solution
-              @solution = solution
-            end
-
-            ##
-            # Build an instance of BindingInstance
-            # @param [Hash] payload Payload response from the API
-            # @return [BindingInstance] BindingInstance
-            def get_instance(payload)
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], )
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              '<Twilio.Notify.V1.BindingPage>'
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class BindingContext < InstanceContext
-            ##
-            # Initialize the BindingContext
-            # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The SID of the
-            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource] to fetch the
-            #   resource from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   Binding resource to fetch.
-            # @return [BindingContext] BindingContext
-            def initialize(version, service_sid, sid)
-              super(version)
-
-              # Path Solution
-              @solution = {service_sid: service_sid, sid: sid, }
-              @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}"
-            end
-
-            ##
-            # Fetch the BindingInstance
-            # @return [BindingInstance] Fetched BindingInstance
-            def fetch
-              payload = @version.fetch('GET', @uri)
-
-              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
-            end
-
-            ##
-            # Delete the BindingInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-               @version.delete('DELETE', @uri)
-            end
-
-            ##
-            # Provide a user friendly representation
-            def to_s
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Notify.V1.BindingContext #{context}>"
-            end
-
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Notify.V1.BindingContext #{context}>"
-            end
-          end
-
-          ##
-          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class BindingInstance < InstanceResource
-            ##
-            # Initialize the BindingInstance
-            # @param [Version] version Version that contains the resource
-            # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The SID of the
-            #   {Service}[https://www.twilio.com/docs/notify/api/service-resource] the resource
-            #   is associated with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   Binding resource to fetch.
-            # @return [BindingInstance] BindingInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
-              super(version)
-
-              # Marshaled Properties
-              @properties = {
-                  'sid' => payload['sid'],
-                  'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
-                  'credential_sid' => payload['credential_sid'],
-                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
-                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'notification_protocol_version' => payload['notification_protocol_version'],
-                  'endpoint' => payload['endpoint'],
-                  'identity' => payload['identity'],
-                  'binding_type' => payload['binding_type'],
-                  'address' => payload['address'],
-                  'tags' => payload['tags'],
-                  'url' => payload['url'],
-                  'links' => payload['links'],
-              }
-
-              # Context
-              @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
-            end
-
-            ##
-            # Generate an instance context for the instance, the context is capable of
-            # performing various actions.  All instance actions are proxied to the context
-            # @return [BindingContext] BindingContext for this BindingInstance
-            def context
-              unless @instance_context
-                @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'], )
-              end
-              @instance_context
-            end
-
-            ##
-            # @return [String] The unique string that identifies the resource
-            def sid
-              @properties['sid']
-            end
-
-            ##
-            # @return [String] The SID of the Account that created the resource
-            def account_sid
-              @properties['account_sid']
-            end
-
-            ##
-            # @return [String] The SID of the Service that the resource is associated with
-            def service_sid
-              @properties['service_sid']
-            end
-
-            ##
-            # @return [String] The SID of the Credential resource to be used to send notifications to this Binding
-            def credential_sid
-              @properties['credential_sid']
-            end
-
-            ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
-            def date_created
-              @properties['date_created']
-            end
-
-            ##
-            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
-            def date_updated
-              @properties['date_updated']
-            end
-
-            ##
-            # @return [String] The protocol version to use to send the notification
-            def notification_protocol_version
-              @properties['notification_protocol_version']
-            end
-
-            ##
-            # @return [String] Deprecated
-            def endpoint
-              @properties['endpoint']
-            end
-
-            ##
-            # @return [String] The `identity` value that identifies the new resource's User
-            def identity
-              @properties['identity']
-            end
-
-            ##
-            # @return [String] The type of the Binding
-            def binding_type
-              @properties['binding_type']
-            end
-
-            ##
-            # @return [String] The channel-specific address
-            def address
-              @properties['address']
-            end
-
-            ##
-            # @return [Array[String]] The list of tags associated with this Binding
-            def tags
-              @properties['tags']
-            end
-
-            ##
-            # @return [String] The absolute URL of the Binding resource
-            def url
-              @properties['url']
-            end
-
-            ##
-            # @return [String] The URLs of related resources
-            def links
-              @properties['links']
-            end
-
-            ##
-            # Fetch the BindingInstance
-            # @return [BindingInstance] Fetched BindingInstance
-            def fetch
-              context.fetch
-            end
 
-            ##
-            # Delete the BindingInstance
-            # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
-            end
 
-            ##
-            # Provide a user friendly representation
-            def to_s
-              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.BindingInstance #{values}>"
-            end
-
-            ##
-            # Provide a detailed, user friendly representation
-            def inspect
-              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.BindingInstance #{values}>"
+module Twilio
+    module REST
+        class Notify < NotifyBase
+            class V1 < Version
+                class ServiceContext < InstanceContext
+
+                     class BindingList < ListResource
+                
+                    ##
+                    # Initialize the BindingList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BindingList] BindingList
+                    def initialize(version, service_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { service_sid: service_sid }
+                        @uri = "/Services/#{@solution[:service_sid]}/Bindings"
+                        
+                    end
+                    ##
+                    # Create the BindingInstance
+                    # @param [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). Up to 20 Bindings can be created for the same Identity in a given Service.
+                    # @param [BindingType] binding_type 
+                    # @param [String] address 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.
+                    # @param [Array[String]] tag A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.
+                    # @param [String] notification_protocol_version The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). 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.
+                    # @param [String] credential_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. Applies to only `apn`, `fcm`, and `gcm` type Bindings.
+                    # @param [String] endpoint Deprecated.
+                    # @return [BindingInstance] Created BindingInstance
+                    def create(
+                        identity: nil, 
+                        binding_type: nil, 
+                        address: nil, 
+                        tag: :unset, 
+                        notification_protocol_version: :unset, 
+                        credential_sid: :unset, 
+                        endpoint: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                            'BindingType' => binding_type,
+                            'Address' => address,
+                            'Tag' => Twilio.serialize_list(tag) { |e| e },
+                            'NotificationProtocolVersion' => notification_protocol_version,
+                            'CredentialSid' => credential_sid,
+                            'Endpoint' => endpoint,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
+                        BindingInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                        )
+                    end
+
+                    ##
+                    # Create the BindingInstanceMetadata
+                    # @param [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). Up to 20 Bindings can be created for the same Identity in a given Service.
+                    # @param [BindingType] binding_type 
+                    # @param [String] address 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.
+                    # @param [Array[String]] tag A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.
+                    # @param [String] notification_protocol_version The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). 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.
+                    # @param [String] credential_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. Applies to only `apn`, `fcm`, and `gcm` type Bindings.
+                    # @param [String] endpoint Deprecated.
+                    # @return [BindingInstance] Created BindingInstance
+                    def create_with_metadata(
+                      identity: nil, 
+                      binding_type: nil, 
+                      address: nil, 
+                      tag: :unset, 
+                      notification_protocol_version: :unset, 
+                      credential_sid: :unset, 
+                      endpoint: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                            'BindingType' => binding_type,
+                            'Address' => address,
+                            'Tag' => Twilio.serialize_list(tag) { |e| e },
+                            'NotificationProtocolVersion' => notification_protocol_version,
+                            'CredentialSid' => credential_sid,
+                            'Endpoint' => endpoint,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        binding_instance = BindingInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                        )
+                        BindingInstanceMetadata.new(
+                            @version,
+                            binding_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # Lists BindingInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Date] start_date Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Date] end_date Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
+                    # @param [Array[String]] tag Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            start_date: start_date,
+                            end_date: end_date,
+                            identity: identity,
+                            tag: tag,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Date] start_date Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Date] end_date Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
+                    # @param [Array[String]] tag Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            start_date: start_date,
+                            end_date: end_date,
+                            identity: identity,
+                            tag: tag,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # Lists BindingPageMetadata records from the API as a list.
+                      # @param [Date] start_date Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                      # @param [Date] end_date Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                      # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
+                      # @param [Array[String]] tag Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'StartDate' =>  Twilio.serialize_iso8601_date(start_date),
+                            'EndDate' =>  Twilio.serialize_iso8601_date(end_date),
+                            
+                            'Identity' =>  Twilio.serialize_list(identity) { |e| e },
+                            
+                            'Tag' =>  Twilio.serialize_list(tag) { |e| e },
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        BindingPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields BindingInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of BindingInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [Date] start_date Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Date] end_date Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.
+                    # @param [Array[String]] identity The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.
+                    # @param [Array[String]] tag Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.
+                    # @param [String] page_token PageToken provided by the API
+                    # @param [Integer] page_number Page Number, this value is simply for client state
+                    # @param [Integer] page_size Number of records to return, defaults to 50
+                    # @return [Page] Page of BindingInstance
+                    def page(start_date: :unset, end_date: :unset, identity: :unset, tag: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
+                        params = Twilio::Values.of({
+                            'StartDate' =>  Twilio.serialize_iso8601_date(start_date),
+                            'EndDate' =>  Twilio.serialize_iso8601_date(end_date),
+                            
+                            'Identity' =>  Twilio.serialize_list(identity) { |e| e },
+                            
+                            'Tag' =>  Twilio.serialize_list(tag) { |e| e },
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        BindingPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of BindingInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of BindingInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    BindingPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Notify.V1.BindingList>'
+                    end
+                end
+
+
+                class BindingContext < InstanceContext
+                    ##
+                    # Initialize the BindingContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] service_sid The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) to fetch the resource from.
+                    # @param [String] sid The Twilio-provided string that uniquely identifies the Binding resource to fetch.
+                    # @return [BindingContext] BindingContext
+                    def initialize(version, service_sid, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { service_sid: service_sid, sid: sid,  }
+                        @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the BindingInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the BindingInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          binding_instance = BindingInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          BindingInstanceMetadata.new(@version, binding_instance, response.headers, response.status_code)
+                    end
+
+                    ##
+                    # Fetch the BindingInstance
+                    # @return [BindingInstance] Fetched BindingInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        BindingInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the BindingInstanceMetadata
+                    # @return [BindingInstance] Fetched BindingInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        binding_instance = BindingInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                        BindingInstanceMetadata.new(
+                            @version,
+                            binding_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Notify.V1.BindingContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Notify.V1.BindingContext #{context}>"
+                    end
+                end
+
+                class BindingInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BindingInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BindingInstance] binding_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [BindingInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, binding_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @binding_instance = binding_instance
+                    end
+
+                    def binding
+                        @binding_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BindingInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BindingListResponse < InstanceListResource
+                    # @param [Array<BindingInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @binding_instance = payload.body[key].map do |data|
+                        BindingInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def binding_instance
+                          @instance
+                      end
+                  end
+
+                class BindingPage < Page
+                    ##
+                    # Initialize the BindingPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BindingPage] BindingPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BindingInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BindingInstance] BindingInstance
+                    def get_instance(payload)
+                        BindingInstance.new(@version, payload, service_sid: @solution[:service_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Notify.V1.BindingPage>'
+                    end
+                end
+
+                class BindingPageMetadata < PageMetadata
+                    attr_reader :binding_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @binding_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @binding_page << BindingListResponse.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
+                        @binding_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Notify::V1PageMetadata>';
+                    end
+                end
+                class BindingListResponse < InstanceListResource
+
+                    # @param [Array<BindingInstance>] 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
+                      @binding = data_list.map do |data|
+                        BindingInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def binding
+                        @binding
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class BindingInstance < InstanceResource
+                    ##
+                    # Initialize the BindingInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Binding
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BindingInstance] BindingInstance
+                    def initialize(version, payload , service_sid: nil, sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'credential_sid' => payload['credential_sid'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'notification_protocol_version' => payload['notification_protocol_version'],
+                            'endpoint' => payload['endpoint'],
+                            'identity' => payload['identity'],
+                            'binding_type' => payload['binding_type'],
+                            'address' => payload['address'],
+                            'tags' => payload['tags'],
+                            'url' => payload['url'],
+                            'links' => payload['links'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [BindingContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = BindingContext.new(@version , @params['service_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Binding resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Binding resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Service](https://www.twilio.com/docs/notify/api/service-resource) the resource is associated with.
+                    def service_sid
+                        @properties['service_sid']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def credential_sid
+                        @properties['credential_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def notification_protocol_version
+                        @properties['notification_protocol_version']
+                    end
+                    
+                    ##
+                    # @return [String] Deprecated.
+                    def endpoint
+                        @properties['endpoint']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def identity
+                        @properties['identity']
+                    end
+                    
+                    ##
+                    # @return [String] The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.
+                    def binding_type
+                        @properties['binding_type']
+                    end
+                    
+                    ##
+                    # @return [String] 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.
+                    def address
+                        @properties['address']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] 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.
+                    def tags
+                        @properties['tags']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Binding resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Hash] The URLs of related resources.
+                    def links
+                        @properties['links']
+                    end
+                    
+                    ##
+                    # Delete the BindingInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the BindingInstance
+                    # @return [BindingInstance] Fetched BindingInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Notify.V1.BindingInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Notify.V1.BindingInstance #{values}>"
+                    end
+                end
+
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+