Class: GeniusReferrals::ReferralsResource
- Defined in:
- lib/genius_referrals/resources/referrals.rb
Instance Method Summary collapse
-
#create(account_slug, advocate_token, referral) ⇒ Object
Create a referral.
-
#delete(account_slug, advocate_token, referral_id) ⇒ Object
Delete one referral.
-
#list(account_slug, advocate_token, page: 1, limit: 10, filter: nil, sort: nil) ⇒ Object
List referrals for one advocate.
-
#retrieve(account_slug, advocate_token, referral_id) ⇒ Object
Retrieve one referral.
-
#update(account_slug, advocate_token, referral_id, referral) ⇒ Object
Replace one referral.
Methods inherited from Resource
Constructor Details
This class inherits a constructor from GeniusReferrals::Resource
Instance Method Details
#create(account_slug, advocate_token, referral) ⇒ Object
Create a referral.
11 12 13 14 15 |
# File 'lib/genius_referrals/resources/referrals.rb', line 11 def create(account_slug, advocate_token, referral) request('POST', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals", json: wrapped('referral', referral)) end |
#delete(account_slug, advocate_token, referral_id) ⇒ Object
Delete one referral.
30 31 32 |
# File 'lib/genius_referrals/resources/referrals.rb', line 30 def delete(account_slug, advocate_token, referral_id) request('DELETE', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}") end |
#list(account_slug, advocate_token, page: 1, limit: 10, filter: nil, sort: nil) ⇒ Object
List referrals for one advocate.
4 5 6 7 8 |
# File 'lib/genius_referrals/resources/referrals.rb', line 4 def list(account_slug, advocate_token, page: 1, limit: 10, filter: nil, sort: nil) page('GET', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals", params: compact(page: page, limit: limit, filter: filter, sort: sort)) end |
#retrieve(account_slug, advocate_token, referral_id) ⇒ Object
Retrieve one referral.
18 19 20 |
# File 'lib/genius_referrals/resources/referrals.rb', line 18 def retrieve(account_slug, advocate_token, referral_id) request('GET', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}") end |
#update(account_slug, advocate_token, referral_id, referral) ⇒ Object
Replace one referral.
23 24 25 26 27 |
# File 'lib/genius_referrals/resources/referrals.rb', line 23 def update(account_slug, advocate_token, referral_id, referral) request('PUT', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}", json: wrapped('referral', referral)) end |