##
# 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 SyncMapContext < InstanceContext
            ##
            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
            class SyncMapItemList < ListResource
              ##
              # Initialize the SyncMapItemList
              # @param [Version] version Version that contains the resource
              # @param [String] service_sid The unique SID identifier of the Service Instance
              #   that hosts this Map object.
              # @param [String] map_sid The unique 34-character SID identifier of the Map
              #   containing this Item.
              # @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 unique user-defined key of this Map Item. Up to 256
              #   characters long.
              # @param [Hash] data Contains arbitrary user-defined, schema-less data that this
              #   Map Item stores, represented by a JSON object, up to 16KB.
              # @param [String] ttl Alias for item_ttl. If both are provided, this value is
              #   ignored.
              # @param [String] item_ttl Time-to-live of this item in seconds, defaults to no
              #   expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
              #   expiry, the map item will be cleaned up at least in a matter of hours, and often
              #   within seconds, making this a good tool for garbage management.
              # @param [String] collection_ttl Time-to-live of this item's parent Map in
              #   seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0
              #   for infinity. This parameter can only be used when the map item's data or ttl is
              #   updated in the same request.
              # @return [SyncMapItemInstance] Newly created SyncMapItemInstance
              def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
                data = Twilio::Values.of({
                    'Key' => key,
                    'Data' => Twilio.serialize_object(data),
                    'Ttl' => ttl,
                    'ItemTtl' => item_ttl,
                    'CollectionTtl' => collection_ttl,
                })

                payload = @version.create(
                    'POST',
                    @uri,
                    data: data
                )

                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 A string; asc or desc. Map Items
              #   are [ordered
              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
              #   key.
              # @param [String] from The Item key offset (including the specified key). If not
              #   present, query is performed from the start or end, depending on the Order query
              #   parameter.
              # @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: :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 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 A string; asc or desc. Map Items
              #   are [ordered
              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
              #   key.
              # @param [String] from The Item key offset (including the specified key). If not
              #   present, query is performed from the start or end, depending on the Order query
              #   parameter.
              # @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: :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 SyncMapItemInstance 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 SyncMapItemInstance records from the API.
              # Request is executed immediately.
              # @param [sync_map_item.QueryResultOrder] order A string; asc or desc. Map Items
              #   are [ordered
              #   lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item
              #   key.
              # @param [String] from The Item key offset (including the specified key). If not
              #   present, query is performed from the start or end, depending on the Order query
              #   parameter.
              # @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: :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
                )
                SyncMapItemPage.new(@version, response, @solution)
              end

              ##
              # Retrieve a single page of SyncMapItemInstance records from the API.
              # Request is executed immediately.
              # @param [String] target_url API-generated URL for the requested results page
              # @return [Page] Page of SyncMapItemInstance
              def get_page(target_url)
                response = @version.domain.request(
                    'GET',
                    target_url
                )
                SyncMapItemPage.new(@version, response, @solution)
              end

              ##
              # Provide a user friendly representation
              def to_s
                '#<Twilio.Sync.V1.SyncMapItemList>'
              end
            end

            ##
            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
            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
              # @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)
                SyncMapItemInstance.new(
                    @version,
                    payload,
                    service_sid: @solution[:service_sid],
                    map_sid: @solution[:map_sid],
                )
              end

              ##
              # Provide a user friendly representation
              def to_s
                '<Twilio.Sync.V1.SyncMapItemPage>'
              end
            end

            ##
            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
            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 = Twilio::Values.of({})

                payload = @version.fetch(
                    'GET',
                    @uri,
                    params,
                )

                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
                @version.delete('delete', @uri)
              end

              ##
              # Update the SyncMapItemInstance
              # @param [Hash] data Contains an arbitrary JSON object to be stored in this Map
              #   Item. Serialized to string to respect HTTP form input, up to 16KB.
              # @param [String] ttl Alias for item_ttl. If both are provided, this value is
              #   ignored.
              # @param [String] item_ttl Time-to-live of this item in seconds, defaults to no
              #   expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
              #   expiry, the map item will be cleaned up at least in a matter of hours, and often
              #   within seconds, making this a good tool for garbage management.
              # @param [String] collection_ttl Time-to-live of this item's parent Map in
              #   seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0
              #   for infinity. This parameter can only be used when the map item's data or ttl is
              #   updated in the same request.
              # @return [SyncMapItemInstance] Updated SyncMapItemInstance
              def update(data: :unset, 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.update(
                    'POST',
                    @uri,
                    data: data,
                )

                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(',')
                "#<Twilio.Sync.V1.SyncMapItemContext #{context}>"
              end
            end

            ##
            # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
            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 unique SID identifier of the Service Instance
              #   that hosts this Map object.
              # @param [String] map_sid The unique 34-character SID identifier of the Map
              #   containing this Item.
              # @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_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, '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
              # @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

              ##
              # @return [String] The unique user-defined key of this Map Item.
              def key
                @properties['key']
              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 Service Instance that hosts this Map object.
              def service_sid
                @properties['service_sid']
              end

              ##
              # @return [String] The unique 34-character SID identifier of the Map containing this Item.
              def map_sid
                @properties['map_sid']
              end

              ##
              # @return [String] The absolute URL for this Map.
              def url
                @properties['url']
              end

              ##
              # @return [String] Contains the current revision of this Map, represented by a string identifier.
              def revision
                @properties['revision']
              end

              ##
              # @return [Hash] Contains arbitrary user-defined, schema-less data that this Map Item stores, represented by a JSON object, up to 16KB.
              def data
                @properties['data']
              end

              ##
              # @return [Time] Contains the date this Map expires and gets deleted automatically.
              def date_expires
                @properties['date_expires']
              end

              ##
              # @return [Time] The date this Map was created, given in UTC ISO 8601 format.
              def date_created
                @properties['date_created']
              end

              ##
              # @return [Time] Specifies the date this Map was last updated, given in UTC ISO 8601 format.
              def date_updated
                @properties['date_updated']
              end

              ##
              # @return [String] The identity of the Map creator.
              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 Contains an arbitrary JSON object to be stored in this Map
              #   Item. Serialized to string to respect HTTP form input, up to 16KB.
              # @param [String] ttl Alias for item_ttl. If both are provided, this value is
              #   ignored.
              # @param [String] item_ttl Time-to-live of this item in seconds, defaults to no
              #   expiration. In the range [1, 31 536 000 (1 year)], or 0 for infinity. Upon
              #   expiry, the map item will be cleaned up at least in a matter of hours, and often
              #   within seconds, making this a good tool for garbage management.
              # @param [String] collection_ttl Time-to-live of this item's parent Map in
              #   seconds, defaults to no expiration. In the range [1, 31 536 000 (1 year)], or 0
              #   for infinity. This parameter can only be used when the map item's data or ttl is
              #   updated in the same request.
              # @return [SyncMapItemInstance] Updated SyncMapItemInstance
              def update(data: :unset, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
                context.update(data: data, ttl: ttl, item_ttl: item_ttl, collection_ttl: collection_ttl, )
              end

              ##
              # Provide a user friendly representation
              def to_s
                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
                "<Twilio.Sync.V1.SyncMapItemInstance #{values}>"
              end

              ##
              # Provide a detailed, user friendly representation
              def inspect
                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
                "<Twilio.Sync.V1.SyncMapItemInstance #{values}>"
              end
            end
          end
        end
      end
    end
  end
end