twilio-ruby 5.0.0.rc3 → 5.0.0.rc4

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

@@ -0,0 +1,217 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /       
+
+module Twilio
+  module REST
+    class Notifications < Domain
+      class V1 < Version
+        class ServiceContext < InstanceContext
+          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] identity The identity
+            # @param [String] tag The tag
+            # @param [String] body The body
+            # @param [String] 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
+            
+            # @return [NotificationInstance] Newly created NotificationInstance
+            def create(identity: nil, tag: nil, body: nil, priority: nil, ttl: nil, title: nil, sound: nil, action: nil, data: nil, apn: nil, gcm: nil)
+              data = {
+                  'Identity' => identity,
+                  'Tag' => tag,
+                  'Body' => body,
+                  'Priority' => priority,
+                  'Ttl' => ttl,
+                  'Title' => title,
+                  'Sound' => sound,
+                  'Action' => action,
+                  'Data' => data,
+                  'Apn' => apn,
+                  'Gcm' => gcm,
+              }
+              
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+              
+              return NotificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution['service_sid'],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Notifications.V1.NotificationList>'
+            end
+          end
+        
+          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
+            # @param [String] service_sid The service_sid
+            
+            # @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)
+              return NotificationInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution['service_sid'],
+              )
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Notifications.V1.NotificationPage>'
+            end
+          end
+        
+          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(payload['date_created']),
+                  'identities' => payload['identities'],
+                  'tags' => payload['tags'],
+                  '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'],
+              }
+            end
+            
+            def sid
+              @properties['sid']
+            end
+            
+            def account_sid
+              @properties['account_sid']
+            end
+            
+            def service_sid
+              @properties['service_sid']
+            end
+            
+            def date_created
+              @properties['date_created']
+            end
+            
+            def identities
+              @properties['identities']
+            end
+            
+            def tags
+              @properties['tags']
+            end
+            
+            def priority
+              @properties['priority']
+            end
+            
+            def ttl
+              @properties['ttl']
+            end
+            
+            def title
+              @properties['title']
+            end
+            
+            def body
+              @properties['body']
+            end
+            
+            def sound
+              @properties['sound']
+            end
+            
+            def action
+              @properties['action']
+            end
+            
+            def data
+              @properties['data']
+            end
+            
+            def apn
+              @properties['apn']
+            end
+            
+            def gcm
+              @properties['gcm']
+            end
+            
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Notifications.V1.NotificationInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/notifications/v1/service.rb

