perata-sdk 0.1.1 → 0.3.0

data/lib/perata/services.rb

@@ -3,13 +3,152 @@
 # Code generated by sdk/generator. DO NOT EDIT.
 
 module Perata
+  # The API's benefits.
+  class BenefitsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Criar um benefício custom, license_key, feature_flag ou meter_credit; downloads e os benefícios do Discord e do GitHub se configuram no painel.
+    #
+    # @param params [BenefitsCreateParams, Hash]
+    # @return [Benefit]
+    def create(params, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/benefits", body: BenefitsCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Benefit.from_hash(data)
+    end
+
+    # Excluir um benefício: ele sai de todos os produtos e é revogado de quem o tem. The API answers 204, so there is nothing to return.
+    #
+    # @return [nil]
+    def delete(benefit, idempotency_key: nil, api_key: nil)
+      @client.request("DELETE", "/api/v1/benefits/#{Perata.segment(benefit)}", idempotency_key: idempotency_key, api_key: api_key)
+      nil
+    end
+
+    # Ler um benefício.
+    #
+    # @return [Benefit]
+    def get(benefit, api_key: nil)
+      data = @client.request("GET", "/api/v1/benefits/#{Perata.segment(benefit)}", api_key: api_key)
+      Benefit.from_hash(data)
+    end
+
+    # Listar benefícios, opcionalmente de um tipo (type). One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Benefit>]
+    def list(page: nil, limit: nil, type: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "type" => type }
+      data = @client.request("GET", "/api/v1/benefits", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Benefit.from_hash(item) }
+    end
+
+    # Walks every page of benefits:list from +page+, item by item.
+    #
+    # @return [Enumerator<Benefit>]
+    def list_iter(page: nil, limit: nil, type: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, type: type, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Listar as concessões de um benefício, opcionalmente de um cliente (customer_id) ou só as vigentes (is_granted). One page; +list_grants_iter+ walks every page.
+    #
+    # @return [Page<BenefitGrant>]
+    def list_grants(benefit, page: nil, limit: nil, customer_id: nil, is_granted: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "customer_id" => customer_id, "is_granted" => is_granted }
+      data = @client.request("GET", "/api/v1/benefits/#{Perata.segment(benefit)}/grants", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| BenefitGrant.from_hash(item) }
+    end
+
+    # Walks every page of benefits:list_grants from +page+, item by item.
+    #
+    # @return [Enumerator<BenefitGrant>]
+    def list_grants_iter(benefit, page: nil, limit: nil, customer_id: nil, is_granted: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list_grants(benefit, page: at, limit: limit, customer_id: customer_id, is_granted: is_granted, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Atualizar o nome, a visibilidade, as propriedades e os metadados de um benefício; o tipo e a descrição dada na criação não mudam, e o que a concessão já entregou fica como foi entregue.
+    #
+    # @param params [BenefitsUpdateParams, Hash]
+    # @return [Benefit]
+    def update(benefit, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/benefits/#{Perata.segment(benefit)}", body: BenefitsUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Benefit.from_hash(data)
+    end
+  end
+
+  # The API's checkout-links.
+  class CheckoutLinksService
+    def initialize(client)
+      @client = client
+    end
+
+    # Criar um link de checkout: uma oferta durável de um ou mais produtos, com desconto, quantidade e páginas de retorno.
+    #
+    # @param params [CheckoutLinksCreateParams, Hash]
+    # @return [CheckoutLink]
+    def create(params, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/checkout-links", body: CheckoutLinksCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      CheckoutLink.from_hash(data)
+    end
+
+    # Excluir um link de checkout: ele deixa de abrir checkouts; os que já abriu continuam. The API answers 204, so there is nothing to return.
+    #
+    # @return [nil]
+    def delete(checkout_link, idempotency_key: nil, api_key: nil)
+      @client.request("DELETE", "/api/v1/checkout-links/#{Perata.segment(checkout_link)}", idempotency_key: idempotency_key, api_key: api_key)
+      nil
+    end
+
+    # Ler um link de checkout.
+    #
+    # @return [CheckoutLink]
+    def get(checkout_link, api_key: nil)
+      data = @client.request("GET", "/api/v1/checkout-links/#{Perata.segment(checkout_link)}", api_key: api_key)
+      CheckoutLink.from_hash(data)
+    end
+
+    # Listar links de checkout. One page; +list_iter+ walks every page.
+    #
+    # @return [Page<CheckoutLink>]
+    def list(page: nil, limit: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit }
+      data = @client.request("GET", "/api/v1/checkout-links", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| CheckoutLink.from_hash(item) }
+    end
+
+    # Walks every page of checkout-links:list from +page+, item by item.
+    #
+    # @return [Enumerator<CheckoutLink>]
+    def list_iter(page: nil, limit: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Atualizar o rótulo, as páginas de retorno, os produtos e os metadados de um link; a quantidade e o desconto ficam como foram publicados.
+    #
+    # @param params [CheckoutLinksUpdateParams, Hash]
+    # @return [CheckoutLink]
+    def update(checkout_link, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/checkout-links/#{Perata.segment(checkout_link)}", body: CheckoutLinksUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      CheckoutLink.from_hash(data)
+    end
+  end
+
   # The API's checkouts.
   class CheckoutsService
     def initialize(client)
       @client = client
     end
 
-    # Create a checkout address for one product and price.
+    # Criar o endereço de um checkout para um produto e um preço.
     #
     # @param params [CheckoutsCreateParams, Hash]
     # @return [Checkout]
@@ -17,6 +156,39 @@ module Perata
       data = @client.request("POST", "/api/v1/checkouts", body: CheckoutsCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
       Checkout.from_hash(data)
     end
+
+    # Ler um checkout: o endereço, o estado e as páginas de retorno.
+    #
+    # @return [Checkout]
+    def get(checkout, api_key: nil)
+      data = @client.request("GET", "/api/v1/checkouts/#{Perata.segment(checkout)}", api_key: api_key)
+      Checkout.from_hash(data)
+    end
+
+    # Atualizar o rótulo e as páginas de retorno de um checkout ativo.
+    #
+    # @param params [CheckoutsUpdateParams, Hash]
+    # @return [Checkout]
+    def update(checkout, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/checkouts/#{Perata.segment(checkout)}", body: CheckoutsUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Checkout.from_hash(data)
+    end
+  end
+
+  # The API's customer-sessions.
+  class CustomerSessionsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Entrar com um cliente no portal do cliente: o endereço o abre já autenticado.
+    #
+    # @param params [CustomerSessionsCreateParams, Hash]
+    # @return [CustomerSession]
+    def create(params, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/customer-sessions", body: CustomerSessionsCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      CustomerSession.from_hash(data)
+    end
   end
 
   # The API's customers.
@@ -25,7 +197,7 @@ module Perata
       @client = client
     end
 
-    # Create a customer.
+    # Criar um cliente.
     #
     # @param params [CustomersCreateParams, Hash]
     # @return [Customer]
@@ -34,7 +206,15 @@ module Perata
       Customer.from_hash(data)
     end
 
-    # Read a customer.
+    # Excluir um cliente: as assinaturas terminam na hora, os benefícios são revogados e o ID externo é liberado; pedidos e pagamentos continuam. The API answers 204, so there is nothing to return.
+    #
+    # @return [nil]
+    def delete(customer, idempotency_key: nil, api_key: nil)
+      @client.request("DELETE", "/api/v1/customers/#{Perata.segment(customer)}", idempotency_key: idempotency_key, api_key: api_key)
+      nil
+    end
+
+    # Ler um cliente.
     #
     # @return [Customer]
     def get(customer, api_key: nil)
@@ -42,7 +222,23 @@ module Perata
       Customer.from_hash(data)
     end
 
-    # List customers. One page; +list_iter+ walks every page.
+    # Ler um cliente pelo ID dele no sistema do lojista (external_id).
+    #
+    # @return [Customer]
+    def get_external(external_id, api_key: nil)
+      data = @client.request("GET", "/api/v1/external-customers/#{Perata.segment(external_id)}", api_key: api_key)
+      Customer.from_hash(data)
+    end
+
+    # Ler o estado de um cliente: assinaturas ativas e benefícios vigentes, inclusive os feature flags.
+    #
+    # @return [CustomerState]
+    def get_state(customer, api_key: nil)
+      data = @client.request("GET", "/api/v1/customers/#{Perata.segment(customer)}/state", api_key: api_key)
+      CustomerState.from_hash(data)
+    end
+
+    # Listar clientes. One page; +list_iter+ walks every page.
     #
     # @return [Page<Customer>]
     def list(page: nil, limit: nil, api_key: nil)
@@ -60,6 +256,178 @@ module Perata
       end
       block ? items.each(&block) : items
     end
+
+    # Atualizar o nome, o e-mail ou o ID externo de um cliente; o ID externo não muda depois de definido.
+    #
+    # @param params [CustomersUpdateParams, Hash]
+    # @return [Customer]
+    def update(customer, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/customers/#{Perata.segment(customer)}", body: CustomersUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Customer.from_hash(data)
+    end
+
+    # Atualizar um cliente pelo ID dele no sistema do lojista (external_id).
+    #
+    # @param params [CustomersUpdateExternalParams, Hash]
+    # @return [Customer]
+    def update_external(external_id, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/external-customers/#{Perata.segment(external_id)}", body: CustomersUpdateExternalParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Customer.from_hash(data)
+    end
+  end
+
+  # The API's discounts.
+  class DiscountsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Criar um desconto percentual (basis_points) ou fixo em reais (amount_cents).
+    #
+    # @param params [DiscountsCreateParams, Hash]
+    # @return [Discount]
+    def create(params, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/discounts", body: DiscountsCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Discount.from_hash(data)
+    end
+
+    # Excluir um desconto: sai das listas e dos checkouts e o código fica livre; o que ele já descontou continua nos registros. The API answers 204, so there is nothing to return.
+    #
+    # @return [nil]
+    def delete(discount, idempotency_key: nil, api_key: nil)
+      @client.request("DELETE", "/api/v1/discounts/#{Perata.segment(discount)}", idempotency_key: idempotency_key, api_key: api_key)
+      nil
+    end
+
+    # Ler um desconto.
+    #
+    # @return [Discount]
+    def get(discount, api_key: nil)
+      data = @client.request("GET", "/api/v1/discounts/#{Perata.segment(discount)}", api_key: api_key)
+      Discount.from_hash(data)
+    end
+
+    # Listar descontos. One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Discount>]
+    def list(page: nil, limit: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit }
+      data = @client.request("GET", "/api/v1/discounts", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Discount.from_hash(item) }
+    end
+
+    # Walks every page of discounts:list from +page+, item by item.
+    #
+    # @return [Enumerator<Discount>]
+    def list_iter(page: nil, limit: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Atualizar um desconto; o tipo e a duração não mudam, e depois do primeiro uso o valor e os meses também não.
+    #
+    # @param params [DiscountsUpdateParams, Hash]
+    # @return [Discount]
+    def update(discount, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/discounts/#{Perata.segment(discount)}", body: DiscountsUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Discount.from_hash(data)
+    end
+  end
+
+  # The API's disputes.
+  class DisputesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Ler uma disputa.
+    #
+    # @return [Dispute]
+    def get(dispute, api_key: nil)
+      data = @client.request("GET", "/api/v1/disputes/#{Perata.segment(dispute)}", api_key: api_key)
+      Dispute.from_hash(data)
+    end
+
+    # Listar disputas, opcionalmente de um status (status). One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Dispute>]
+    def list(page: nil, limit: nil, status: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "status" => status }
+      data = @client.request("GET", "/api/v1/disputes", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Dispute.from_hash(item) }
+    end
+
+    # Walks every page of disputes:list from +page+, item by item.
+    #
+    # @return [Enumerator<Dispute>]
+    def list_iter(page: nil, limit: nil, status: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, status: status, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+  end
+
+  # The API's events.
+  class EventsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Listar os eventos de consumo que as origens enviaram, do mais novo ao mais antigo. One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Event>]
+    def list(page: nil, limit: nil, customer_id: nil, start: nil, end_: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "customer_id" => customer_id, "start" => start, "end" => end_ }
+      data = @client.request("GET", "/api/v1/events", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Event.from_hash(item) }
+    end
+
+    # Walks every page of events:list from +page+, item by item.
+    #
+    # @return [Enumerator<Event>]
+    def list_iter(page: nil, limit: nil, customer_id: nil, start: nil, end_: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, customer_id: customer_id, start: start, end_: end_, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+  end
+
+  # The API's meters.
+  class MetersService
+    def initialize(client)
+      @client = client
+    end
+
+    # Ler um medidor: o filtro dos eventos que ele conta, a agregação e a unidade.
+    #
+    # @return [Meter]
+    def get(meter, api_key: nil)
+      data = @client.request("GET", "/api/v1/meters/#{Perata.segment(meter)}", api_key: api_key)
+      Meter.from_hash(data)
+    end
+
+    # Listar medidores; os arquivados só com is_archived=true. One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Meter>]
+    def list(page: nil, limit: nil, is_archived: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "is_archived" => is_archived }
+      data = @client.request("GET", "/api/v1/meters", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Meter.from_hash(item) }
+    end
+
+    # Walks every page of meters:list from +page+, item by item.
+    #
+    # @return [Enumerator<Meter>]
+    def list_iter(page: nil, limit: nil, is_archived: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, is_archived: is_archived, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
   end
 
   # The API's orders.
@@ -68,7 +436,31 @@ module Perata
       @client = client
     end
 
-    # List orders: paid checkouts. One page; +list_iter+ walks every page.
+    # Ler um pedido: um checkout pago.
+    #
+    # @return [Order]
+    def get(order, api_key: nil)
+      data = @client.request("GET", "/api/v1/orders/#{Perata.segment(order)}", api_key: api_key)
+      Order.from_hash(data)
+    end
+
+    # Ler a fatura de um pedido, o documento comercial que o lojista gerou; sem ela, 404.
+    #
+    # @return [OrderInvoice]
+    def get_invoice(order, api_key: nil)
+      data = @client.request("GET", "/api/v1/orders/#{Perata.segment(order)}/invoice", api_key: api_key)
+      OrderInvoice.from_hash(data)
+    end
+
+    # Ler o recibo de um pedido: o que foi pago, quando e como.
+    #
+    # @return [OrderReceipt]
+    def get_receipt(order, api_key: nil)
+      data = @client.request("GET", "/api/v1/orders/#{Perata.segment(order)}/receipt", api_key: api_key)
+      OrderReceipt.from_hash(data)
+    end
+
+    # Listar pedidos: checkouts pagos. One page; +list_iter+ walks every page.
     #
     # @return [Page<Order>]
     def list(page: nil, limit: nil, api_key: nil)
@@ -94,7 +486,7 @@ module Perata
       @client = client
     end
 
-    # Stop charging a stored card; refused while an active subscription charges it.
+    # Parar de cobrar um cartão guardado; recusado enquanto uma assinatura ativa o cobra.
     #
     # @return [PaymentMethodDetached]
     def detach(payment_method, idempotency_key: nil, api_key: nil)
@@ -102,7 +494,7 @@ module Perata
       PaymentMethodDetached.from_hash(data)
     end
 
-    # List a customer's stored cards: brand, last four digits and expiry. One page; +list_iter+ walks every page.
+    # Listar os cartões guardados de um cliente: bandeira, quatro últimos dígitos e validade. One page; +list_iter+ walks every page.
     #
     # @return [Page<PaymentMethod>]
     def list(customer, page: nil, limit: nil, api_key: nil)
@@ -128,7 +520,7 @@ module Perata
       @client = client
     end
 
-    # Read a payment.
+    # Ler um pagamento.
     #
     # @return [Payment]
     def get(payment, api_key: nil)
@@ -136,7 +528,7 @@ module Perata
       Payment.from_hash(data)
     end
 
-    # List payments. One page; +list_iter+ walks every page.
+    # Listar pagamentos. One page; +list_iter+ walks every page.
     #
     # @return [Page<Payment>]
     def list(page: nil, limit: nil, api_key: nil)
@@ -162,7 +554,7 @@ module Perata
       @client = client
     end
 
-    # Create a BRL price, one-time or recurring.
+    # Criar um preço em reais, avulso ou recorrente.
     #
     # @param params [PricesCreateParams, Hash]
     # @return [Price]
@@ -171,7 +563,7 @@ module Perata
       Price.from_hash(data)
     end
 
-    # List prices, optionally of one product (product_id). One page; +list_iter+ walks every page.
+    # Listar preços, opcionalmente de um produto (product_id). One page; +list_iter+ walks every page.
     #
     # @return [Page<Price>]
     def list(page: nil, limit: nil, product_id: nil, api_key: nil)
@@ -197,7 +589,15 @@ module Perata
       @client = client
     end
 
-    # Create a product.
+    # Arquivar um produto: sai das vendas novas e o que já foi vendido continua apontando para ele.
+    #
+    # @return [Product]
+    def archive(product, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/products/#{Perata.segment(product)}/archive", idempotency_key: idempotency_key, api_key: api_key)
+      Product.from_hash(data)
+    end
+
+    # Criar um produto.
     #
     # @param params [ProductsCreateParams, Hash]
     # @return [Product]
@@ -206,7 +606,7 @@ module Perata
       Product.from_hash(data)
     end
 
-    # Read a product.
+    # Ler um produto.
     #
     # @return [Product]
     def get(product, api_key: nil)
@@ -214,7 +614,7 @@ module Perata
       Product.from_hash(data)
     end
 
-    # List products. One page; +list_iter+ walks every page.
+    # Listar produtos. One page; +list_iter+ walks every page.
     #
     # @return [Page<Product>]
     def list(page: nil, limit: nil, api_key: nil)
@@ -232,6 +632,15 @@ module Perata
       end
       block ? items.each(&block) : items
     end
+
+    # Atualizar o nome ou a descrição de um produto ativo.
+    #
+    # @param params [ProductsUpdateParams, Hash]
+    # @return [Product]
+    def update(product, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/products/#{Perata.segment(product)}", body: ProductsUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Product.from_hash(data)
+    end
   end
 
   # The API's refunds.
@@ -240,7 +649,7 @@ module Perata
       @client = client
     end
 
-    # Refund part or all of a payment.
+    # Reembolsar parte ou todo um pagamento.
     #
     # @param params [RefundsCreateParams, Hash]
     # @return [Refund]
@@ -248,6 +657,25 @@ module Perata
       data = @client.request("POST", "/api/v1/refunds", body: RefundsCreateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
       Refund.from_hash(data)
     end
+
+    # Listar reembolsos, opcionalmente de um pagamento (payment_id). One page; +list_iter+ walks every page.
+    #
+    # @return [Page<Refund>]
+    def list(page: nil, limit: nil, payment_id: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "payment_id" => payment_id }
+      data = @client.request("GET", "/api/v1/refunds", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| Refund.from_hash(item) }
+    end
+
+    # Walks every page of refunds:list from +page+, item by item.
+    #
+    # @return [Enumerator<Refund>]
+    def list_iter(page: nil, limit: nil, payment_id: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list(page: at, limit: limit, payment_id: payment_id, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
   end
 
   # The API's subscriptions.
@@ -256,7 +684,7 @@ module Perata
       @client = client
     end
 
-    # Cancel a subscription, by default at the end of its period.
+    # Cancelar uma assinatura, por padrão no fim do período.
     #
     # @param params [SubscriptionsCancelParams, Hash]
     # @return [Subscription]
@@ -265,7 +693,7 @@ module Perata
       Subscription.from_hash(data)
     end
 
-    # Read a subscription.
+    # Ler uma assinatura.
     #
     # @return [Subscription]
     def get(subscription, api_key: nil)
@@ -273,7 +701,7 @@ module Perata
       Subscription.from_hash(data)
     end
 
-    # List subscriptions, optionally of one customer (customer_id). One page; +list_iter+ walks every page.
+    # Listar assinaturas, opcionalmente de um cliente (customer_id). One page; +list_iter+ walks every page.
     #
     # @return [Page<Subscription>]
     def list(page: nil, limit: nil, customer_id: nil, api_key: nil)
@@ -291,5 +719,93 @@ module Perata
       end
       block ? items.each(&block) : items
     end
+
+    # Trocar o plano de uma assinatura: outro preço e, se quiser, outra quantidade, com a forma de ratear a diferença (proration_behavior).
+    #
+    # @param params [SubscriptionsUpdateParams, Hash]
+    # @return [Subscription]
+    def update(subscription, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/subscriptions/#{Perata.segment(subscription)}", body: SubscriptionsUpdateParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      Subscription.from_hash(data)
+    end
+  end
+
+  # The API's webhooks.
+  class WebhooksService
+    def initialize(client)
+      @client = client
+    end
+
+    # Criar um endpoint de webhook; o segredo que assina as mensagens vem só nesta resposta.
+    #
+    # @param params [WebhooksCreateEndpointParams, Hash]
+    # @return [WebhookEndpointCreated]
+    def create_endpoint(params, idempotency_key: nil, api_key: nil)
+      data = @client.request("POST", "/api/v1/webhooks/endpoints", body: WebhooksCreateEndpointParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      WebhookEndpointCreated.from_hash(data)
+    end
+
+    # Excluir um endpoint de webhook; as entregas que ainda esperavam por ele falham. The API answers 204, so there is nothing to return.
+    #
+    # @return [nil]
+    def delete_endpoint(endpoint, idempotency_key: nil, api_key: nil)
+      @client.request("DELETE", "/api/v1/webhooks/endpoints/#{Perata.segment(endpoint)}", idempotency_key: idempotency_key, api_key: api_key)
+      nil
+    end
+
+    # Ler um endpoint de webhook.
+    #
+    # @return [WebhookEndpoint]
+    def get_endpoint(endpoint, api_key: nil)
+      data = @client.request("GET", "/api/v1/webhooks/endpoints/#{Perata.segment(endpoint)}", api_key: api_key)
+      WebhookEndpoint.from_hash(data)
+    end
+
+    # Listar as últimas 100 entregas de eventos aos endpoints, opcionalmente de um endpoint (endpoint_id) ou de uma situação (status). One page; +list_deliveries_iter+ walks every page.
+    #
+    # @return [Page<WebhookDelivery>]
+    def list_deliveries(page: nil, limit: nil, endpoint_id: nil, status: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit, "endpoint_id" => endpoint_id, "status" => status }
+      data = @client.request("GET", "/api/v1/webhooks/deliveries", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| WebhookDelivery.from_hash(item) }
+    end
+
+    # Walks every page of webhooks:list_deliveries from +page+, item by item.
+    #
+    # @return [Enumerator<WebhookDelivery>]
+    def list_deliveries_iter(page: nil, limit: nil, endpoint_id: nil, status: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list_deliveries(page: at, limit: limit, endpoint_id: endpoint_id, status: status, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Listar os endpoints de webhook do lojista. One page; +list_endpoints_iter+ walks every page.
+    #
+    # @return [Page<WebhookEndpoint>]
+    def list_endpoints(page: nil, limit: nil, api_key: nil)
+      query = { "page" => page, "limit" => limit }
+      data = @client.request("GET", "/api/v1/webhooks/endpoints", query: query, api_key: api_key)
+      Page.from_hash(data) { |item| WebhookEndpoint.from_hash(item) }
+    end
+
+    # Walks every page of webhooks:list_endpoints from +page+, item by item.
+    #
+    # @return [Enumerator<WebhookEndpoint>]
+    def list_endpoints_iter(page: nil, limit: nil, api_key: nil, &block)
+      items = Page.iterate(page) do |at|
+        list_endpoints(page: at, limit: limit, api_key: api_key)
+      end
+      block ? items.each(&block) : items
+    end
+
+    # Atualizar o endereço, o formato, os eventos ou a descrição de um endpoint, ou ligar e desligar o envio (enabled); o segredo não muda.
+    #
+    # @param params [WebhooksUpdateEndpointParams, Hash]
+    # @return [WebhookEndpoint]
+    def update_endpoint(endpoint, params, idempotency_key: nil, api_key: nil)
+      data = @client.request("PATCH", "/api/v1/webhooks/endpoints/#{Perata.segment(endpoint)}", body: WebhooksUpdateEndpointParams.coerce(params).to_wire, idempotency_key: idempotency_key, api_key: api_key)
+      WebhookEndpoint.from_hash(data)
+    end
   end
 end