abacatepay-ruby 0.1.0 → 1.1.0

data/lib/{abacatepay/enums/billing → abacate_pay/enums/billings}/methods.rb

@@ -2,7 +2,7 @@
 
 module AbacatePay
   module Enums
-    module Billing
+    module Billings
       # Enumeration defining billing methods.
       #
       # This enumeration is used to represent different payment methods available for billing.
@@ -11,10 +11,18 @@ module AbacatePay
         # @return [String] Represents the PIX payment method, a popular instant payment system in Brazil
         PIX = "PIX"
 
+        # @return [String] Credit card payment
+        CARD = "CARD"
+
+        # Boleto bancário. Supports a due date and late-payment interest/fine —
+        # see Resources::Checkouts#due_date, #interest and #fine.
+        # @return [String] Boleto payment method
+        BOLETO = "BOLETO"
+
         # Gets all valid method values
         # @return [Array<String>] List of all valid payment methods
         def self.values
-          [PIX]
+          [PIX, CARD, BOLETO]
         end
 
         # Validates if a given value is a valid method
@@ -30,9 +38,10 @@ module AbacatePay
         # @raise [ArgumentError] if value is invalid
         def self.validate!(value)
           raise ArgumentError, "Invalid payment method: #{value}" unless valid?(value)
+
           value
         end
       end
     end
   end
-end
+end

data/lib/{abacatepay/enums/billing → abacate_pay/enums/billings}/statuses.rb

@@ -2,7 +2,7 @@
 
 module AbacatePay
   module Enums
-    module Billing
+    module Billings
       # Enumeration defining billing statuses.
       #
       # This enumeration is used to represent the various statuses that a billing process can have.
@@ -46,9 +46,10 @@ module AbacatePay
         # @raise [ArgumentError] if value is invalid
         def self.validate!(value)
           raise ArgumentError, "Invalid status: #{value}" unless valid?(value)
+
           value
         end
       end
     end
   end
-end
+end

data/lib/abacate_pay/enums/checkouts/statuses.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Checkouts
+      class Statuses
+        PENDING = "PENDING"
+        EXPIRED = "EXPIRED"
+        CANCELLED = "CANCELLED"
+        PAID = "PAID"
+        REFUNDED = "REFUNDED"
+
+        def self.values
+          [PENDING, EXPIRED, CANCELLED, PAID, REFUNDED]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid checkout status: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/coupons/discount_kinds.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Coupons
+      class DiscountKinds
+        PERCENTAGE = "PERCENTAGE"
+        FIXED = "FIXED"
+
+        def self.values
+          [PERCENTAGE, FIXED]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid discount kind: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/coupons/statuses.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Coupons
+      class Statuses
+        ACTIVE = "ACTIVE"
+        INACTIVE = "INACTIVE"
+        EXPIRED = "EXPIRED"
+
+        def self.values
+          [ACTIVE, INACTIVE, EXPIRED]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid coupon status: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/payouts/statuses.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Payouts
+      class Statuses
+        PENDING = "PENDING"
+        COMPLETE = "COMPLETE"
+        CANCELLED = "CANCELLED"
+        EXPIRED = "EXPIRED"
+        REFUNDED = "REFUNDED"
+
+        def self.values
+          [PENDING, COMPLETE, CANCELLED, EXPIRED, REFUNDED]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid payout status: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/pix/key_types.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Pix
+      class KeyTypes
+        CPF = "CPF"
+        CNPJ = "CNPJ"
+        PHONE = "PHONE"
+        EMAIL = "EMAIL"
+        RANDOM = "RANDOM"
+        BR_CODE = "BR_CODE"
+
+        def self.values
+          [CPF, CNPJ, PHONE, EMAIL, RANDOM, BR_CODE]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid PIX key type: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/products/cycles.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Products
+      class Cycles
+        WEEKLY = "WEEKLY"
+        MONTHLY = "MONTHLY"
+        SEMIANNUALLY = "SEMIANNUALLY"
+        ANNUALLY = "ANNUALLY"
+
+        def self.values
+          [WEEKLY, MONTHLY, SEMIANNUALLY, ANNUALLY]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid product cycle: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/transfers/statuses.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Transfers
+      class Statuses
+        PENDING = "PENDING"
+        COMPLETE = "COMPLETE"
+        CANCELLED = "CANCELLED"
+        EXPIRED = "EXPIRED"
+        REFUNDED = "REFUNDED"
+        FAILED = "FAILED"
+
+        def self.values
+          [PENDING, COMPLETE, CANCELLED, EXPIRED, REFUNDED, FAILED]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid transfer status: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums/webhooks/event_types.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Enums
+    module Webhooks
+      class EventTypes
+        CHECKOUT_COMPLETED = "checkout.completed"
+        CHECKOUT_REFUNDED = "checkout.refunded"
+        CHECKOUT_DISPUTED = "checkout.disputed"
+        TRANSPARENT_COMPLETED = "transparent.completed"
+        TRANSPARENT_REFUNDED = "transparent.refunded"
+        TRANSPARENT_DISPUTED = "transparent.disputed"
+        SUBSCRIPTION_COMPLETED = "subscription.completed"
+        SUBSCRIPTION_RENEWED = "subscription.renewed"
+        SUBSCRIPTION_CANCELLED = "subscription.cancelled"
+
+        # Recurring charge failed — the dunning signal. Without handling this,
+        # a failing subscription looks identical to a healthy one.
+        SUBSCRIPTION_PAYMENT_FAILED = "subscription.payment_failed"
+
+        SUBSCRIPTION_TRIAL_STARTED = "subscription.trial_started"
+        TRANSFER_COMPLETED = "transfer.completed"
+        TRANSFER_FAILED = "transfer.failed"
+        PAYOUT_COMPLETED = "payout.completed"
+        PAYOUT_FAILED = "payout.failed"
+
+        def self.values
+          [
+            CHECKOUT_COMPLETED, CHECKOUT_REFUNDED, CHECKOUT_DISPUTED,
+            TRANSPARENT_COMPLETED, TRANSPARENT_REFUNDED, TRANSPARENT_DISPUTED,
+            SUBSCRIPTION_COMPLETED, SUBSCRIPTION_RENEWED, SUBSCRIPTION_CANCELLED,
+            SUBSCRIPTION_PAYMENT_FAILED, SUBSCRIPTION_TRIAL_STARTED,
+            TRANSFER_COMPLETED, TRANSFER_FAILED,
+            PAYOUT_COMPLETED, PAYOUT_FAILED
+          ]
+        end
+
+        def self.valid?(value)
+          values.include?(value)
+        end
+
+        def self.validate!(value)
+          raise ArgumentError, "Invalid webhook event type: #{value}" unless valid?(value)
+
+          value
+        end
+      end
+    end
+  end
+end

