Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleContext::BundleCopyList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, bundle_sid: nil) ⇒ BundleCopyList

Initialize the BundleCopyList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 29

def initialize(version, bundle_sid: nil)
    super(version)
    # Path Solution
    @solution = { bundle_sid: bundle_sid }
    @uri = "/RegulatoryCompliance/Bundles/#{@solution[:bundle_sid]}/Copies"
    
end

Instance Method Details

#create(friendly_name: :unset) ⇒ BundleCopyInstance

Create the BundleCopyInstance



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 40

def create(
    friendly_name: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
    })

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

#each ⇒ Object

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



101
102
103
104
105
106
107
108
109
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 101

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



135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 135

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

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

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



70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 70

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



118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 118

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: params)

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

#stream(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.



88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 88

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



146
147
148
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 146

def to_s
    '#<Twilio.Numbers.V2.BundleCopyList>'
end