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



46
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
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 46

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

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



164
165
166
167
168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 164

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



220
221
222
223
224
225
226
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 220

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

#list(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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.

  • 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`.

  • 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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 100

def list(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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,
        friendly_name: friendly_name,
        regulation_sid: regulation_sid,
        iso_country: iso_country,
        number_type: number_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

#page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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.

  • 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`.

  • 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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 192

def page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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,
        'FriendlyName' => friendly_name,
        'RegulationSid' => regulation_sid,
        'IsoCountry' => iso_country,
        'NumberType' => number_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,
    })

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

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

#stream(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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.

  • 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`.

  • 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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 140

def stream(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_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,
        friendly_name: friendly_name,
        regulation_sid: regulation_sid,
        iso_country: iso_country,
        number_type: number_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], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



231
232
233
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb', line 231

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