Class: Dolibarr::Api::Supplierorders

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

Defined Under Namespace

Classes: Contact, Contacts, Lines

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Supplierorders

Returns a new instance of Supplierorders.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#approve(id:, supplierorders_approve_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/supplierorders/{id}/approve'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: supplierorders_approve_model
  )
end

#create(create_supplierorders_model: nil) ⇒ Object 



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

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

#delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/dolibarr-api/api/supplierorders.rb', line 44

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

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

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



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

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

#make_order(id:, supplierorders_make_order_model:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

  @connection.call(
    :POST,
    '/supplierorders/{id}/makeorder'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: supplierorders_make_order_model
  )
end

#receive_order(id:, supplierorders_receive_order_model:) ⇒ Object

Raises:

  • (ArgumentError) 


80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/dolibarr-api/api/supplierorders.rb', line 80

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

  @connection.call(
    :POST,
    '/supplierorders/{id}/receive'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: supplierorders_receive_order_model
  )
end

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

Raises:

  • (ArgumentError) 


94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/dolibarr-api/api/supplierorders.rb', line 94

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

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

#validate(id:, supplierorders_validate_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/dolibarr-api/api/supplierorders.rb', line 107

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

  @connection.call(
    :POST,
    '/supplierorders/{id}/validate'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: supplierorders_validate_model
  )
end