Class: Twilio::REST::Trusthub::V1::TrustProductsList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ TrustProductsList

Initialize the TrustProductsList



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

def initialize(version)
  super(version)

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

Instance Method Details

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

Create the TrustProductsInstance



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products.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)

  TrustProductsInstance.new(@version, payload, )
end

#each ⇒ Object

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



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

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

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

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



67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products.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 TrustProductsInstance records from the API. Request is executed immediately.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products.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)

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

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

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



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/twilio-ruby/rest/trusthub/v1/trust_products.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_s ⇒ Object

Provide a user friendly representation



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

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