Class: Twilio::REST::Api::V2010::AccountContext::SipList::DomainContext::CredentialListMappingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid: nil, domain_sid: nil) ⇒ CredentialListMappingList

Initialize the CredentialListMappingList

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) (defaults to: nil) —

    The account_sid

  • domain_sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies the SIP domain in Twilio



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 22

def initialize(version, account_sid: nil, domain_sid: nil)
  super(version)

  # Path Solution
  @solution = {
      account_sid: ,
      domain_sid: domain_sid
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:domain_sid]}/CredentialListMappings.json"
end

Instance Method Details

#create(credential_list_sid: nil) ⇒ CredentialListMappingInstance

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

Parameters:

  • credential_list_sid (String) (defaults to: nil) —

    The credential_list_sid

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 38

def create(credential_list_sid: nil)
  data = Twilio::Values.of({
      'CredentialListSid' => credential_list_sid,
  })

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

  CredentialListMappingInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      domain_sid: @solution[:domain_sid],
  )
end

#each ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 100

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of CredentialListMappingInstance



138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 138

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

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

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

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



68
69
70
71
72
73
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 68

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

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

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

Parameters:

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



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 119

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  CredentialListMappingPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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

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:

  • (Enumerable) —

    Enumerable that will yield up to limit results



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 86

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

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



148
149
150
 
# File 'lib/twilio-ruby/rest/api/v2010/account/sip/domain/credential_list_mapping.rb', line 148

def to_s
  '#<Twilio.Api.V2010.CredentialListMappingList>'
end