perata-sdk 0.2.0 → 0.3.0

data/lib/perata/params.rb

@@ -3,6 +3,239 @@
 # Code generated by sdk/generator. DO NOT EDIT.
 
 module Perata
+  # The body of benefits:create.
+  class BenefitsCreateParams < Params
+    MEMBERS = %i[description metadata name properties type visibility].freeze
+
+    # @return [String, nil]
+    attr_reader :description
+
+    # Até 50 pares; valor em texto, número ou booleano. No feature_flag, os valores da flag.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :metadata
+
+    # Como o benefício aparece nos produtos e para o cliente; até 80 caracteres.
+    # @return [String]
+    attr_reader :name
+
+    # Os campos do tipo. custom: note. license_key: prefix, expires_in, expires_unit (day, month, year), activation_limit, customer_can_deactivate, usage_limit. meter_credit: meter_id, units, rollover. feature_flag: nenhum.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :properties
+
+    # @return [String ("custom", "license_key", "feature_flag", "meter_credit")]
+    attr_reader :type
+
+    # @return [String ("public", "private"), nil]
+    attr_reader :visibility
+
+    def initialize(description: nil, metadata: nil, name:, properties: nil, type:, visibility: nil)
+      @description = description
+      @metadata = metadata
+      @name = name
+      @properties = properties
+      @type = type
+      @visibility = visibility
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["description"] = @description unless @description.nil?
+      wire["metadata"] = Perata.wire(@metadata) unless @metadata.nil?
+      wire["name"] = @name
+      wire["properties"] = Perata.wire(@properties) unless @properties.nil?
+      wire["type"] = @type
+      wire["visibility"] = @visibility unless @visibility.nil?
+      wire
+    end
+  end
+
+  # The body of benefits:update.
+  class BenefitsUpdateParams < Params
+    MEMBERS = %i[metadata name properties visibility].freeze
+
+    # Substitui os metadados; {} os limpa.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :metadata
+
+    # @return [String, nil]
+    attr_reader :name
+
+    # Os campos do tipo, aplicados sobre os guardados; o que ficar de fora não muda.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :properties
+
+    # @return [String ("public", "private"), nil]
+    attr_reader :visibility
+
+    def initialize(metadata: nil, name: nil, properties: nil, visibility: nil)
+      @metadata = metadata
+      @name = name
+      @properties = properties
+      @visibility = visibility
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["metadata"] = Perata.wire(@metadata) unless @metadata.nil?
+      wire["name"] = @name unless @name.nil?
+      wire["properties"] = Perata.wire(@properties) unless @properties.nil?
+      wire["visibility"] = @visibility unless @visibility.nil?
+      wire
+    end
+  end
+
+  # The body of checkout-links:create.
+  class CheckoutLinksCreateParams < Params
+    MEMBERS = %i[allow_discount_codes cancel_url capture_mode discount_id expires_at label max_installments metadata price_id price_ids product_id quantity require_billing_address success_url trial_interval trial_interval_count].freeze
+
+    # @return [Boolean, nil]
+    attr_reader :allow_discount_codes
+
+    # @return [String, nil]
+    attr_reader :cancel_url
+
+    # @return [String ("automatic", "manual"), nil]
+    attr_reader :capture_mode
+
+    # Desconto fixado no link.
+    # @return [String, nil]
+    attr_reader :discount_id
+
+    # Data e hora RFC 3339 no futuro.
+    # @return [String, nil]
+    attr_reader :expires_at
+
+    # @return [String, nil]
+    attr_reader :label
+
+    # De 0 a 12; 0 segue a organização.
+    # @return [Integer, nil]
+    attr_reader :max_installments
+
+    # Até 50 pares; valor em texto, número ou booleano.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :metadata
+
+    # @return [String, nil]
+    attr_reader :price_id
+
+    # Um preço de cada produto, na ordem em que o comprador os vê; até 20.
+    # @return [Array<String>, nil]
+    attr_reader :price_ids
+
+    # Com price_id, o produto que o link vende; ou use price_ids.
+    # @return [String, nil]
+    attr_reader :product_id
+
+    # @return [Integer, nil]
+    attr_reader :quantity
+
+    # @return [Boolean, nil]
+    attr_reader :require_billing_address
+
+    # @return [String, nil]
+    attr_reader :success_url
+
+    # @return [String ("day", "week", "month", "year"), nil]
+    attr_reader :trial_interval
+
+    # @return [Integer, nil]
+    attr_reader :trial_interval_count
+
+    def initialize(allow_discount_codes: nil, cancel_url: nil, capture_mode: nil, discount_id: nil, expires_at: nil, label: nil, max_installments: nil, metadata: nil, price_id: nil, price_ids: nil, product_id: nil, quantity: nil, require_billing_address: nil, success_url: nil, trial_interval: nil, trial_interval_count: nil)
+      @allow_discount_codes = allow_discount_codes
+      @cancel_url = cancel_url
+      @capture_mode = capture_mode
+      @discount_id = discount_id
+      @expires_at = expires_at
+      @label = label
+      @max_installments = max_installments
+      @metadata = metadata
+      @price_id = price_id
+      @price_ids = price_ids
+      @product_id = product_id
+      @quantity = quantity
+      @require_billing_address = require_billing_address
+      @success_url = success_url
+      @trial_interval = trial_interval
+      @trial_interval_count = trial_interval_count
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["allow_discount_codes"] = @allow_discount_codes unless @allow_discount_codes.nil?
+      wire["cancel_url"] = @cancel_url unless @cancel_url.nil?
+      wire["capture_mode"] = @capture_mode unless @capture_mode.nil?
+      wire["discount_id"] = @discount_id unless @discount_id.nil?
+      wire["expires_at"] = @expires_at unless @expires_at.nil?
+      wire["label"] = @label unless @label.nil?
+      wire["max_installments"] = @max_installments unless @max_installments.nil?
+      wire["metadata"] = Perata.wire(@metadata) unless @metadata.nil?
+      wire["price_id"] = @price_id unless @price_id.nil?
+      wire["price_ids"] = Perata.wire(@price_ids) unless @price_ids.nil?
+      wire["product_id"] = @product_id unless @product_id.nil?
+      wire["quantity"] = @quantity unless @quantity.nil?
+      wire["require_billing_address"] = @require_billing_address unless @require_billing_address.nil?
+      wire["success_url"] = @success_url unless @success_url.nil?
+      wire["trial_interval"] = @trial_interval unless @trial_interval.nil?
+      wire["trial_interval_count"] = @trial_interval_count unless @trial_interval_count.nil?
+      wire
+    end
+  end
+
+  # The body of checkout-links:update.
+  class CheckoutLinksUpdateParams < Params
+    MEMBERS = %i[cancel_url label metadata price_ids require_billing_address success_url].freeze
+
+    # @return [String, nil]
+    attr_reader :cancel_url
+
+    # @return [String, nil]
+    attr_reader :label
+
+    # Substitui os metadados; {} os limpa.
+    # @return [Hash{String => Object}, nil]
+    attr_reader :metadata
+
+    # Substitui os produtos do link.
+    # @return [Array<String>, nil]
+    attr_reader :price_ids
+
+    # @return [Boolean, nil]
+    attr_reader :require_billing_address
+
+    # @return [String, nil]
+    attr_reader :success_url
+
+    def initialize(cancel_url: nil, label: nil, metadata: nil, price_ids: nil, require_billing_address: nil, success_url: nil)
+      @cancel_url = cancel_url
+      @label = label
+      @metadata = metadata
+      @price_ids = price_ids
+      @require_billing_address = require_billing_address
+      @success_url = success_url
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["cancel_url"] = @cancel_url unless @cancel_url.nil?
+      wire["label"] = @label unless @label.nil?
+      wire["metadata"] = Perata.wire(@metadata) unless @metadata.nil?
+      wire["price_ids"] = Perata.wire(@price_ids) unless @price_ids.nil?
+      wire["require_billing_address"] = @require_billing_address unless @require_billing_address.nil?
+      wire["success_url"] = @success_url unless @success_url.nil?
+      wire
+    end
+  end
+
   # The body of checkouts:create.
   class CheckoutsCreateParams < Params
     MEMBERS = %i[cancel_url label price_id product_id quantity success_url].freeze
