Module: Invoiced::Operations::List

Included in:
Contact, Coupon, CreditBalanceAdjustment, CreditNote, CustomField, Customer, CustomerChasingCadence, EmailTemplate, Estimate, Event, GlAccount, Inbox, Invoice, InvoiceChasingCadence, Item, LateFeeSchedule, LineItem, Member, MerchantAccount, Note, Payment, PaymentMethod, PaymentSource, PdfTemplate, Plan, Role, SignUpPage, SmsTemplate, Subscription, Task, TaxRate, TaxRule, Theme, Webhook
Defined in:
lib/invoiced/operations/list.rb

Instance Method Summary collapse

Instance Method Details

#list(params = {}) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/invoiced/operations/list.rb', line 4

def list(params={})
    response = @client.request(:get, self.endpoint(), params)

    # build objects
    objects = Util.build_objects(self, response[:body])

    # store the metadata from the list operation
    metadata = Invoiced::List.new(response[:headers][:link], response[:headers][:x_total_count])

    return objects, metadata
end