Class: Twilio::REST::Trusthub::V1::CustomerProfilesList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CustomerProfilesList

Initialize the CustomerProfilesList

Parameters:

  • version (Version)

    Version that contains the resource


18
19
20
21
22
23
24
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/CustomerProfiles"
end

Instance Method Details

#create(friendly_name: nil, email: nil, policy_sid: nil, status_callback: :unset) ⇒ CustomerProfilesInstance

Create the CustomerProfilesInstance

Parameters:

  • friendly_name (String) (defaults to: nil)

    The string that you assigned to describe the resource.

  • email (String) (defaults to: nil)

    The email address that will receive updates when the Customer-Profile resource changes status.

  • policy_sid (String) (defaults to: nil)

    The unique string of a policy that is associated to the Customer-Profile resource.

  • status_callback (String) (defaults to: :unset)

    The URL we call to inform your application of status changes.

Returns:


37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 37

def create(friendly_name: nil, email: nil, policy_sid: nil, status_callback: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'Email' => email,
      'PolicySid' => policy_sid,
      'StatusCallback' => status_callback,
  })

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

  CustomerProfilesInstance.new(@version, payload, )
end

#eachObject

When passed a block, yields CustomerProfilesInstance 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/trusthub/v1/customer_profiles.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 CustomerProfilesInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of CustomerProfilesInstance


154
155
156
157
158
159
160
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 154

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

#list(status: :unset, friendly_name: :unset, policy_sid: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • status (customer_profiles.Status) (defaults to: :unset)

    The verification status of the Customer-Profile resource.

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • policy_sid (String) (defaults to: :unset)

    The unique string of a policy that is associated to the Customer-Profile resource.

  • 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


67
68
69
70
71
72
73
74
75
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 67

def list(status: :unset, friendly_name: :unset, policy_sid: :unset, limit: nil, page_size: nil)
  self.stream(
      status: status,
      friendly_name: friendly_name,
      policy_sid: policy_sid,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(status: :unset, friendly_name: :unset, policy_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • status (customer_profiles.Status) (defaults to: :unset)

    The verification status of the Customer-Profile resource.

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • policy_sid (String) (defaults to: :unset)

    The unique string of a policy that is associated to the Customer-Profile resource.

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


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

def page(status: :unset, friendly_name: :unset, policy_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Status' => status,
      'FriendlyName' => friendly_name,
      'PolicySid' => policy_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(status: :unset, friendly_name: :unset, policy_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • status (customer_profiles.Status) (defaults to: :unset)

    The verification status of the Customer-Profile resource.

  • friendly_name (String) (defaults to: :unset)

    The string that you assigned to describe the resource.

  • policy_sid (String) (defaults to: :unset)

    The unique string of a policy that is associated to the Customer-Profile resource.

  • 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
101
102
103
104
105
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 94

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

  page = self.page(
      status: status,
      friendly_name: friendly_name,
      policy_sid: policy_sid,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


164
165
166
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles.rb', line 164

def to_s
  '#<Twilio.Trusthub.V1.CustomerProfilesList>'
end