Class: Eligible::V1_0::RestAPIBase

Inherits:
APIResource show all
Defined in:
lib/eligible/v1_0/rest_api_base.rb

Constant Summary collapse

REST_API_VERSION =
'1.0'.freeze

Instance Attribute Summary

Attributes inherited from EligibleObject

#api_key, #eligible_id

Class Method Summary collapse

Methods inherited from APIResource

api_url, class_name, endpoint_name, require_param, required_param_validation, rest_api_params, send_request, url

Methods inherited from EligibleObject

#[], #[]=, construct_from, #each, #error, #initialize, #keys, #refresh_from, #to_hash, #to_json, #values

Constructor Details

This class inherits a constructor from Eligible::EligibleObject

Class Method Details

.create(params, opts = {}) ⇒ Object



12
13
14
# File 'lib/eligible/v1_0/rest_api_base.rb', line 12

def self.create(params, opts = {})
  send_request :post, api_url(endpoint_name), rest_api_params(params), **opts
end

.delete(id, opts = {}) ⇒ Object



24
25
26
# File 'lib/eligible/v1_0/rest_api_base.rb', line 24

def self.delete(id, opts = {})
  send_request :delete, api_url(endpoint_name, rest_api_params(id), :id), rest_api_params(id), **opts.merge(required_params: [:id])
end

.list(params, opts = {}) ⇒ Object



20
21
22
# File 'lib/eligible/v1_0/rest_api_base.rb', line 20

def self.list(params, opts = {})
  send_request :get, api_url(endpoint_name), rest_api_params(params), **opts
end

.retrieve(id, opts = {}) ⇒ Object



8
9
10
# File 'lib/eligible/v1_0/rest_api_base.rb', line 8

def self.retrieve(id, opts = {})
  send_request :get, api_url(endpoint_name, rest_api_params(id), :id), rest_api_params(id), **opts.merge(required_params: [:id])
end

.update(params, opts = {}) ⇒ Object



16
17
18
# File 'lib/eligible/v1_0/rest_api_base.rb', line 16

def self.update(params, opts = {})
  send_request :put, api_url(endpoint_name, rest_api_params(params), :id), rest_api_params(params), **opts.merge(required_params: [:id])
end