twilio-ruby 7.3.3 → 7.10.1

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

@@ -1,394 +0,0 @@
-##
-#    This code was generated by
-#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
-#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
-#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
-#
-#    Twilio - Preview
-#    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.
-#
-
-
-module Twilio
-    module REST
-        class Preview < PreviewBase
-            class Sync < Version
-                class ServiceContext < InstanceContext
-                class SyncListContext < InstanceContext
-
-                     class SyncListPermissionList < ListResource
-                
-                    ##
-                    # Initialize the SyncListPermissionList
-                    # @param [Version] version Version that contains the resource
-                    # @return [SyncListPermissionList] SyncListPermissionList
-                    def initialize(version, service_sid: nil, list_sid: nil)
-                        super(version)
-                        # Path Solution
-                        @solution = { service_sid: service_sid, list_sid: list_sid }
-                        @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Permissions"
-                        
-                    end
-                
-                    ##
-                    # Lists SyncListPermissionInstance 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 Instance 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 SyncListPermissionInstance 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 SyncListPermissionInstance 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 SyncListPermissionInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
-                        params = Twilio::Values.of({
-                            'PageToken' => page_token,
-                            'Page' => page_number,
-                            'PageSize' => page_size,
-                        })
-
-                        response = @version.page('GET', @uri, params: params)
-
-                        SyncListPermissionPage.new(@version, response, @solution)
-                    end
-
-                    ##
-                    # Retrieve a single page of SyncListPermissionInstance records from the API.
-                    # Request is executed immediately.
-                    # @param [String] target_url API-generated URL for the requested results page
-                    # @return [Page] Page of SyncListPermissionInstance
-                    def get_page(target_url)
-                        response = @version.domain.request(
-                            'GET',
-                            target_url
-                        )
-                    SyncListPermissionPage.new(@version, response, @solution)
-                    end
-                    
-
-
-                    # Provide a user friendly representation
-                    def to_s
-                        '#<Twilio.Preview.Sync.SyncListPermissionList>'
-                    end
-                end
-
-
-                class SyncListPermissionContext < InstanceContext
-                    ##
-                    # Initialize the SyncListPermissionContext
-                    # @param [Version] version Version that contains the resource
-                    # @param [String] service_sid The unique SID identifier of the Sync Service Instance.
-                    # @param [String] list_sid Identifier of the Sync List. Either a SID or a unique name.
-                    # @param [String] identity Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.
-                    # @return [SyncListPermissionContext] SyncListPermissionContext
-                    def initialize(version, service_sid, list_sid, identity)
-                        super(version)
-
-                        # Path Solution
-                        @solution = { service_sid: service_sid, list_sid: list_sid, identity: identity,  }
-                        @uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Permissions/#{@solution[:identity]}"
-
-                        
-                    end
-                    ##
-                    # Delete the SyncListPermissionInstance
-                    # @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
-
-                    ##
-                    # Fetch the SyncListPermissionInstance
-                    # @return [SyncListPermissionInstance] Fetched SyncListPermissionInstance
-                    def fetch
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        payload = @version.fetch('GET', @uri, headers: headers)
-                        SyncListPermissionInstance.new(
-                            @version,
-                            payload,
-                            service_sid: @solution[:service_sid],
-                            list_sid: @solution[:list_sid],
-                            identity: @solution[:identity],
-                        )
-                    end
-
-                    ##
-                    # Update the SyncListPermissionInstance
-                    # @param [Boolean] read Boolean flag specifying whether the identity can read the Sync List.
-                    # @param [Boolean] write Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.
-                    # @param [Boolean] manage Boolean flag specifying whether the identity can delete the Sync List.
-                    # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
-                    def update(
-                        read: nil, 
-                        write: nil, 
-                        manage: nil
-                    )
-
-                        data = Twilio::Values.of({
-                            'Read' => read,
-                            'Write' => write,
-                            'Manage' => manage,
-                        })
-
-                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
-                        
-                        payload = @version.update('POST', @uri, data: data, headers: headers)
-                        SyncListPermissionInstance.new(
-                            @version,
-                            payload,
-                            service_sid: @solution[:service_sid],
-                            list_sid: @solution[:list_sid],
-                            identity: @solution[:identity],
-                        )
-                    end
-
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Preview.Sync.SyncListPermissionContext #{context}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
-                        "#<Twilio.Preview.Sync.SyncListPermissionContext #{context}>"
-                    end
-                end
-
-                class SyncListPermissionPage < Page
-                    ##
-                    # Initialize the SyncListPermissionPage
-                    # @param [Version] version Version that contains the resource
-                    # @param [Response] response Response from the API
-                    # @param [Hash] solution Path solution for the resource
-                    # @return [SyncListPermissionPage] SyncListPermissionPage
-                    def initialize(version, response, solution)
-                        super(version, response)
-
-                        # Path Solution
-                        @solution = solution
-                    end
-
-                    ##
-                    # Build an instance of SyncListPermissionInstance
-                    # @param [Hash] payload Payload response from the API
-                    # @return [SyncListPermissionInstance] SyncListPermissionInstance
-                    def get_instance(payload)
-                        SyncListPermissionInstance.new(@version, payload, service_sid: @solution[:service_sid], list_sid: @solution[:list_sid])
-                    end
-
-                    ##
-                    # Provide a user friendly representation
-                    def to_s
-                        '<Twilio.Preview.Sync.SyncListPermissionPage>'
-                    end
-                end
-                class SyncListPermissionInstance < InstanceResource
-                    ##
-                    # Initialize the SyncListPermissionInstance
-                    # @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 SyncListPermission
-                    #   resource.
-                    # @param [String] sid The SID of the Call resource to fetch.
-                    # @return [SyncListPermissionInstance] SyncListPermissionInstance
-                    def initialize(version, payload , service_sid: nil, list_sid: nil, identity: nil)
-                        super(version)
-                        
-                        # Marshaled Properties
-                        @properties = { 
-                            'account_sid' => payload['account_sid'],
-                            'service_sid' => payload['service_sid'],
-                            'list_sid' => payload['list_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  || @properties['service_sid']  ,'list_sid' => list_sid  || @properties['list_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
-                    # @return [SyncListPermissionContext] CallContext for this CallInstance
-                    def context
-                        unless @instance_context
-                            @instance_context = SyncListPermissionContext.new(@version , @params['service_sid'], @params['list_sid'], @params['identity'])
-                        end
-                        @instance_context
-                    end
-                    
-                    ##
-                    # @return [String] The unique SID identifier of the Twilio Account.
-                    def account_sid
-                        @properties['account_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The unique SID identifier of the Sync Service Instance.
-                    def service_sid
-                        @properties['service_sid']
-                    end
-                    
-                    ##
-                    # @return [String] The unique SID identifier of the Sync List to which the Permission applies.
-                    def list_sid
-                        @properties['list_sid']
-                    end
-                    
-                    ##
-                    # @return [String] Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.
-                    def identity
-                        @properties['identity']
-                    end
-                    
-                    ##
-                    # @return [Boolean] Boolean flag specifying whether the identity can read the Sync List and its Items.
-                    def read
-                        @properties['read']
-                    end
-                    
-                    ##
-                    # @return [Boolean] Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.
-                    def write
-                        @properties['write']
-                    end
-                    
-                    ##
-                    # @return [Boolean] Boolean flag specifying whether the identity can delete the Sync List.
-                    def manage
-                        @properties['manage']
-                    end
-                    
-                    ##
-                    # @return [String] Contains an absolute URL for this Sync List Permission.
-                    def url
-                        @properties['url']
-                    end
-                    
-                    ##
-                    # Delete the SyncListPermissionInstance
-                    # @return [Boolean] True if delete succeeds, false otherwise
-                    def delete
-
-                        context.delete
-                    end
-
-                    ##
-                    # Fetch the SyncListPermissionInstance
-                    # @return [SyncListPermissionInstance] Fetched SyncListPermissionInstance
-                    def fetch
-
-                        context.fetch
-                    end
-
-                    ##
-                    # Update the SyncListPermissionInstance
-                    # @param [Boolean] read Boolean flag specifying whether the identity can read the Sync List.
-                    # @param [Boolean] write Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.
-                    # @param [Boolean] manage Boolean flag specifying whether the identity can delete the Sync List.
-                    # @return [SyncListPermissionInstance] Updated SyncListPermissionInstance
-                    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.SyncListPermissionInstance #{values}>"
-                    end
-
-                    ##
-                    # Provide a detailed, user friendly representation
-                    def inspect
-                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                        "<Twilio.Preview.Sync.SyncListPermissionInstance #{values}>"
-                    end
-                end
-
-             end
-             end
-            end
-        end
-    end
-end
-
-