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
36
 
# 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



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/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 41

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

#create_with_metadata(friendly_name: :unset) ⇒ BundleCopyInstance

Create the BundleCopyInstanceMetadata



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 67

def create_with_metadata(
  friendly_name: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    bundle_copy_instance = BundleCopyInstance.new(
        @version,
        response.body,
        bundle_sid: @solution[:bundle_sid],
    )
    BundleCopyInstanceMetadata.new(
        @version,
        bundle_copy_instance,
        response.headers,
        response.status_code
    )
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.



160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 160

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.



197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 197

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.



107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 107

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

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

Lists BundleCopyPageMetadata records from the API as a list.



143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 143

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

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

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 177

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

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

    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.



125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 125

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



208
209
210
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle/bundle_copy.rb', line 208

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