Class: Adyen::GrantOffersApi

Inherits:
Service
  • Object
show all
Defined in:
lib/adyen/services/capital/grant_offers_api.rb,
lib/adyen/services/balancePlatform/grant_offers_api.rb

Overview

NOTE: This class is auto generated by OpenAPI Generator Ref: openapi-generator.tech

Do not edit the class manually.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Service

action_for_method_name, #create_query_string

Constructor Details

#initialize(client, version = DEFAULT_VERSION) ⇒ GrantOffersApi

Returns a new instance of GrantOffersApi.



11
12
13
 
# File 'lib/adyen/services/capital/grant_offers_api.rb', line 11

def initialize(client, version = DEFAULT_VERSION)
  super(client, version, 'Capital')
end

Instance Attribute Details

#service ⇒ Object

Returns the value of attribute service.



9
10
11
 
# File 'lib/adyen/services/capital/grant_offers_api.rb', line 9

def service
  @service
end

#version ⇒ Object

Returns the value of attribute version.



9
10
11
 
# File 'lib/adyen/services/capital/grant_offers_api.rb', line 9

def version
  @version
end

Instance Method Details

#get_all_available_grant_offers(headers: {}, query_params: {}) ⇒ Object

Get all available grant offers

Deprecated since Configuration API v2 Use the ‘/grantOffers` endpoint from the [Capital API](docs.adyen.com/api-explorer/capital/latest/get/grantOffers) instead.



19
20
21
22
23
24
 
# File 'lib/adyen/services/balancePlatform/grant_offers_api.rb', line 19

def get_all_available_grant_offers(headers: {}, query_params: {})
  endpoint = build_endpoint('/grantOffers')
  endpoint += create_query_string(query_params)
  action = { method: 'get', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end

#get_all_grant_offers(headers: {}, query_params: {}) ⇒ Object

Get all available static offers



16
17
18
19
20
21
 
# File 'lib/adyen/services/capital/grant_offers_api.rb', line 16

def get_all_grant_offers(headers: {}, query_params: {})
  endpoint = build_endpoint('/grantOffers')
  endpoint += create_query_string(query_params)
  action = { method: 'get', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end

#get_grant_offer(grant_offer_id, headers: {}) ⇒ Object

Get a grant offer

Deprecated since Configuration API v2 Use the ‘/grantOffers/id` endpoint from the [Capital API](docs.adyen.com/api-explorer/capital/latest/get/grantOffers/(id)) instead.



24
25
26
27
28
29
 
# File 'lib/adyen/services/capital/grant_offers_api.rb', line 24

def get_grant_offer(id, headers: {})
  endpoint = build_endpoint('/grantOffers/{id}', id)
  
  action = { method: 'get', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end