method-ruby 0.1.0 → 0.2.1

data/lib/method_ruby/models/payment_delete_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#delete
+    class PaymentDeleteParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute payment_id
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::PaymentDeleteParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::PaymentDeleteParams::MethodVersion }
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(payment_id:, method_version:, idempotency_key: nil, request_options: {})
+      #   @param payment_id [String]
+      #   @param method_version [Symbol, MethodRuby::Models::PaymentDeleteParams::MethodVersion]
+      #   @param idempotency_key [String]
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payment_delete_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#delete
+    class PaymentDeleteResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #   A Payment represents a transfer of funds between two accounts.
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object] A Payment represents a transfer of funds between two accounts.
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end

data/lib/method_ruby/models/payment_list_params.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#list
+    class PaymentListParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::PaymentListParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::PaymentListParams::MethodVersion }
+
+      # @!attribute acc_id
+      #   Filter payments by either the source or destination account ID.
+      #
+      #   @return [String, nil]
+      optional :acc_id, String
+
+      # @!attribute destination
+      #   Filter payments by destination account ID.
+      #
+      #   @return [String, nil]
+      optional :destination, String
+
+      # @!attribute destination_holder_id
+      #   Filter payments by destination entity ID.
+      #
+      #   @return [String, nil]
+      optional :destination_holder_id, String
+
+      # @!attribute expand
+      #   Expand payment source or destination accounts inline. Nested account expansion
+      #   is supported for latest verification sessions on the source or destination.
+      #
+      #   @return [Array<Symbol, MethodRuby::Models::PaymentListParams::Expand>, nil]
+      optional :expand, -> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::PaymentListParams::Expand] }
+
+      # @!attribute from_date
+      #   Filter results from this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @return [Date, nil]
+      optional :from_date, Date
+
+      # @!attribute holder_id
+      #   Filter payments by either the source or destination entity ID.
+      #
+      #   @return [String, nil]
+      optional :holder_id, String
+
+      # @!attribute page
+      #   Page number for pagination (1-indexed).
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute page_cursor
+      #   Cursor for cursor-based pagination. Use the value from
+      #   `Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.
+      #
+      #   @return [String, nil]
+      optional :page_cursor, String
+
+      # @!attribute page_limit
+      #   Number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_limit, Integer
+
+      # @!attribute reversal_id
+      #   Filter payments by reversal ID.
+      #
+      #   @return [String, nil]
+      optional :reversal_id, String
+
+      # @!attribute source
+      #   Filter payments by source account ID.
+      #
+      #   @return [String, nil]
+      optional :source, String
+
+      # @!attribute source_holder_id
+      #   Filter payments by source entity ID.
+      #
+      #   @return [String, nil]
+      optional :source_holder_id, String
+
+      # @!attribute status
+      #   Filter payments by status.
+      #
+      #   @return [Symbol, MethodRuby::Models::PaymentListParams::Status, nil]
+      optional :status, enum: -> { MethodRuby::PaymentListParams::Status }
+
+      # @!attribute to_date
+      #   Filter results to this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @return [Date, nil]
+      optional :to_date, Date
+
+      # @!attribute type
+      #   Filter payments by payment type.
+      #
+      #   @return [Symbol, MethodRuby::Models::PaymentListParams::Type, nil]
+      optional :type, enum: -> { MethodRuby::PaymentListParams::Type }
+
+      # @!method initialize(method_version:, acc_id: nil, destination: nil, destination_holder_id: nil, expand: nil, from_date: nil, holder_id: nil, page: nil, page_cursor: nil, page_limit: nil, reversal_id: nil, source: nil, source_holder_id: nil, status: nil, to_date: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {MethodRuby::Models::PaymentListParams} for more details.
+      #
+      #   @param method_version [Symbol, MethodRuby::Models::PaymentListParams::MethodVersion]
+      #
+      #   @param acc_id [String] Filter payments by either the source or destination account ID.
+      #
+      #   @param destination [String] Filter payments by destination account ID.
+      #
+      #   @param destination_holder_id [String] Filter payments by destination entity ID.
+      #
+      #   @param expand [Array<Symbol, MethodRuby::Models::PaymentListParams::Expand>] Expand payment source or destination accounts inline. Nested account expansion
+      #
+      #   @param from_date [Date] Filter results from this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @param holder_id [String] Filter payments by either the source or destination entity ID.
+      #
+      #   @param page [Integer] Page number for pagination (1-indexed).
+      #
+      #   @param page_cursor [String] Cursor for cursor-based pagination. Use the value from `Pagination-Page-Cursor-N
+      #
+      #   @param page_limit [Integer] Number of items per page.
+      #
+      #   @param reversal_id [String] Filter payments by reversal ID.
+      #
+      #   @param source [String] Filter payments by source account ID.
+      #
+      #   @param source_holder_id [String] Filter payments by source entity ID.
+      #
+      #   @param status [Symbol, MethodRuby::Models::PaymentListParams::Status] Filter payments by status.
+      #
+      #   @param to_date [Date] Filter results to this date (inclusive, YYYY-MM-DD format).
+      #
+      #   @param type [Symbol, MethodRuby::Models::PaymentListParams::Type] Filter payments by payment type.
+      #
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        SOURCE = :source
+        DESTINATION = :destination
+        SOURCE_LATEST_VERIFICATION_SESSION = :"source.latest_verification_session"
+        DESTINATION_LATEST_VERIFICATION_SESSION = :"destination.latest_verification_session"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter payments by status.
+      module Status
+        extend MethodRuby::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSING = :processing
+        SENT = :sent
+        POSTED = :posted
+        SETTLED = :settled
+        FAILED = :failed
+        REVERSED = :reversed
+        CANCELED = :canceled
+        CASHED = :cashed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Filter payments by payment type.
+      module Type
+        extend MethodRuby::Internal::Type::Enum
+
+        STANDARD = :standard
+        CLEARING = :clearing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payment_list_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#list
+    class PaymentListResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object]
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end

