twilio-ruby 5.0.0 → 5.1.0

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

@@ -0,0 +1,438 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+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 service_sid
+            # @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
+
+            ##
+            # Retrieve a single page of BindingInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] identity The identity
+            # @param [binding.BindingType] binding_type The binding_type
+            # @param [String] address The address
+            # @param [String] tag The tag
+            # @param [String] notification_protocol_version The notification_protocol_version
+            # @param [String] credential_sid The credential_sid
+            # @param [String] endpoint The endpoint
+            # @return [BindingInstance] Newly 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' => tag,
+                  '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 The start_date
+            # @param [Date] end_date The end_date
+            # @param [String] identity The identity
+            # @param [String] tag The tag
+            # @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 The start_date
+            # @param [Date] end_date The end_date
+            # @param [String] identity The identity
+            # @param [String] tag The tag
+            # @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 The start_date
+            # @param [Date] end_date The end_date
+            # @param [String] identity The identity
+            # @param [String] tag The tag
+            # @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' => identity,
+                  'Tag' => tag,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  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 service_sid
+            # @param [String] sid The sid
+            # @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 a BindingInstance
+            # @return [BindingInstance] Fetched BindingInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              BindingInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Deletes the BindingInstance
+            # @return [Boolean] true if delete succeeds, true 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
+          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 service_sid
+            # @param [String] sid The sid
+            # @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 sid
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The service_sid
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [String] The credential_sid
+            def credential_sid
+              @properties['credential_sid']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date_updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The notification_protocol_version
+            def notification_protocol_version
+              @properties['notification_protocol_version']
+            end
+
+            ##
+            # @return [String] The endpoint
+            def endpoint
+              @properties['endpoint']
+            end
+
+            ##
+            # @return [String] The identity
+            def identity
+              @properties['identity']
+            end
+
+            ##
+            # @return [String] The binding_type
+            def binding_type
+              @properties['binding_type']
+            end
+
+            ##
+            # @return [String] The address
+            def address
+              @properties['address']
+            end
+
+            ##
+            # @return [String] The tags
+            def tags
+              @properties['tags']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [String] The links
+            def links
+              @properties['links']
+            end
+
+            ##
+            # Fetch a BindingInstance
+            # @return [BindingInstance] Fetched BindingInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes the BindingInstance
+            # @return [Boolean] true if delete succeeds, true 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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,294 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+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 NotificationList < ListResource
+            ##
+            # Initialize the NotificationList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @return [NotificationList] NotificationList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {
+                  service_sid: service_sid
+              }
+              @uri = "/Services/#{@solution[:service_sid]}/Notifications"
+            end
+
+            ##
+            # Retrieve a single page of NotificationInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] body The body
+            # @param [notification.Priority] priority The priority
+            # @param [String] ttl The ttl
+            # @param [String] title The title
+            # @param [String] sound The sound
+            # @param [String] action The action
+            # @param [String] data The data
+            # @param [String] apn The apn
+            # @param [String] gcm The gcm
+            # @param [String] sms The sms
+            # @param [Hash] facebook_messenger The facebook_messenger
+            # @param [String] fcm The fcm
+            # @param [String] segment The segment
+            # @param [String] alexa The alexa
+            # @param [String] to_binding The to_binding
+            # @param [String] identity The identity
+            # @param [String] tag The tag
+            # @return [NotificationInstance] Newly 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, identity: :unset, tag: :unset)
+              data = Twilio::Values.of({
+                  'Identity' => identity,
+                  'Tag' => tag,
+                  'Body' => body,
+                  'Priority' => priority,
+                  'Ttl' => ttl,
+                  'Title' => title,
+                  'Sound' => sound,
+                  'Action' => action,
+                  'Data' => data,
+                  'Apn' => apn,
+                  'Gcm' => gcm,
+                  'Sms' => sms,
+                  'FacebookMessenger' => Twilio.serialize_object(facebook_messenger),
+                  'Fcm' => fcm,
+                  'Segment' => segment,
+                  'Alexa' => alexa,
+                  'ToBinding' => to_binding,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              NotificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Notify.V1.NotificationList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class NotificationPage < Page
+            ##
+            # Initialize the NotificationPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [NotificationPage] NotificationPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of NotificationInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [NotificationInstance] NotificationInstance
+            def get_instance(payload)
+              NotificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+              )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Notify.V1.NotificationPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+          class NotificationInstance < InstanceResource
+            ##
+            # Initialize the NotificationInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The service_sid
+            # @return [NotificationInstance] NotificationInstance
+            def initialize(version, payload, service_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'identities' => payload['identities'],
+                  'tags' => payload['tags'],
+                  'segments' => payload['segments'],
+                  'priority' => payload['priority'],
+                  'ttl' => payload['ttl'].to_i,
+                  'title' => payload['title'],
+                  'body' => payload['body'],
+                  'sound' => payload['sound'],
+                  'action' => payload['action'],
+                  'data' => payload['data'],
+                  'apn' => payload['apn'],
+                  'gcm' => payload['gcm'],
+                  'fcm' => payload['fcm'],
+                  'sms' => payload['sms'],
+                  'facebook_messenger' => payload['facebook_messenger'],
+                  'alexa' => payload['alexa'],
+              }
+            end
+
+            ##
+            # @return [String] The sid
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The service_sid
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [String] The identities
+            def identities
+              @properties['identities']
+            end
+
+            ##
+            # @return [String] The tags
+            def tags
+              @properties['tags']
+            end
+
+            ##
+            # @return [String] The segments
+            def segments
+              @properties['segments']
+            end
+
+            ##
+            # @return [notification.Priority] The priority
+            def priority
+              @properties['priority']
+            end
+
+            ##
+            # @return [String] The ttl
+            def ttl
+              @properties['ttl']
+            end
+
+            ##
+            # @return [String] The title
+            def title
+              @properties['title']
+            end
+
+            ##
+            # @return [String] The body
+            def body
+              @properties['body']
+            end
+
+            ##
+            # @return [String] The sound
+            def sound
+              @properties['sound']
+            end
+
+            ##
+            # @return [String] The action
+            def action
+              @properties['action']
+            end
+
+            ##
+            # @return [Hash] The data
+            def data
+              @properties['data']
+            end
+
+            ##
+            # @return [Hash] The apn
+            def apn
+              @properties['apn']
+            end
+
+            ##
+            # @return [Hash] The gcm
+            def gcm
+              @properties['gcm']
+            end
+
+            ##
+            # @return [Hash] The fcm
+            def fcm
+              @properties['fcm']
+            end
+
+            ##
+            # @return [Hash] The sms
+            def sms
+              @properties['sms']
+            end
+
+            ##
+            # @return [Hash] The facebook_messenger
+            def facebook_messenger
+              @properties['facebook_messenger']
+            end
+
+            ##
+            # @return [Hash] The alexa
+            def alexa
+              @properties['alexa']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Notify.V1.NotificationInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end