Class: Twilio::REST::Notify::V1::ServiceContext::UserContext::UserBindingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/user/user_binding.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, identity: nil) ⇒ UserBindingList

Initialize the UserBindingList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The service_sid

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

    The identity



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 22

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

  # Path Solution
  @solution = {
      service_sid: service_sid,
      identity: identity
  }
  @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}/Bindings"
end

Instance Method Details

#create(binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset) ⇒ UserBindingInstance

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

Parameters:

  • binding_type (user_binding.BindingType) (defaults to: nil) —

    The binding_type

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

    The address

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

    The tag

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

    The notification_protocol_version

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

    The credential_sid

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

    The endpoint

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 43

def create(binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset)
  data = Twilio::Values.of({
      'BindingType' => binding_type,
      'Address' => address,
      'Tag' => tag,
      'NotificationProtocolVersion' => notification_protocol_version,
      'CredentialSid' => credential_sid,
      'Endpoint' => endpoint,
  })

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

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

#each ⇒ Object

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



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

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 UserBindingInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of UserBindingInstance



166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 166

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

#list(start_date: :unset, end_date: :unset, tag: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

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

    The tag

  • 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



81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 81

def list(start_date: :unset, end_date: :unset, tag: :unset, limit: nil, page_size: nil)
  self.stream(
      start_date: start_date,
      end_date: end_date,
      tag: tag,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(start_date: :unset, end_date: :unset, tag: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

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

    The tag

  • 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 UserBindingInstance



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 144

def page(start_date: :unset, end_date: :unset, tag: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'StartDate' => Twilio.serialize_iso8601_date(start_date),
      'EndDate' => Twilio.serialize_iso8601_date(end_date),
      'Tag' => tag,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  UserBindingPage.new(@version, response, @solution)
end

#stream(start_date: :unset, end_date: :unset, tag: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • start_date (Date) (defaults to: :unset) —

    The start_date

  • end_date (Date) (defaults to: :unset) —

    The end_date

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

    The tag

  • 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



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 105

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

  page = self.page(
      start_date: start_date,
      end_date: end_date,
      tag: tag,
      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



176
177
178
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user/user_binding.rb', line 176

def to_s
  '#<Twilio.Notify.V1.UserBindingList>'
end