data/lib/method_ruby/models/payment_retrieve_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#retrieve
+    class PaymentRetrieveParams < MethodRuby::Internal::Type::BaseModel
+      extend MethodRuby::Internal::Type::RequestParameters::Converter
+      include MethodRuby::Internal::Type::RequestParameters
+
+      # @!attribute payment_id
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::PaymentRetrieveParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::PaymentRetrieveParams::MethodVersion }
+
+      # @!attribute expand
+      #   Expand payment source or destination accounts inline. Nested account expansion
+      #   is supported for latest verification sessions on the source or destination.
+      #
+      #   @return [Array<Symbol, MethodRuby::Models::PaymentRetrieveParams::Expand>, nil]
+      optional :expand,
+               -> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::PaymentRetrieveParams::Expand] }
+
+      # @!method initialize(payment_id:, method_version:, expand: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {MethodRuby::Models::PaymentRetrieveParams} for more details.
+      #
+      #   @param payment_id [String]
+      #
+      #   @param method_version [Symbol, MethodRuby::Models::PaymentRetrieveParams::MethodVersion]
+      #
+      #   @param expand [Array<Symbol, MethodRuby::Models::PaymentRetrieveParams::Expand>] Expand payment source or destination accounts inline. Nested account expansion
+      #
+      #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Expand
+        extend MethodRuby::Internal::Type::Enum
+
+        SOURCE = :source
+        DESTINATION = :destination
+        SOURCE_LATEST_VERIFICATION_SESSION = :"source.latest_verification_session"
+        DESTINATION_LATEST_VERIFICATION_SESSION = :"destination.latest_verification_session"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payment_retrieve_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    # @see MethodRuby::Resources::Payments#retrieve
+    class PaymentRetrieveResponse < MethodRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #   A Payment represents a transfer of funds between two accounts.
+      #
+      #   @return [Object]
+      required :data, MethodRuby::Internal::Type::Unknown
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      required :message, String, nil?: true
+
+      # @!attribute success
+      #   Always `true` for successful responses.
+      #
+      #   @return [Boolean]
+      required :success, MethodRuby::Internal::Type::Boolean
+
+      # @!method initialize(data:, message:, success:)
+      #   @param data [Object] A Payment represents a transfer of funds between two accounts.
+      #
+      #   @param message [String, nil]
+      #
+      #   @param success [Boolean] Always `true` for successful responses.
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_list_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#list
+      class ReversalListParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute payment_id
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Payments::ReversalListParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Payments::ReversalListParams::MethodVersion }
+
+        # @!method initialize(payment_id:, method_version:, request_options: {})
+        #   @param payment_id [String]
+        #   @param method_version [Symbol, MethodRuby::Models::Payments::ReversalListParams::MethodVersion]
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_list_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#list
+      class ReversalListResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object]
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_retrieve_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#retrieve
+      class ReversalRetrieveParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute payment_id
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!attribute reversal_id
+        #
+        #   @return [String]
+        required :reversal_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Payments::ReversalRetrieveParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Payments::ReversalRetrieveParams::MethodVersion }
+
+        # @!method initialize(payment_id:, reversal_id:, method_version:, request_options: {})
+        #   @param payment_id [String]
+        #   @param reversal_id [String]
+        #   @param method_version [Symbol, MethodRuby::Models::Payments::ReversalRetrieveParams::MethodVersion]
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_retrieve_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#retrieve
+      class ReversalRetrieveResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #   A reversal for a payment, representing a return of funds.
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object] A reversal for a payment, representing a return of funds.
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_update_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#update
+      class ReversalUpdateParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute payment_id
+        #
+        #   @return [String]
+        required :payment_id, String
+
+        # @!attribute reversal_id
+        #
+        #   @return [String]
+        required :reversal_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Payments::ReversalUpdateParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Payments::ReversalUpdateParams::MethodVersion }
+
+        # @!attribute status
+        #   Updated status for the reversal.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(payment_id:, reversal_id:, method_version:, status: nil, idempotency_key: nil, request_options: {})
+        #   @param payment_id [String]
+        #
+        #   @param reversal_id [String]
+        #
+        #   @param method_version [Symbol, MethodRuby::Models::Payments::ReversalUpdateParams::MethodVersion]
+        #
+        #   @param status [String] Updated status for the reversal.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/payments/reversal_update_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Payments
+      # @see MethodRuby::Resources::Payments::Reversals#update
+      class ReversalUpdateResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #   A reversal for a payment, representing a return of funds.
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object] A reversal for a payment, representing a return of funds.
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/ping_check_params.rb

@@ -7,8 +7,23 @@ module MethodRuby
       extend MethodRuby::Internal::Type::RequestParameters::Converter
       include MethodRuby::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute method_version
+      #
+      #   @return [Symbol, MethodRuby::Models::PingCheckParams::MethodVersion]
+      required :method_version, enum: -> { MethodRuby::PingCheckParams::MethodVersion }
+
+      # @!method initialize(method_version:, request_options: {})
+      #   @param method_version [Symbol, MethodRuby::Models::PingCheckParams::MethodVersion]
       #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      module MethodVersion
+        extend MethodRuby::Internal::Type::Enum
+
+        METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end