Class: Twilio::REST::Trusthub::V1::CustomerProfilesContext::CustomerProfilesEntityAssignmentsList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, customer_profile_sid: nil) ⇒ CustomerProfilesEntityAssignmentsList

Initialize the CustomerProfilesEntityAssignmentsList



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 28

def initialize(version, customer_profile_sid: nil)
    super(version)
    # Path Solution
    @solution = { customer_profile_sid: customer_profile_sid }
    @uri = "/CustomerProfiles/#{@solution[:customer_profile_sid]}/EntityAssignments"
    
end

Instance Method Details

#create(object_sid: nil) ⇒ CustomerProfilesEntityAssignmentsInstance

Create the CustomerProfilesEntityAssignmentsInstance



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 39

def create(
    object_sid: nil
)

    data = Twilio::Values.of({
        'ObjectSid' => object_sid,
    })

    
    payload = @version.create('POST', @uri, data: data)
    CustomerProfilesEntityAssignmentsInstance.new(
        @version,
        payload,
        customer_profile_sid: @solution[:customer_profile_sid],
    )
end

#each ⇒ Object

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



103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 103

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



139
140
141
142
143
144
145
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 139

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

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

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



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

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

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

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



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 121

def page(object_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'ObjectType' => object_type,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

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



89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 89

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

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



150
151
152
 
# File 'lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_entity_assignments.rb', line 150

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