twilio-ruby 5.0.0.rc18 → 5.0.0.rc19

data/lib/twilio-ruby/rest/preview/sync/service/document.rb

@@ -2,7 +2,7 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /       
+#       /       /
 
 module Twilio
   module REST
@@ -17,14 +17,14 @@ module Twilio
             # @return [DocumentList] DocumentList
             def initialize(version, service_sid: nil)
               super(version)
-              
+
               # Path Solution
               @solution = {
                   service_sid: service_sid
               }
               @uri = "/Services/#{@solution[:service_sid]}/Documents"
             end
-            
+
             ##
             # Retrieve a single page of DocumentInstance records from the API.
             # Request is executed immediately.
@@ -36,20 +36,20 @@ module Twilio
                   'UniqueName' => unique_name,
                   'Data' => data,
               }
-              
+
               payload = @version.create(
                   'POST',
                   @uri,
                   data: data
               )
-              
+
               return DocumentInstance.new(
                   @version,
                   payload,
                   service_sid: @solution[:service_sid],
               )
             end
-            
+
             ##
             # Lists DocumentInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
@@ -67,7 +67,7 @@ module Twilio
                   page_size: page_size
               ).entries
             end
-            
+
             ##
             # Streams DocumentInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
@@ -81,14 +81,14 @@ module Twilio
             # @return [Enumerable] Enumerable that will yield up to limit results
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
-              
+
               page = self.page(
                   page_size: limits[:page_size],
               )
-              
+
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
-            
+
             ##
             # When passed a block, yields DocumentInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
@@ -101,16 +101,16 @@ module Twilio
             #                       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 DocumentInstance records from the API.
             # Request is executed immediately.
@@ -131,14 +131,14 @@ module Twilio
               )
               return DocumentPage.new(@version, response, @solution)
             end
-            
+
             ##
             # Provide a user friendly representation
             def to_s
               '#<Twilio.Preview.Sync.DocumentList>'
             end
           end
-        
+
           class DocumentPage < Page
             ##
             # Initialize the DocumentPage
@@ -149,11 +149,11 @@ module Twilio
             # @return [DocumentPage] DocumentPage
             def initialize(version, response, solution)
               super(version, response)
-              
+
               # Path Solution
               @solution = solution
             end
-            
+
             ##
             # Build an instance of DocumentInstance
             # @param [Hash] payload Payload response from the API
@@ -165,14 +165,14 @@ module Twilio
                   service_sid: @solution[:service_sid],
               )
             end
-            
+
             ##
             # Provide a user friendly representation
             def to_s
               '<Twilio.Preview.Sync.DocumentPage>'
             end
           end
-        
+
           class DocumentContext < InstanceContext
             ##
             # Initialize the DocumentContext
@@ -182,27 +182,30 @@ module Twilio
             # @return [DocumentContext] DocumentContext
             def initialize(version, service_sid, sid)
               super(version)
-              
+
               # Path Solution
               @solution = {
                   service_sid: service_sid,
                   sid: sid,
               }
               @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:sid]}"
+
+              # Dependents
+              @document_permissions = nil
             end
-            
+
             ##
             # Fetch a DocumentInstance
             # @return [DocumentInstance] Fetched DocumentInstance
             def fetch
               params = {}
-              
+
               payload = @version.fetch(
                   'GET',
                   @uri,
                   params,
               )
