raims 0.1.1

data/lib/raims/services.rb

@@ -0,0 +1,506 @@
+# frozen_string_literal: true
+# Generated by scripts/generate.py. Do not edit.
+
+module Raims
+
+  class AccountsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve account fees.
+    # @return [Raims::AccountFees]
+    def retrieve_fees(params = {}, options = {})
+      @client.request('GetAccountFees', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve the account number.
+    # @return [Raims::AccountNumber]
+    def retrieve_number(params = {}, options = {})
+      @client.request('GetAccountNumber', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve checkout settings.
+    # @return [Raims::CheckoutSettings]
+    def retrieve_checkout_settings(params = {}, options = {})
+      @client.request('GetCheckoutSettings', path_params: {}, params: params, options: options)
+    end
+
+    # Update checkout customization.
+    # @return [Raims::CheckoutSettings]
+    def update_checkout_settings(params = {}, options = {})
+      @client.request('UpdateCheckoutSettings', path_params: {}, params: params, options: options)
+    end
+
+    # Prepare a logo upload.
+    # @return [Raims::CheckoutAssetUpload]
+    def create_checkout_logo_upload(params = {}, options = {})
+      @client.request('CreateCheckoutLogoUpload', path_params: {}, params: params, options: options)
+    end
+
+    # Prepare an icon upload.
+    # @return [Raims::CheckoutAssetUpload]
+    def create_checkout_favicon_upload(params = {}, options = {})
+      @client.request('CreateCheckoutFaviconUpload', path_params: {}, params: params, options: options)
+    end
+
+    # Discard an image upload.
+    # @return [Raims::CheckoutAssetUploadDeleted]
+    def delete_checkout_asset_upload(id, params = {}, options = {})
+      @client.request('DeleteCheckoutAssetUpload', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve account context.
+    # @return [Raims::AccountContext]
+    def retrieve_context(params = {}, options = {})
+      @client.request('GetAccountContext', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class BalancesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve the current balance.
+    # @return [Raims::Balance]
+    def retrieve(params = {}, options = {})
+      @client.request('GetBalance', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve expected receipts.
+    # @return [Raims::BalanceForecast]
+    def forecast(params = {}, options = {})
+      @client.request('GetBalanceForecast', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class ChargesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Create a new charge.
+    # @return [Raims::ChargeCreated]
+    def create(params = {}, options = {})
+      @client.request('CreateCharge', path_params: {}, params: params, options: options)
+    end
+
+    # List charges.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListCharges', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a charge.
+    # @return [Raims::Charge]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetCharge', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Update an existing charge.
+    # @return [Raims::Charge]
+    def update(id, params = {}, options = {})
+      @client.request('UpdateCharge', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Revoke a charge.
+    # @return [Raims::ChargeRevoked or Raims::ChargeRevocationPending]
+    def revoke(id, params = {}, options = {})
+      @client.request('RevokeCharge', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve payment information.
+    # @return [Raims::PaymentReceipt]
+    def retrieve_payment(id, params = {}, options = {})
+      @client.request('GetChargePayment', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve a payment receipt.
+    # @return [Raims::FinancialDocument]
+    def retrieve_receipt(id, params = {}, options = {})
+      @client.request('GetChargeReceipt', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve a boleto document.
+    # @return [Raims::FinancialDocument]
+    def retrieve_boleto(id, params = {}, options = {})
+      @client.request('GetChargeBoleto', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Request a refund.
+    # @return [Raims::Refund]
+    def create_refund(id, params = {}, options = {})
+      @client.request('CreateRefund', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # List refunds for a charge.
+    # @return [Raims::ApiList]
+    def list_refunds(id, params = {}, options = {})
+      @client.request('ListChargeRefunds', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve refund eligibility.
+    # @return [Raims::RefundEligibility]
+    def retrieve_refund_eligibility(id, params = {}, options = {})
+      @client.request('GetRefundEligibility', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve charge statistics.
+    # @return [Raims::ChargeStatistics]
+    def statistics(params = {}, options = {})
+      @client.request('GetChargeStatistics', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class CustomersService
+    def initialize(client)
+      @client = client
+    end
+
+    # Create a customer.
+    # @return [Raims::CustomerCreated]
+    def create(params = {}, options = {})
+      @client.request('CreateCustomer', path_params: {}, params: params, options: options)
+    end
+
+    # List customers.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListCustomers', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a customer.
+    # @return [Raims::CustomerListItem]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetCustomer', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Update an existing customer.
+    # @return [Raims::CustomerListItem]
+    def update(id, params = {}, options = {})
+      @client.request('UpdateCustomer', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Delete a customer.
+    # @return [Raims::CustomerDeleted]
+    def delete(id, params = {}, options = {})
+      @client.request('DeleteCustomer', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Delete customers in a batch.
+    # @return [Raims::CustomerBatchDeleted]
+    def delete_batch(params = {}, options = {})
+      @client.request('DeleteCustomersBatch', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class DisputesService
+    def initialize(client)
+      @client = client
+    end
+
+    # List disputes.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListDisputes', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a dispute.
+    # @return [Raims::Dispute]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetDispute', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class PaymentLinksService
+    def initialize(client)
+      @client = client
+    end
+
+    # Create or retrieve a payment link.
+    # @return [Raims::PaymentLink]
+    def create(params = {}, options = {})
+      @client.request('CreatePaymentLink', path_params: {}, params: params, options: options)
+    end
+
+    # List payment links.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListPaymentLinks', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a payment link.
+    # @return [Raims::PaymentLinkDetails]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetPaymentLink', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Update a payment link.
+    # @return [Raims::PaymentLink]
+    def update(id, params = {}, options = {})
+      @client.request('UpdatePaymentLink', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Request payment link delivery by email.
+    # @return [Raims::PaymentLinkEmailRequestAccepted]
+    def send_email(id, params = {}, options = {})
+      @client.request('SendPaymentLinkEmail', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class RefundsService
+    def initialize(client)
+      @client = client
+    end
+
+    # List refunds.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListRefunds', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a refund.
+    # @return [Raims::Refund]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetRefund', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve a refund receipt.
+    # @return [Raims::FinancialDocument]
+    def retrieve_receipt(id, params = {}, options = {})
+      @client.request('GetRefundReceipt', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class StatementsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve statements.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListStatements', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a statement entry.
+    # @return [Raims::Statement]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetStatement', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class WebhookEventTypesService
+    def initialize(client)
+      @client = client
+    end
+
+    # List available event types.
+    # @return [Raims::WebhookEventTypeListResponse]
+    def list(params = {}, options = {})
+      @client.request('ListWebhookEventTypes', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class WebhooksService
+    def initialize(client)
+      @client = client
+    end
+
+    # Create a webhook.
+    # @return [Raims::WebhookCreated]
+    def create(params = {}, options = {})
+      @client.request('CreateWebhook', path_params: {}, params: params, options: options)
+    end
+
+    # List webhooks.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListWebhooks', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a webhook.
+    # @return [Raims::Webhook]
+    def retrieve(webhook_id, params = {}, options = {})
+      @client.request('GetWebhook', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Update a webhook.
+    # @return [Raims::Webhook]
+    def update(webhook_id, params = {}, options = {})
+      @client.request('UpdateWebhook', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Delete a webhook.
+    # @return [nil]
+    def delete(webhook_id, params = {}, options = {})
+      @client.request('DeleteWebhook', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Retrieve webhook failures.
+    # @return [Raims::WebhookHealth]
+    def retrieve_health(webhook_id, params = {}, options = {})
+      @client.request('GetWebhookHealth', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Pause or resume deliveries.
+    # @return [Raims::WebhookPause]
+    def set_pause(webhook_id, params = {}, options = {})
+      @client.request('SetWebhookPause', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Rotate the signing secret.
+    # @return [Raims::WebhookSecretRotation]
+    def rotate_secret(webhook_id, params = {}, options = {})
+      @client.request('RotateWebhookSecret', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+
+    # Send a test event.
+    # @return [Raims::WebhookTestAccepted]
+    def test(webhook_id, params = {}, options = {})
+      @client.request('TestWebhook', path_params: {'webhook_id' => webhook_id}, params: params, options: options)
+    end
+  end
+
+  class WithdrawalDestinationsService
+    def initialize(client)
+      @client = client
+    end
+
+    # List withdrawal destinations.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListWithdrawalDestinations', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a withdrawal destination.
+    # @return [Raims::WithdrawalDestination]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetWithdrawalDestination', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class WithdrawalsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Request a withdrawal.
+    # @return [Raims::Withdrawal]
+    def create(params = {}, options = {})
+      @client.request('CreateWithdrawal', path_params: {}, params: params, options: options)
+    end
+
+    # List withdrawals.
+    # @return [Raims::ApiList]
+    def list(params = {}, options = {})
+      @client.request('ListWithdrawals', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve a withdrawal.
+    # @return [Raims::Withdrawal]
+    def retrieve(id, params = {}, options = {})
+      @client.request('GetWithdrawal', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Retrieve withdrawal conditions.
+    # @return [Raims::WithdrawalLimits]
+    def retrieve_limits(params = {}, options = {})
+      @client.request('GetWithdrawalLimits', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve the withdrawal processing summary.
+    # @return [Raims::WithdrawalSummary]
+    def retrieve_summary(params = {}, options = {})
+      @client.request('GetWithdrawalSummary', path_params: {}, params: params, options: options)
+    end
+
+    # Retrieve automatic withdrawal settings.
+    # @return [Raims::AutomaticWithdrawalSettings]
+    def retrieve_automatic_settings(params = {}, options = {})
+      @client.request('GetAutomaticWithdrawalSettings', path_params: {}, params: params, options: options)
+    end
+
+    # Update automatic withdrawals.
+    # @return [Raims::AutomaticWithdrawalSettings]
+    def update_automatic_settings(params = {}, options = {})
+      @client.request('UpdateAutomaticWithdrawalSettings', path_params: {}, params: params, options: options)
+    end
+  end
+
+  class SimulationChargesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Confirm a simulated payment.
+    # @return [Raims::ChargeSimulation]
+    def confirm_payment(id, params = {}, options = {})
+      @client.request('ConfirmSimulationPayment', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Simulate payment failure.
+    # @return [Raims::ChargeSimulation]
+    def fail_payment(id, params = {}, options = {})
+      @client.request('FailSimulationPayment', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Prepare a scenario.
+    # @return [Raims::ChargeScenario]
+    def configure_scenario(id, params = {}, options = {})
+      @client.request('ConfigureSimulationScenario', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Resolve a pending scenario.
+    # @return [Raims::ChargeScenario]
+    def resolve_scenario(id, params = {}, options = {})
+      @client.request('ResolveSimulationScenario', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Issue a test payment.
+    # @return [Raims::Charge]
+    def issue_payment(id, params = {}, options = {})
+      @client.request('IssueSimulationPayment', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Simulate boleto compensation.
+    # @return [Raims::ChargeBoletoCompensation]
+    def compensate_boleto(id, params = {}, options = {})
+      @client.request('CompensateSimulationBoleto', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Simulate a pending refund.
+    # @return [Raims::Refund]
+    def create_refund(id, params = {}, options = {})
+      @client.request('CreateSimulationRefund', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class SimulationRefundsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Complete a simulated refund.
+    # @return [Raims::Refund]
+    def complete(id, params = {}, options = {})
+      @client.request('CompleteSimulationRefund', path_params: {'id' => id}, params: params, options: options)
+    end
+
+    # Simulate refund failure.
+    # @return [Raims::Refund]
+    def fail(id, params = {}, options = {})
+      @client.request('FailSimulationRefund', path_params: {'id' => id}, params: params, options: options)
+    end
+  end
+
+  class SimulationsService
+    attr_reader :charges, :refunds
+
+    def initialize(client)
+      @charges = SimulationChargesService.new(client)
+      @refunds = SimulationRefundsService.new(client)
+    end
+  end
+end

data/lib/raims/util.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'bigdecimal'
+
+module Raims
+  module Util
+    MAX_DECIMAL_EXPONENT = 4300
+
+    class JsonDecimal
+      def self.new(token)
+        Util.parse_decimal(token)
+      end
+    end
+    private_constant :JsonDecimal
+
+    module_function
+
+    def visible_ascii(value, maximum, label)
+      unless value.is_a?(String) && value.ascii_only? && value.match?(/\A[\x21-\x7e]{1,#{maximum}}\z/)
+        raise ArgumentError, "#{label} must contain visible ASCII without spaces."
+      end
+      value.dup.freeze
+    end
+
+    def timeout(value)
+      unless (value.is_a?(Integer) || value.is_a?(Float)) && value.finite? && value.positive? && value <= 300
+        raise ArgumentError, 'timeout must be greater than zero and at most 300 seconds.'
+      end
+      value.to_f
+    end
+
+    def retries(value)
+      raise ArgumentError, 'max_network_retries must be an integer between zero and five.' unless value.is_a?(Integer) && (0..5).cover?(value)
+      value
+    end
+
+    def deep_freeze(value)
+      case value
+      when Hash
+        value.each { |key, child| deep_freeze(key); deep_freeze(child) }
+      when Array
+        value.each { |child| deep_freeze(child) }
+      end
+      value.freeze
+    end
+
+    def json_value(value, seen = {}, depth = 0)
+      raise ArgumentError, 'Request parameters are nested too deeply.' if depth > 100
+      case value
+      when Hash, Array
+        raise ArgumentError, 'Request parameters cannot contain cycles.' if seen[value.object_id]
+        seen[value.object_id] = true
+        begin
+          if value.is_a?(Array)
+            value.map { |child| json_value(child, seen, depth + 1) }
+          else
+            value.each_with_object({}) do |(key, child), result|
+              raise ArgumentError, 'JSON field names must be strings or symbols.' unless key.is_a?(String) || key.is_a?(Symbol)
+              key = utf8_string(key.to_s)
+              raise ArgumentError, 'JSON field names must be unique after UTF-8 conversion.' if result.key?(key)
+              result[key] = json_value(child, seen, depth + 1)
+            end
+          end
+        ensure
+          seen.delete(value.object_id)
+        end
+      when String
+        utf8_string(value)
+      when Integer, TrueClass, FalseClass, NilClass
+        value
+      when Float
+        raise ArgumentError, 'JSON numbers must be finite.' unless value.finite?
+        value
+      else
+        raise ArgumentError, 'Request parameters must contain only JSON values.'
+      end
+    end
+
+    def utf8_string(value)
+      text = if value.encoding == Encoding::ASCII_8BIT
+               value.dup.force_encoding(Encoding::UTF_8)
+             else
+               value.encode(Encoding::UTF_8)
+             end
+      raise ArgumentError, 'JSON strings must contain valid text convertible to UTF-8.' unless text.valid_encoding?
+      text
+    rescue EncodingError
+      raise ArgumentError, 'JSON strings must contain valid text convertible to UTF-8.', cause: nil
+    end
+
+    def parse_json(body)
+      text = body.dup.force_encoding(Encoding::UTF_8)
+      raise JSON::ParserError, 'Invalid UTF-8.' unless text.valid_encoding?
+      normalize_number(JSON.parse(text, max_nesting: 100, allow_nan: false, create_additions: false, decimal_class: JsonDecimal))
+    end
+
+    def parse_decimal(token)
+      coefficient, exponent = token.split(/[eE]/, 2)
+      if exponent
+        digits = exponent.delete_prefix('-').delete_prefix('+').sub(/\A0+/, '')
+        if digits.length > 4 || digits.to_i > MAX_DECIMAL_EXPONENT
+          raise JSON::ParserError, 'JSON number exceeds the supported size.'
+        end
+      end
+      value = BigDecimal(token)
+      unless value.finite? && value.exponent.abs <= MAX_DECIMAL_EXPONENT && !(value.zero? && coefficient.match?(/[1-9]/))
+        raise JSON::ParserError, 'JSON number cannot be represented without losing its value.'
+      end
+      value
+    rescue ArgumentError
+      raise JSON::ParserError, 'JSON number cannot be represented.', cause: nil
+    end
+
+    def normalize_number(value)
+      case value
+      when BigDecimal
+        unless value.finite? && value.exponent.abs <= MAX_DECIMAL_EXPONENT
+          raise JSON::ParserError, 'JSON number exceeds the supported size.'
+        end
+        value.frac.zero? ? value.to_i : value
+      when Array
+        value.map { |child| normalize_number(child) }
+      when Hash
+        value.transform_values { |child| normalize_number(child) }
+      else
+        value
+      end
+    end
+
+    def plain(value)
+      case value
+      when ApiResource then value.to_h
+      when Hash then value.transform_values { |child| plain(child) }
+      when Array then value.map { |child| plain(child) }
+      when String then value.dup
+      else value
+      end
+    end
+  end
+end

data/lib/raims/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Raims
+  VERSION = '0.1.1'
+end