Class: Twilio::REST::Numbers::V1::SigningRequestConfigurationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ SigningRequestConfigurationList

Initialize the SigningRequestConfigurationList



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 26

def initialize(version)
    super(version)
    # Path Solution
    @solution = {  }
    @uri = "/SigningRequest/Configuration"
    
end

Instance Method Details

#create(body: :unset) ⇒ SigningRequestConfigurationInstance

Create the SigningRequestConfigurationInstance



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 37

def create(body: :unset
)

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

#each ⇒ Object

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



104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 104

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



145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 145

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

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

Lists SigningRequestConfigurationInstance 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
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 67

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

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

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 123

def page(country: :unset, product: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Country' => country,
        'Product' => product,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(country: :unset, product: :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
98
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 89

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

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



156
157
158
 
# File 'lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb', line 156

def to_s
    '#<Twilio.Numbers.V1.SigningRequestConfigurationList>'
end