perata-sdk 0.5.4 → 0.5.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +68 -4
- data/lib/perata/client.rb +12 -1
- data/lib/perata/models.rb +308 -34
- data/lib/perata/params.rb +44 -16
- data/lib/perata/services.rb +651 -73
- data/lib/perata/version.rb +1 -1
- data/lib/perata/webhooks.rb +8 -3
- metadata +1 -1
data/lib/perata/params.rb
CHANGED
|
@@ -10,7 +10,7 @@ module Perata
|
|
|
10
10
|
# @return [String, nil]
|
|
11
11
|
attr_reader :description
|
|
12
12
|
|
|
13
|
-
# Até 50 pares
|
|
13
|
+
# Pares guardados no benefício. No feature_flag, são os valores da flag. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
14
14
|
# @return [Hash{String => Object}, nil]
|
|
15
15
|
attr_reader :metadata
|
|
16
16
|
|
|
@@ -55,7 +55,7 @@ module Perata
|
|
|
55
55
|
class BenefitsUpdateParams < Params
|
|
56
56
|
MEMBERS = %i[metadata name properties visibility].freeze
|
|
57
57
|
|
|
58
|
-
# Substitui os metadados; {} os limpa.
|
|
58
|
+
# Substitui os metadados; {} os limpa. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
59
59
|
# @return [Hash{String => Object}, nil]
|
|
60
60
|
attr_reader :metadata
|
|
61
61
|
|
|
@@ -116,7 +116,7 @@ module Perata
|
|
|
116
116
|
# @return [Integer, nil]
|
|
117
117
|
attr_reader :max_installments
|
|
118
118
|
|
|
119
|
-
# Até 50 pares
|
|
119
|
+
# Pares guardados no link. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
120
120
|
# @return [Hash{String => Object}, nil]
|
|
121
121
|
attr_reader :metadata
|
|
122
122
|
|
|
@@ -199,7 +199,7 @@ module Perata
|
|
|
199
199
|
# @return [String, nil]
|
|
200
200
|
attr_reader :label
|
|
201
201
|
|
|
202
|
-
# Substitui os metadados; {} os limpa.
|
|
202
|
+
# Substitui os metadados; {} os limpa. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
203
203
|
# @return [Hash{String => Object}, nil]
|
|
204
204
|
attr_reader :metadata
|
|
205
205
|
|
|
@@ -238,7 +238,7 @@ module Perata
|
|
|
238
238
|
|
|
239
239
|
# The body of checkouts:create.
|
|
240
240
|
class CheckoutsCreateParams < Params
|
|
241
|
-
MEMBERS = %i[allow_discount_codes amount_cents cancel_url client_reference_id customer_email customer_id customer_name expires_in external_customer_id items label metadata price_id product_id quantity require_billing_address return_url success_url].freeze
|
|
241
|
+
MEMBERS = %i[allow_discount_codes amount_cents cancel_url client_reference_id customer_email customer_id customer_name discount_id expires_in external_customer_id items label metadata price_id product_id quantity require_billing_address return_url subscription_start_at success_url].freeze
|
|
242
242
|
|
|
243
243
|
# Deixa o comprador digitar um código de desconto; desligado quando fica de fora.
|
|
244
244
|
# @return [Boolean, nil]
|
|
@@ -267,6 +267,10 @@ module Perata
|
|
|
267
267
|
# @return [String, nil]
|
|
268
268
|
attr_reader :customer_name
|
|
269
269
|
|
|
270
|
+
# O desconto do catálogo que o checkout aplica sozinho, sem o comprador digitar código: o valor dele (percentual ou fixo) é tirado do total e vale como o desconto foi criado, uma vez, por alguns meses ou para sempre. Um desconto limitado a produtos (product_ids na criação do desconto) só vale para esses produtos: num checkout de uma câmera, o desconto de uma câmera. Um id que não é de um desconto ativo do catálogo é recusado com 422.
|
|
271
|
+
# @return [String, nil]
|
|
272
|
+
attr_reader :discount_id
|
|
273
|
+
|
|
270
274
|
# Segundos em que a sessão e o client_secret continuam valendo, de um minuto a três dias; 1800 (30 minutos) quando fica de fora. Uma sessão paga com Pix pode ser aberta até esse prazo e, aberta, o Pix gerado vale 24 horas.
|
|
271
275
|
# @return [Integer, nil]
|
|
272
276
|
attr_reader :expires_in
|
|
@@ -275,14 +279,14 @@ module Perata
|
|
|
275
279
|
# @return [String, nil]
|
|
276
280
|
attr_reader :external_customer_id
|
|
277
281
|
|
|
278
|
-
# As linhas do pedido, até 50, para o comprador ler o detalhe: aparecem no checkout (página, modal, componentes e transparente), no pedido, no recibo, no portal do cliente e nos eventos.
|
|
282
|
+
# As linhas do pedido, até 50, para o comprador ler o detalhe: aparecem no checkout (página, modal, componentes e transparente), no pedido, no recibo, no portal do cliente e nos eventos. Em um preço de valor livre, a soma de quantity vezes unit_amount_cents precisa ser igual a amount_cents, ou a resposta é 422; enviadas sem amount_cents, a soma é o valor. Em um preço com valor próprio, como o de uma assinatura, as linhas só mostram ao comprador do que o valor é feito e fixam nada: envie-as sem amount_cents, com a soma igual ao valor do preço vezes a quantidade (senão 422), e o preço continua sendo quem define o que se cobra.
|
|
279
283
|
# @return [Array<CheckoutsCreateItem>, nil]
|
|
280
284
|
attr_reader :items
|
|
281
285
|
|
|
282
286
|
# @return [String, nil]
|
|
283
287
|
attr_reader :label
|
|
284
288
|
|
|
285
|
-
#
|
|
289
|
+
# Pares guardados no link do checkout e devolvidos no checkout, no pedido, no pagamento e nos eventos da venda. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
286
290
|
# @return [Hash{String => Object}, nil]
|
|
287
291
|
attr_reader :metadata
|
|
288
292
|
|
|
@@ -304,10 +308,14 @@ module Perata
|
|
|
304
308
|
# @return [String, nil]
|
|
305
309
|
attr_reader :return_url
|
|
306
310
|
|
|
311
|
+
# O dia da primeira cobrança de uma assinatura, como o trial_end do Stripe: o cartão é guardado e conferido com o emissor, nada é cobrado hoje e a primeira cobrança acontece nesse dia, no cartão guardado; as seguintes seguem a periodicidade do preço a partir dele. Só vale em um preço recorrente com valor, e só no cartão de crédito: a página não oferece Pix nem boleto. Vale o dia no horário de São Paulo, da meia-noite dele, qualquer que seja o fuso enviado; a hora não conta. Tem de ser de amanhã a um ano, senão a resposta é 422. A resposta devolve o instante como a Peráta o guarda, em subscription_start_at. Quem abre o checkout depois da data recebe 410.
|
|
312
|
+
# @return [String, nil]
|
|
313
|
+
attr_reader :subscription_start_at
|
|
314
|
+
|
|
307
315
|
# @return [String, nil]
|
|
308
316
|
attr_reader :success_url
|
|
309
317
|
|
|
310
|
-
def initialize(allow_discount_codes: nil, amount_cents: nil, cancel_url: nil, client_reference_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, expires_in: nil, external_customer_id: nil, items: nil, label: nil, metadata: nil, price_id:, product_id:, quantity: nil, require_billing_address: nil, return_url: nil, success_url: nil)
|
|
318
|
+
def initialize(allow_discount_codes: nil, amount_cents: nil, cancel_url: nil, client_reference_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, discount_id: nil, expires_in: nil, external_customer_id: nil, items: nil, label: nil, metadata: nil, price_id:, product_id:, quantity: nil, require_billing_address: nil, return_url: nil, subscription_start_at: nil, success_url: nil)
|
|
311
319
|
@allow_discount_codes = allow_discount_codes
|
|
312
320
|
@amount_cents = amount_cents
|
|
313
321
|
@cancel_url = cancel_url
|
|
@@ -315,6 +323,7 @@ module Perata
|
|
|
315
323
|
@customer_email = customer_email
|
|
316
324
|
@customer_id = customer_id
|
|
317
325
|
@customer_name = customer_name
|
|
326
|
+
@discount_id = discount_id
|
|
318
327
|
@expires_in = expires_in
|
|
319
328
|
@external_customer_id = external_customer_id
|
|
320
329
|
@items = items
|
|
@@ -325,6 +334,7 @@ module Perata
|
|
|
325
334
|
@quantity = quantity
|
|
326
335
|
@require_billing_address = require_billing_address
|
|
327
336
|
@return_url = return_url
|
|
337
|
+
@subscription_start_at = subscription_start_at
|
|
328
338
|
@success_url = success_url
|
|
329
339
|
freeze
|
|
330
340
|
end
|
|
@@ -339,6 +349,7 @@ module Perata
|
|
|
339
349
|
wire["customer_email"] = @customer_email unless @customer_email.nil?
|
|
340
350
|
wire["customer_id"] = @customer_id unless @customer_id.nil?
|
|
341
351
|
wire["customer_name"] = @customer_name unless @customer_name.nil?
|
|
352
|
+
wire["discount_id"] = @discount_id unless @discount_id.nil?
|
|
342
353
|
wire["expires_in"] = @expires_in unless @expires_in.nil?
|
|
343
354
|
wire["external_customer_id"] = @external_customer_id unless @external_customer_id.nil?
|
|
344
355
|
wire["items"] = Perata.wire(@items) unless @items.nil?
|
|
@@ -349,6 +360,7 @@ module Perata
|
|
|
349
360
|
wire["quantity"] = @quantity unless @quantity.nil?
|
|
350
361
|
wire["require_billing_address"] = @require_billing_address unless @require_billing_address.nil?
|
|
351
362
|
wire["return_url"] = @return_url unless @return_url.nil?
|
|
363
|
+
wire["subscription_start_at"] = @subscription_start_at unless @subscription_start_at.nil?
|
|
352
364
|
wire["success_url"] = @success_url unless @success_url.nil?
|
|
353
365
|
wire
|
|
354
366
|
end
|
|
@@ -1024,23 +1036,37 @@ module Perata
|
|
|
1024
1036
|
|
|
1025
1037
|
# The body of refunds:create.
|
|
1026
1038
|
class RefundsCreateParams < Params
|
|
1027
|
-
MEMBERS = %i[amount_cents note payment_id reason].freeze
|
|
1039
|
+
MEMBERS = %i[amount_cents metadata note order_id payment_id reason].freeze
|
|
1028
1040
|
|
|
1029
|
-
#
|
|
1041
|
+
# Quanto devolver, em centavos, de 1 até o que ainda pode ser devolvido. Sem ele, devolve tudo o que ainda pode ser devolvido.
|
|
1042
|
+
# @return [Integer, nil]
|
|
1030
1043
|
attr_reader :amount_cents
|
|
1031
1044
|
|
|
1045
|
+
# Pares seus guardados no reembolso; voltam como refund_metadata no reembolso e nos eventos refund.created e refund.updated, onde metadata é o do pedido. O filtro metadata[chave]=valor de GET /refunds procura estes pares. Até 50 pares de chave e valor: a chave tem de 1 a 40 caracteres, e o valor é um texto de 1 a 500 caracteres, um número ou um booleano. Texto sem caracteres de controle nem de direção invisível.
|
|
1046
|
+
# @return [Hash{String => Object}, nil]
|
|
1047
|
+
attr_reader :metadata
|
|
1048
|
+
|
|
1049
|
+
# Uma observação sua, de até 500 caracteres.
|
|
1032
1050
|
# @return [String, nil]
|
|
1033
1051
|
attr_reader :note
|
|
1034
1052
|
|
|
1035
|
-
#
|
|
1053
|
+
# O pedido (o id que GET /orders/{id} recebe) cujo pagamento capturado é devolvido. Dispensa o payment_id.
|
|
1054
|
+
# @return [String, nil]
|
|
1055
|
+
attr_reader :order_id
|
|
1056
|
+
|
|
1057
|
+
# O pagamento de que o dinheiro volta. Envie este ou o order_id; os dois juntos só se forem do mesmo pagamento.
|
|
1058
|
+
# @return [String, nil]
|
|
1036
1059
|
attr_reader :payment_id
|
|
1037
1060
|
|
|
1038
|
-
#
|
|
1061
|
+
# Por que o dinheiro volta. Sem ele, requested_by_customer; com other a note é obrigatória.
|
|
1062
|
+
# @return [String ("requested_by_customer", "duplicate", "fraudulent", "product_unavailable", "service_disruption", "other"), nil]
|
|
1039
1063
|
attr_reader :reason
|
|
1040
1064
|
|
|
1041
|
-
def initialize(amount_cents
|
|
1065
|
+
def initialize(amount_cents: nil, metadata: nil, note: nil, order_id: nil, payment_id: nil, reason: nil)
|
|
1042
1066
|
@amount_cents = amount_cents
|
|
1067
|
+
@metadata = metadata
|
|
1043
1068
|
@note = note
|
|
1069
|
+
@order_id = order_id
|
|
1044
1070
|
@payment_id = payment_id
|
|
1045
1071
|
@reason = reason
|
|
1046
1072
|
freeze
|
|
@@ -1049,10 +1075,12 @@ module Perata
|
|
|
1049
1075
|
# The body as the API reads it.
|
|
1050
1076
|
def to_wire
|
|
1051
1077
|
wire = {}
|
|
1052
|
-
wire["amount_cents"] = @amount_cents
|
|
1078
|
+
wire["amount_cents"] = @amount_cents unless @amount_cents.nil?
|
|
1079
|
+
wire["metadata"] = Perata.wire(@metadata) unless @metadata.nil?
|
|
1053
1080
|
wire["note"] = @note unless @note.nil?
|
|
1054
|
-
wire["
|
|
1055
|
-
wire["
|
|
1081
|
+
wire["order_id"] = @order_id unless @order_id.nil?
|
|
1082
|
+
wire["payment_id"] = @payment_id unless @payment_id.nil?
|
|
1083
|
+
wire["reason"] = @reason unless @reason.nil?
|
|
1056
1084
|
wire
|
|
1057
1085
|
end
|
|
1058
1086
|
end
|