metronome-sdk 1.0.0 → 2.0.0

data/lib/metronome_sdk/models/v1/customers/customer_alert.rb

@@ -12,8 +12,8 @@ module MetronomeSDK
           required :alert, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert }
 
           # @!attribute customer_status
-          #   The status of the customer alert. If the alert is archived, null will be
-          #   returned.
+          #   The status of the threshold notification. If the notification is archived, null
+          #   will be returned.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil]
           required :customer_status,
@@ -21,7 +21,7 @@ module MetronomeSDK
                    nil?: true
 
           # @!attribute triggered_by
-          #   If present, indicates the reason the alert was triggered.
+          #   If present, indicates the reason the threshold notification was triggered.
           #
           #   @return [String, nil]
           optional :triggered_by, String, nil?: true
@@ -32,52 +32,53 @@ module MetronomeSDK
           #
           #   @param alert [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert]
           #
-          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the customer alert. If the alert is archived, null will be returne
+          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the threshold notification. If the notification is archived, null
           #
-          #   @param triggered_by [String, nil] If present, indicates the reason the alert was triggered.
+          #   @param triggered_by [String, nil] If present, indicates the reason the threshold notification was triggered.
 
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#alert
           class Alert < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute id
-            #   the Metronome ID of the alert
+            #   the Metronome ID of the threshold notification
             #
             #   @return [String]
             required :id, String
 
             # @!attribute name
-            #   Name of the alert
+            #   Name of the threshold notification
             #
             #   @return [String]
             required :name, String
 
             # @!attribute status
-            #   Status of the alert
+            #   Status of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status]
             required :status, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Status }
 
             # @!attribute threshold
-            #   Threshold value of the alert policy
+            #   Threshold value of the notification policy
             #
             #   @return [Float]
             required :threshold, Float
 
             # @!attribute type
-            #   Type of the alert
+            #   Type of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type]
             required :type, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type }
 
             # @!attribute updated_at
-            #   Timestamp for when the alert was last updated
+            #   Timestamp for when the threshold notification was last updated
             #
             #   @return [Time]
             required :updated_at, Time
 
             # @!attribute credit_grant_type_filters
-            #   An array of strings, representing a way to filter the credit grant this alert
-            #   applies to, by looking at the credit_grant_type field on the credit grant. This
-            #   field is only defined for CreditPercentage and CreditBalance alerts
+            #   An array of strings, representing a way to filter the credit grant this
+            #   threshold notification applies to, by looking at the credit_grant_type field on
+            #   the credit grant. This field is only defined for CreditPercentage and
+            #   CreditBalance notifications
             #
             #   @return [Array<String>, nil]
             optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -88,30 +89,31 @@ module MetronomeSDK
             optional :credit_type, -> { MetronomeSDK::CreditTypeData }, nil?: true
 
             # @!attribute custom_field_filters
-            #   A list of custom field filters for alert types that support advanced filtering
+            #   A list of custom field filters for notification types that support advanced
+            #   filtering
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>, nil]
             optional :custom_field_filters,
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter] }
 
             # @!attribute group_key_filter
-            #   Scopes alert evaluation to a specific presentation group key on individual line
-            #   items. Only present for spend alerts.
+            #   Scopes threshold notification evaluation to a specific presentation group key on
+            #   individual line items. Only present for spend notifications.
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter, nil]
             optional :group_key_filter, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter }
 
             # @!attribute group_values
-            #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-            #   group key on individual line items.
+            #   Only present for `spend_threshold_reached` notifications. Scope notification to
+            #   a specific group key on individual line items.
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>, nil]
             optional :group_values,
                      -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue] }
 
             # @!attribute invoice_types_filter
-            #   Only supported for invoice_total_reached alerts. A list of invoice types to
-            #   evaluate.
+            #   Only supported for invoice_total_reached threshold notifications. A list of
+            #   invoice types to evaluate.
             #
             #   @return [Array<String>, nil]
             optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -128,33 +130,33 @@ module MetronomeSDK
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
             #
-            #   @param id [String] the Metronome ID of the alert
+            #   @param id [String] the Metronome ID of the threshold notification
             #
-            #   @param name [String] Name of the alert
+            #   @param name [String] Name of the threshold notification
             #
-            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the alert
+            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the threshold notification
             #
-            #   @param threshold [Float] Threshold value of the alert policy
+            #   @param threshold [Float] Threshold value of the notification policy
             #
-            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the alert
+            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the threshold notification
             #
-            #   @param updated_at [Time] Timestamp for when the alert was last updated
+            #   @param updated_at [Time] Timestamp for when the threshold notification was last updated
             #
-            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
             #
             #   @param credit_type [MetronomeSDK::Models::CreditTypeData, nil]
             #
-            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering
+            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
             #
-            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes threshold notification evaluation to a specific presentation group key on
             #
