metronome-sdk 1.0.0 → 2.1.0

data/rbi/metronome_sdk/models/v1/setting_upsert_avalara_credentials_params.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class SettingUpsertAvalaraCredentialsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The Avalara environment to use (SANDBOX or PRODUCTION).
+        sig do
+          returns(
+            MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol
+          )
+        end
+        attr_accessor :avalara_environment
+
+        # The password for the Avalara account.
+        sig { returns(String) }
+        attr_accessor :avalara_password
+
+        # The username for the Avalara account.
+        sig { returns(String) }
+        attr_accessor :avalara_username
+
+        # The delivery method IDs of the billing provider configurations to update, can be
+        # found in the response of the `/listConfiguredBillingProviders` endpoint.
+        sig { returns(T::Array[String]) }
+        attr_accessor :delivery_method_ids
+
+        sig do
+          params(
+            avalara_environment:
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol,
+            avalara_password: String,
+            avalara_username: String,
+            delivery_method_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Avalara environment to use (SANDBOX or PRODUCTION).
+          avalara_environment:,
+          # The password for the Avalara account.
+          avalara_password:,
+          # The username for the Avalara account.
+          avalara_username:,
+          # The delivery method IDs of the billing provider configurations to update, can be
+          # found in the response of the `/listConfiguredBillingProviders` endpoint.
+          delivery_method_ids:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              avalara_environment:
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::OrSymbol,
+              avalara_password: String,
+              avalara_username: String,
+              delivery_method_ids: T::Array[String],
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The Avalara environment to use (SANDBOX or PRODUCTION).
+        module AvalaraEnvironment
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PRODUCTION =
+            T.let(
+              :PRODUCTION,
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+            )
+          SANDBOX =
+            T.let(
+              :SANDBOX,
+              MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/setting_upsert_avalara_credentials_response.rbi

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

data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_params.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The billing provider set for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol
+            )
+          end
+          attr_accessor :billing_provider
+
+          # Account-level configuration for the billing provider. The structure of this
+          # object is specific to the billing provider and delivery provider combination.
+          # See examples below.
+          sig { returns(T::Hash[Symbol, T.anything]) }
+          attr_accessor :configuration
+
+          # The method to use for delivering invoices for this configuration.
+          sig do
+            returns(
+              MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol
+            )
+          end
+          attr_accessor :delivery_method
+
+          sig do
+            params(
+              billing_provider:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol,
+              configuration: T::Hash[Symbol, T.anything],
+              delivery_method:
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The billing provider set for this configuration.
+            billing_provider:,
+            # Account-level configuration for the billing provider. The structure of this
+            # object is specific to the billing provider and delivery provider combination.
+            # See examples below.
+            configuration:,
+            # The method to use for delivering invoices for this configuration.
+            delivery_method:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                billing_provider:
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::OrSymbol,
+                configuration: T::Hash[Symbol, T.anything],
+                delivery_method:
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::OrSymbol,
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The billing provider set for this configuration.
+          module BillingProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AWS_MARKETPLACE =
+              T.let(
+                :aws_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
+            AZURE_MARKETPLACE =
+              T.let(
+                :azure_marketplace,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The method to use for delivering invoices for this configuration.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            DIRECT_TO_BILLING_PROVIDER =
+              T.let(
+                :direct_to_billing_provider,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SQS =
+              T.let(
+                :aws_sqs,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+            AWS_SNS =
+              T.let(
+                :aws_sns,
+                MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/settings/billing_provider_create_response.rbi

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

data/rbi/metronome_sdk/models/v1/settings/billing_provider_list_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Settings::BillingProviderListParams,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The cursor to the next page of results
+          sig { returns(T.nilable(String)) }
+          attr_accessor :next_page
+
+          sig do
+            params(
+              next_page: T.nilable(String),
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The cursor to the next page of results
+            next_page: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                next_page: T.nilable(String),
+                request_options: MetronomeSDK::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/settings/billing_provider_list_response.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        class BillingProviderListResponse < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data
+              ]
+            )
+          end
+          attr_accessor :data
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :next_page
+
+          sig do
+            params(
+              data:
+                T::Array[
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::OrHash
+                ],
+              next_page: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(data:, next_page: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data
+                  ],
+                next_page: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The billing provider set for this configuration.
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+              )
+            end
+            attr_accessor :billing_provider
+
+            # The method to use for delivering invoices to this customer.
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+              )
+            end
+            attr_accessor :delivery_method
+
+            # Configuration for the delivery method. The structure of this object is specific
+            # to the delivery method. Some configuration may be omitted for security reasons.
+            sig { returns(T::Hash[Symbol, T.anything]) }
+            attr_accessor :delivery_method_configuration
+
+            # ID of the delivery method to use for this customer.
+            sig { returns(String) }
+            attr_accessor :delivery_method_id
+
+            sig do
+              params(
+                billing_provider:
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::OrSymbol,
+                delivery_method:
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::OrSymbol,
+                delivery_method_configuration: T::Hash[Symbol, T.anything],
+                delivery_method_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The billing provider set for this configuration.
+              billing_provider:,
+              # The method to use for delivering invoices to this customer.
+              delivery_method:,
+              # Configuration for the delivery method. The structure of this object is specific
+              # to the delivery method. Some configuration may be omitted for security reasons.
+              delivery_method_configuration:,
+              # ID of the delivery method to use for this customer.
+              delivery_method_id:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  billing_provider:
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol,
+                  delivery_method:
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol,
+                  delivery_method_configuration: T::Hash[Symbol, T.anything],
+                  delivery_method_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The billing provider set for this configuration.
+            module BillingProvider
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              AWS_MARKETPLACE =
+                T.let(
+                  :aws_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              STRIPE =
+                T.let(
+                  :stripe,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              NETSUITE =
+                T.let(
+                  :netsuite,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              CUSTOM =
+                T.let(
+                  :custom,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              AZURE_MARKETPLACE =
+                T.let(
+                  :azure_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              QUICKBOOKS_ONLINE =
+                T.let(
+                  :quickbooks_online,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              WORKDAY =
+                T.let(
+                  :workday,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              GCP_MARKETPLACE =
+                T.let(
+                  :gcp_marketplace,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+              METRONOME =
+                T.let(
+                  :metronome,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The method to use for delivering invoices to this customer.
+            module DeliveryMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              DIRECT_TO_BILLING_PROVIDER =
+                T.let(
+                  :direct_to_billing_provider,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              AWS_SQS =
+                T.let(
+                  :aws_sqs,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              TACKLE =
+                T.let(
+                  :tackle,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+              AWS_SNS =
+                T.let(
+                  :aws_sns,
+                  MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end