-              
+
               return DocumentInstance.new(
                   @version,
                   payload,
@@ -210,14 +213,14 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
             ##
             # Deletes the DocumentInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               return @version.delete('delete', @uri)
             end
-            
+
             ##
             # Update the DocumentInstance
             # @param [Hash] data The data
@@ -226,13 +229,13 @@ module Twilio
               data = {
                   'Data' => data,
               }
-              
+
               payload = @version.update(
                   'POST',
                   @uri,
                   data: data,
               )
-              
+
               return DocumentInstance.new(
                   @version,
                   payload,
@@ -240,7 +243,31 @@ module Twilio
                   sid: @solution[:sid],
               )
             end
-            
+
+            ##
+            # Access the document_permissions
+            # @return [DocumentPermissionList] DocumentPermissionList
+            def document_permissions(identity=:unset)
+              if identity != :unset
+                return DocumentPermissionContext.new(
+                    @version,
+                    @solution[:service_sid],
+                    @solution[:sid],
+                    identity,
+                )
+              end
+
+              unless @document_permissions
+                @document_permissions = DocumentPermissionList.new(
+                    @version,
+                    service_sid: @solution[:service_sid],
+                    document_sid: @solution[:sid],
+                )
+              end
+
+              @document_permissions
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -248,7 +275,7 @@ module Twilio
               "#<Twilio.Preview.Sync.DocumentContext #{context}>"
             end
           end
-        
+
           class DocumentInstance < InstanceResource
             ##
             # Initialize the DocumentInstance
@@ -259,7 +286,7 @@ module Twilio
             # @return [DocumentInstance] DocumentInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
-              
+
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
@@ -267,13 +294,14 @@ module Twilio
                   'account_sid' => payload['account_sid'],
                   'service_sid' => payload['service_sid'],
                   'url' => payload['url'],
+                  'links' => payload['links'],
                   'revision' => payload['revision'],
                   'data' => payload['data'],
                   'date_created' => Twilio.deserialize_iso8601(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601(payload['date_updated']),
                   'created_by' => payload['created_by'],
               }
-              
+
               # Context
               @instance_context = nil
               @params = {
@@ -281,7 +309,7 @@ module Twilio
                   '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
@@ -297,61 +325,65 @@ module Twilio
               end
               @instance_context
             end
-            
+
             def sid
               @properties['sid']
             end
-            
+
             def unique_name
               @properties['unique_name']
             end
-            
+
             def account_sid
               @properties['account_sid']
             end
-            
+
             def service_sid
               @properties['service_sid']
             end
-            
+
             def url
               @properties['url']
             end
-            
+
+            def links
+              @properties['links']
+            end
+
             def revision
               @properties['revision']
             end
-            
+
             def data
               @properties['data']
             end
-            
+
             def date_created
               @properties['date_created']
             end
-            
+
             def date_updated
               @properties['date_updated']
             end
-            
+
             def created_by
               @properties['created_by']
             end
-            
+
             ##
             # Fetch a DocumentInstance
             # @return [DocumentInstance] Fetched DocumentInstance
             def fetch
               context.fetch
             end
-            
+
             ##
             # Deletes the DocumentInstance
             # @return [Boolean] true if delete succeeds, true otherwise
             def delete
               context.delete
             end
-            
+
             ##
             # Update the DocumentInstance
             # @param [Hash] data The data
@@ -361,7 +393,14 @@ module Twilio
                   data: data,
               )
             end
-            
+
+            ##
+            # Access the document_permissions
+            # @return [document_permissions] document_permissions
+            def document_permissions
+              context.document_permissions
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/preview/sync/service/document/document_permission.rb

@@ -0,0 +1,377 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Preview < Domain
+      class Sync < Version
+        class ServiceContext < InstanceContext
+          class DocumentContext < InstanceContext
+            class DocumentPermissionList < ListResource
+              ##
+              # Initialize the DocumentPermissionList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The unique SID identifier of the Sync Service
+              #   Instance.
+              # @param [String] document_sid The unique SID identifier of the Sync Document to
+              #   which the Permission applies.
+              # @return [DocumentPermissionList] DocumentPermissionList
+              def initialize(version, service_sid: nil, document_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    document_sid: document_sid
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions"
+              end
+
+              ##
+              # Lists DocumentPermissionInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @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(limit: nil, page_size: nil)
+                self.stream(
+                    limit: limit,
+                    page_size: page_size
+                ).entries
+              end
+
+              ##
+              # Streams DocumentPermissionInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @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(limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(
+                    page_size: limits[:page_size],
+                )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields DocumentPermissionInstance records from the API.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @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 DocumentPermissionInstance records from the API.
+              # Request is executed immediately.
+              # @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 DocumentPermissionInstance
+              def page(page_token: nil, page_number: nil, page_size: nil)
+                params = {
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                }
+                response = @version.page(
+                    'GET',
+                    @uri,
+                    params
+                )
+                return DocumentPermissionPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Preview.Sync.DocumentPermissionList>'
+              end
+            end
+
+            class DocumentPermissionPage < Page
+              ##
+              # Initialize the DocumentPermissionPage
+              # @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 unique SID identifier of the Sync Service
+              #   Instance.
+              # @param [String] document_sid The unique SID identifier of the Sync Document to
+              #   which the Permission applies.
+              # @return [DocumentPermissionPage] DocumentPermissionPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of DocumentPermissionInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [DocumentPermissionInstance] DocumentPermissionInstance
+              def get_instance(payload)
+                return DocumentPermissionInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    document_sid: @solution[:document_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Preview.Sync.DocumentPermissionPage>'
+              end
+            end
+
+            class DocumentPermissionContext < InstanceContext
+              ##
+              # Initialize the DocumentPermissionContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The service_sid
+              # @param [String] document_sid Identifier of the Sync Document. Either a SID or a
+              #   unique name.
+              # @param [String] identity Arbitrary string identifier representing a user
+              #   associated with an FPA token, assigned by the developer.
+              # @return [DocumentPermissionContext] DocumentPermissionContext
+              def initialize(version, service_sid, document_sid, identity)
+                super(version)
+
+                # Path Solution
+                @solution = {
+                    service_sid: service_sid,
+                    document_sid: document_sid,
+                    identity: identity,
+                }
+                @uri = "/Services/#{@solution[:service_sid]}/Documents/#{@solution[:document_sid]}/Permissions/#{@solution[:identity]}"
+              end
+
+              ##
+              # Fetch a DocumentPermissionInstance
+              # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
+              def fetch
+                params = {}
+
+                payload = @version.fetch(
+                    'GET',
+                    @uri,
+                    params,
+                )
+
+                return DocumentPermissionInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    document_sid: @solution[:document_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Deletes the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                return @version.delete('delete', @uri)
+              end
+
+              ##
+              # Update the DocumentPermissionInstance
+              # @param [Boolean] read Boolean flag specifying whether the identity can read the
+              #   Sync Document.
+              # @param [Boolean] write Boolean flag specifying whether the identity can update
+              #   the Sync Document.
+              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
+              #   the Sync Document.
+              # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
+              def update(read: nil, write: nil, manage: nil)
+                data = {
+                    'Read' => read,
+                    'Write' => write,
+                    'Manage' => manage,
+                }
+
+                payload = @version.update(
+                    'POST',
+                    @uri,
+                    data: data,
+                )
+
+                return DocumentPermissionInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    document_sid: @solution[:document_sid],
+                    identity: @solution[:identity],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Preview.Sync.DocumentPermissionContext #{context}>"
+              end
+            end
+
+            class DocumentPermissionInstance < InstanceResource
+              ##
+              # Initialize the DocumentPermissionInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The unique SID identifier of the Sync Service
+              #   Instance.
+              # @param [String] document_sid The unique SID identifier of the Sync Document to
+              #   which the Permission applies.
+              # @param [String] identity Arbitrary string identifier representing a user
+              #   associated with an FPA token, assigned by the developer.
+              # @return [DocumentPermissionInstance] DocumentPermissionInstance
+              def initialize(version, payload, service_sid: nil, document_sid: nil, identity: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'service_sid' => payload['service_sid'],
+                    'document_sid' => payload['document_sid'],
+                    'identity' => payload['identity'],
+                    'read' => payload['read'],
+                    'write' => payload['write'],
+                    'manage' => payload['manage'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {
+                    'service_sid' => service_sid,
+                    'document_sid' => document_sid,
+                    'identity' => identity || @properties['identity'],
+                }
+              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 [DocumentPermissionContext] DocumentPermissionContext for this DocumentPermissionInstance
+              def context
+                unless @instance_context
+                  @instance_context = DocumentPermissionContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['document_sid'],
+                      @params['identity'],
+                  )
+                end
+                @instance_context
+              end
+
+              def account_sid
+                @properties['account_sid']
+              end
+
+              def service_sid
+                @properties['service_sid']
+              end
+
+              def document_sid
+                @properties['document_sid']
+              end
+
+              def identity
+                @properties['identity']
+              end
+
+              def read
+                @properties['read']
+              end
+
+              def write
+                @properties['write']
+              end
+
+              def manage
+                @properties['manage']
+              end
+
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch a DocumentPermissionInstance
+              # @return [DocumentPermissionInstance] Fetched DocumentPermissionInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Deletes the DocumentPermissionInstance
+              # @return [Boolean] true if delete succeeds, true otherwise
+              def delete
+                context.delete
+              end
+
+              ##
+              # Update the DocumentPermissionInstance
+              # @param [Boolean] read Boolean flag specifying whether the identity can read the
+              #   Sync Document.
+              # @param [Boolean] write Boolean flag specifying whether the identity can update
+              #   the Sync Document.
+              # @param [Boolean] manage Boolean flag specifying whether the identity can delete
+              #   the Sync Document.
+              # @return [DocumentPermissionInstance] Updated DocumentPermissionInstance
+              def update(read: nil, write: nil, manage: nil)
+                context.update(
+                    read: read,
+                    write: write,
+                    manage: manage,
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Preview.Sync.DocumentPermissionInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end