@@ -48,15 +281,52 @@ module Perata
     end
   end
 
+  # The body of checkouts:update.
+  class CheckoutsUpdateParams < Params
+    MEMBERS = %i[cancel_url label success_url].freeze
+
+    # Endereço https; vazio retira.
+    # @return [String, nil]
+    attr_reader :cancel_url
+
+    # @return [String, nil]
+    attr_reader :label
+
+    # Endereço https; vazio retira.
+    # @return [String, nil]
+    attr_reader :success_url
+
+    def initialize(cancel_url: nil, label: nil, success_url: nil)
+      @cancel_url = cancel_url
+      @label = label
+      @success_url = success_url
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["cancel_url"] = @cancel_url unless @cancel_url.nil?
+      wire["label"] = @label unless @label.nil?
+      wire["success_url"] = @success_url unless @success_url.nil?
+      wire
+    end
+  end
+
   # The body of customer-sessions:create.
   class CustomerSessionsCreateParams < Params
-    MEMBERS = %i[customer_id].freeze
+    MEMBERS = %i[customer_id return_url].freeze
 
     # @return [String]
     attr_reader :customer_id
 
-    def initialize(customer_id:)
+    # Optional https address of your app the portal offers to go back to.
+    # @return [String, nil]
+    attr_reader :return_url
+
+    def initialize(customer_id:, return_url: nil)
       @customer_id = customer_id
