Class: PolenCharityDonation

Inherits:
Object
  • Object
show all
Defined in:
lib/polen_charity_donation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_token) ⇒ PolenCharityDonation

Returns a new instance of PolenCharityDonation.

Parameters:

  • api_token —

    token de acesso



10
11
12
13
 
# File 'lib/polen_charity_donation_api.rb', line 10

def initialize(api_token)
  @api_token = api_token.to_s
  @base_url = "https://api.polen.com.br/api/v2"
end

Instance Attribute Details

#api_token ⇒ Object (readonly)

Returns the value of attribute api_token.



8
9
10
 
# File 'lib/polen_charity_donation_api.rb', line 8

def api_token
  @api_token
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



8
9
10
 
# File 'lib/polen_charity_donation_api.rb', line 8

def base_url
  @base_url
end

Instance Method Details

#add_cause_store(payload, params) ⇒ Object

Método que adiciona uma causa a uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



183
184
185
186
 
# File 'lib/polen_charity_donation_api.rb', line 183

def add_cause_store(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/store/cause/add", payload.to_json, { content_type: :json, params: params })
end

#add_user_cause(payload, params) ⇒ Object

Método que adiciona ou remove uma causa a um usuário

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



299
300
301
302
 
# File 'lib/polen_charity_donation_api.rb', line 299

def add_user_cause(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/user/create", payload.to_json, { content_type: :json, params: params })
end

#create_company(payload, params = {}) ⇒ Object

Método que cria uma nova empresa na em uma conta

Parameters:

  • payload —

    dados para atualização

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



80
81
82
83
 
# File 'lib/polen_charity_donation_api.rb', line 80

def create_company(payload, params={})
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/company/create", payload.to_json, { content_type: :json, params: params })
end

#create_notify_donation(payload, params) ⇒ Object

Método que adiciona uma nova doação feita em uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



127
128
129
130
 
# File 'lib/polen_charity_donation_api.rb', line 127

def create_notify_donation(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/donation/notify/create", payload.to_json, { content_type: :json, params: params })
end

#create_store(payload, params) ⇒ Object

Método para cadastar uma nova loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



192
193
194
195
 
# File 'lib/polen_charity_donation_api.rb', line 192

def create_store(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/store/create", payload.to_json, { content_type: :json, params: params })
end

#create_user(payload, params) ⇒ Object

Método que atualiza um usuário de uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



290
291
292
293
 
# File 'lib/polen_charity_donation_api.rb', line 290

def create_user(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/user/create", payload.to_json, { content_type: :json, params: params })
end

#donation_direct(payload, params = {}) ⇒ Object

Método que cria uma doação direta

Parameters:

  • payload —

    dados para atualização

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



91
92
93
94
 
# File 'lib/polen_charity_donation_api.rb', line 91

def donation_direct(payload, params={})
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/donation/direct", payload.to_json, { content_type: :json, params: params })
end

#get_all_cause(params = {}) ⇒ Object

Método que retorna todas as causas registradas

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



20
21
22
23
 
# File 'lib/polen_charity_donation_api.rb', line 20

def get_all_cause(params={})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/cause/all", params: params)
end

#get_cause_categories(params = {}) ⇒ Object

Método que retorna todas as categorias de causas registradas

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



28
29
30
31
 
# File 'lib/polen_charity_donation_api.rb', line 28

def get_cause_categories(params={})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/cause/categories", params: params)
end

#get_company_details(params) ⇒ Object

Método que retorna detalhe de uma empresa

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



46
47
48
49
 
# File 'lib/polen_charity_donation_api.rb', line 46

def get_company_details(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/company/detail", params: params)
end

#get_company_list(params = {}) ⇒ Object

Método que retorna todas as empresas de uma conta

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



54
55
56
57
 
# File 'lib/polen_charity_donation_api.rb', line 54

def get_company_list(params={})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/company/list", params: params)
end

#get_company_stores(params) ⇒ Object

Método que retorna as lojas de uma empresa

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



62
63
64
65
 
# File 'lib/polen_charity_donation_api.rb', line 62

def get_company_stores(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/company/stores", params: params)
end

#get_content_detail(params) ⇒ Object

Método que retorna os detalhes de um conteúdo em especifico

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



219
220
221
222
 
# File 'lib/polen_charity_donation_api.rb', line 219

def get_content_detail(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/transparency/content/detail", params: params)
end

#get_content_list(params) ⇒ Object

Método que retorna uma lista de conteúdos da instituição apoiada

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



235
236
237
238
 
# File 'lib/polen_charity_donation_api.rb', line 235

def get_content_list(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/transparency/content/list", params: params)
end

#get_finance_billing_list(params) ⇒ Object

Método que retorna faturas da loja

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



137
138
139
140
 
# File 'lib/polen_charity_donation_api.rb', line 137

def get_finance_billing_list(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/finance/billing/list", params: params)
end

#get_impact_consolidated(params) ⇒ Object

Método que retorna um consolidado total já doado

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



211
212
213
214
 
# File 'lib/polen_charity_donation_api.rb', line 211

def get_impact_consolidated(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/transparency/impact/consolidated", params: params)
end

#get_notify_donation(params) ⇒ Object

Método que retorna os detalhes de uma doação

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



101
102
103
104
 
# File 'lib/polen_charity_donation_api.rb', line 101

def get_notify_donation(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/donation/notify/detail", params: params)
end

#get_notify_donation_list(params) ⇒ Object

Método que retorna uma lista de doações de uma loja

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



109
110
111
112
 
# File 'lib/polen_charity_donation_api.rb', line 109

def get_notify_donation_list(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/donation/notify/list", params: params)
end

#get_own_cause(params) ⇒ Object

Método que retorna todas as causas apoidas por uma loja

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



36
37
38
39
 
# File 'lib/polen_charity_donation_api.rb', line 36

def get_own_cause(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/cause", params: params)
end

#get_platform_list(params = {}) ⇒ Object

Método que retorna uma lista de plataformas cadastradas

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



147
148
149
150
 
# File 'lib/polen_charity_donation_api.rb', line 147

def get_platform_list(params = {})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/platform/list", params: params)
end

#get_store_details(params = {}) ⇒ Object

Método que retorna detalhes de uma loja

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



157
158
159
160
 
# File 'lib/polen_charity_donation_api.rb', line 157

def get_store_details(params = {})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/store/detail", params: params)
end

#get_store_list(params = {}) ⇒ Object

Método que retorna uma lista de lojas cadastradas em uma conta

Parameters:

  • params (defaults to: {}) —

    parametros de configuração

Returns:

  • Object



165
166
167
168
 
# File 'lib/polen_charity_donation_api.rb', line 165

def get_store_list(params = {})
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/store/list", params: params)
end

#get_transparency_receipts(params) ⇒ Object

Método que retorna os recibos de doações

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



227
228
229
230
 
# File 'lib/polen_charity_donation_api.rb', line 227

def get_transparency_receipts(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/transparency/receipts", params: params)
end

#get_user_details(params) ⇒ Object

Método que retorna detalhes de um usuário

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



256
257
258
259
 
# File 'lib/polen_charity_donation_api.rb', line 256

def get_user_details(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/user/detail", params: params)
end

#get_user_impact(params) ⇒ Object

Método que retorna detalhes do impacto causado pelo usuário

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



264
265
266
267
 
# File 'lib/polen_charity_donation_api.rb', line 264

def get_user_impact(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/user/impact", params: params)
end

#get_user_list(params) ⇒ Object

Método que retorna a lista de usuários de uma loja

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



272
273
274
275
 
# File 'lib/polen_charity_donation_api.rb', line 272

def get_user_list(params)
  params[:api_token] = @api_token
  RestClient.get("#{@base_url}/user/list", params: params)
end

#remove_cause_store(payload, params) ⇒ Object

Método para remover uma causa de uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



201
202
203
204
 
# File 'lib/polen_charity_donation_api.rb', line 201

def remove_cause_store(payload, params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/store/cause/remove", payload.to_json, { content_type: :json, params: params })
end

#update_company(payload, params) ⇒ Object

Método que atualiza os dados de uma empresa

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



71
72
73
74
 
# File 'lib/polen_charity_donation_api.rb', line 71

def update_company(payload, params)
  params[:api_token] = @api_token
  RestClient.put("#{@base_url}/company/update", payload.to_json, { content_type: :json, params: params })
end

#update_notify_donation(payload, params) ⇒ Object

Método que atualiza o status da doação

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



118
119
120
121
 
# File 'lib/polen_charity_donation_api.rb', line 118

def update_notify_donation(payload, params)
  params[:api_token] = @api_token
  RestClient.put("#{@base_url}/donation/notify/update", payload.to_json, { content_type: :json, params: params })
end

#update_status_transaction(params) ⇒ Object

Método que retorna uma lista de conteúdos da instituição apoiada

Parameters:

  • params —

    parametros de configuração

Returns:

  • Object



246
247
248
249
 
# File 'lib/polen_charity_donation_api.rb', line 246

def update_status_transaction(params)
  params[:api_token] = @api_token
  RestClient.post("#{@base_url}/transaction/update/status",{}, params: params)
end

#update_store(payload, params) ⇒ Object

Método que atualiza uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



174
175
176
177
 
# File 'lib/polen_charity_donation_api.rb', line 174

def update_store(payload, params)
  params[:api_token] = @api_token
  RestClient.put("#{@base_url}/store/update", payload.to_json, { content_type: :json, params: params })
end

#update_user(payload, params) ⇒ Object

Método que atualiza um usuário de uma loja

Parameters:

  • payload —

    dados para atualização

  • params —

    parametros de configuração

Returns:

  • Object



281
282
283
284
 
# File 'lib/polen_charity_donation_api.rb', line 281

def update_user(payload, params)
  params[:api_token] = @api_token
  RestClient.put("#{@base_url}/user/update", payload.to_json, { content_type: :json, params: params })
end