metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class InvoiceRetrievePdfParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Customers::InvoiceRetrievePdfParams,
+                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
+end

data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi

@@ -17,6 +17,7 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :id
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T::Hash[Symbol, String]) }
           attr_accessor :custom_fields
 
@@ -79,6 +80,7 @@ module MetronomeSDK
           def self.new(
             # the ID of the customer plan
             id:,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields:,
             plan_description:,
             # the ID of the plan

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

@@ -0,0 +1,316 @@
+# 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(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,
+            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,
+          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,
+              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 do
+              params(
+                payment_intent_id: String,
+                error:
+                  MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(payment_intent_id:, error: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  payment_intent_id: String,
+                  error:
+                    MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error
+                }
+              )
+            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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,48 @@
+# 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

@@ -0,0 +1,35 @@
+# 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

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

@@ -0,0 +1,91 @@
+# 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

@@ -0,0 +1,33 @@
+# 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/models/v1/plan_detail.rbi

@@ -12,6 +12,7 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :id
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -81,6 +82,7 @@ module MetronomeSDK
         end
         def self.new(
           id:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           name:,
           credit_grants: nil,

data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi

@@ -28,6 +28,7 @@ module MetronomeSDK
         sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
         attr_writer :credit_type
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -112,6 +113,7 @@ module MetronomeSDK
           id:,
           charge_type:,
           credit_type:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           name:,
           prices:,