Class: Dolibarr::Api::Invoices::Templates

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/invoices/templates.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Templates

Returns a new instance of Templates.



5
6
7
 
# File 'lib/dolibarr-api/api/invoices/templates.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#get(id:, contact_list: nil) ⇒ Object

Raises:

  • (ArgumentError) 


9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/dolibarr-api/api/invoices/templates.rb', line 9

def get(id:, contact_list: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/invoices/templates/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    query: { 'contact_list' => contact_list }
  )
end

#list(sortfield: nil, sortorder: nil, limit: nil, page: nil, thirdparty_ids: nil, status: nil, sqlfilters: nil, properties: nil, pagination_data: nil, loadlinkedobjects: nil, with_lines: nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/dolibarr-api/api/invoices/templates.rb', line 22

def list(sortfield: nil, sortorder: nil, limit: nil, page: nil, thirdparty_ids: nil, status: nil, sqlfilters: nil, properties: nil, pagination_data: nil, loadlinkedobjects: nil, with_lines: nil)
  @connection.call(
    :GET,
    '/invoices/templates',
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'thirdparty_ids' => thirdparty_ids, 'status' => status, 'sqlfilters' => sqlfilters, 'properties' => properties, 'pagination_data' => pagination_data, 'loadlinkedobjects' => loadlinkedobjects, 'withLines' => with_lines }
  )
end