##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
#
# frozen_string_literal: true
module Twilio
module REST
class Sync < Domain
class V1 < Version
class ServiceContext < InstanceContext
class SyncListContext < InstanceContext
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class SyncListItemList < ListResource
##
# Initialize the SyncListItemList
# @param [Version] version Version that contains the resource
# @param [String] service_sid The SID of the [Sync
# Service](https://www.twilio.com/docs/sync/api/service) the resource is
# associated with.
# @param [String] list_sid The SID of the Sync List that contains the List Item.
# @return [SyncListItemList] SyncListItemList
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]}/Items"
end
##
# Create the SyncListItemInstance
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
# object that the List Item stores. Can be up to 16KB in length.
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
# this value is ignored.
# @param [String] item_ttl How long, in seconds, before the List Item expires
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
# The default value is `0`, which means the List Item does not expire. The List
# Item will be deleted automatically after it expires, but there can be a delay
# between the expiration time and the resources's deletion.
# @param [String] collection_ttl How long, in seconds, before the List Item's
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
# List does not expire. The Sync List will be deleted automatically after it
# expires, but there can be a delay between the expiration time and the
# resources's deletion.
# @return [SyncListItemInstance] Created SyncListItemInstance
def create(data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
data = Twilio::Values.of({
'Data' => Twilio.serialize_object(data),
'Ttl' => ttl,
'ItemTtl' => item_ttl,
'CollectionTtl' => collection_ttl,
})
payload = @version.create('POST', @uri, data: data)
SyncListItemInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
list_sid: @solution[:list_sid],
)
end
##
# Lists SyncListItemInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [sync_list_item.QueryResultOrder] order How to order the List Items
# returned by their `index` value. Can be: `asc` (ascending) or `desc`
# (descending) and the default is ascending.
# @param [String] from The `index` of the first Sync List Item resource to read.
# See also `bounds`.
# @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
# Item referenced by the `from` parameter or `exclusive` to start with the next
# List Item. The default value is `inclusive`.
# @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: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
end
##
# Streams SyncListItemInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [sync_list_item.QueryResultOrder] order How to order the List Items
# returned by their `index` value. Can be: `asc` (ascending) or `desc`
# (descending) and the default is ascending.
# @param [String] from The `index` of the first Sync List Item resource to read.
# See also `bounds`.
# @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
# Item referenced by the `from` parameter or `exclusive` to start with the next
# List Item. The default value is `inclusive`.
# @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: :unset, from: :unset, bounds: :unset, 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 SyncListItemInstance 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 SyncListItemInstance records from the API.
# Request is executed immediately.
# @param [sync_list_item.QueryResultOrder] order How to order the List Items
# returned by their `index` value. Can be: `asc` (ascending) or `desc`
# (descending) and the default is ascending.
# @param [String] from The `index` of the first Sync List Item resource to read.
# See also `bounds`.
# @param [sync_list_item.QueryFromBoundType] bounds Whether to include the List
# Item referenced by the `from` parameter. Can be: `inclusive` to include the List
# Item referenced by the `from` parameter or `exclusive` to start with the next
# List Item. The default value is `inclusive`.
# @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 SyncListItemInstance
def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'Order' => order,
'From' => from,
'Bounds' => bounds,
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page('GET', @uri, params)
SyncListItemPage.new(@version, response, @solution)
end
##
# Retrieve a single page of SyncListItemInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of SyncListItemInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
SyncListItemPage.new(@version, response, @solution)
end
##
# Provide a user friendly representation
def to_s
'#<Twilio.Sync.V1.SyncListItemList>'
end
end
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class SyncListItemPage < Page
##
# Initialize the SyncListItemPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [SyncListItemPage] SyncListItemPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of SyncListItemInstance
# @param [Hash] payload Payload response from the API
# @return [SyncListItemInstance] SyncListItemInstance
def get_instance(payload)
SyncListItemInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
list_sid: @solution[:list_sid],
)
end
##
# Provide a user friendly representation
def to_s
'<Twilio.Sync.V1.SyncListItemPage>'
end
end
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class SyncListItemContext < InstanceContext
##
# Initialize the SyncListItemContext
# @param [Version] version Version that contains the resource
# @param [String] service_sid The SID of the [Sync
# Service](https://www.twilio.com/docs/sync/api/service) with the Sync List Item
# resource to fetch.
# @param [String] list_sid The SID of the Sync List with the Sync List Item
# resource to fetch. Can be the Sync List resource's `sid` or its `unique_name`.
# @param [String] index The index of the Sync List Item resource to fetch.
# @return [SyncListItemContext] SyncListItemContext
def initialize(version, service_sid, list_sid, index)
super(version)
# Path Solution
@solution = {service_sid: service_sid, list_sid: list_sid, index: index, }
@uri = "/Services/#{@solution[:service_sid]}/Lists/#{@solution[:list_sid]}/Items/#{@solution[:index]}"
end
##
# Fetch the SyncListItemInstance
# @return [SyncListItemInstance] Fetched SyncListItemInstance
def fetch
payload = @version.fetch('GET', @uri)
SyncListItemInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
list_sid: @solution[:list_sid],
index: @solution[:index],
)
end
##
# Delete the SyncListItemInstance
# @param [String] if_match The If-Match HTTP request header
# @return [Boolean] true if delete succeeds, false otherwise
def delete(if_match: :unset)
headers = Twilio::Values.of({'If-Match' => if_match, })
@version.delete('DELETE', @uri, headers: headers)
end
##
# Update the SyncListItemInstance
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
# object that the List Item stores. Can be up to 16KB in length.
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
# this value is ignored.
# @param [String] item_ttl How long, in seconds, before the List Item expires
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
# The default value is `0`, which means the List Item does not expire. The List
# Item will be deleted automatically after it expires, but there can be a delay
# between the expiration time and the resources's deletion.
# @param [String] collection_ttl How long, in seconds, before the List Item's
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
# List does not expire. The Sync List will be deleted automatically after it
# expires, but there can be a delay between the expiration time and the
# resources's deletion.
# @param [String] if_match The If-Match HTTP request header
# @return [SyncListItemInstance] Updated SyncListItemInstance
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
data = Twilio::Values.of({
'Data' => Twilio.serialize_object(data),
'Ttl' => ttl,
'ItemTtl' => item_ttl,
'CollectionTtl' => collection_ttl,
})
headers = Twilio::Values.of({'If-Match' => if_match, })
payload = @version.update('POST', @uri, data: data, headers: headers)
SyncListItemInstance.new(
@version,
payload,
service_sid: @solution[:service_sid],
list_sid: @solution[:list_sid],
index: @solution[:index],
)
end
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Sync.V1.SyncListItemContext #{context}>"
end
##
# Provide a detailed, user friendly representation
def inspect
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Sync.V1.SyncListItemContext #{context}>"
end
end
##
# PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
class SyncListItemInstance < InstanceResource
##
# Initialize the SyncListItemInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] service_sid The SID of the [Sync
# Service](https://www.twilio.com/docs/sync/api/service) the resource is
# associated with.
# @param [String] list_sid The SID of the Sync List that contains the List Item.
# @param [String] index The index of the Sync List Item resource to fetch.
# @return [SyncListItemInstance] SyncListItemInstance
def initialize(version, payload, service_sid: nil, list_sid: nil, index: nil)
super(version)
# Marshaled Properties
@properties = {
'index' => payload['index'].to_i,
'account_sid' => payload['account_sid'],
'service_sid' => payload['service_sid'],
'list_sid' => payload['list_sid'],
'url' => payload['url'],
'revision' => payload['revision'],
'data' => payload['data'],
'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
'created_by' => payload['created_by'],
}
# Context
@instance_context = nil
@params = {
'service_sid' => service_sid,
'list_sid' => list_sid,
'index' => index || @properties['index'],
}
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 [SyncListItemContext] SyncListItemContext for this SyncListItemInstance
def context
unless @instance_context
@instance_context = SyncListItemContext.new(
@version,
@params['service_sid'],
@params['list_sid'],
@params['index'],
)
end
@instance_context
end
##
# @return [String] The automatically generated index of the List Item
def index
@properties['index']
end
##
# @return [String] The SID of the Account that created the resource
def account_sid
@properties['account_sid']
end
##
# @return [String] The SID of the Sync Service that the resource is associated with
def service_sid
@properties['service_sid']
end
##
# @return [String] The SID of the Sync List that contains the List Item
def list_sid
@properties['list_sid']
end
##
# @return [String] The absolute URL of the List Item resource
def url
@properties['url']
end
##
# @return [String] The current revision of the item, represented as a string
def revision
@properties['revision']
end
##
# @return [Hash] An arbitrary, schema-less object that the List Item stores
def data
@properties['data']
end
##
# @return [Time] The ISO 8601 date and time in GMT when the List Item expires
def date_expires
@properties['date_expires']
end
##
# @return [Time] The ISO 8601 date and time in GMT when the resource was created
def date_created
@properties['date_created']
end
##
# @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
def date_updated
@properties['date_updated']
end
##
# @return [String] The identity of the List Item's creator
def created_by
@properties['created_by']
end
##
# Fetch the SyncListItemInstance
# @return [SyncListItemInstance] Fetched SyncListItemInstance
def fetch
context.fetch
end
##
# Delete the SyncListItemInstance
# @param [String] if_match The If-Match HTTP request header
# @return [Boolean] true if delete succeeds, false otherwise
def delete(if_match: :unset)
context.delete(if_match: if_match, )
end
##
# Update the SyncListItemInstance
# @param [Hash] data A JSON string that represents an arbitrary, schema-less
# object that the List Item stores. Can be up to 16KB in length.
# @param [String] ttl An alias for `item_ttl`. If both parameters are provided,
# this value is ignored.
# @param [String] item_ttl How long, in seconds, before the List Item expires
# (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year).
# The default value is `0`, which means the List Item does not expire. The List
# Item will be deleted automatically after it expires, but there can be a delay
# between the expiration time and the resources's deletion.
# @param [String] collection_ttl How long, in seconds, before the List Item's
# parent Sync List expires (time-to-live) and is deleted. Can be an integer from
# 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync
# List does not expire. The Sync List will be deleted automatically after it
# expires, but there can be a delay between the expiration time and the
# resources's deletion.
# @param [String] if_match The If-Match HTTP request header
# @return [SyncListItemInstance] Updated SyncListItemInstance
def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset, if_match: :unset)
context.update(
data: data,
ttl: ttl,
item_ttl: item_ttl,
collection_ttl: collection_ttl,
if_match: if_match,
)
end
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Sync.V1.SyncListItemInstance #{values}>"
end
##
# Provide a detailed, user friendly representation
def inspect
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Sync.V1.SyncListItemInstance #{values}>"
end
end
end
end
end
end
end
end