Class: Dolibarr::Api::Products::Attributes

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Attributes

Returns a new instance of Attributes.



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

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(products_add_attributes_model:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def create(products_add_attributes_model:)
  raise ArgumentError, 'products_add_attributes_model is required' if products_add_attributes_model.nil?

  @connection.call(
    :POST,
    '/products/attributes',
    type: nil,
    auth: ['api_key'],
    body: products_add_attributes_model
  )
end

#delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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



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

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

#ref(ref:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#ref_ext(ref_ext:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#ref_values(ref:) ⇒ Object

Raises:

  • (ArgumentError) 


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

def ref_values(ref:)
  raise ArgumentError, 'ref is required' if ref.nil?

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

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

Raises:

  • (ArgumentError) 


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

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

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

#values(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#values_delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

#values_get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/dolibarr-api/api/products/attributes.rb', line 128

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

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

#values_post(id:, products_add_attribute_value_model:) ⇒ Object

Raises:

  • (ArgumentError) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/dolibarr-api/api/products/attributes.rb', line 140

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

  @connection.call(
    :POST,
    '/products/attributes/{id}/values'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: products_add_attribute_value_model
  )
end

#values_put(id:, products_update_attribute_value_model:) ⇒ Object

Raises:

  • (ArgumentError) 


154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/dolibarr-api/api/products/attributes.rb', line 154

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

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

#values_ref(id:, ref:) ⇒ Object

Raises:

  • (ArgumentError) 


168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/dolibarr-api/api/products/attributes.rb', line 168

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

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

#values_ref_delete(id:, ref:) ⇒ Object

Raises:

  • (ArgumentError) 


182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/dolibarr-api/api/products/attributes.rb', line 182

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

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