Class: Adyen::DonationCampaignsApi

Inherits:
Service
  • Object
show all
Defined in:
lib/adyen/services/management/donation_campaigns_api.rb

Overview

NOTE: This class is auto generated by OpenAPI Generator Ref: https://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) ⇒ DonationCampaignsApi

Returns a new instance of DonationCampaignsApi.



11
12
13
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 11

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

Instance Attribute Details

#service ⇒ Object

Returns the value of attribute service.



9
10
11
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 9

def service
  @service
end

#version ⇒ Object

Returns the value of attribute version.



9
10
11
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 9

def version
  @version
end

Instance Method Details

#create_donation_campaign(request, company_id, headers: {}) ⇒ Object

Create a donation campaign



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

def create_donation_campaign(request, company_id, headers: {})
  endpoint = build_endpoint('/companies/{companyId}/campaignManagement', company_id)
  
  action = { method: 'post', url: endpoint }
  @client.call_adyen_api(@service, action, request, headers, @version)
end

#delete_donation_campaign(company_id, donation_campaign_id, headers: {}) ⇒ Object

Delete a donation campaign



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

def delete_donation_campaign(company_id, donation_campaign_id, headers: {})
  endpoint = build_endpoint('/companies/{companyId}/campaignManagement/{donationCampaignId}', company_id, donation_campaign_id)
  
  action = { method: 'delete', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end

#list_donation_campaigns_for_account_holder(company_id, account_holder_id, headers: {}, query_params: {}) ⇒ Object

Get the donation campaigns for an account holder



32
33
34
35
36
37
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 32

def (company_id, , headers: {}, query_params: {})
  endpoint = build_endpoint('/companies/{companyId}/campaignManagement/accountHolders/{accountHolderId}', company_id, )
  endpoint += create_query_string(query_params)
  action = { method: 'get', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end

#list_nonprofits(request, company_id, headers: {}, query_params: {}) ⇒ Object

Get a list of nonprofits



40
41
42
43
44
45
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 40

def list_nonprofits(request, company_id, headers: {}, query_params: {})
  endpoint = build_endpoint('/companies/{companyId}/nonprofits', company_id)
  endpoint += create_query_string(query_params)
  action = { method: 'post', url: endpoint }
  @client.call_adyen_api(@service, action, request, headers, @version)
end

#update_donation_campaign(request, company_id, donation_campaign_id, headers: {}) ⇒ Object

Update a donation campaign



48
49
50
51
52
53
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 48

def update_donation_campaign(request, company_id, donation_campaign_id, headers: {})
  endpoint = build_endpoint('/companies/{companyId}/campaignManagement/{donationCampaignId}', company_id, donation_campaign_id)
  
  action = { method: 'patch', url: endpoint }
  @client.call_adyen_api(@service, action, request, headers, @version)
end

#update_donation_campaign_status(company_id, donation_campaign_id, status, headers: {}) ⇒ Object

Activate or end a donation campaign



56
57
58
59
60
61
 
# File 'lib/adyen/services/management/donation_campaigns_api.rb', line 56

def update_donation_campaign_status(company_id, donation_campaign_id, status, headers: {})
  endpoint = build_endpoint('/companies/{companyId}/campaignManagement/{donationCampaignId}/status/{status}', company_id, donation_campaign_id, status)
  
  action = { method: 'post', url: endpoint }
  @client.call_adyen_api(@service, action, {}, headers, @version)
end