Method: Invoicexpress::Client::Clients#clients

Defined in:
lib/invoicexpress/client/clients.rb

#clients(options = {}) ⇒ Array<Invoicexpress::Models::Client>

Returns all your clients

Parameters:

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

    a customizable set of options

Options Hash (options):

  • per_page (Integer) — default: 30

    You can specify how many results you want to fetch

  • page (Integer) — default: 1

    You can ask a specific page of clients

Returns:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized



14
15
16
17
18
# File 'lib/invoicexpress/client/clients.rb', line 14

def clients(options={})
  params = { :per_page => 30, :page => 1, :klass => Invoicexpress::Models::Client }

  get("clients.xml", params.merge(options))
end