metronome-sdk 3.6.0 → 3.7.0

data/rbi/metronome_sdk/models/v1/payment_list_params.rbi

@@ -1,91 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      class PaymentListParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              MetronomeSDK::V1::PaymentListParams,
-              MetronomeSDK::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :customer_id
-
-        sig { returns(String) }
-        attr_accessor :invoice_id
-
-        # The maximum number of payments to return. Defaults to 25.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :limit
-
-        sig { params(limit: Integer).void }
-        attr_writer :limit
-
-        # The next page token from a previous response.
-        sig { returns(T.nilable(String)) }
-        attr_reader :next_page
-
-        sig { params(next_page: String).void }
-        attr_writer :next_page
-
-        sig do
-          returns(
-            T.nilable(T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol])
-          )
-        end
-        attr_reader :statuses
-
-        sig do
-          params(
-            statuses: T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol]
-          ).void
-        end
-        attr_writer :statuses
-
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            limit: Integer,
-            next_page: String,
-            statuses: T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol],
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          customer_id:,
-          invoice_id:,
-          # The maximum number of payments to return. Defaults to 25.
-          limit: nil,
-          # The next page token from a previous response.
-          next_page: nil,
-          statuses: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              customer_id: String,
-              invoice_id: String,
-              limit: Integer,
-              next_page: String,
-              statuses: T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol],
-              request_options: MetronomeSDK::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/models/v1/payment_status.rbi

