metronome-sdk 1.0.0 → 2.1.0

data/sig/metronome_sdk/models/v1/customers/invoice.rbs

@@ -12,7 +12,8 @@ module MetronomeSDK
             total: Float,
             type: String,
             amendment_id: String,
-            billable_status: MetronomeSDK::Models::V1::Customers::Invoice::billable_status,
+            billable_status: top,
+            constituent_invoices: ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice],
             contract_custom_fields: ::Hash[Symbol, String],
             contract_id: String,
             correction_record: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord,
@@ -25,6 +26,7 @@ module MetronomeSDK
             issued_at: Time,
             net_payment_terms_days: Float,
             netsuite_sales_order_id: String,
+            payer: MetronomeSDK::V1::Customers::Invoice::Payer,
             plan_custom_fields: ::Hash[Symbol, String],
             plan_id: String,
             plan_name: String,
@@ -53,11 +55,15 @@ module MetronomeSDK
 
           def amendment_id=: (String) -> String
 
-          attr_reader billable_status: MetronomeSDK::Models::V1::Customers::Invoice::billable_status?
+          attr_reader billable_status: top?
 
-          def billable_status=: (
-            MetronomeSDK::Models::V1::Customers::Invoice::billable_status
-          ) -> MetronomeSDK::Models::V1::Customers::Invoice::billable_status
+          def billable_status=: (top) -> top
+
+          attr_reader constituent_invoices: ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice]?
+
+          def constituent_invoices=: (
+            ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice]
+          ) -> ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice]
 
           attr_reader contract_custom_fields: ::Hash[Symbol, String]?
 
@@ -113,6 +119,12 @@ module MetronomeSDK
 
           def netsuite_sales_order_id=: (String) -> String
 
+          attr_reader payer: MetronomeSDK::V1::Customers::Invoice::Payer?
+
+          def payer=: (
+            MetronomeSDK::V1::Customers::Invoice::Payer
+          ) -> MetronomeSDK::V1::Customers::Invoice::Payer
+
           attr_reader plan_custom_fields: ::Hash[Symbol, String]?
 
           def plan_custom_fields=: (
@@ -154,7 +166,8 @@ module MetronomeSDK
             total: Float,
             type: String,
             ?amendment_id: String,
-            ?billable_status: MetronomeSDK::Models::V1::Customers::Invoice::billable_status,
+            ?billable_status: top,
+            ?constituent_invoices: ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice],
             ?contract_custom_fields: ::Hash[Symbol, String],
             ?contract_id: String,
             ?correction_record: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord,
@@ -167,6 +180,7 @@ module MetronomeSDK
             ?issued_at: Time,
             ?net_payment_terms_days: Float,
             ?netsuite_sales_order_id: String,
+            ?payer: MetronomeSDK::V1::Customers::Invoice::Payer,
             ?plan_custom_fields: ::Hash[Symbol, String],
             ?plan_id: String,
             ?plan_name: String,
@@ -185,7 +199,8 @@ module MetronomeSDK
             total: Float,
             type: String,
             amendment_id: String,
-            billable_status: MetronomeSDK::Models::V1::Customers::Invoice::billable_status,
+            billable_status: top,
+            constituent_invoices: ::Array[MetronomeSDK::V1::Customers::Invoice::ConstituentInvoice],
             contract_custom_fields: ::Hash[Symbol, String],
             contract_id: String,
             correction_record: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord,
@@ -198,6 +213,7 @@ module MetronomeSDK
             issued_at: Time,
             net_payment_terms_days: Float,
             netsuite_sales_order_id: String,
+            payer: MetronomeSDK::V1::Customers::Invoice::Payer,
             plan_custom_fields: ::Hash[Symbol, String],
             plan_id: String,
             plan_name: String,
@@ -232,6 +248,7 @@ module MetronomeSDK
               netsuite_invoice_billing_end: Time,
               netsuite_invoice_billing_start: Time,
               netsuite_item_id: String,