+      @return_url = return_url
       freeze
     end
 
@@ -64,6 +334,7 @@ module Perata
     def to_wire
       wire = {}
       wire["customer_id"] = @customer_id
+      wire["return_url"] = @return_url unless @return_url.nil?
       wire
     end
   end
@@ -98,6 +369,220 @@ module Perata
     end
   end
 
+  # The body of customers:update.
+  class CustomersUpdateParams < Params
+    MEMBERS = %i[email external_id name].freeze
+
+    # @return [String, nil]
+    attr_reader :email
+
+    # Só pode ser definido uma vez.
+    # @return [String, nil]
+    attr_reader :external_id
+
+    # @return [String, nil]
+    attr_reader :name
+
+    def initialize(email: nil, external_id: nil, name: nil)
+      @email = email
+      @external_id = external_id
+      @name = name
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["email"] = @email unless @email.nil?
+      wire["external_id"] = @external_id unless @external_id.nil?
+      wire["name"] = @name unless @name.nil?
+      wire
+    end
+  end
+
+  # The body of discounts:create.
+  class DiscountsCreateParams < Params
+    MEMBERS = %i[amount_cents basis_points code duration duration_in_months ends_at max_redemptions max_redemptions_per_customer name product_ids starts_at type].freeze
+
+    # Em centavos, obrigatório no tipo fixed.
+    # @return [Integer, nil]
+    attr_reader :amount_cents
+
+    # De 1 a 10000, obrigatório no tipo percentage.
+    # @return [Integer, nil]
+    attr_reader :basis_points
+
+    # Até 64 letras, números, hífens ou sublinhados; sem ele o desconto só se aplica por um link de checkout ou pela API.
+    # @return [String, nil]
+    attr_reader :code
+
+    # @return [String ("once", "repeating", "forever")]
+    attr_reader :duration
+
+    # De 1 a 120, só no duration repeating.
+    # @return [Integer, nil]
+    attr_reader :duration_in_months
+
+    # Data e hora RFC 3339, depois de starts_at.
+    # @return [String, nil]
+    attr_reader :ends_at
+
+    # @return [Integer, nil]
+    attr_reader :max_redemptions
+
+    # @return [Integer, nil]
+    attr_reader :max_redemptions_per_customer
+
+    # @return [String]
+    attr_reader :name
+
+    # Os produtos do desconto; vazio, todos.
+    # @return [Array<String>, nil]
+    attr_reader :product_ids
+
+    # Data e hora RFC 3339; agora, se omitida.
+    # @return [String, nil]
+    attr_reader :starts_at
+
+    # @return [String ("percentage", "fixed")]
+    attr_reader :type
+
+    def initialize(amount_cents: nil, basis_points: nil, code: nil, duration:, duration_in_months: nil, ends_at: nil, max_redemptions: nil, max_redemptions_per_customer: nil, name:, product_ids: nil, starts_at: nil, type:)
+      @amount_cents = amount_cents
+      @basis_points = basis_points
+      @code = code
+      @duration = duration
+      @duration_in_months = duration_in_months
+      @ends_at = ends_at
+      @max_redemptions = max_redemptions
+      @max_redemptions_per_customer = max_redemptions_per_customer
+      @name = name
+      @product_ids = product_ids
+      @starts_at = starts_at
+      @type = type
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["amount_cents"] = @amount_cents unless @amount_cents.nil?
+      wire["basis_points"] = @basis_points unless @basis_points.nil?
+      wire["code"] = @code unless @code.nil?
+      wire["duration"] = @duration
+      wire["duration_in_months"] = @duration_in_months unless @duration_in_months.nil?
+      wire["ends_at"] = @ends_at unless @ends_at.nil?
+      wire["max_redemptions"] = @max_redemptions unless @max_redemptions.nil?
+      wire["max_redemptions_per_customer"] = @max_redemptions_per_customer unless @max_redemptions_per_customer.nil?
+      wire["name"] = @name
+      wire["product_ids"] = Perata.wire(@product_ids) unless @product_ids.nil?
+      wire["starts_at"] = @starts_at unless @starts_at.nil?
+      wire["type"] = @type
+      wire
+    end
+  end
+
+  # The body of discounts:update.
+  class DiscountsUpdateParams < Params
+    MEMBERS = %i[amount_cents basis_points code duration_in_months ends_at max_redemptions max_redemptions_per_customer name product_ids starts_at].freeze
+
+    # @return [Integer, nil]
+    attr_reader :amount_cents
+
+    # @return [Integer, nil]
+    attr_reader :basis_points
+
+    # null tira o código.
+    # @return [String, nil]
+    attr_reader :code
+
+    # @return [Integer, nil]
+    attr_reader :duration_in_months
+
+    # null tira o fim.
+    # @return [String, nil]
+    attr_reader :ends_at
+
+    # null tira o limite.
+    # @return [Integer, nil]
+    attr_reader :max_redemptions
+
+    # null tira o limite.
+    # @return [Integer, nil]
+    attr_reader :max_redemptions_per_customer
+
+    # @return [String, nil]
+    attr_reader :name
+
+    # Substitui os produtos do desconto.
+    # @return [Array<String>, nil]
+    attr_reader :product_ids
+
+    # @return [String, nil]
+    attr_reader :starts_at
+
+    def initialize(amount_cents: nil, basis_points: nil, code: nil, duration_in_months: nil, ends_at: nil, max_redemptions: nil, max_redemptions_per_customer: nil, name: nil, product_ids: nil, starts_at: nil)
+      @amount_cents = amount_cents
+      @basis_points = basis_points
+      @code = code
+      @duration_in_months = duration_in_months
+      @ends_at = ends_at
+      @max_redemptions = max_redemptions
+      @max_redemptions_per_customer = max_redemptions_per_customer
+      @name = name
+      @product_ids = product_ids
+      @starts_at = starts_at
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["amount_cents"] = @amount_cents unless @amount_cents.nil?
+      wire["basis_points"] = @basis_points unless @basis_points.nil?
+      wire["code"] = @code unless @code.nil?
+      wire["duration_in_months"] = @duration_in_months unless @duration_in_months.nil?
+      wire["ends_at"] = @ends_at unless @ends_at.nil?
+      wire["max_redemptions"] = @max_redemptions unless @max_redemptions.nil?
+      wire["max_redemptions_per_customer"] = @max_redemptions_per_customer unless @max_redemptions_per_customer.nil?
+      wire["name"] = @name unless @name.nil?
+      wire["product_ids"] = Perata.wire(@product_ids) unless @product_ids.nil?
+      wire["starts_at"] = @starts_at unless @starts_at.nil?
+      wire
+    end
+  end
+
+  # The body of customers:update_external.
+  class CustomersUpdateExternalParams < Params
+    MEMBERS = %i[email external_id name].freeze
+
+    # @return [String, nil]
+    attr_reader :email
+
+    # Só pode ser definido uma vez.
+    # @return [String, nil]
+    attr_reader :external_id
+
+    # @return [String, nil]
+    attr_reader :name
+
+    def initialize(email: nil, external_id: nil, name: nil)
+      @email = email
+      @external_id = external_id
+      @name = name
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["email"] = @email unless @email.nil?
+      wire["external_id"] = @external_id unless @external_id.nil?
+      wire["name"] = @name unless @name.nil?
+      wire
+    end
+  end
+
   # The body of prices:create.
   class PricesCreateParams < Params
     MEMBERS = %i[amount_cents interval product_id type].freeze
