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

Parameters:

  • version (Version) —

    Version that contains the resource



48
49
50
51
52
53
54
55
 
# 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

Parameters:

Returns:



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

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

#create_with_metadata(public_api_create_role_assignment_request: nil) ⇒ RoleAssignmentInstance

Create the RoleAssignmentInstanceMetadata

Parameters:

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 81

def create_with_metadata(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'] = '*/*'
    response = @version.create_with_metadata('POST', @uri, headers: headers, data: public_api_create_role_assignment_request.to_json)
    role_assignment_instance = RoleAssignmentInstance.new(
        @version,
        response.body,
        organization_sid: @solution[:organization_sid],
    )
    RoleAssignmentInstanceMetadata.new(
        @version,
        role_assignment_instance,
        response.headers,
        response.status_code
    )
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.



181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 181

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of RoleAssignmentInstance



222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 222

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.

Parameters:

  • identity (String) (defaults to: :unset)
  • scope (String) (defaults to: :unset)
  • 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



118
119
120
121
122
123
124
125
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 118

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

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

Returns Array of up to limit results.

Parameters:

  • 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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 162

def list_with_metadata(identity: :unset, scope: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Identity' => identity,
        'Scope' => scope,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    RoleAssignmentPageMetadata.new(@version, response, @solution, limits[:limit])
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.

Parameters:

  • identity (String) (defaults to: :unset)
  • scope (String) (defaults to: :unset)
  • 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 RoleAssignmentInstance



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 200

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.

Parameters:

  • identity (String) (defaults to: :unset)
  • scope (String) (defaults to: :unset)
  • 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



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 140

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



233
234
235
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/role_assignment.rb', line 233

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