data/lib/abacate_pay/enums.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "abacate_pay/enums/billings/frequencies"
+require "abacate_pay/enums/billings/methods"
+require "abacate_pay/enums/billings/statuses"
+require "abacate_pay/enums/checkouts/statuses"
+require "abacate_pay/enums/coupons/discount_kinds"
+require "abacate_pay/enums/coupons/statuses"
+require "abacate_pay/enums/payouts/statuses"
+require "abacate_pay/enums/pix/key_types"
+require "abacate_pay/enums/products/cycles"
+require "abacate_pay/enums/transfers/statuses"
+require "abacate_pay/enums/webhooks/event_types"
+
+module AbacatePay
+  # The Enums module contains all enumeration classes used
+  # throughout the AbacatePay SDK.
+  module Enums
+  end
+end

data/lib/{abacatepay/resources/billing → abacate_pay/resources/billings}/metadata.rb

@@ -2,7 +2,7 @@
 
 module AbacatePay
   module Resources
-    module Billing
+    class Billings
       # Represents metadata for a billing resource in the AbacatePay system.
       #
       # This class contains additional information related to a billing resource,
@@ -23,13 +23,7 @@ module AbacatePay
         def initialize(data)
           fill(data)
         end
-
-        protected
-
-        def to_hash
-          super
-        end
       end
     end
   end
-end
+end

data/lib/{abacatepay/resources/billing → abacate_pay/resources/billings}/product.rb

@@ -2,7 +2,7 @@
 
 module AbacatePay
   module Resources
-    module Billing
+    class Billings
       # Represents a product in a billing resource in the AbacatePay system.
       #
       # This class contains information about a product, such as its identifier,
@@ -32,13 +32,7 @@ module AbacatePay
         def initialize(data)
           fill(data)
         end
-
-        protected
-
-        def to_hash
-          super
-        end
       end
     end
   end
-end
+end

data/lib/{abacatepay/resources/billing.rb → abacate_pay/resources/billings.rb}

@@ -1,27 +1,24 @@
 # frozen_string_literal: true
 
-require "abacate_pay/resources/billing/metadata"
-require "abacate_pay/resources/billing/product"
-
 module AbacatePay
   module Resources
     # Represents a billing resource in the AbacatePay payment system.
     #
     # Manages billing-related data including payment methods, products, scheduling,
     # and customer information for recurring and one-time payments.