@@ -158,6 +643,31 @@ module Perata
     end
   end
 
+  # The body of products:update.
+  class ProductsUpdateParams < Params
+    MEMBERS = %i[description name].freeze
+
+    # @return [String, nil]
+    attr_reader :description
+
+    # @return [String, nil]
+    attr_reader :name
+
+    def initialize(description: nil, name: nil)
+      @description = description
+      @name = name
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["description"] = @description unless @description.nil?
+      wire["name"] = @name unless @name.nil?
+      wire
+    end
+  end
+
   # The body of refunds:create.
   class RefundsCreateParams < Params
     MEMBERS = %i[amount_cents note payment_id reason].freeze
@@ -193,6 +703,39 @@ module Perata
     end
   end
 
+  # The body of subscriptions:update.
+  class SubscriptionsUpdateParams < Params
+    MEMBERS = %i[price_id proration_behavior quantity].freeze
+
+    # O preço recorrente para onde a assinatura vai.
+    # @return [String]
+    attr_reader :price_id
+
+    # prorate (padrão): rateia o resto do período no próximo valor cobrado; invoice: cobra a diferença agora; next_period: troca no fim do período; reset: cobra o período inteiro do novo plano agora e reinicia o ciclo.
+    # @return [String ("prorate", "invoice", "next_period", "reset"), nil]
+    attr_reader :proration_behavior
+
+    # A nova quantidade; omitida, fica a atual.
+    # @return [Integer, nil]
+    attr_reader :quantity
+
+    def initialize(price_id:, proration_behavior: nil, quantity: nil)
+      @price_id = price_id
+      @proration_behavior = proration_behavior
+      @quantity = quantity
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["price_id"] = @price_id
+      wire["proration_behavior"] = @proration_behavior unless @proration_behavior.nil?
+      wire["quantity"] = @quantity unless @quantity.nil?
+      wire
+    end
+  end
+
   # The body of subscriptions:cancel.
   class SubscriptionsCancelParams < Params
     MEMBERS = %i[at_period_end reason].freeze
