Module: BookingSync::API::Client::BillingAddresses

Included in:

BookingSync::API::Client

Defined in:

lib/bookingsync/api/client/billing_addresses.rb

Instance Method Summary

• #billing_addresses(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

  List billing addresses.

Instance Method Details

#billing_addresses(options = {}, &block) ⇒ Array<BookingSync::API::Resource>

List billing addresses

Returns billing addresses for the account user is authenticated with.

Examples:

Get the list of billing addresses for the current account

billing_addresses = @api.billing_addresses
billing_addresses.first.city # => "Paris"

Get the list of billing addresses only with city and address1 for smaller response

@api.billing_addresses(fields: [:city, :address1])

Parameters:

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

  A customizable set of options.

Options Hash (options):

• fields: (Array) —

  List of fields to be fetched.

Returns:

• (Array<BookingSync::API::Resource>) —

  Array of billing addresses.

See Also:

• addresss/#list-billing-addresses

# File 'lib/bookingsync/api/client/billing_addresses.rb', line 17

def billing_addresses(options = {}, &block)
  paginate :billing_addresses, options, &block
end