-            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
+            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` notifications. Scope notification to
             #
-            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
             #
             #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
 
-            # Status of the alert
+            # Status of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#status
             module Status
@@ -168,7 +170,7 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
-            # Type of the alert
+            # Type of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#type
             module Type
@@ -243,8 +245,8 @@ module MetronomeSDK
               required :value, String
 
               # @!method initialize(key:, value:)
-              #   Scopes alert evaluation to a specific presentation group key on individual line
-              #   items. Only present for spend alerts.
+              #   Scopes threshold notification evaluation to a specific presentation group key on
+              #   individual line items. Only present for spend notifications.
               #
               #   @param key [String]
               #   @param value [String]
@@ -267,8 +269,8 @@ module MetronomeSDK
             end
           end
 
-          # The status of the customer alert. If the alert is archived, null will be
-          # returned.
+          # The status of the threshold notification. If the notification is archived, null
+          # will be returned.
           #
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#customer_status
           module CustomerStatus

data/lib/metronome_sdk/models/v1/customers/invoice.rb

@@ -50,8 +50,8 @@ module MetronomeSDK
           # @!attribute billable_status
           #   This field's availability is dependent on your client's configuration.
           #
-          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus, nil]
-          optional :billable_status, enum: -> { MetronomeSDK::V1::Customers::Invoice::BillableStatus }
+          #   @return [Object, nil]
+          optional :billable_status, MetronomeSDK::Internal::Type::Unknown
 
           # @!attribute contract_custom_fields
           #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
@@ -180,7 +180,7 @@ module MetronomeSDK
           #
           #   @param amendment_id [String]
           #
-          #   @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::BillableStatus] This field's availability is dependent on your client's configuration.
+          #   @param billable_status [Object] This field's availability is dependent on your client's configuration.
           #
           #   @param contract_custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
@@ -805,19 +805,6 @@ module MetronomeSDK
             end
           end
 
-          # This field's availability is dependent on your client's configuration.
-          #
-          # @see MetronomeSDK::Models::V1::Customers::Invoice#billable_status
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
-
-            BILLABLE = :billable
-            UNBILLABLE = :unbillable
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
           # @see MetronomeSDK::Models::V1::Customers::Invoice#correction_record
           class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute corrected_invoice_id
@@ -866,16 +853,52 @@ module MetronomeSDK
               #   @return [String, nil]
               optional :invoice_id, String
 
+              # @!attribute invoiced_sub_total
+              #   The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_sub_total, Float
+
+              # @!attribute invoiced_total
+              #   The total amount invoiced, if available from the billing provider.
+              #
+              #   @return [Float, nil]
+              optional :invoiced_total, Float
+
               # @!attribute issued_at_timestamp
               #
               #   @return [Time, nil]
               optional :issued_at_timestamp, Time
 
-              # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+              # @!attribute pdf_url
+              #   A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @return [String, nil]
+              optional :pdf_url, String
+
+              # @!attribute tax
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @return [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax, nil]
+              optional :tax,
+                       -> { MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax }
+
+              # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
               #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
+              #
               #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
+              #
               #   @param invoice_id [String]
+              #
+              #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+              #
+              #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+              #
               #   @param issued_at_timestamp [Time]
+              #
+              #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+              #
+              #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
               # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#billing_provider_type
               module BillingProviderType
@@ -913,6 +936,36 @@ module MetronomeSDK
                 # @!method self.values
                 #   @return [Array<Symbol>]
               end
+
+              # @see MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice#tax
+              class Tax < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute total_tax_amount
+                #   The total tax amount applied to the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_tax_amount, Float
+
+                # @!attribute total_taxable_amount
+                #   The total taxable amount of the invoice.
+                #
+                #   @return [Float, nil]
+                optional :total_taxable_amount, Float
+
+                # @!attribute transaction_id
+                #   The transaction ID associated with the tax calculation.
+                #
+                #   @return [String, nil]
+                optional :transaction_id, String
+
+                # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+                #   Tax details for the invoice, if available from the billing provider.
+                #
+                #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+                #
+                #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+                #
+                #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+              end
             end
           end
 
@@ -935,16 +988,51 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :invoice_id, String
 
+            # @!attribute invoiced_sub_total
+            #   The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_sub_total, Float
+
+            # @!attribute invoiced_total
+            #   The total amount invoiced, if available from the billing provider.
+            #
+            #   @return [Float, nil]
+            optional :invoiced_total, Float
+
             # @!attribute issued_at_timestamp
             #
             #   @return [Time, nil]
             optional :issued_at_timestamp, Time
 
-            # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
+            # @!attribute pdf_url
+            #   A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @return [String, nil]
+            optional :pdf_url, String
+
+            # @!attribute tax
+            #   Tax details for the invoice, if available from the billing provider.
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax, nil]
+            optional :tax, -> { MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax }
+
+            # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, invoiced_sub_total: nil, invoiced_total: nil, issued_at_timestamp: nil, pdf_url: nil, tax: nil)
             #   @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::BillingProviderType]
+            #
             #   @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::ExternalStatus]
+            #
             #   @param invoice_id [String]
+            #
+            #   @param invoiced_sub_total [Float] The subtotal amount invoiced, if available from the billing provider.
+            #
+            #   @param invoiced_total [Float] The total amount invoiced, if available from the billing provider.
+            #
             #   @param issued_at_timestamp [Time]
+            #
+            #   @param pdf_url [String] A URL to the PDF of the invoice, if available from the billing provider.
+            #
+            #   @param tax [MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::Tax] Tax details for the invoice, if available from the billing provider.
 
             # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#billing_provider_type
             module BillingProviderType
@@ -982,6 +1070,36 @@ module MetronomeSDK
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            # @see MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice#tax
+            class Tax < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute total_tax_amount
+              #   The total tax amount applied to the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_tax_amount, Float
+
+              # @!attribute total_taxable_amount
+              #   The total taxable amount of the invoice.
+              #
+              #   @return [Float, nil]
+              optional :total_taxable_amount, Float
+
+              # @!attribute transaction_id
+              #   The transaction ID associated with the tax calculation.
+              #
+              #   @return [String, nil]
+              optional :transaction_id, String
+
+              # @!method initialize(total_tax_amount: nil, total_taxable_amount: nil, transaction_id: nil)
+              #   Tax details for the invoice, if available from the billing provider.
+              #
+              #   @param total_tax_amount [Float] The total tax amount applied to the invoice.
+              #
+              #   @param total_taxable_amount [Float] The total taxable amount of the invoice.
+              #
+              #   @param transaction_id [String] The transaction ID associated with the tax calculation.
+            end
           end
 
           class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#retrieve_pdf
+        class InvoiceRetrievePdfParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute invoice_id
+          #
+          #   @return [String]
+          required :invoice_id, String
+
+          # @!method initialize(customer_id:, invoice_id:, request_options: {})
+          #   @param customer_id [String]
+          #   @param invoice_id [String]
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#list
+      class Payment < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute amount_paid
+        #
+        #   @return [Float, nil]
+        optional :amount_paid, Float
+
+        # @!attribute contract_id
+        #
+        #   @return [String, nil]
+        optional :contract_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute error_message
+        #
+        #   @return [String, nil]
+        optional :error_message, String
+
+        # @!attribute fiat_credit_type
+        #
+        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+        optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String
+
+        # @!attribute payment_gateway
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway, nil]
+        optional :payment_gateway, -> { MetronomeSDK::V1::Payment::PaymentGateway }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PaymentStatus, nil]
+        optional :status, enum: -> { MetronomeSDK::V1::PaymentStatus }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(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)
+        #   @param id [String]
+        #   @param amount [Float]
+        #   @param amount_paid [Float]
+        #   @param contract_id [String]
+        #   @param created_at [Time]
+        #   @param customer_id [String]
+        #   @param error_message [String]
+        #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
+        #   @param invoice_id [String]
+        #   @param payment_gateway [MetronomeSDK::Models::V1::Payment::PaymentGateway]
+        #   @param status [Symbol, MetronomeSDK::Models::V1::PaymentStatus]
+        #   @param updated_at [Time]
+
+        # @see MetronomeSDK::Models::V1::Payment#payment_gateway
+        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute stripe
+          #
+          #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          required :stripe, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+          required :type, enum: -> { MetronomeSDK::V1::Payment::PaymentGateway::Type }
+
+          # @!method initialize(stripe:, type:)
+          #   @param stripe [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          #   @param type [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#stripe
+          class Stripe < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute payment_intent_id
+            #
+            #   @return [String]
+            required :payment_intent_id, String
+
+            # @!attribute error
+            #
+            #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error, nil]
+            optional :error, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error }
+
+            # @!method initialize(payment_intent_id:, error: nil)
+            #   @param payment_intent_id [String]
+            #   @param error [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error]
+
+            # @see MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe#error
+            class Error < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute code
+              #
+              #   @return [String, nil]
+              optional :code, String
+
+              # @!attribute decline_code
+              #
+              #   @return [String, nil]
+              optional :decline_code, String
+
+              # @!attribute type
+              #
+              #   @return [String, nil]
+              optional :type, String
+
+              # @!method initialize(code: nil, decline_code: nil, type: nil)
+              #   @param code [String]
+              #   @param decline_code [String]
+              #   @param type [String]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#type
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            STRIPE = :stripe
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!method initialize(customer_id:, invoice_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param invoice_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment]
+        required :data, -> { MetronomeSDK::V1::Payment }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Payment]
+      end
+    end
+  end
+end