Class: Reach::REST::Api::Authentix::AuthenticationTrialItemList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AuthenticationTrialItemList

Initialize the AuthenticationTrialItemList

Parameters:

  • version (Version) —

    Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/authentix/v1/authenticationTrials"
    
end

Instance Method Details

#each ⇒ Object

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



112
113
114
115
116
117
118
119
120
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 112

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of AuthenticationTrialItemInstance



173
174
175
176
177
178
179
180
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 173

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

#list(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

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

    Retrieve authentication trials sent only to this phone number or email. The phone number must be in the E.164 format.

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

    Retrieve authentication trials with the specified status.

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

    Retrieve authentication trials sent via the specified channel.

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

    Retrieve authentication trials from the configuration whose ID matches the specified one.

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

    Retrieve authentication trials from the authentication whose ID matches the specified one.

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

    Retrieve authentication trials sent to the specified destination country (in ISO 3166-1 alpha-2). Only possible when ‘dest` is a phone number.

  • sent_at (Time) (defaults to: :unset) —

    Retrieve only authentication trials created at the specified date. Must be in ISO 8601 format.

  • sent_after (Time) (defaults to: :unset) —

    Retrieve only authentication trials created after the specified datetime. Must be in ISO 8601 format.

  • sent_before (Time) (defaults to: :unset) —

    Retrieve only authentication trials created before the specified datetime. Must be in ISO 8601 format.

  • 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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 54

def list(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, limit: nil, page_size: nil)
    self.stream(
        dest: dest,
        trial_status: trial_status,
        channel: channel,
        configuration_id: configuration_id,
        authentication_id: authentication_id,
        country: country,
        sent_at: sent_at,
        sent_after: sent_after,
        sent_before: sent_before,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

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

    Retrieve authentication trials sent only to this phone number or email. The phone number must be in the E.164 format.

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

    Retrieve authentication trials with the specified status.

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

    Retrieve authentication trials sent via the specified channel.

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

    Retrieve authentication trials from the configuration whose ID matches the specified one.

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

    Retrieve authentication trials from the authentication whose ID matches the specified one.

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

    Retrieve authentication trials sent to the specified destination country (in ISO 3166-1 alpha-2). Only possible when ‘dest` is a phone number.

  • sent_at (Time) (defaults to: :unset) —

    Retrieve only authentication trials created at the specified date. Must be in ISO 8601 format.

  • sent_after (Time) (defaults to: :unset) —

    Retrieve only authentication trials created after the specified datetime. Must be in ISO 8601 format.

  • sent_before (Time) (defaults to: :unset) —

    Retrieve only authentication trials created before the specified datetime. Must be in ISO 8601 format.

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

Returns:

  • (Page) —

    Page of AuthenticationTrialItemInstance



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 137

def page(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Reach::Values.of({
        
        'dest' => dest,
        
        'trialStatus' => trial_status,
        
        'channel' => channel,
        
        'configurationId' => configuration_id,
        
        'authenticationId' => authentication_id,
        
        'country' => country,
        
        'sentAt' =>  Reach.serialize_iso8601_datetime(sent_at),
        
        'sentAfter' =>  Reach.serialize_iso8601_datetime(sent_after),
        
        'sentBefore' =>  Reach.serialize_iso8601_datetime(sent_before),
        
        'page' => page_number,
        'pageSize' => page_size,
    })

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

    AuthenticationTrialItemPage.new(baseUrl, @version, response, @solution)
end

#stream(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

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

    Retrieve authentication trials sent only to this phone number or email. The phone number must be in the E.164 format.

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

    Retrieve authentication trials with the specified status.

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

    Retrieve authentication trials sent via the specified channel.

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

    Retrieve authentication trials from the configuration whose ID matches the specified one.

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

    Retrieve authentication trials from the authentication whose ID matches the specified one.

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

    Retrieve authentication trials sent to the specified destination country (in ISO 3166-1 alpha-2). Only possible when ‘dest` is a phone number.

  • sent_at (Time) (defaults to: :unset) —

    Retrieve only authentication trials created at the specified date. Must be in ISO 8601 format.

  • sent_after (Time) (defaults to: :unset) —

    Retrieve only authentication trials created after the specified datetime. Must be in ISO 8601 format.

  • sent_before (Time) (defaults to: :unset) —

    Retrieve only authentication trials created before the specified datetime. Must be in ISO 8601 format.

  • 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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 90

def stream(dest: :unset, trial_status: :unset, channel: :unset, configuration_id: :unset, authentication_id: :unset, country: :unset, sent_at: :unset, sent_after: :unset, sent_before: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        dest: dest,
        trial_status: trial_status,
        channel: channel,
        configuration_id: configuration_id,
        authentication_id: authentication_id,
        country: country,
        sent_at: sent_at,
        sent_after: sent_after,
        sent_before: sent_before,
        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



185
186
187
 
# File 'lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb', line 185

def to_s
    '#<Reach.Api.Authentix.AuthenticationTrialItemList>'
end