Class: Dolibarr::Api::Setup
- Inherits:
-
Object
- Object
- Dolibarr::Api::Setup
- Defined in:
- lib/dolibarr-api/api/setup.rb
Defined Under Namespace
Classes: Conf, Establishments, Extrafields, Modules
Instance Method Summary collapse
-
#initialize(connection) ⇒ Setup
constructor
A new instance of Setup.
- #retrieve_availability(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_check_integrity(target:) ⇒ Object
- #retrieve_company ⇒ Object
- #retrieve_country_by_code(code:, lang: nil) ⇒ Object
- #retrieve_country_by_id(id:, lang: nil) ⇒ Object
- #retrieve_country_by_iso(iso:, lang: nil) ⇒ Object
- #retrieve_list_of_action_triggers(sortfield: nil, sortorder: nil, limit: nil, page: nil, elementtype: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_civilities(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_contact_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_countries(sortfield: nil, sortorder: nil, limit: nil, page: nil, filter: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_currencies(multicurrency: nil, sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_event_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_expense_reports_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_holiday_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_incoterms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_legal_form(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_measuring_units(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_public_holidays(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_regions(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_staff(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_states(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_towns(sortfield: nil, sortorder: nil, limit: nil, page: nil, zipcode: nil, town: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_of_vat(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, fk_country: nil, sqlfilters: nil) ⇒ Object
- #retrieve_list_ofsocial_networks(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_ordering_methods(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_ordering_origins(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_payment_terms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_payment_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
- #retrieve_region_by_code(code:) ⇒ Object
- #retrieve_region_by_id(id:) ⇒ Object
- #retrieve_shipping_modes(limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_state_by_code(code:) ⇒ Object
- #retrieve_state_by_id(id:) ⇒ Object
- #retrieve_thirdparties_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_tickets_categories(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_tickets_severities(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
- #retrieve_tickets_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
Constructor Details
#initialize(connection) ⇒ Setup
Returns a new instance of Setup.
5 6 7 |
# File 'lib/dolibarr-api/api/setup.rb', line 5 def initialize(connection) @connection = connection end |
Instance Method Details
#retrieve_availability(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
9 10 11 12 13 14 15 16 17 |
# File 'lib/dolibarr-api/api/setup.rb', line 9 def retrieve_availability(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/availability', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_check_integrity(target:) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/dolibarr-api/api/setup.rb', line 19 def retrieve_check_integrity(target:) raise ArgumentError, 'target is required' if target.nil? @connection.call( :GET, '/setup/checkintegrity', type: nil, auth: ['api_key'], query: { 'target' => target } ) end |
#retrieve_company ⇒ Object
31 32 33 34 35 36 37 38 |
# File 'lib/dolibarr-api/api/setup.rb', line 31 def retrieve_company @connection.call( :GET, '/setup/company', type: nil, auth: ['api_key'] ) end |
#retrieve_country_by_code(code:, lang: nil) ⇒ Object
40 41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/dolibarr-api/api/setup.rb', line 40 def retrieve_country_by_code(code:, lang: nil) raise ArgumentError, 'code is required' if code.nil? @connection.call( :GET, '/setup/dictionary/countries/byCode/{code}' .gsub('{code}', ERB::Util.url_encode(code.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'], query: { 'lang' => lang } ) end |
#retrieve_country_by_id(id:, lang: nil) ⇒ Object
53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/dolibarr-api/api/setup.rb', line 53 def retrieve_country_by_id(id:, lang: nil) raise ArgumentError, 'id is required' if id.nil? @connection.call( :GET, '/setup/dictionary/countries/{id}' .gsub('{id}', ERB::Util.url_encode(id.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'], query: { 'lang' => lang } ) end |
#retrieve_country_by_iso(iso:, lang: nil) ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/dolibarr-api/api/setup.rb', line 66 def retrieve_country_by_iso(iso:, lang: nil) raise ArgumentError, 'iso is required' if iso.nil? @connection.call( :GET, '/setup/dictionary/countries/byISO/{iso}' .gsub('{iso}', ERB::Util.url_encode(iso.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'], query: { 'lang' => lang } ) end |
#retrieve_list_of_action_triggers(sortfield: nil, sortorder: nil, limit: nil, page: nil, elementtype: nil, lang: nil, sqlfilters: nil) ⇒ Object
79 80 81 82 83 84 85 86 87 |
# File 'lib/dolibarr-api/api/setup.rb', line 79 def retrieve_list_of_action_triggers(sortfield: nil, sortorder: nil, limit: nil, page: nil, elementtype: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/actiontriggers', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'elementtype' => elementtype, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_civilities(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
89 90 91 92 93 94 95 96 97 |
# File 'lib/dolibarr-api/api/setup.rb', line 89 def retrieve_list_of_civilities(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/civilities', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'module' => module_, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_contact_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
99 100 101 102 103 104 105 106 107 |
# File 'lib/dolibarr-api/api/setup.rb', line 99 def retrieve_list_of_contact_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/contact_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'type' => type, 'module' => module_, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_countries(sortfield: nil, sortorder: nil, limit: nil, page: nil, filter: nil, lang: nil, sqlfilters: nil) ⇒ Object
109 110 111 112 113 114 115 116 117 |
# File 'lib/dolibarr-api/api/setup.rb', line 109 def retrieve_list_of_countries(sortfield: nil, sortorder: nil, limit: nil, page: nil, filter: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/countries', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'filter' => filter, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_currencies(multicurrency: nil, sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
119 120 121 122 123 124 125 126 127 |
# File 'lib/dolibarr-api/api/setup.rb', line 119 def retrieve_list_of_currencies(multicurrency: nil, sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/currencies', type: nil, auth: ['api_key'], query: { 'multicurrency' => multicurrency, 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_event_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, sqlfilters: nil) ⇒ Object
129 130 131 132 133 134 135 136 137 |
# File 'lib/dolibarr-api/api/setup.rb', line 129 def retrieve_list_of_event_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, type: nil, module_: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/event_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'type' => type, 'module' => module_, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_expense_reports_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, sqlfilters: nil) ⇒ Object
139 140 141 142 143 144 145 146 147 |
# File 'lib/dolibarr-api/api/setup.rb', line 139 def retrieve_list_of_expense_reports_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, module_: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/expensereport_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'module' => module_, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_holiday_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
149 150 151 152 153 154 155 156 157 |
# File 'lib/dolibarr-api/api/setup.rb', line 149 def retrieve_list_of_holiday_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/holiday_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'fk_country' => fk_country, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_incoterms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
159 160 161 162 163 164 165 166 167 |
# File 'lib/dolibarr-api/api/setup.rb', line 159 def retrieve_list_of_incoterms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/incoterms', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_legal_form(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, active: nil, sqlfilters: nil) ⇒ Object
169 170 171 172 173 174 175 176 177 |
# File 'lib/dolibarr-api/api/setup.rb', line 169 def retrieve_list_of_legal_form(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/legal_form', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'country' => country, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_measuring_units(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
179 180 181 182 183 184 185 186 187 |
# File 'lib/dolibarr-api/api/setup.rb', line 179 def retrieve_list_of_measuring_units(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/units', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_public_holidays(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
189 190 191 192 193 194 195 196 197 |
# File 'lib/dolibarr-api/api/setup.rb', line 189 def retrieve_list_of_public_holidays(sortfield: nil, sortorder: nil, limit: nil, page: nil, fk_country: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/public_holiday', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'fk_country' => fk_country, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_regions(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) ⇒ Object
199 200 201 202 203 204 205 206 207 |
# File 'lib/dolibarr-api/api/setup.rb', line 199 def retrieve_list_of_regions(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/regions', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'country' => country, 'filter' => filter, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_staff(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
209 210 211 212 213 214 215 216 217 |
# File 'lib/dolibarr-api/api/setup.rb', line 209 def retrieve_list_of_staff(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/staff', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_states(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) ⇒ Object
219 220 221 222 223 224 225 226 227 |
# File 'lib/dolibarr-api/api/setup.rb', line 219 def retrieve_list_of_states(sortfield: nil, sortorder: nil, limit: nil, page: nil, country: nil, filter: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/states', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'country' => country, 'filter' => filter, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_towns(sortfield: nil, sortorder: nil, limit: nil, page: nil, zipcode: nil, town: nil, active: nil, sqlfilters: nil) ⇒ Object
229 230 231 232 233 234 235 236 237 |
# File 'lib/dolibarr-api/api/setup.rb', line 229 def retrieve_list_of_towns(sortfield: nil, sortorder: nil, limit: nil, page: nil, zipcode: nil, town: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/towns', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'zipcode' => zipcode, 'town' => town, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_of_vat(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, fk_country: nil, sqlfilters: nil) ⇒ Object
239 240 241 242 243 244 245 246 247 |
# File 'lib/dolibarr-api/api/setup.rb', line 239 def retrieve_list_of_vat(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, fk_country: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/vat', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'fk_country' => fk_country, 'sqlfilters' => sqlfilters } ) end |
#retrieve_list_ofsocial_networks(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
249 250 251 252 253 254 255 256 257 |
# File 'lib/dolibarr-api/api/setup.rb', line 249 def (sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/socialnetworks', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_ordering_methods(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
259 260 261 262 263 264 265 266 267 |
# File 'lib/dolibarr-api/api/setup.rb', line 259 def retrieve_ordering_methods(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/ordering_methods', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_ordering_origins(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
269 270 271 272 273 274 275 276 277 |
# File 'lib/dolibarr-api/api/setup.rb', line 269 def retrieve_ordering_origins(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/ordering_origins', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_payment_terms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
279 280 281 282 283 284 285 286 287 |
# File 'lib/dolibarr-api/api/setup.rb', line 279 def retrieve_payment_terms(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/payment_terms', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_payment_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) ⇒ Object
289 290 291 292 293 294 295 296 297 |
# File 'lib/dolibarr-api/api/setup.rb', line 289 def retrieve_payment_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/payment_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'sqlfilters' => sqlfilters } ) end |
#retrieve_region_by_code(code:) ⇒ Object
299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/dolibarr-api/api/setup.rb', line 299 def retrieve_region_by_code(code:) raise ArgumentError, 'code is required' if code.nil? @connection.call( :GET, '/setup/dictionary/regions/byCode/{code}' .gsub('{code}', ERB::Util.url_encode(code.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'] ) end |
#retrieve_region_by_id(id:) ⇒ Object
311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/dolibarr-api/api/setup.rb', line 311 def retrieve_region_by_id(id:) raise ArgumentError, 'id is required' if id.nil? @connection.call( :GET, '/setup/dictionary/regions/{id}' .gsub('{id}', ERB::Util.url_encode(id.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'] ) end |
#retrieve_shipping_modes(limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
323 324 325 326 327 328 329 330 331 |
# File 'lib/dolibarr-api/api/setup.rb', line 323 def retrieve_shipping_modes(limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/shipping_methods', type: nil, auth: ['api_key'], query: { 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_state_by_code(code:) ⇒ Object
333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/dolibarr-api/api/setup.rb', line 333 def retrieve_state_by_code(code:) raise ArgumentError, 'code is required' if code.nil? @connection.call( :GET, '/setup/dictionary/states/byCode/{code}' .gsub('{code}', ERB::Util.url_encode(code.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'] ) end |
#retrieve_state_by_id(id:) ⇒ Object
345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/dolibarr-api/api/setup.rb', line 345 def retrieve_state_by_id(id:) raise ArgumentError, 'id is required' if id.nil? @connection.call( :GET, '/setup/dictionary/states/{id}' .gsub('{id}', ERB::Util.url_encode(id.to_s)), type: Dolibarr::Api::Models::Obj, auth: ['api_key'] ) end |
#retrieve_thirdparties_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
357 358 359 360 361 362 363 364 365 |
# File 'lib/dolibarr-api/api/setup.rb', line 357 def retrieve_thirdparties_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/thirdparty_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_tickets_categories(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
367 368 369 370 371 372 373 374 375 |
# File 'lib/dolibarr-api/api/setup.rb', line 367 def retrieve_tickets_categories(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/ticket_categories', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_tickets_severities(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
377 378 379 380 381 382 383 384 385 |
# File 'lib/dolibarr-api/api/setup.rb', line 377 def retrieve_tickets_severities(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/ticket_severities', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |
#retrieve_tickets_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) ⇒ Object
387 388 389 390 391 392 393 394 395 |
# File 'lib/dolibarr-api/api/setup.rb', line 387 def retrieve_tickets_types(sortfield: nil, sortorder: nil, limit: nil, page: nil, active: nil, lang: nil, sqlfilters: nil) @connection.call( :GET, '/setup/dictionary/ticket_types', type: nil, auth: ['api_key'], query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'active' => active, 'lang' => lang, 'sqlfilters' => sqlfilters } ) end |