class PolenCharityDonation

Attributes

api_token[R]
base_url[R]

Public Class Methods

new(api_token) click to toggle source

@param api_token token de acesso

# 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

Public Instance Methods

add_cause_store(payload, params) click to toggle source

Método que adiciona uma causa a uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que adiciona ou remove uma causa a um usuário @param payload dados para atualização @param params parametros de configuração @return Object

# 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={}) click to toggle source

Método que cria uma nova empresa na em uma conta @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que adiciona uma nova doação feita em uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método para cadastar uma nova loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que atualiza um usuário de uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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={}) click to toggle source

Método que cria uma doação direta @param payload dados para atualização @param params parametros de configuração @return Object

# 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={}) click to toggle source

Método que retorna todas as causas registradas @param params parametros de configuração @return Object

# 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={}) click to toggle source

Método que retorna todas as categorias de causas registradas @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna detalhe de uma empresa @param params parametros de configuração @return Object

# 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={}) click to toggle source

Método que retorna todas as empresas de uma conta @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna as lojas de uma empresa @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna os detalhes de um conteúdo em especifico @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna uma lista de conteúdos da instituição apoiada @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna faturas da loja @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna um consolidado total já doado @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna os detalhes de uma doação @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna uma lista de doações de uma loja @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna todas as causas apoidas por uma loja @param params parametros de configuração @return Object

# 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 = {}) click to toggle source

Método que retorna uma lista de plataformas cadastradas @param params parametros de configuração @return Object

# 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 = {}) click to toggle source

Método que retorna detalhes de uma loja @param params parametros de configuração @return Object

# 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 = {}) click to toggle source

Método que retorna uma lista de lojas cadastradas em uma conta @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna os recibos de doações @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna detalhes de um usuário @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna detalhes do impacto causado pelo usuário @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna a lista de usuários de uma loja @param params parametros de configuração @return Object

# 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) click to toggle source

Método para remover uma causa de uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que atualiza os dados de uma empresa @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que atualiza o status da doação @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que retorna uma lista de conteúdos da instituição apoiada @param params parametros de configuração @return Object

# 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) click to toggle source

Método que atualiza uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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) click to toggle source

Método que atualiza um usuário de uma loja @param payload dados para atualização @param params parametros de configuração @return Object

# 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