Class: Twilio::REST::Verify::V2::ServiceContext::EntityContext::FactorList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, identity: nil) ⇒ FactorList

Initialize the FactorList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique SID identifier of the Service.

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

    The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user’s UUID, GUID, or SID.



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 26

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

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

Instance Method Details

#create(binding: nil, friendly_name: nil, factor_type: nil, config: nil, twilio_sandbox_mode: :unset, authorization: :unset) ⇒ FactorInstance

Create the FactorInstance

Parameters:

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

    A unique binding for this Factor that identifies it. E.g. the algorithm and public key for ‘push` factors. It must be a json string with the required properties for the given factor type. Required when creating a new Factor. This value is never returned because it can contain customer secrets.

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

    The friendly name of this Factor

  • factor_type (factor.FactorTypes) (defaults to: nil) —

    The Type of this Factor. Currently only ‘push` is supported

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

    The config required for this Factor. It must be a json string with the required properties for the given factor type

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

    The Twilio-Sandbox-Mode HTTP request header

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

    The Authorization HTTP request header

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 49

def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil, twilio_sandbox_mode: :unset, authorization: :unset)
  data = Twilio::Values.of({
      'Binding' => binding,
      'FriendlyName' => friendly_name,
      'FactorType' => factor_type,
      'Config' => config,
  })
  headers = Twilio::Values.of({
      'Twilio-Sandbox-Mode' => twilio_sandbox_mode,
      'Authorization' => authorization,
  })

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

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

#each ⇒ Object

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



111
112
113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 111

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of FactorInstance



147
148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 147

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

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

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

Parameters:

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

    The Twilio-Sandbox-Mode HTTP request header

  • 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



83
84
85
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 83

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

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

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

Parameters:

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

    The Twilio-Sandbox-Mode HTTP request header

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



129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 129

def page(twilio_sandbox_mode: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  headers = Twilio::Values.of({'Twilio-Sandbox-Mode' => twilio_sandbox_mode, })

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

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

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

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

Parameters:

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

    The Twilio-Sandbox-Mode HTTP request header

  • 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



99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 99

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

  page = self.page(twilio_sandbox_mode: twilio_sandbox_mode, 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



157
158
159
 
# File 'lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb', line 157

def to_s
  '#<Twilio.Verify.V2.FactorList>'
end