Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::BundleList

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

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ BundleList

Initialize the BundleList

Parameters:

  • version (Version) —

    Version that contains the resource



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

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

Instance Method Details

#create(friendly_name: nil, email: nil, status_callback: :unset, regulation_sid: :unset, iso_country: :unset, end_user_type: :unset, number_type: :unset, is_test: :unset) ⇒ BundleInstance

Create the BundleInstance

Parameters:

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

    The string that you assigned to describe the resource.

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

    The email address that will receive updates when the Bundle resource changes status.

  • status_callback (String) (defaults to: :unset) —

    The URL we call to inform your application of status changes.

  • regulation_sid (String) (defaults to: :unset) —

    The unique string of a regulation that is associated to the Bundle resource.

  • iso_country (String) (defaults to: :unset) —

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle’s phone number country ownership request.

  • end_user_type (EndUserType) (defaults to: :unset)
  • number_type (String) (defaults to: :unset) —

    The type of phone number of the Bundle’s ownership request. Can be ‘local`, `mobile`, `national`, or `toll-free`.

  • is_test (Boolean) (defaults to: :unset) —

    Indicates that Bundle is a Test Bundle and will be Auto-Rejected

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 47

def create(
  friendly_name: nil, 
  email: nil, 
  status_callback: :unset, 
  regulation_sid: :unset, 
  iso_country: :unset, 
  end_user_type: :unset, 
  number_type: :unset, 
  is_test: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Email' => email,
        'StatusCallback' => status_callback,
        'RegulationSid' => regulation_sid,
        'IsoCountry' => iso_country,
        'EndUserType' => end_user_type,
        'NumberType' => number_type,
        'IsTest' => is_test,
    })

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

#create_with_metadata(friendly_name: nil, email: nil, status_callback: :unset, regulation_sid: :unset, iso_country: :unset, end_user_type: :unset, number_type: :unset, is_test: :unset) ⇒ BundleInstance

Create the BundleInstanceMetadata

Parameters:

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

    The string that you assigned to describe the resource.

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

    The email address that will receive updates when the Bundle resource changes status.

  • status_callback (String) (defaults to: :unset) —

    The URL we call to inform your application of status changes.

  • regulation_sid (String) (defaults to: :unset) —

    The unique string of a regulation that is associated to the Bundle resource.

  • iso_country (String) (defaults to: :unset) —

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle’s phone number country ownership request.

  • end_user_type (EndUserType) (defaults to: :unset)
  • number_type (String) (defaults to: :unset) —

    The type of phone number of the Bundle’s ownership request. Can be ‘local`, `mobile`, `national`, or `toll-free`.

  • is_test (Boolean) (defaults to: :unset) —

    Indicates that Bundle is a Test Bundle and will be Auto-Rejected

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 93

def create_with_metadata(
  friendly_name: nil, 
  email: nil, 
  status_callback: :unset, 
  regulation_sid: :unset, 
  iso_country: :unset, 
  end_user_type: :unset, 
  number_type: :unset, 
  is_test: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Email' => email,
        'StatusCallback' => status_callback,
        'RegulationSid' => regulation_sid,
        'IsoCountry' => iso_country,
        'EndUserType' => end_user_type,
        'NumberType' => number_type,
        'IsTest' => is_test,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    bundle_instance = BundleInstance.new(
        @version,
        response.body,
    )
    BundleInstanceMetadata.new(
        @version,
        bundle_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 281

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit])
    return [].each if result.nil?
    result.each {|x| yield x}
end

#get_page(target_url) ⇒ Page

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of BundleInstance



348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 348

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

