Class: Twilio::REST::Notify::V1::ServiceContext::BindingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/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) ⇒ BindingList

Initialize the BindingList

Parameters:



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

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

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

Instance Method Details

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

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

Parameters:

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

    The ‘identity` value that uniquely identifies the new resource’s [User](www.twilio.com/docs/chat/rest/users) within the [Service](www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.

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

    The transport technology to use for the Binding. Can be: ‘apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.

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

    The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.

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

    A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.

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

    The protocol version to use to send the notification. This defaults to the value of ‘default_xxxx_notification_protocol_version` for the protocol in the [Service](www.twilio.com/docs/notify/api/service-resource). The current version is `“3”` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.

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

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only ‘apn`, `fcm`, and `gcm` type Bindings.

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

    Deprecated.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 61

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

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

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

#each ⇒ Object

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 152

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of BindingInstance



202
203
204
205
206
207
208
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 202

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

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

Lists BindingInstance 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) —

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    Only include usage that occurred on or before this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    The [User](www.twilio.com/docs/chat/rest/users)‘s `identity` value of the resources to read.

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

    Only list Bindings that have all of the specified Tags. The following implicit tags are available: ‘all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.

  • 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



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 102

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

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

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

Parameters:

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

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    Only include usage that occurred on or before this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    The [User](www.twilio.com/docs/chat/rest/users)‘s `identity` value of the resources to read.

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

    Only list Bindings that have all of the specified Tags. The following implicit tags are available: ‘all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 179

def page(start_date: :unset, end_date: :unset, identity: :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),
      'Identity' => Twilio.serialize_list(identity) { |e| e },
      'Tag' => Twilio.serialize_list(tag) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  BindingPage.new(@version, response, @solution)
end

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

Streams BindingInstance 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) —

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    Only include usage that occurred on or before this date. Specify the date in GMT and format as ‘YYYY-MM-DD`.

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

    The [User](www.twilio.com/docs/chat/rest/users)‘s `identity` value of the resources to read.

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

    Only list Bindings that have all of the specified Tags. The following implicit tags are available: ‘all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.

  • 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



134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 134

def stream(start_date: :unset, end_date: :unset, identity: :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,
      identity: identity,
      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



212
213
214
 
# File 'lib/twilio-ruby/rest/notify/v1/service/binding.rb', line 212

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