@@ -217,4 +760,85 @@ module Perata
       wire
     end
   end
+
+  # The body of webhooks:create_endpoint.
+  class WebhooksCreateEndpointParams < Params
+    MEMBERS = %i[description events format url].freeze
+
+    # Sem ele, o domínio do endereço. Único por organização e ambiente.
+    # @return [String, nil]
+    attr_reader :description
+
+    # Os eventos de que o endpoint é avisado, da lista de eventos deste documento; sem eles, nenhum é enviado.
+    # @return [Array<String>, nil]
+    attr_reader :events
+
+    # Sem ele, o que o endereço indica.
+    # @return [String ("raw", "discord", "slack"), nil]
+    attr_reader :format
+
+    # Endereço https público; endereços internos são recusados.
+    # @return [String]
+    attr_reader :url
+
+    def initialize(description: nil, events: nil, format: nil, url:)
+      @description = description
+      @events = events
+      @format = format
+      @url = url
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["description"] = @description unless @description.nil?
+      wire["events"] = Perata.wire(@events) unless @events.nil?
+      wire["format"] = @format unless @format.nil?
+      wire["url"] = @url
+      wire
+    end
+  end
+
+  # The body of webhooks:update_endpoint.
+  class WebhooksUpdateEndpointParams < Params
+    MEMBERS = %i[description enabled events format url].freeze
+
+    # @return [String, nil]
+    attr_reader :description
+
+    # false desliga o envio, e as entregas esperam; true o religa.
+    # @return [Boolean, nil]
+    attr_reader :enabled
+
+    # Substitui os eventos.
+    # @return [Array<String>, nil]
+    attr_reader :events
+
+    # @return [String ("raw", "discord", "slack"), nil]
+    attr_reader :format
+
+    # @return [String, nil]
+    attr_reader :url
+
+    def initialize(description: nil, enabled: nil, events: nil, format: nil, url: nil)
+      @description = description
+      @enabled = enabled
+      @events = events
+      @format = format
+      @url = url
+      freeze
+    end
+
+    # The body as the API reads it.
+    def to_wire
+      wire = {}
+      wire["description"] = @description unless @description.nil?
+      wire["enabled"] = @enabled unless @enabled.nil?
+      wire["events"] = Perata.wire(@events) unless @events.nil?
+      wire["format"] = @format unless @format.nil?
+      wire["url"] = @url unless @url.nil?
+      wire
+    end
+  end
 end