#list(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • status (Status) (defaults to: :unset) —

    The verification status of the Bundle resource. Please refer to [Bundle Statuses](www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.

  • bundle_sids (String) (defaults to: :unset) —

    A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match ‘^BU32$`.

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource. The column can contain 255 variable characters.

  • regulation_sid (String) (defaults to: :unset) —

    The unique string of a [Regulation resource](www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.

  • iso_country (String) (defaults to: :unset) —

    The 2-digit [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle’s phone number country ownership request.

  • number_type (String) (defaults to: :unset) —

    The type of phone number of the Bundle’s ownership request. Can be ‘local`, `mobile`, `national`, or `toll-free`.

  • end_user_type (String) (defaults to: :unset) —

    The end user type of the regulation of the Bundle. Can be ‘business` or `individual`.

  • has_valid_until_date (Boolean) (defaults to: :unset) —

    Indicates that the Bundle is a valid Bundle until a specified expiration date.

  • sort_by (SortBy) (defaults to: :unset) —

    Can be ‘valid-until` or `date-updated`. Defaults to `date-created`.

  • sort_direction (SortDirection) (defaults to: :unset) —

    Default is ‘DESC`. Can be `ASC` or `DESC`.

  • valid_until_date (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_before (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_after (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • 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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 159

def list(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
    self.stream(
        status: status,
        bundle_sids: bundle_sids,
        friendly_name: friendly_name,
        regulation_sid: regulation_sid,
        iso_country: iso_country,
        number_type: number_type,
        end_user_type: end_user_type,
        has_valid_until_date: has_valid_until_date,
        sort_by: sort_by,
        sort_direction: sort_direction,
        valid_until_date: valid_until_date,
        valid_until_date_before: valid_until_date_before,
        valid_until_date_after: valid_until_date_after,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil) ⇒ Array

Returns Array of up to limit results.

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 251

def list_with_metadata(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Status' => status,
        'BundleSids' => bundle_sids,
        'FriendlyName' => friendly_name,
        'RegulationSid' => regulation_sid,
        'IsoCountry' => iso_country,
        'NumberType' => number_type,
        'EndUserType' => end_user_type,
        'HasValidUntilDate' => has_valid_until_date,
        'SortBy' => sort_by,
        'SortDirection' => sort_direction,
        'ValidUntilDate' =>  Twilio.serialize_iso8601_datetime(valid_until_date),
        'ValidUntilDate<' =>  Twilio.serialize_iso8601_datetime(valid_until_date_before),
        'ValidUntilDate>' =>  Twilio.serialize_iso8601_datetime(valid_until_date_after),
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    BundlePageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • status (Status) (defaults to: :unset) —

    The verification status of the Bundle resource. Please refer to [Bundle Statuses](www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.

  • bundle_sids (String) (defaults to: :unset) —

    A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match ‘^BU32$`.

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource. The column can contain 255 variable characters.

  • regulation_sid (String) (defaults to: :unset) —

    The unique string of a [Regulation resource](www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.

  • iso_country (String) (defaults to: :unset) —

    The 2-digit [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle’s phone number country ownership request.

  • number_type (String) (defaults to: :unset) —

    The type of phone number of the Bundle’s ownership request. Can be ‘local`, `mobile`, `national`, or `toll-free`.

  • end_user_type (String) (defaults to: :unset) —

    The end user type of the regulation of the Bundle. Can be ‘business` or `individual`.

  • has_valid_until_date (Boolean) (defaults to: :unset) —

    Indicates that the Bundle is a valid Bundle until a specified expiration date.

  • sort_by (SortBy) (defaults to: :unset) —

    Can be ‘valid-until` or `date-updated`. Defaults to `date-created`.

  • sort_direction (SortDirection) (defaults to: :unset) —

    Default is ‘DESC`. Can be `ASC` or `DESC`.

  • valid_until_date (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_before (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_after (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 315

def page(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Status' => status,
        'BundleSids' => bundle_sids,
        'FriendlyName' => friendly_name,
        'RegulationSid' => regulation_sid,
        'IsoCountry' => iso_country,
        'NumberType' => number_type,
        'EndUserType' => end_user_type,
        'HasValidUntilDate' => has_valid_until_date,
        'SortBy' => sort_by,
        'SortDirection' => sort_direction,
        'ValidUntilDate' =>  Twilio.serialize_iso8601_datetime(valid_until_date),
        'ValidUntilDate<' =>  Twilio.serialize_iso8601_datetime(valid_until_date_before),
        'ValidUntilDate>' =>  Twilio.serialize_iso8601_datetime(valid_until_date_after),
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :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.

Parameters:

  • status (Status) (defaults to: :unset) —

    The verification status of the Bundle resource. Please refer to [Bundle Statuses](www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses) for more details.

  • bundle_sids (String) (defaults to: :unset) —

    A comma-separated list of Bundle SIDs to filter the results (maximum 20). Each Bundle SID must match ‘^BU32$`.

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource. The column can contain 255 variable characters.

  • regulation_sid (String) (defaults to: :unset) —

    The unique string of a [Regulation resource](www.twilio.com/docs/phone-numbers/regulatory/api/regulations) that is associated to the Bundle resource.

  • iso_country (String) (defaults to: :unset) —

    The 2-digit [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the Bundle’s phone number country ownership request.

  • number_type (String) (defaults to: :unset) —

    The type of phone number of the Bundle’s ownership request. Can be ‘local`, `mobile`, `national`, or `toll-free`.

  • end_user_type (String) (defaults to: :unset) —

    The end user type of the regulation of the Bundle. Can be ‘business` or `individual`.

  • has_valid_until_date (Boolean) (defaults to: :unset) —

    Indicates that the Bundle is a valid Bundle until a specified expiration date.

  • sort_by (SortBy) (defaults to: :unset) —

    Can be ‘valid-until` or `date-updated`. Defaults to `date-created`.

  • sort_direction (SortDirection) (defaults to: :unset) —

    Default is ‘DESC`. Can be `ASC` or `DESC`.

  • valid_until_date (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_before (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • valid_until_date_after (Time) (defaults to: :unset) —

    Date to filter Bundles having their ‘valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well. [ISO 8601](en.wikipedia.org/wiki/ISO_8601) is the acceptable date format.

  • 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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 203

def stream(status: :unset, bundle_sids: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, end_user_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date: :unset, valid_until_date_before: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        status: status,
        bundle_sids: bundle_sids,
        friendly_name: friendly_name,
        regulation_sid: regulation_sid,
        iso_country: iso_country,
        number_type: number_type,
        end_user_type: end_user_type,
        has_valid_until_date: has_valid_until_date,
        sort_by: sort_by,
        sort_direction: sort_direction,
        valid_until_date: valid_until_date,
        valid_until_date_before: valid_until_date_before,
        valid_until_date_after: valid_until_date_after,
        page_size: limits[:page_size], )

    return [].each if page.nil?

    result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
    return [].each if result.nil?
    result
end

#to_s ⇒ Object

Provide a user friendly representation



359
360
361
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 359

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