Class: Dolibarr::Api::Thirdparties

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

Defined Under Namespace

Classes: Accounts, Bankaccounts, Barcode, Categories, Email, GenerateBankAccountDocument, Merge, Notifications, Notificationsbycode, Representative, Setpricelevel, Splitdiscount, SupplierCategories

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Thirdparties

Returns a new instance of Thirdparties.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(create_thirdparties_model: nil) ⇒ Object 



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

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

#delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :DELETE,
    '/thirdparties/{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/thirdparties.rb', line 31

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

  @connection.call(
    :GET,
    '/thirdparties/{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, mode: nil, category: nil, sqlfilters: nil, properties: nil, pagination_data: nil) ⇒ Object 



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

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

#retrieve_fixed_amount_discounts(id:, mode: nil, filter: nil, sortfield: nil, sortorder: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

def retrieve_fixed_amount_discounts(id:, mode: nil, filter: nil, sortfield: nil, sortorder: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/thirdparties/{id}/fixedamountdiscounts'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'mode' => mode, 'filter' => filter, 'sortfield' => sortfield, 'sortorder' => sortorder }
  )
end

#retrieve_invoices_qualified_for_credit_note(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#retrieve_invoices_qualified_for_replacement(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#retrieve_out_standing_invoices(id:, mode: nil) ⇒ Object

Raises:

  • (ArgumentError) 


90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/dolibarr-api/api/thirdparties.rb', line 90

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

  @connection.call(
    :GET,
    '/thirdparties/{id}/outstandinginvoices'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'mode' => mode }
  )
end

#retrieve_out_standing_order(id:, mode: nil) ⇒ Object

Raises:

  • (ArgumentError) 


103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/dolibarr-api/api/thirdparties.rb', line 103

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

  @connection.call(
    :GET,
    '/thirdparties/{id}/outstandingorders'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'mode' => mode }
  )
end

#retrieve_out_standing_proposals(id:, mode: nil) ⇒ Object

Raises:

  • (ArgumentError) 


116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/dolibarr-api/api/thirdparties.rb', line 116

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

  @connection.call(
    :GET,
    '/thirdparties/{id}/outstandingproposals'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'mode' => mode }
  )
end

#retrieve_sales_representatives(id:, mode: nil) ⇒ Object

Raises:

  • (ArgumentError) 


129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/dolibarr-api/api/thirdparties.rb', line 129

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

  @connection.call(
    :GET,
    '/thirdparties/{id}/representatives'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    query: { 'mode' => mode }
  )
end

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

Raises:

  • (ArgumentError) 


142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/dolibarr-api/api/thirdparties.rb', line 142

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

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