+              origin: MetronomeSDK::V1::Customers::Invoice::LineItem::Origin,
               postpaid_commit: MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit,
               presentation_group_values: ::Hash[Symbol, String?],
               pricing_group_values: ::Hash[Symbol, String],
@@ -343,6 +360,12 @@ module MetronomeSDK
 
             def netsuite_item_id=: (String) -> String
 
+            attr_reader origin: MetronomeSDK::V1::Customers::Invoice::LineItem::Origin?
+
+            def origin=: (
+              MetronomeSDK::V1::Customers::Invoice::LineItem::Origin
+            ) -> MetronomeSDK::V1::Customers::Invoice::LineItem::Origin
+
             attr_reader postpaid_commit: MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit?
 
             def postpaid_commit=: (
@@ -459,6 +482,7 @@ module MetronomeSDK
               ?netsuite_invoice_billing_end: Time,
               ?netsuite_invoice_billing_start: Time,
               ?netsuite_item_id: String,
+              ?origin: MetronomeSDK::V1::Customers::Invoice::LineItem::Origin,
               ?postpaid_commit: MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit,
               ?presentation_group_values: ::Hash[Symbol, String?],
               ?pricing_group_values: ::Hash[Symbol, String],
@@ -503,6 +527,7 @@ module MetronomeSDK
               netsuite_invoice_billing_end: Time,
               netsuite_invoice_billing_start: Time,
               netsuite_item_id: String,
+              origin: MetronomeSDK::V1::Customers::Invoice::LineItem::Origin,
               postpaid_commit: MetronomeSDK::V1::Customers::Invoice::LineItem::PostpaidCommit,
               presentation_group_values: ::Hash[Symbol, String?],
               pricing_group_values: ::Hash[Symbol, String],
@@ -557,6 +582,38 @@ module MetronomeSDK
               end
             end
 
+            type origin =
+              {
+                contract_id: String,
+                customer_id: String,
+                invoice_id: String,
+                line_item_id: String
+              }
+
+            class Origin < MetronomeSDK::Internal::Type::BaseModel
+              attr_accessor contract_id: String
+
+              attr_accessor customer_id: String
+
+              attr_accessor invoice_id: String
+
+              attr_accessor line_item_id: String
+
+              def initialize: (
+                contract_id: String,
+                customer_id: String,
+                invoice_id: String,
+                line_item_id: String
+              ) -> void
+
+              def to_hash: -> {
+                contract_id: String,
+                customer_id: String,
+                invoice_id: String,
+                line_item_id: String
+              }
+            end
+
             type postpaid_commit = { id: String }
 
             class PostpaidCommit < MetronomeSDK::Internal::Type::BaseModel
@@ -738,15 +795,27 @@ module MetronomeSDK
             end
           end
 
-          type billable_status = :billable | :unbillable
+          type constituent_invoice =
+            { contract_id: String, customer_id: String, invoice_id: String }
+
+          class ConstituentInvoice < MetronomeSDK::Internal::Type::BaseModel
+            attr_accessor contract_id: String
+
+            attr_accessor customer_id: String
 
-          module BillableStatus
-            extend MetronomeSDK::Internal::Type::Enum
+            attr_accessor invoice_id: String
 
-            BILLABLE: :billable
-            UNBILLABLE: :unbillable
+            def initialize: (
+              contract_id: String,
+              customer_id: String,
+              invoice_id: String
+            ) -> void
 
-            def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::Invoice::billable_status]
+            def to_hash: -> {
+              contract_id: String,
+              customer_id: String,
+              invoice_id: String
+            }
           end
 
           type correction_record =
@@ -787,14 +856,23 @@ module MetronomeSDK
             type corrected_external_invoice =
               {
                 billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type,
+                billing_provider_error: String,
                 external_status: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::external_status,
                 invoice_id: String,
-                issued_at_timestamp: Time
+                invoiced_sub_total: Float,
+                invoiced_total: Float,
+                issued_at_timestamp: Time,
+                pdf_url: String,
+                tax: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
               }
 
             class CorrectedExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
               attr_accessor billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type
 
