Class: Phaxio::Resources::PortOrder

Inherits:

Phaxio::Resource

• Object
• Phaxio::Resource
• Phaxio::Resources::PortOrder

Defined in:

lib/phaxio/resources/port_order.rb

Overview

Provides functionality for viewing and managing port orders.

Instance Attribute Summary

• #account_identifier ⇒ String

  The identifier for the account associated with the numbers.

• #bill_received_at ⇒ Time

  The time the bill for the order was received.

• #billing_address1 ⇒ String

  The first billing address line.

• #billing_address2 ⇒ String

  The second billing address line.

• #billing_city ⇒ String

  The billing address city.

• #billing_number ⇒ String

  The E.164 billing number.

• #billing_state ⇒ String

  The billing address state.

• #billing_zip ⇒ String

  The billing address zip.

• #completed_at ⇒ Time

  The time the order was completed.

• #contact_email ⇒ String

  The email address for the order.

• #contact_number ⇒ String

  The E.164 contact number.

• #created_at ⇒ Time

  The time the order was created.

• #esig ⇒ String

  The electronic signature used to sign the order.

• #has_bill ⇒ true | false

  Whether or not a bill will be provided.

• #id ⇒ Integer

  The ID associated with this order.

• #legal_agreement ⇒ true | false

  Whether or not the legal agreement is accepted.

• #name_of_business ⇒ String

  The name of the business.

• #name_on_account ⇒ String

  The name associated with the account.

• #port_numbers ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PortNumber>

  A collection of port numbers associated with the order.

• #port_out_pin ⇒ String

  The PIN or password needed to port out the numbers.

• #port_type ⇒ String

  Type of numbers to be ported.

• #provider_name ⇒ String

  The provider name.

• #requested_for ⇒ Time

  The time the order was requested for.

• #status ⇒ String

  The status of this order.

• #updated_at ⇒ Time

  The time the order was updated.

Class Method Summary

• .create(params = {}) ⇒ Phaxio::Resources::PortOrder

  Create a port order.

• .get(id, params = {}) ⇒ Phaxio::Resource::PortOrder (also: retrieve, find)

  Get port order info.

• .list(params = {}) ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PortOrder>

  List port orders in date range.

Methods inherited from Phaxio::Resource

response_collection, response_record

Instance Attribute Details

#account_identifier ⇒ String

Returns The identifier for the account associated with the numbers.

Returns:

• (String) —

  The identifier for the account associated with the numbers.

# File 'lib/phaxio/resources/port_order.rb', line 20

#bill_received_at ⇒ Time

Returns the time the bill for the order was received.

Returns:

• (Time) —

  the time the bill for the order was received.

# File 'lib/phaxio/resources/port_order.rb', line 80

#billing_address1 ⇒ String

Returns the first billing address line.

Returns:

• (String) —

  the first billing address line.

# File 'lib/phaxio/resources/port_order.rb', line 41

#billing_address2 ⇒ String

Returns the second billing address line.

Returns:

• (String) —

  the second billing address line.

# File 'lib/phaxio/resources/port_order.rb', line 44

#billing_city ⇒ String

Returns the billing address city.

Returns:

• (String) —

  the billing address city.

# File 'lib/phaxio/resources/port_order.rb', line 47

#billing_number ⇒ String

Returns the E.164 billing number.

Returns:

• (String) —

  the E.164 billing number.

# File 'lib/phaxio/resources/port_order.rb', line 38

#billing_state ⇒ String

Returns the billing address state.

Returns:

• (String) —

  the billing address state.

# File 'lib/phaxio/resources/port_order.rb', line 50

#billing_zip ⇒ String

Returns the billing address zip.

Returns:

• (String) —

  the billing address zip.

# File 'lib/phaxio/resources/port_order.rb', line 53

#completed_at ⇒ Time

Returns the time the order was completed.

Returns:

• (Time) —

  the time the order was completed.

# File 'lib/phaxio/resources/port_order.rb', line 89

has_time_attributes %w[
  created_at updated_at bill_received_at requested_for completed_at
]

#contact_email ⇒ String

Returns The email address for the order.

Returns:

• (String) —

  The email address for the order.

# File 'lib/phaxio/resources/port_order.rb', line 17

#contact_number ⇒ String

Returns the E.164 contact number.

Returns:

• (String) —

  the E.164 contact number.

# File 'lib/phaxio/resources/port_order.rb', line 14

#created_at ⇒ Time

Returns the time the order was created.

Returns:

• (Time) —

  the time the order was created.

# File 'lib/phaxio/resources/port_order.rb', line 74

#esig ⇒ String

Returns the electronic signature used to sign the order.

Returns:

• (String) —

  the electronic signature used to sign the order.

# File 'lib/phaxio/resources/port_order.rb', line 56

#has_bill ⇒ true | false

Returns whether or not a bill will be provided. (only present on new orders).

Returns:

• (true | false) —

  whether or not a bill will be provided. (only present on new orders)

# File 'lib/phaxio/resources/port_order.rb', line 59

#id ⇒ Integer

Returns the ID associated with this order.

Returns:

• (Integer) —

  the ID associated with this order.

# File 'lib/phaxio/resources/port_order.rb', line 8

#legal_agreement ⇒ true | false

Returns whether or not the legal agreement is accepted. (only present on new orders).

Returns:

• (true | false) —

  whether or not the legal agreement is accepted. (only present on new orders)

# File 'lib/phaxio/resources/port_order.rb', line 67

