Class: Twilio::REST::Supersim::V1::EsimProfileList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ EsimProfileList

Initialize the EsimProfileList



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

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

Instance Method Details

#create(callback_url: :unset, callback_method: :unset, generate_matching_id: :unset, eid: :unset) ⇒ EsimProfileInstance

Create the EsimProfileInstance



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 40

def create(
    callback_url: :unset, 
    callback_method: :unset, 
    generate_matching_id: :unset, 
    eid: :unset
)

    data = Twilio::Values.of({
        'CallbackUrl' => callback_url,
        'CallbackMethod' => callback_method,
        'GenerateMatchingId' => generate_matching_id,
        'Eid' => eid,
    })

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

#each ⇒ Object

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



118
119
120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 118

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



158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 158

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

#list(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil) ⇒ Array

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



78
79
80
81
82
83
84
85
86
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 78

def list(eid: :unset, sim_sid: :unset, status: :unset, limit: nil, page_size: nil)
    self.stream(
        eid: eid,
        sim_sid: sim_sid,
        status: status,
        limit: limit,
        page_size: page_size
    ).entries
end

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

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 138

def page(eid: :unset, sim_sid: :unset, status: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'Eid' => eid,
        'SimSid' => sim_sid,
        'Status' => status,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })

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

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

#stream(eid: :unset, sim_sid: :unset, status: :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.



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 102

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

    page = self.page(
        eid: eid,
        sim_sid: sim_sid,
        status: status,
        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



169
170
171
 
# File 'lib/twilio-ruby/rest/supersim/v1/esim_profile.rb', line 169

def to_s
    '#<Twilio.Supersim.V1.EsimProfileList>'
end