+              attr_reader billing_provider_error: String?
+
+              def billing_provider_error=: (String) -> String
+
               attr_reader external_status: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::external_status?
 
               def external_status=: (
@@ -805,22 +883,50 @@ module MetronomeSDK
 
               def invoice_id=: (String) -> String
 
+              attr_reader invoiced_sub_total: Float?
+
+              def invoiced_sub_total=: (Float) -> Float
+
+              attr_reader invoiced_total: Float?
+
+              def invoiced_total=: (Float) -> Float
+
               attr_reader issued_at_timestamp: Time?
 
               def issued_at_timestamp=: (Time) -> Time
 
+              attr_reader pdf_url: String?
+
+              def pdf_url=: (String) -> String
+
+              attr_reader tax: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax?
+
+              def tax=: (
+                MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
+              ) -> MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
+
               def initialize: (
                 billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type,
+                ?billing_provider_error: String,
                 ?external_status: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::external_status,
                 ?invoice_id: String,
-                ?issued_at_timestamp: Time
+                ?invoiced_sub_total: Float,
+                ?invoiced_total: Float,
+                ?issued_at_timestamp: Time,
+                ?pdf_url: String,
+                ?tax: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
               ) -> void
 
               def to_hash: -> {
                 billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type,
+                billing_provider_error: String,
                 external_status: MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::external_status,
                 invoice_id: String,
-                issued_at_timestamp: Time
+                invoiced_sub_total: Float,
+                invoiced_total: Float,
+                issued_at_timestamp: Time,
+                pdf_url: String,
+                tax: MetronomeSDK::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::Tax
               }
 
               type billing_provider_type =
@@ -832,6 +938,7 @@ module MetronomeSDK
                 | :quickbooks_online
                 | :workday
                 | :gcp_marketplace
+                | :metronome
 
               module BillingProviderType
                 extend MetronomeSDK::Internal::Type::Enum
@@ -844,6 +951,7 @@ module MetronomeSDK
                 QUICKBOOKS_ONLINE: :quickbooks_online
                 WORKDAY: :workday
                 GCP_MARKETPLACE: :gcp_marketplace
+                METRONOME: :metronome
 
                 def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::billing_provider_type]
               end
@@ -878,20 +986,62 @@ module MetronomeSDK
 
                 def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::Invoice::CorrectionRecord::CorrectedExternalInvoice::external_status]
               end
+
+              type tax =
+                {
+                  total_tax_amount: Float,
+                  total_taxable_amount: Float,
+                  transaction_id: String
+                }
+
+              class Tax < MetronomeSDK::Internal::Type::BaseModel
+                attr_reader total_tax_amount: Float?
+
+                def total_tax_amount=: (Float) -> Float
+
+                attr_reader total_taxable_amount: Float?
+
+                def total_taxable_amount=: (Float) -> Float
+
+                attr_reader transaction_id: String?
+
+                def transaction_id=: (String) -> String
+
+                def initialize: (
+                  ?total_tax_amount: Float,
+                  ?total_taxable_amount: Float,
+                  ?transaction_id: String
+                ) -> void
+
+                def to_hash: -> {
+                  total_tax_amount: Float,
+                  total_taxable_amount: Float,
+                  transaction_id: String
+                }
+              end
             end
           end
 
           type external_invoice =
             {
               billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::billing_provider_type,
+              billing_provider_error: String,
               external_status: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::external_status,
               invoice_id: String,
-              issued_at_timestamp: Time
+              invoiced_sub_total: Float,
+              invoiced_total: Float,
+              issued_at_timestamp: Time,
+              pdf_url: String,
+              tax: MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
             }
 
           class ExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
             attr_accessor billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::billing_provider_type
 