has_normal_attributes %w[
  id contact_number contact_email name_on_account name_of_business provider_name
  billing_number billing_address1 billing_address2 account_identifier
  billing_city billing_state billing_zip esig legal_agreement port_type port_out_pin
  status
]

#name_of_business ⇒ String

Returns the name of the business.

Returns:

• (String) —

  the name of the business.

# File 'lib/phaxio/resources/port_order.rb', line 32

#name_on_account ⇒ String

Returns the name associated with the account.

Returns:

• (String) —

  the name associated with the account.

# File 'lib/phaxio/resources/port_order.rb', line 29

#port_numbers ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PortNumber>

Returns a collection of port numbers associated with the order.

Returns:

• (Phaxio::Resource::Collection<Phaxio::Resources::PortNumber>) —

  a collection of port numbers associated with the order

# File 'lib/phaxio/resources/port_order.rb', line 97

has_collection_attributes({port_numbers: PortNumber})

#port_out_pin ⇒ String

Returns The PIN or password needed to port out the numbers.

Returns:

• (String) —

  The PIN or password needed to port out the numbers.

# File 'lib/phaxio/resources/port_order.rb', line 26

#port_type ⇒ String

Returns Type of numbers to be ported. Either “business” or “residential”.

Returns:

• (String) —

  Type of numbers to be ported. Either “business” or “residential”.

# File 'lib/phaxio/resources/port_order.rb', line 23

#provider_name ⇒ String

Returns the provider name.

Returns:

• (String) —

  the provider name.

# File 'lib/phaxio/resources/port_order.rb', line 35

#requested_for ⇒ Time

Returns the time the order was requested for.

Returns:

• (Time) —

  the time the order was requested for.

# File 'lib/phaxio/resources/port_order.rb', line 83

#status ⇒ String

Returns the status of this order.

Returns:

• (String) —

  the status of this order.

# File 'lib/phaxio/resources/port_order.rb', line 11

#updated_at ⇒ Time

Returns the time the order was updated.

Returns:

• (Time) —

  the time the order was updated.

# File 'lib/phaxio/resources/port_order.rb', line 77

Class Method Details

.create(params = {}) ⇒ Phaxio::Resources::PortOrder

Create a port order.

Parameters:

• params (Hash) (defaults to: {}) —

  Any parameters to send to Phaxio.

  • port_numbers [Array<String>] - Numbers to port.

  • contact_number [String] - Number to contact about the port.

  • contact_email [String] - The email address for the order.

  • account_identifier [String] - The identifier for the account associated with the numbers.

  • port_type [String] - Type of numbers to be ported. Either “business” or “residential”.

  • port_out_pin [String] - The PIN or password needed to port out the numbers.

  • name_on_account [String] - Name on the account for the port.

  • name_of_business [String] - Name of business associated with the port.

  • provider_name [String] - Name of provider for the port.

  • esig [String] - Electronic signature used to sign the order.

  • legal_agreement [true | false] - Indicates acceptance of the legal agreement.

  • has_bill [true | false] - Indicates whether or not a bill will be provided. If true, billing number and address fields are not needed.

  • billing_number [String] - Billing number.

  • billing_address1 [String] - Billing address line 1

  • billing_address2 [String] - Billing address line 2

  • billing_city [String] - Billing address city.

  • billing_state [String] - Billing address state.

  • billing_zip [String] - Billing address zip.

Returns:

• (Phaxio::Resources::PortOrder)

Raises:

• (Phaxio::Error::PhaxioError)

See Also:

• https://www.phaxio.com/docs/api/v2/port_orders/create_port_order

# File 'lib/phaxio/resources/port_order.rb', line 140

def create params = {}
  response = Client.request :post, port_orders_endpoint, params
  response_record response
end

.get(id, params = {}) ⇒ Phaxio::Resource::PortOrder Also known as: retrieve, find

Get port order info.

Parameters:

• id (Integer) —

  The ID of the order to retrieve.

• params (Hash) (defaults to: {}) —

  A hash of parameters to send to Phaxio. This action takes no unique parameters.

Returns:

• (Phaxio::Resource::PortOrder)

Raises:

• (Phaxio::Error::PhaxioError)

See Also:

• https://www.phaxio.com/docs/api/v2/port_orders/get_port_order

# File 'lib/phaxio/resources/port_order.rb', line 153

def get id, params = {}
  response = Client.request :get, port_order_endpoint(id.to_i), params
  response_record response
end

.list(params = {}) ⇒ Phaxio::Resource::Collection<Phaxio::Resources::PortOrder>

Note:

This action accepts paging parameters:

• per_page [Integer] - The maximum number of results to return per call (i.e. “page”). Max 1000.

• page [Integer] - The page number to return for the request. 1-based.

List port orders in date range.

Parameters:

• params (Hash) (defaults to: {}) —

  Any parameters to send to Phaxio.

  • created_before [String] - RFC 3339 timestamp representing the end of the range.

  • created_after [String] - RFC 3339 timestamp representing the beginning of the range.

Returns:

• (Phaxio::Resource::Collection<Phaxio::Resources::PortOrder>) —

  The collection of port orders matching your request.

Raises:

• (Phaxio::Error::PhaxioError) —

  Phaxio::Error::PhaxioError

See Also:

• https://www.phaxio.com/docs/api/v2/port_orders/list_port_orders

# File 'lib/phaxio/resources/port_order.rb', line 110

def list params = {}
  response = Client.request :get, port_orders_endpoint, params
  response_collection response
end