Class: Printavo::Resources::Base

Inherits:

Object

• Object
• Printavo::Resources::Base

Defined in:

lib/printavo/resources/base.rb

Direct Known Subclasses

Account, ApprovalRequests, Categories, Contacts, ContractorProfiles, CustomAddresses, Customers, DeliveryMethods, EmailTemplates, Expenses, Fees, Imprints, Inquiries, Invoices, Jobs, LineItemGroups, LineItems, MerchOrders, MerchStores, Mockups, Orders, PaymentRequests, PaymentTerms, Payments, PresetTaskGroups, PresetTasks, PricingMatrices, ProductionFiles, Products, Statuses, Tasks, Threads, TransactionPayments, Transactions, TypesOfWork, Users, Vendors

Instance Method Summary

• #all_pages(first: 25, **kwargs) ⇒ Array

  Returns all records across all pages as a flat Array.

• #each_page(first: 25, **kwargs) {|records| ... } ⇒ Object

  Yields each page of records as an Array, following cursors automatically.

• #initialize(graphql) ⇒ Base constructor

  A new instance of Base.

Constructor Details

#initialize(graphql) ⇒ Base

Returns a new instance of Base.

# File 'lib/printavo/resources/base.rb', line 7

def initialize(graphql)
  @graphql = graphql
end

Instance Method Details

#all_pages(first: 25, **kwargs) ⇒ Array

Returns all records across all pages as a flat Array. Extra keyword arguments are forwarded to fetch_page (e.g. order_id: for Jobs).

Examples:

all_customers = client.customers.all_pages
all_jobs      = client.jobs.all_pages(order_id: "99")

Parameters:

• first (Integer) (defaults to: 25) —

  page size per request (default 25)

Returns:

• (Array)

# File 'lib/printavo/resources/base.rb', line 41

def all_pages(first: 25, **kwargs)
  [].tap { |all| each_page(first: first, **kwargs) { |records| all.concat(records) } }
end

#each_page(first: 25, **kwargs) {|records| ... } ⇒ Object

Yields each page of records as an Array, following cursors automatically. Extra keyword arguments are forwarded to fetch_page (e.g. order_id: for Jobs).

Examples:

client.customers.each_page(first: 50) do |records|
  records.each { |c| puts c.full_name }
end

Parameters:

• first (Integer) (defaults to: 25) —

  page size (default 25)

Yield Parameters:

• records (Array) —

  one page of domain model objects

# File 'lib/printavo/resources/base.rb', line 21

def each_page(first: 25, **kwargs)
  after = nil
  loop do
    page = fetch_page(first: first, after: after, **kwargs)
    yield(page.records)
    break unless page.has_next_page

    after = page.end_cursor
  end
end