@@ -0,0 +1,478 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /       
+
+module Twilio
+  module REST
+    class Notifications < Domain
+      class V1 < Version
+        class ServiceList < ListResource
+          ##
+          # Initialize the ServiceList
+          # @param [Version] version Version that contains the resource
+          
+          # @return [ServiceList] ServiceList
+          def initialize(version)
+            super(version)
+            
+            # Path Solution
+            @solution = {}
+            @uri = "/Services"
+          end
+          
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name The friendly_name
+          # @param [String] apn_credential_sid The apn_credential_sid
+          # @param [String] gcm_credential_sid The gcm_credential_sid
+          # @param [String] default_apn_notification_protocol_version The
+          #   default_apn_notification_protocol_version
+          # @param [String] default_gcm_notification_protocol_version The
+          #   default_gcm_notification_protocol_version
+          
+          # @return [ServiceInstance] Newly created ServiceInstance
+          def create(friendly_name: nil, apn_credential_sid: nil, gcm_credential_sid: nil, default_apn_notification_protocol_version: nil, default_gcm_notification_protocol_version: nil)
+            data = {
+                'FriendlyName' => friendly_name,
+                'ApnCredentialSid' => apn_credential_sid,
+                'GcmCredentialSid' => gcm_credential_sid,
+                'DefaultApnNotificationProtocolVersion' => default_apn_notification_protocol_version,
+                'DefaultGcmNotificationProtocolVersion' => default_gcm_notification_protocol_version,
+            }
+            
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+            
+            return ServiceInstance.new(
+                @version,
+                payload,
+            )
+          end
+          
+          ##
+          # Lists ServiceInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [String] friendly_name The friendly_name
+          # @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(friendly_name: nil, limit: nil, page_size: nil)
+            self.stream(
+                friendly_name: friendly_name,
+                limit: limit,
+                page_size: page_size
+            ).entries
+          end
+          
+          ##
+          # Streams ServiceInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] friendly_name The friendly_name
+          # @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(friendly_name: nil, limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+            
+            page = self.page(
+                friendly_name: friendly_name,
+                page_size: limits['page_size'],
+            )
+            
+            @version.stream(page, limit: limits['limit'], page_limit: limits['page_limit'])
+          end
+          
+          ##
+          # When passed a block, yields ServiceInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [String] friendly_name The friendly_name
+          # @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)
+          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 ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name The friendly_name
+          # @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 ServiceInstance
+          def page(friendly_name: nil, page_token: nil, page_number: nil, page_size: nil)
+            params = {
+                'FriendlyName' => friendly_name,
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            }
+            response = @version.page(
+                'GET',
+                @uri,
+                params
+            )
+            return ServicePage.new(@version, response, @solution)
+          end
+          
+          ##
+          # Constructs a ServiceContext
+          # @param [String] sid The sid
+          
+          # @return [ServiceContext] ServiceContext
+          def get(sid)
+            ServiceContext.new(
+                @version,
+                sid: sid,
+            )
+          end
+          
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Notifications.V1.ServiceList>'
+          end
+        end
+      
+        class ServicePage < Page
+          ##
+          # Initialize the ServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          
+          # @return [ServicePage] ServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+            
+            # Path Solution
+            @solution = solution
+          end
+          
+          ##
+          # Build an instance of ServiceInstance
+          # @param [Hash] payload Payload response from the API
+          
+          # @return [ServiceInstance] ServiceInstance
+          def get_instance(payload)
+            return ServiceInstance.new(
+                @version,
+                payload,
+            )
+          end
+          
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Notifications.V1.ServicePage>'
+          end
+        end
+      
+        class ServiceContext < InstanceContext
+          ##
+          # Initialize the ServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The sid
+          
+          # @return [ServiceContext] ServiceContext
+          def initialize(version, sid)
+            super(version)
+            
+            # Path Solution
+            @solution = {
+                sid: sid,
+            }
+            @uri = "/Services/#{@solution[:sid]}"
+            
+            # Dependents
+            @bindings = nil
+            @notifications = nil
+          end
+          
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            return @version.delete('delete', @uri)
+          end
+          
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            params = {}
+            
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+            
+            return ServiceInstance.new(
+                @version,
+                payload,
+                sid: @solution['sid'],
+            )
+          end
+          
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name The friendly_name
+          # @param [String] apn_credential_sid The apn_credential_sid
+          # @param [String] gcm_credential_sid The gcm_credential_sid
+          # @param [String] default_apn_notification_protocol_version The
+          #   default_apn_notification_protocol_version
+          # @param [String] default_gcm_notification_protocol_version The
+          #   default_gcm_notification_protocol_version
+          
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: nil, apn_credential_sid: nil, gcm_credential_sid: nil, default_apn_notification_protocol_version: nil, default_gcm_notification_protocol_version: nil)
+            data = {
+                'FriendlyName' => friendly_name,
+                'ApnCredentialSid' => apn_credential_sid,
+                'GcmCredentialSid' => gcm_credential_sid,
+                'DefaultApnNotificationProtocolVersion' => default_apn_notification_protocol_version,
+                'DefaultGcmNotificationProtocolVersion' => default_gcm_notification_protocol_version,
+            }
+            
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+            
+            return ServiceInstance.new(
+                @version,
+                payload,
+                sid: @solution['sid'],
+            )
+          end
+          
+          ##
+          # Access the bindings
+          # @return [BindingList] BindingList
+          def bindings(sid=:unset)
+            if sid != :unset
+              return BindingContext.new(
+                  @version,
+                  @solution[:sid],
+                  sid,
+              )
+            end
+            
+            unless @bindings
+              @bindings = BindingList.new(
+                  @version,
+                  service_sid: @solution[:sid],
+              )
+            end
+            
+            @bindings
+          end
+          
+          ##
+          # Access the notifications
+          # @return [NotificationList] NotificationList
+          def notifications
+            unless @notifications
+              @notifications = NotificationList.new(
+                  @version,
+                  service_sid: @solution[:sid],
+              )
+            end
+            
+            @notifications
+          end
+          
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Notifications.V1.ServiceContext #{context}>"
+          end
+        end
+      
+        class ServiceInstance < InstanceResource
+          ##
+          # Initialize the ServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The sid
+          
+          # @return [ServiceInstance] ServiceInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+            
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
+                'apn_credential_sid' => payload['apn_credential_sid'],
+                'gcm_credential_sid' => payload['gcm_credential_sid'],
+                'default_apn_notification_protocol_version' => payload['default_apn_notification_protocol_version'],
+                'default_gcm_notification_protocol_version' => payload['default_gcm_notification_protocol_version'],
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+            
+            # Context
+            @instance_context = nil
+            @params = {
+                '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
+          # @param [Version] version Version that contains the resource
+          
+          # @return [ServiceContext] ServiceContext for this ServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = ServiceContext.new(
+                  @version,
+                  @params['sid'],
+              )
+            end
+            @instance_context
+          end
+          
+          def sid
+            @properties['sid']
+          end
+          
+          def account_sid
+            @properties['account_sid']
+          end
+          
+          def friendly_name
+            @properties['friendly_name']
+          end
+          
+          def date_created
+            @properties['date_created']
+          end
+          
+          def date_updated
+            @properties['date_updated']
+          end
+          
+          def apn_credential_sid
+            @properties['apn_credential_sid']
+          end
+          
+          def gcm_credential_sid
+            @properties['gcm_credential_sid']
+          end
+          
+          def default_apn_notification_protocol_version
+            @properties['default_apn_notification_protocol_version']
+          end
+          
+          def default_gcm_notification_protocol_version
+            @properties['default_gcm_notification_protocol_version']
+          end
+          
+          def url
+            @properties['url']
+          end
+          
+          def links
+            @properties['links']
+          end
+          
+          ##
+          # Deletes the ServiceInstance
+          # @return [Boolean] true if delete succeeds, true otherwise
+          def delete
+            @context.delete()
+          end
+          
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            @context.fetch()
+          end
+          
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name The friendly_name
+          # @param [String] apn_credential_sid The apn_credential_sid
+          # @param [String] gcm_credential_sid The gcm_credential_sid
+          # @param [String] default_apn_notification_protocol_version The
+          #   default_apn_notification_protocol_version
+          # @param [String] default_gcm_notification_protocol_version The
+          #   default_gcm_notification_protocol_version
+          
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: nil, apn_credential_sid: nil, gcm_credential_sid: nil, default_apn_notification_protocol_version: nil, default_gcm_notification_protocol_version: nil)
+            @context.update(
+                apn_credential_sid: apn_credential_sid,
+                gcm_credential_sid: gcm_credential_sid,
+                default_apn_notification_protocol_version: default_apn_notification_protocol_version,
+                default_gcm_notification_protocol_version: default_gcm_notification_protocol_version,
+            )
+          end
+          
+          ##
+          # Access the bindings
+          # @return [bindings] bindings
+          def bindings
+            @context.bindings
+          end
+          
+          ##
+          # Access the notifications
+          # @return [notifications] notifications
+          def notifications
+            @context.notifications
+          end
+          
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Notifications.V1.ServiceInstance #{context}>"
+          end
+        end
+      end
+    end
+  end
+end