Class: Twilio::REST::Authy::V1::ServiceContext::EntityContext::FactorList

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

    Customer unique identity for the Entity owner of the Factor



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 25

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) ⇒ FactorInstance

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

Parameters:

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

    A unique binding for this Factor that identifies it. E.g. a phone number for ‘sms` 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. One of ‘app-push`, `sms`, `totp`, etc.

  • 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

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 46

def create(binding: nil, friendly_name: nil, factor_type: nil, config: nil)
  data = Twilio::Values.of({
      'Binding' => binding,
      'FriendlyName' => friendly_name,
      'FactorType' => factor_type,
      'Config' => config,
  })

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

  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.



106
107
108
109
110
111
112
113
114
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 106

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



142
143
144
145
146
147
148
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 142

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

#list(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:

  • 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



79
80
81
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 79

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

#page(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:

  • 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



123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 123

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  FactorPage.new(@version, response, @solution)
end

#stream(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:

  • 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



94
95
96
97
98
99
100
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 94

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

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



152
153
154
 
# File 'lib/twilio-ruby/rest/authy/v1/service/entity/factor.rb', line 152

def to_s
  '#<Twilio.Authy.V1.FactorList>'
end