Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ SyncMapList

Initialize the SyncMapList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The SID of the Sync Service the resource is associated with.



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 24

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Maps"
end

Instance Method Details

#create(unique_name: :unset, ttl: :unset, collection_ttl: :unset) ⇒ SyncMapInstance

Create the SyncMapInstance

Parameters:

  • unique_name (String) (defaults to: :unset) —

    An application-defined string that uniquely identifies the resource. It can be used as an alternative to the ‘sid` in the URL path to address the resource.

  • ttl (String) (defaults to: :unset) —

    An alias for ‘collection_ttl`. If both parameters are provided, this value is ignored.

  • collection_ttl (String) (defaults to: :unset) —

    How long, in seconds, before the Sync Map 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 Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources’s deletion.

Returns:



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 45

def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset)
  data = Twilio::Values.of({
      'UniqueName' => unique_name,
      'Ttl' => ttl,
      'CollectionTtl' => collection_ttl,
  })

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

  SyncMapInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

When passed a block, yields SyncMapInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 101

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

#get_page(target_url) ⇒ Page

Retrieve a single page of SyncMapInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SyncMapInstance



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 139

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  SyncMapPage.new(@version, response, @solution)
end

#list(hide_expired: :unset, limit: nil, page_size: nil) ⇒ Array

Lists SyncMapInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

  • hide_expired (sync_map.HideExpiredType) (defaults to: :unset) —

    The default list of Sync Maps will show both active and expired items. It is possible to filter only the active ones by hiding the expired ones.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results



71
72
73
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 71

def list(hide_expired: :unset, limit: nil, page_size: nil)
  self.stream(hide_expired: hide_expired, limit: limit, page_size: page_size).entries
end

#page(hide_expired: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SyncMapInstance records from the API. Request is executed immediately.

Parameters:

  • hide_expired (sync_map.HideExpiredType) (defaults to: :unset) —

    The default list of Sync Maps will show both active and expired items. It is possible to filter only the active ones by hiding the expired ones.

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of SyncMapInstance



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 121

def page(hide_expired: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'HideExpired' => hide_expired,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  SyncMapPage.new(@version, response, @solution)
end

#stream(hide_expired: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams SyncMapInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • hide_expired (sync_map.HideExpiredType) (defaults to: :unset) —

    The default list of Sync Maps will show both active and expired items. It is possible to filter only the active ones by hiding the expired ones.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 89

def stream(hide_expired: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(hide_expired: hide_expired, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



149
150
151
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map.rb', line 149

def to_s
  '#<Twilio.Sync.V1.SyncMapList>'
end