Class: Dolibarr::Api::Bankaccounts

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

Defined Under Namespace

Classes: Lines

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Bankaccounts

Returns a new instance of Bankaccounts.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(create_bankaccounts_model: nil) ⇒ Object 



9
10
11
12
13
14
15
16
17
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 9

def create(create_bankaccounts_model: nil)
  @connection.call(
    :POST,
    '/bankaccounts',
    type: nil,
    auth: ['api_key'],
    body: create_bankaccounts_model
  )
end

#delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 19

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

  @connection.call(
    :DELETE,
    '/bankaccounts/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 31

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

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

#list(sortfield: nil, sortorder: nil, limit: nil, page: nil, category: nil, sqlfilters: nil, properties: nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 43

def list(sortfield: nil, sortorder: nil, limit: nil, page: nil, category: nil, sqlfilters: nil, properties: nil)
  @connection.call(
    :GET,
    '/bankaccounts',
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'category' => category, 'sqlfilters' => sqlfilters, 'properties' => properties }
  )
end

#retrieve_balance(id:) ⇒ Object

Raises:

  • (ArgumentError) 


53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 53

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

  @connection.call(
    :GET,
    '/bankaccounts/{id}/balance'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#transfer(bankaccounts_transfer_model:) ⇒ Object

Raises:

  • (ArgumentError) 


65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 65

def transfer(bankaccounts_transfer_model:)
  raise ArgumentError, 'bankaccounts_transfer_model is required' if bankaccounts_transfer_model.nil?

  @connection.call(
    :POST,
    '/bankaccounts/transfer',
    type: nil,
    auth: ['api_key'],
    body: bankaccounts_transfer_model
  )
end

#update(id:, update_bankaccounts_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/dolibarr-api/api/bankaccounts.rb', line 77

def update(id:, update_bankaccounts_model: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :PUT,
    '/bankaccounts/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    body: update_bankaccounts_model
  )
end