## # This code was generated by # \ / _ _ _| _ _ # | (_)\/(_)(_|\/| |(/_ v1.0.0 # / / module Twilio module REST class Preview < Domain class Sync < Version class ServiceContext < InstanceContext class SyncMapContext < InstanceContext class SyncMapItemList < ListResource ## # Initialize the SyncMapItemList # @param [Version] version Version that contains the resource # @param [String] service_sid The service_sid # @param [String] map_sid The map_sid # @return [SyncMapItemList] SyncMapItemList def initialize(version, service_sid: nil, map_sid: nil) super(version) # Path Solution @solution = { service_sid: service_sid, map_sid: map_sid } @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items" end ## # Retrieve a single page of SyncMapItemInstance records from the API. # Request is executed immediately. # @param [String] key The key # @param [Hash] data The data # @return [SyncMapItemInstance] Newly created SyncMapItemInstance def create(key: nil, data: nil) data = { 'Key' => key, 'Data' => Twilio.serialize_object(data), } payload = @version.create( 'POST', @uri, data: data ) return SyncMapItemInstance.new( @version, payload, service_sid: @solution[:service_sid], map_sid: @solution[:map_sid], ) end ## # Lists SyncMapItemInstance records from the API as a list. # Unlike stream(), this operation is eager and will load `limit` records into # memory before returning. # @param [sync_map_item.QueryResultOrder] order The order # @param [String] from The from # @param [sync_map_item.QueryFromBoundType] bounds The bounds # @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(order: nil, from: nil, bounds: nil, limit: nil, page_size: nil) self.stream( order: order, from: from, bounds: bounds, limit: limit, page_size: page_size ).entries end ## # Streams SyncMapItemInstance records from the API as an Enumerable. # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [sync_map_item.QueryResultOrder] order The order # @param [String] from The from # @param [sync_map_item.QueryFromBoundType] bounds The bounds # @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(order: nil, from: nil, bounds: nil, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( order: order, from: from, bounds: bounds, page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end ## # When passed a block, yields SyncMapItemInstance records from the API. # This operation lazily loads records as efficiently as possible until the limit # is reached. # @param [sync_map_item.QueryResultOrder] order The order # @param [String] from The from # @param [sync_map_item.QueryFromBoundType] bounds The bounds # @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 SyncMapItemInstance records from the API. # Request is executed immediately. # @param [sync_map_item.QueryResultOrder] order The order # @param [String] from The from # @param [sync_map_item.QueryFromBoundType] bounds The bounds # @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 SyncMapItemInstance def page(order: nil, from: nil, bounds: nil, page_token: nil, page_number: nil, page_size: nil) params = { 'Order' => order, 'From' => from, 'Bounds' => bounds, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, } response = @version.page( 'GET', @uri, params ) return SyncMapItemPage.new(@version, response, @solution) end ## # Provide a user friendly representation def to_s '#' end end class SyncMapItemPage < Page ## # Initialize the SyncMapItemPage # @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 # @param [String] map_sid The map_sid # @return [SyncMapItemPage] SyncMapItemPage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of SyncMapItemInstance # @param [Hash] payload Payload response from the API # @return [SyncMapItemInstance] SyncMapItemInstance def get_instance(payload) return SyncMapItemInstance.new( @version, payload, service_sid: @solution[:service_sid], map_sid: @solution[:map_sid], ) end ## # Provide a user friendly representation def to_s '' end end class SyncMapItemContext < InstanceContext ## # Initialize the SyncMapItemContext # @param [Version] version Version that contains the resource # @param [String] service_sid The service_sid # @param [String] map_sid The map_sid # @param [String] key The key # @return [SyncMapItemContext] SyncMapItemContext def initialize(version, service_sid, map_sid, key) super(version) # Path Solution @solution = { service_sid: service_sid, map_sid: map_sid, key: key, } @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items/#{@solution[:key]}" end ## # Fetch a SyncMapItemInstance # @return [SyncMapItemInstance] Fetched SyncMapItemInstance def fetch params = {} payload = @version.fetch( 'GET', @uri, params, ) return SyncMapItemInstance.new( @version, payload, service_sid: @solution[:service_sid], map_sid: @solution[:map_sid], key: @solution[:key], ) end ## # Deletes the SyncMapItemInstance # @return [Boolean] true if delete succeeds, true otherwise def delete return @version.delete('delete', @uri) end ## # Update the SyncMapItemInstance # @param [Hash] data The data # @return [SyncMapItemInstance] Updated SyncMapItemInstance def update(data: nil) data = { 'Data' => Twilio.serialize_object(data), } payload = @version.update( 'POST', @uri, data: data, ) return SyncMapItemInstance.new( @version, payload, service_sid: @solution[:service_sid], map_sid: @solution[:map_sid], key: @solution[:key], ) end ## # Provide a user friendly representation def to_s context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') "#" end end class SyncMapItemInstance < InstanceResource ## # Initialize the SyncMapItemInstance # @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] map_sid The map_sid # @param [String] key The key # @return [SyncMapItemInstance] SyncMapItemInstance def initialize(version, payload, service_sid: nil, map_sid: nil, key: nil) super(version) # Marshaled Properties @properties = { 'key' => payload['key'], 'account_sid' => payload['account_sid'], 'service_sid' => payload['service_sid'], 'map_sid' => payload['map_sid'], 'url' => payload['url'], '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 = { 'service_sid' => service_sid, 'map_sid' => map_sid, 'key' => key || @properties['key'], } 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 [SyncMapItemContext] SyncMapItemContext for this SyncMapItemInstance def context unless @instance_context @instance_context = SyncMapItemContext.new( @version, @params['service_sid'], @params['map_sid'], @params['key'], ) end @instance_context end def key @properties['key'] end def account_sid @properties['account_sid'] end def service_sid @properties['service_sid'] end def map_sid @properties['map_sid'] end def url @properties['url'] 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 SyncMapItemInstance # @return [SyncMapItemInstance] Fetched SyncMapItemInstance def fetch context.fetch end ## # Deletes the SyncMapItemInstance # @return [Boolean] true if delete succeeds, true otherwise def delete context.delete end ## # Update the SyncMapItemInstance # @param [Hash] data The data # @return [SyncMapItemInstance] Updated SyncMapItemInstance def update(data: nil) context.update( data: data, ) end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end end