-    class Billing < Resource
+    class Billings < Resource
       # Maps property names to their corresponding resource classes
       RESOURCE_PROPERTIES = {
-        metadata: 'AbacatePay::Resources::Billing::Metadata',
-        customer: 'AbacatePay::Resources::Customer',
-        products: 'AbacatePay::Resources::Billing::Product'
+        metadata: "AbacatePay::Resources::Billings::Metadata",
+        customer: "AbacatePay::Resources::Customers",
+        products: "AbacatePay::Resources::Billings::Product"
       }.freeze
 
       # Maps property names to their corresponding enum classes
       ENUM_PROPERTIES = {
-        status: 'AbacatePay::Enums::Billing::Statuses',
-        frequency: 'AbacatePay::Enums::Billing::Frequencies',
-        methods: 'AbacatePay::Enums::Billing::Methods'
+        status: "AbacatePay::Enums::Billings::Statuses",
+        frequency: "AbacatePay::Enums::Billings::Frequencies",
+        methods: "AbacatePay::Enums::Billings::Methods"
       }.freeze
 
       # Properties that should be handled as DateTime objects
@@ -86,7 +83,7 @@ module AbacatePay
       # @return [Object] The processed value
       def process_enum_value(property, value)
         enum_class = Object.const_get(ENUM_PROPERTIES[property.to_sym])
-        
+
         if value.is_a?(Array)
           value.map { |item| initialize_enum(enum_class, item) }
         else
@@ -101,8 +98,8 @@ module AbacatePay
       # @return [Object] The processed value
       def process_resource_value(property, value)
         resource_class = Object.const_get(RESOURCE_PROPERTIES[property.to_sym])
-        
-        if property.to_s == 'products' && value.is_a?(Array)
+
+        if property.to_s == "products" && value.is_a?(Array)
           value.map { |item| initialize_resource(resource_class, item) }
         else
           initialize_resource(resource_class, value)
@@ -113,8 +110,11 @@ module AbacatePay
 
       # @!visibility private
       attr_writer :id, :account_id, :url, :methods, :products,
-                 :dev_mode, :amount, :metadata, :frequency, :status,
-                 :customer, :next_billing, :created_at, :updated_at
+                  :dev_mode, :amount, :metadata, :frequency, :status,
+                  :customer, :next_billing, :created_at, :updated_at
     end
   end
-end
+end
+
+require "abacate_pay/resources/billings/metadata"
+require "abacate_pay/resources/billings/product"

data/lib/abacate_pay/resources/checkouts.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    # Represents a checkout session in the AbacatePay system.
+    class Checkouts < Resource
+      RESOURCE_PROPERTIES = {
+        metadata: "AbacatePay::Resources::Billings::Metadata",
+        customer: "AbacatePay::Resources::Customers",
+        products: "AbacatePay::Resources::Billings::Product"
+      }.freeze
+
+      ENUM_PROPERTIES = {
+        status: "AbacatePay::Enums::Checkouts::Statuses",
+        frequency: "AbacatePay::Enums::Billings::Frequencies",
+        methods: "AbacatePay::Enums::Billings::Methods"
+      }.freeze
+
+      DATETIME_PROPERTIES = %w[created_at updated_at].freeze
+
+      attr_reader :id, :url, :amount, :status, :dev_mode, :methods,
+                  :products, :metadata, :customer, :coupons, :external_id,
+                  :frequency, :created_at, :updated_at,
+                  # BOLETO-only: due date (YYYY-MM-DD) plus late-payment charges.
+                  :due_date, :interest, :fine,
+                  # CARD-only: maximum number of instalments offered.
+                  :max_installments,
+                  # Order bump shown at checkout, and free-form merchant data.
+                  :up_sell_product_id, :custom_metadata
+
+      def initialize(data)
+        fill(data)
+      end
+
+      def dev_mode?
+        @dev_mode
+      end
+
+      private
+
+      def process_value(property, value)
+        return nil if value.nil?
+
+        if DATETIME_PROPERTIES.include?(property)
+          initialize_date_time(value)
+        elsif ENUM_PROPERTIES.key?(property.to_sym)
+          process_enum_value(property, value)
+        elsif RESOURCE_PROPERTIES.key?(property.to_sym)
+          process_resource_value(property, value)
+        else
+          value
+        end
+      end
+
+      def process_enum_value(property, value)
+        enum_class = Object.const_get(ENUM_PROPERTIES[property.to_sym])
+
+        if value.is_a?(Array)
+          value.map { |item| initialize_enum(enum_class, item) }
+        else
+          initialize_enum(enum_class, value)
+        end
+      end
+
+      def process_resource_value(property, value)
+        resource_class = Object.const_get(RESOURCE_PROPERTIES[property.to_sym])
+
+        if property.to_s == "products" && value.is_a?(Array)
+          value.map { |item| initialize_resource(resource_class, item) }
+        else
+          initialize_resource(resource_class, value)
+        end
+      end
+
+      protected
+
+      attr_writer :id, :url, :amount, :status, :dev_mode, :methods,
+                  :products, :metadata, :customer, :coupons, :external_id,
+                  :frequency, :created_at, :updated_at,
+                  :due_date, :interest, :fine, :max_installments,
+                  :up_sell_product_id, :custom_metadata
+    end
+  end
+end

