metronome-sdk 3.6.0 → 3.7.0

data/lib/metronome_sdk/models/v1/payment_status.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      module PaymentStatus
-        extend MetronomeSDK::Internal::Type::Enum
-
-        PENDING = :pending
-        REQUIRES_INTERVENTION = :requires_intervention
-        PAID = :paid
-        CANCELED = :canceled
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/metronome_sdk/resources/v1/payments.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Resources
-    class V1
-      class Payments
-        # Fetch all payment attempts for the given invoice.
-        #
-        # @overload list(customer_id:, invoice_id:, limit: nil, next_page: nil, statuses: nil, request_options: {})
-        #
-        # @param customer_id [String]
-        #
-        # @param invoice_id [String]
-        #
-        # @param limit [Integer] The maximum number of payments to return. Defaults to 25.
-        #
-        # @param next_page [String] The next page token from a previous response.
-        #
-        # @param statuses [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>]
-        #
-        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [MetronomeSDK::Internal::BodyCursorPage<MetronomeSDK::Models::V1::Payment>]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentListParams
-        def list(params)
-          parsed, options = MetronomeSDK::V1::PaymentListParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/list",
-            body: parsed,
-            page: MetronomeSDK::Internal::BodyCursorPage,
-            model: MetronomeSDK::V1::Payment,
-            options: options
-          )
-        end
-
-        # Trigger a new attempt by canceling any existing attempts for this invoice and
-        # creating a new Payment. This will trigger another attempt to charge the
-        # Customer's configured Payment Gateway. Payment can only be attempted if all of
-        # the following are true:
-        #
-        # - The Metronome Invoice is finalized
-        # - PLG Invoicing is configured for the Customer
-        # - You cannot attempt payments for invoices that have already been `paid` or
-        #   `voided`.
-        #
-        # Attempting to payment on an ineligible Invoice or Customer will result in a
-        # `400` response.
-        #
-        # @overload attempt(customer_id:, invoice_id:, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param invoice_id [String]
-        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [MetronomeSDK::Models::V1::PaymentAttemptResponse]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentAttemptParams
-        def attempt(params)
-          parsed, options = MetronomeSDK::V1::PaymentAttemptParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/attempt",
-            body: parsed,
-            model: MetronomeSDK::Models::V1::PaymentAttemptResponse,
-            options: options
-          )
-        end
-
-        # Cancel an existing payment attempt for an invoice.
-        #
-        # @overload cancel(customer_id:, invoice_id:, request_options: {})
-        #
-        # @param customer_id [String]
-        # @param invoice_id [String]
-        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [MetronomeSDK::Models::V1::PaymentCancelResponse]
-        #
-        # @see MetronomeSDK::Models::V1::PaymentCancelParams
-        def cancel(params)
-          parsed, options = MetronomeSDK::V1::PaymentCancelParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "v1/payments/cancel",
-            body: parsed,
-            model: MetronomeSDK::Models::V1::PaymentCancelResponse,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [MetronomeSDK::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment.rbi

@@ -1,403 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class Payment < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(MetronomeSDK::V1::Payment, MetronomeSDK::Internal::AnyHash)
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        sig { returns(T.nilable(Float)) }
-        attr_reader :amount
-
-        sig { params(amount: Float).void }
-        attr_writer :amount
-
-        sig { returns(T.nilable(Float)) }
-        attr_reader :amount_paid
-
-        sig { params(amount_paid: Float).void }
-        attr_writer :amount_paid
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :contract_id
-
-        sig { params(contract_id: String).void }
-        attr_writer :contract_id
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :created_at
-
-        sig { params(created_at: Time).void }
-        attr_writer :created_at
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :customer_id
-
-        sig { params(customer_id: String).void }
-        attr_writer :customer_id
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :error_message
-
-        sig { params(error_message: String).void }
-        attr_writer :error_message
-
-        sig { returns(T.nilable(MetronomeSDK::CreditTypeData)) }
-        attr_reader :fiat_credit_type
-
-        sig do
-          params(fiat_credit_type: MetronomeSDK::CreditTypeData::OrHash).void
-        end
-        attr_writer :fiat_credit_type
-
-        sig { returns(T.nilable(String)) }
-        attr_reader :invoice_id
-
-        sig { params(invoice_id: String).void }
-        attr_writer :invoice_id
-
-        sig { returns(T.nilable(MetronomeSDK::V1::Payment::PaymentGateway)) }
-        attr_reader :payment_gateway
-
-        sig do
-          params(
-            payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway::OrHash
-          ).void
-        end
-        attr_writer :payment_gateway
-
-        sig do
-          returns(
-            T.nilable(T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment])
-          )
-        end
-        attr_reader :revenue_system_payments
-
-        sig do
-          params(
-            revenue_system_payments:
-              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash]
-          ).void
-        end
-        attr_writer :revenue_system_payments
-
-        sig do
-          returns(T.nilable(MetronomeSDK::V1::PaymentStatus::TaggedSymbol))
-        end
-        attr_reader :status
-
-        sig { params(status: MetronomeSDK::V1::PaymentStatus::OrSymbol).void }
-        attr_writer :status
-
-        sig { returns(T.nilable(Time)) }
-        attr_reader :updated_at
-
-        sig { params(updated_at: Time).void }
-        attr_writer :updated_at
-
-        sig do
-          params(
-            id: String,
-            amount: Float,
-            amount_paid: Float,
-            contract_id: String,
-            created_at: Time,
-            customer_id: String,
-            error_message: String,
-            fiat_credit_type: MetronomeSDK::CreditTypeData::OrHash,
-            invoice_id: String,
-            payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway::OrHash,
-            revenue_system_payments:
-              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash],
-            status: MetronomeSDK::V1::PaymentStatus::OrSymbol,
-            updated_at: Time
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          amount: nil,
-          amount_paid: nil,
-          contract_id: nil,
-          created_at: nil,
-          customer_id: nil,
-          error_message: nil,
-          fiat_credit_type: nil,
-          invoice_id: nil,
-          payment_gateway: nil,
-          revenue_system_payments: nil,
-          status: nil,
-          updated_at: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              amount: Float,
-              amount_paid: Float,
-              contract_id: String,
-              created_at: Time,
-              customer_id: String,
-              error_message: String,
-              fiat_credit_type: MetronomeSDK::CreditTypeData,
-              invoice_id: String,
-              payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway,
-              revenue_system_payments:
-                T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
-              status: MetronomeSDK::V1::PaymentStatus::TaggedSymbol,
-              updated_at: Time
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::V1::Payment::PaymentGateway,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(MetronomeSDK::V1::Payment::PaymentGateway::Stripe) }
-          attr_reader :stripe
-
-          sig do
-            params(
-              stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::OrHash
-            ).void
-          end
-          attr_writer :stripe
-
-          sig do
-            returns(
-              MetronomeSDK::V1::Payment::PaymentGateway::Type::TaggedSymbol
-            )
-          end
-          attr_accessor :type
-
-          sig do
-            params(
-              stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::OrHash,
-              type: MetronomeSDK::V1::Payment::PaymentGateway::Type::OrSymbol
-            ).returns(T.attached_class)
-          end
-          def self.new(stripe:, type:)
-          end
-
-          sig do
-            override.returns(
-              {
-                stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe,
-                type:
-                  MetronomeSDK::V1::Payment::PaymentGateway::Type::TaggedSymbol
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class Stripe < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :payment_intent_id
-
-            sig do
-              returns(
-                T.nilable(
-                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error
-                )
-              )
-            end
-            attr_reader :error
-
-            sig do
-              params(
-                error:
-                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error::OrHash
-              ).void
-            end
-            attr_writer :error
-
-            sig { returns(T.nilable(String)) }
-            attr_reader :payment_method_id
-
-            sig { params(payment_method_id: String).void }
-            attr_writer :payment_method_id
-
-            sig do
-              params(
-                payment_intent_id: String,
-                error:
-                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error::OrHash,
-                payment_method_id: String
-              ).returns(T.attached_class)
-            end
-            def self.new(payment_intent_id:, error: nil, payment_method_id: nil)
-            end
-
-            sig do
-              override.returns(
-                {
-                  payment_intent_id: String,
-                  error:
-                    MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
-                  payment_method_id: String
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class Error < MetronomeSDK::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                end
-
-              sig { returns(T.nilable(String)) }
-              attr_reader :code
-
-              sig { params(code: String).void }
-              attr_writer :code
-
-              sig { returns(T.nilable(String)) }
-              attr_reader :decline_code
-
-              sig { params(decline_code: String).void }
-              attr_writer :decline_code
-
-              sig { returns(T.nilable(String)) }
-              attr_reader :type
-
-              sig { params(type: String).void }
-              attr_writer :type
-
-              sig do
-                params(
-                  code: String,
-                  decline_code: String,
-                  type: String
-                ).returns(T.attached_class)
-              end
-              def self.new(code: nil, decline_code: nil, type: nil)
-              end
-
-              sig do
-                override.returns(
-                  { code: String, decline_code: String, type: String }
-                )
-              end
-              def to_hash
-              end
-            end
-          end
-
-          module Type
-            extend MetronomeSDK::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(Symbol, MetronomeSDK::V1::Payment::PaymentGateway::Type)
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            STRIPE =
-              T.let(
-                :stripe,
-                MetronomeSDK::V1::Payment::PaymentGateway::Type::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  MetronomeSDK::V1::Payment::PaymentGateway::Type::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::V1::Payment::RevenueSystemPayment,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :revenue_system_provider
-
-          sig { returns(String) }
-          attr_accessor :sync_status
-
-          # The error message from the revenue system, if available.
-          sig { returns(T.nilable(String)) }
-          attr_reader :error_message
-
-          sig { params(error_message: String).void }
-          attr_writer :error_message
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :revenue_system_external_payment_id
-
-          sig { params(revenue_system_external_payment_id: String).void }
-          attr_writer :revenue_system_external_payment_id
-
-          sig do
-            params(
-              revenue_system_provider: String,
-              sync_status: String,
-              error_message: String,
-              revenue_system_external_payment_id: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            revenue_system_provider:,
-            sync_status:,
-            # The error message from the revenue system, if available.
-            error_message: nil,
-            revenue_system_external_payment_id: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                revenue_system_provider: String,
-                sync_status: String,
-                error_message: String,
-                revenue_system_external_payment_id: String
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment_attempt_params.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::V1::PaymentAttemptParams,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :customer_id
-
-        sig { returns(String) }
-        attr_accessor :invoice_id
-
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(customer_id:, invoice_id:, request_options: {})
-        end
-
-        sig do
-          override.returns(
-            {
-              customer_id: String,
-              invoice_id: String,
-              request_options: MetronomeSDK::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment_attempt_response.rbi

@@ -1,35 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::Models::V1::PaymentAttemptResponse,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(MetronomeSDK::V1::Payment) }
-        attr_reader :data
-
-        sig { params(data: MetronomeSDK::V1::Payment::OrHash).void }
-        attr_writer :data
-
-        sig do
-          params(data: MetronomeSDK::V1::Payment::OrHash).returns(
-            T.attached_class
-          )
-        end
-        def self.new(data:)
-        end
-
-        sig { override.returns({ data: MetronomeSDK::V1::Payment }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment_cancel_params.rbi

@@ -1,48 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class PaymentCancelParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::V1::PaymentCancelParams,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :customer_id
-
-        sig { returns(String) }
-        attr_accessor :invoice_id
-
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(customer_id:, invoice_id:, request_options: {})
-        end
-
-        sig do
-          override.returns(
-            {
-              customer_id: String,
-              invoice_id: String,
-              request_options: MetronomeSDK::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment_cancel_response.rbi

@@ -1,35 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class PaymentCancelResponse < MetronomeSDK::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::Models::V1::PaymentCancelResponse,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(MetronomeSDK::V1::Payment) }
-        attr_reader :data
-
-        sig { params(data: MetronomeSDK::V1::Payment::OrHash).void }
-        attr_writer :data
-
-        sig do
-          params(data: MetronomeSDK::V1::Payment::OrHash).returns(
-            T.attached_class
-          )
-        end
-        def self.new(data:)
-        end
-
-        sig { override.returns({ data: MetronomeSDK::V1::Payment }) }
-        def to_hash
-        end
-      end
-    end
-  end
-end