+            attr_reader billing_provider_error: String?
+
+            def billing_provider_error=: (String) -> String
+
             attr_reader external_status: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::external_status?
 
             def external_status=: (
@@ -902,22 +1052,50 @@ module MetronomeSDK
 
             def invoice_id=: (String) -> String
 
+            attr_reader invoiced_sub_total: Float?
+
+            def invoiced_sub_total=: (Float) -> Float
+
+            attr_reader invoiced_total: Float?
+
+            def invoiced_total=: (Float) -> Float
+
             attr_reader issued_at_timestamp: Time?
 
             def issued_at_timestamp=: (Time) -> Time
 
+            attr_reader pdf_url: String?
+
+            def pdf_url=: (String) -> String
+
+            attr_reader tax: MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax?
+
+            def tax=: (
+              MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
+            ) -> MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
+
             def initialize: (
               billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::billing_provider_type,
+              ?billing_provider_error: String,
               ?external_status: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::external_status,
               ?invoice_id: String,
-              ?issued_at_timestamp: Time
+              ?invoiced_sub_total: Float,
+              ?invoiced_total: Float,
+              ?issued_at_timestamp: Time,
+              ?pdf_url: String,
+              ?tax: MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
             ) -> void
 
             def to_hash: -> {
               billing_provider_type: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::billing_provider_type,
+              billing_provider_error: String,
               external_status: MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::external_status,
               invoice_id: String,
-              issued_at_timestamp: Time
+              invoiced_sub_total: Float,
+              invoiced_total: Float,
+              issued_at_timestamp: Time,
+              pdf_url: String,
+              tax: MetronomeSDK::V1::Customers::Invoice::ExternalInvoice::Tax
             }
 
             type billing_provider_type =
@@ -929,6 +1107,7 @@ module MetronomeSDK
               | :quickbooks_online
               | :workday
               | :gcp_marketplace
+              | :metronome
 
             module BillingProviderType
               extend MetronomeSDK::Internal::Type::Enum
@@ -941,6 +1120,7 @@ module MetronomeSDK
               QUICKBOOKS_ONLINE: :quickbooks_online
               WORKDAY: :workday
               GCP_MARKETPLACE: :gcp_marketplace
+              METRONOME: :metronome
 
               def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::billing_provider_type]
             end
@@ -975,6 +1155,39 @@ module MetronomeSDK
 
               def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::Invoice::ExternalInvoice::external_status]
             end
+
+            type tax =
+              {
+                total_tax_amount: Float,
+                total_taxable_amount: Float,
+                transaction_id: String
+              }
+
+            class Tax < MetronomeSDK::Internal::Type::BaseModel
+              attr_reader total_tax_amount: Float?
+
+              def total_tax_amount=: (Float) -> Float
+
+              attr_reader total_taxable_amount: Float?
+
+              def total_taxable_amount=: (Float) -> Float
+
+              attr_reader transaction_id: String?
+
+              def transaction_id=: (String) -> String
+
+              def initialize: (
+                ?total_tax_amount: Float,
+                ?total_taxable_amount: Float,
+                ?transaction_id: String
+              ) -> void
+
+              def to_hash: -> {
+                total_tax_amount: Float,
+                total_taxable_amount: Float,
+                transaction_id: String
+              }
+            end
           end
 
           type invoice_adjustment =
@@ -1020,6 +1233,18 @@ module MetronomeSDK
             }
           end
 
+          type payer = { contract_id: String, customer_id: String }
+
+          class Payer < MetronomeSDK::Internal::Type::BaseModel
+            attr_accessor contract_id: String
+
+            attr_accessor customer_id: String
+
+            def initialize: (contract_id: String, customer_id: String) -> void
+
+            def to_hash: -> { contract_id: String, customer_id: String }
+          end
+
           type reseller_royalty =
             {
               fraction: String,

data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_pdf_params.rbs

@@ -0,0 +1,32 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type invoice_retrieve_pdf_params =
+          { customer_id: String, invoice_id: String }
+          & MetronomeSDK::Internal::Type::request_parameters
+
+        class InvoiceRetrievePdfParams < 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
+end