data/lib/abacate_pay/resources/coupons.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    # Represents a discount coupon in the AbacatePay system.
+    class Coupons < Resource
+      ENUM_PROPERTIES = {
+        status: "AbacatePay::Enums::Coupons::Statuses",
+        discount_kind: "AbacatePay::Enums::Coupons::DiscountKinds"
+      }.freeze
+
+      DATETIME_PROPERTIES = %w[created_at updated_at].freeze
+
+      attr_reader :id, :code, :discount, :discount_kind, :max_redeems,
+                  :current_redeems, :status, :created_at, :updated_at
+
+      def initialize(data)
+        fill(data)
+      end
+
+      private
+
+      def process_value(property, value)
+        return nil if value.nil?
+
+        if DATETIME_PROPERTIES.include?(property)
+          initialize_date_time(value)
+        elsif ENUM_PROPERTIES.key?(property.to_sym)
+          initialize_enum(Object.const_get(ENUM_PROPERTIES[property.to_sym]), value)
+        else
+          value
+        end
+      end
+
+      protected
+
+      attr_writer :id, :code, :discount, :discount_kind, :max_redeems,
+                  :current_redeems, :status, :created_at, :updated_at
+    end
+  end
+end

data/lib/{abacatepay/resources/customer → abacate_pay/resources/customers}/metadata.rb

@@ -2,7 +2,7 @@
 
 module AbacatePay
   module Resources
-    module Customer
+    class Customers
       # Represents metadata for a customer in the AbacatePay system.
       #
       # This class contains additional information about a customer, such as their name,
@@ -26,13 +26,7 @@ module AbacatePay
         def initialize(data)
           fill(data)
         end
-
-        protected
-
-        def to_hash
-          super
-        end
       end
     end
   end
-end
+end

data/lib/{abacatepay/resources/customer.rb → abacate_pay/resources/customers.rb}

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-require "abacate_pay/resources/customer/metadata"
-
 module AbacatePay
   module Resources
     # Represents a customer resource in the AbacatePay payment system.
     #
     # This class handles customer data including identification and metadata,
     # providing a structured way to manage customer information within the system.
-    class Customer < Resource
+    class Customers < Resource
       # Maps property names to their corresponding resource classes
       RESOURCE_PROPERTIES = {
-        metadata: 'AbacatePay::Resources::Customer::Metadata'
+        metadata: "AbacatePay::Resources::Customers::Metadata"
       }.freeze
 
       # @return [String, nil] The unique identifier for the customer
@@ -54,4 +52,6 @@ module AbacatePay
       attr_writer :id, :metadata
     end
   end
-end
+end
+
+require "abacate_pay/resources/customers/metadata"

data/lib/abacate_pay/resources/payouts.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AbacatePay
+  module Resources
+    # Represents a payout (withdrawal) in the AbacatePay system.
+    class Payouts < Resource
+      ENUM_PROPERTIES = {
+        status: "AbacatePay::Enums::Payouts::Statuses"
+      }.freeze
+
+      DATETIME_PROPERTIES = %w[created_at updated_at].freeze
+
+      attr_reader :id, :amount, :external_id, :description,
+                  :status, :created_at, :updated_at
+
+      def initialize(data)
+        fill(data)
+      end
+
+      private
+
+      def process_value(property, value)
+        return nil if value.nil?
+
+        if DATETIME_PROPERTIES.include?(property)
+          initialize_date_time(value)
+        elsif ENUM_PROPERTIES.key?(property.to_sym)
+          initialize_enum(Object.const_get(ENUM_PROPERTIES[property.to_sym]), value)
+        else
+          value
+        end
+      end
+
+      protected
+
+      attr_writer :id, :amount, :external_id, :description,
+                  :status, :created_at, :updated_at
+    end
+  end
+end