Class: Twilio::REST::PreviewIam::Versionless::OrganizationContext::RoleAssignmentList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb

Defined Under Namespace

Classes: PublicApiCreateRoleAssignmentRequest

Instance Method Summary collapse

Constructor Details

#initialize(version, organization_sid: nil) ⇒ RoleAssignmentList

Initialize the RoleAssignmentList



48
49
50
51
52
53
54
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 48

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

Instance Method Details

#create(public_api_create_role_assignment_request: nil) ⇒ RoleAssignmentInstance

Create the RoleAssignmentInstance



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 59

def create(public_api_create_role_assignment_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
     headers['Accept'] = '*/*'
    payload = @version.create('POST', @uri, headers: headers, data: public_api_create_role_assignment_request.to_json)
    RoleAssignmentInstance.new(
        @version,
        payload,
        organization_sid: @solution[:organization_sid],
    )
end

#each ⇒ Object

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



127
128
129
130
131
132
133
134
135
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 127

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



168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 168

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

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

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



90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 90

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

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

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 146

def page(identity: :unset, scope: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Identity' => identity,
        'Scope' => scope,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(identity: :unset, scope: :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.



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 112

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

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



179
180
181
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 179

def to_s
    '#<Twilio.PreviewIam.Versionless.RoleAssignmentList>'
end