@@ -1,33 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Models
-    module V1
-      module PaymentStatus
-        extend MetronomeSDK::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, MetronomeSDK::V1::PaymentStatus) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PENDING = T.let(:pending, MetronomeSDK::V1::PaymentStatus::TaggedSymbol)
-        REQUIRES_INTERVENTION =
-          T.let(
-            :requires_intervention,
-            MetronomeSDK::V1::PaymentStatus::TaggedSymbol
-          )
-        PAID = T.let(:paid, MetronomeSDK::V1::PaymentStatus::TaggedSymbol)
-        CANCELED =
-          T.let(:canceled, MetronomeSDK::V1::PaymentStatus::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[MetronomeSDK::V1::PaymentStatus::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/metronome_sdk/resources/v1/payments.rbi

@@ -1,72 +0,0 @@
-# typed: strong
-
-module MetronomeSDK
-  module Resources
-    class V1
-      class Payments
-        # Fetch all payment attempts for the given invoice.
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            limit: Integer,
-            next_page: String,
-            statuses: T::Array[MetronomeSDK::V1::PaymentStatus::OrSymbol],
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(
-            MetronomeSDK::Internal::BodyCursorPage[MetronomeSDK::V1::Payment]
-          )
-        end
-        def list(
-          customer_id:,
-          invoice_id:,
-          # The maximum number of payments to return. Defaults to 25.
-          limit: nil,
-          # The next page token from a previous response.
-          next_page: nil,
-          statuses: nil,
-          request_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.
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(MetronomeSDK::Models::V1::PaymentAttemptResponse)
-        end
-        def attempt(customer_id:, invoice_id:, request_options: {})
-        end
-
-        # Cancel an existing payment attempt for an invoice.
-        sig do
-          params(
-            customer_id: String,
-            invoice_id: String,
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(MetronomeSDK::Models::V1::PaymentCancelResponse)
-        end
-        def cancel(customer_id:, invoice_id:, request_options: {})
-        end
-
-        # @api private
-        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment.rbs

@@ -1,243 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment =
-        {
-          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: ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
-          status: MetronomeSDK::Models::V1::payment_status,
-          updated_at: Time
-        }
-
-      class Payment < MetronomeSDK::Internal::Type::BaseModel
-        attr_accessor id: String
-
-        attr_reader amount: Float?
-
-        def amount=: (Float) -> Float
-
-        attr_reader amount_paid: Float?
-
-        def amount_paid=: (Float) -> Float
-
-        attr_reader contract_id: String?
-
-        def contract_id=: (String) -> String
-
-        attr_reader created_at: Time?
-
-        def created_at=: (Time) -> Time
-
-        attr_reader customer_id: String?
-
-        def customer_id=: (String) -> String
-
-        attr_reader error_message: String?
-
-        def error_message=: (String) -> String
-
-        attr_reader fiat_credit_type: MetronomeSDK::CreditTypeData?
-
-        def fiat_credit_type=: (
-          MetronomeSDK::CreditTypeData
-        ) -> MetronomeSDK::CreditTypeData
-
-        attr_reader invoice_id: String?
-
-        def invoice_id=: (String) -> String
-
-        attr_reader payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway?
-
-        def payment_gateway=: (
-          MetronomeSDK::V1::Payment::PaymentGateway
-        ) -> MetronomeSDK::V1::Payment::PaymentGateway
-
-        attr_reader revenue_system_payments: ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment]?
-
-        def revenue_system_payments=: (
-          ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment]
-        ) -> ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment]
-
-        attr_reader status: MetronomeSDK::Models::V1::payment_status?
-
-        def status=: (
-          MetronomeSDK::Models::V1::payment_status
-        ) -> MetronomeSDK::Models::V1::payment_status
-
-        attr_reader updated_at: Time?
-
-        def updated_at=: (Time) -> Time
-
-        def initialize: (
-          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: ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
-          ?status: MetronomeSDK::Models::V1::payment_status,
-          ?updated_at: Time
-        ) -> void
-
-        def to_hash: -> {
-          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: ::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
-          status: MetronomeSDK::Models::V1::payment_status,
-          updated_at: Time
-        }
-
-        type payment_gateway =
-          {
-            stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe,
-            type: MetronomeSDK::Models::V1::Payment::PaymentGateway::type_
-          }
-
-        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
-          attr_accessor stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe
-
-          attr_accessor type: MetronomeSDK::Models::V1::Payment::PaymentGateway::type_
-
-          def initialize: (
-            stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe,
-            type: MetronomeSDK::Models::V1::Payment::PaymentGateway::type_
-          ) -> void
-
-          def to_hash: -> {
-            stripe: MetronomeSDK::V1::Payment::PaymentGateway::Stripe,
-            type: MetronomeSDK::Models::V1::Payment::PaymentGateway::type_
-          }
-
-          type stripe =
-            {
-              payment_intent_id: String,
-              error: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
-              payment_method_id: String
-            }
-
-          class Stripe < MetronomeSDK::Internal::Type::BaseModel
-            attr_accessor payment_intent_id: String
-
-            attr_reader error: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error?
-
-            def error=: (
-              MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error
-            ) -> MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error
-
-            attr_reader payment_method_id: String?
-
-            def payment_method_id=: (String) -> String
-
-            def initialize: (
-              payment_intent_id: String,
-              ?error: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
-              ?payment_method_id: String
-            ) -> void
-
-            def to_hash: -> {
-              payment_intent_id: String,
-              error: MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error,
-              payment_method_id: String
-            }
-
-            type error = { code: String, decline_code: String, type: String }
-
-            class Error < MetronomeSDK::Internal::Type::BaseModel
-              attr_reader code: String?
-
-              def code=: (String) -> String
-
-              attr_reader decline_code: String?
-
-              def decline_code=: (String) -> String
-
-              attr_reader type: String?
-
-              def type=: (String) -> String
-
-              def initialize: (
-                ?code: String,
-                ?decline_code: String,
-                ?type: String
-              ) -> void
-
-              def to_hash: -> {
-                code: String,
-                decline_code: String,
-                type: String
-              }
-            end
-          end
-
-          type type_ = :stripe
-
-          module Type
-            extend MetronomeSDK::Internal::Type::Enum
-
-            STRIPE: :stripe
-
-            def self?.values: -> ::Array[MetronomeSDK::Models::V1::Payment::PaymentGateway::type_]
-          end
-        end
-
-        type revenue_system_payment =
-          {
-            revenue_system_provider: String,
-            sync_status: String,
-            error_message: String,
-            revenue_system_external_payment_id: String
-          }
-
-        class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
-          attr_accessor revenue_system_provider: String
-
-          attr_accessor sync_status: String
-
-          attr_reader error_message: String?
-
-          def error_message=: (String) -> String
-
-          attr_reader revenue_system_external_payment_id: String?
-
-          def revenue_system_external_payment_id=: (String) -> String
-
-          def initialize: (
-            revenue_system_provider: String,
-            sync_status: String,
-            ?error_message: String,
-            ?revenue_system_external_payment_id: String
-          ) -> void
-
-          def to_hash: -> {
-            revenue_system_provider: String,
-            sync_status: String,
-            error_message: String,
-            revenue_system_external_payment_id: String
-          }
-        end
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_attempt_params.rbs

@@ -1,30 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_attempt_params =
-        { customer_id: String, invoice_id: String }
-        & MetronomeSDK::Internal::Type::request_parameters
-
-      class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        attr_accessor customer_id: String
-
-        attr_accessor invoice_id: String
-
-        def initialize: (
-          customer_id: String,
-          invoice_id: String,
-          ?request_options: MetronomeSDK::request_opts
-        ) -> void
-
-        def to_hash: -> {
-          customer_id: String,
-          invoice_id: String,
-          request_options: MetronomeSDK::RequestOptions
-        }
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_attempt_response.rbs

@@ -1,15 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_attempt_response = { data: MetronomeSDK::V1::Payment }
-
-      class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
-        attr_accessor data: MetronomeSDK::V1::Payment
-
-        def initialize: (data: MetronomeSDK::V1::Payment) -> void
-
-        def to_hash: -> { data: MetronomeSDK::V1::Payment }
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_cancel_params.rbs

@@ -1,30 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_cancel_params =
-        { customer_id: String, invoice_id: String }
-        & MetronomeSDK::Internal::Type::request_parameters
-
-      class PaymentCancelParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        attr_accessor customer_id: String
-
-        attr_accessor invoice_id: String
-
-        def initialize: (
-          customer_id: String,
-          invoice_id: String,
-          ?request_options: MetronomeSDK::request_opts
-        ) -> void
-
-        def to_hash: -> {
-          customer_id: String,
-          invoice_id: String,
-          request_options: MetronomeSDK::RequestOptions
-        }
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_cancel_response.rbs

@@ -1,15 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_cancel_response = { data: MetronomeSDK::V1::Payment }
-
-      class PaymentCancelResponse < MetronomeSDK::Internal::Type::BaseModel
-        attr_accessor data: MetronomeSDK::V1::Payment
-
-        def initialize: (data: MetronomeSDK::V1::Payment) -> void
-
-        def to_hash: -> { data: MetronomeSDK::V1::Payment }
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_list_params.rbs

@@ -1,56 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_list_params =
-        {
-          customer_id: String,
-          invoice_id: String,
-          limit: Integer,
-          next_page: String,
-          statuses: ::Array[MetronomeSDK::Models::V1::payment_status]
-        }
-        & MetronomeSDK::Internal::Type::request_parameters
-
-      class PaymentListParams < MetronomeSDK::Internal::Type::BaseModel
-        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
-        include MetronomeSDK::Internal::Type::RequestParameters
-
-        attr_accessor customer_id: String
-
-        attr_accessor invoice_id: String
-
-        attr_reader limit: Integer?
-
-        def limit=: (Integer) -> Integer
-
-        attr_reader next_page: String?
-
-        def next_page=: (String) -> String
-
-        attr_reader statuses: ::Array[MetronomeSDK::Models::V1::payment_status]?
-
-        def statuses=: (
-          ::Array[MetronomeSDK::Models::V1::payment_status]
-        ) -> ::Array[MetronomeSDK::Models::V1::payment_status]
-
-        def initialize: (
-          customer_id: String,
-          invoice_id: String,
-          ?limit: Integer,
-          ?next_page: String,
-          ?statuses: ::Array[MetronomeSDK::Models::V1::payment_status],
-          ?request_options: MetronomeSDK::request_opts
-        ) -> void
-
-        def to_hash: -> {
-          customer_id: String,
-          invoice_id: String,
-          limit: Integer,
-          next_page: String,
-          statuses: ::Array[MetronomeSDK::Models::V1::payment_status],
-          request_options: MetronomeSDK::RequestOptions
-        }
-      end
-    end
-  end
-end

data/sig/metronome_sdk/models/v1/payment_status.rbs

@@ -1,19 +0,0 @@
-module MetronomeSDK
-  module Models
-    module V1
-      type payment_status =
-        :pending | :requires_intervention | :paid | :canceled
-
-      module PaymentStatus
-        extend MetronomeSDK::Internal::Type::Enum
-
-        PENDING: :pending
-        REQUIRES_INTERVENTION: :requires_intervention
-        PAID: :paid
-        CANCELED: :canceled
-
-        def self?.values: -> ::Array[MetronomeSDK::Models::V1::payment_status]
-      end
-    end
-  end
-end

data/sig/metronome_sdk/resources/v1/payments.rbs

@@ -1,30 +0,0 @@
-module MetronomeSDK
-  module Resources
-    class V1
-      class Payments
-        def list: (
-          customer_id: String,
-          invoice_id: String,
-          ?limit: Integer,
-          ?next_page: String,
-          ?statuses: ::Array[MetronomeSDK::Models::V1::payment_status],
-          ?request_options: MetronomeSDK::request_opts
-        ) -> MetronomeSDK::Internal::BodyCursorPage[MetronomeSDK::V1::Payment]
-
-        def attempt: (
-          customer_id: String,
-          invoice_id: String,
-          ?request_options: MetronomeSDK::request_opts
-        ) -> MetronomeSDK::Models::V1::PaymentAttemptResponse
-
-        def cancel: (
-          customer_id: String,
-          invoice_id: String,
-          ?request_options: MetronomeSDK::request_opts
-        ) -> MetronomeSDK::Models::V1::PaymentCancelResponse
-
-        def initialize: (client: MetronomeSDK::Client) -> void
-      end
-    end
-  end
-end