metronome-sdk 1.0.0 → 2.1.0

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelParams < 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_cancel_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelResponse < 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

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#list
+      class PaymentListParams < 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
+
+        # @!attribute limit
+        #   The maximum number of payments to return. Defaults to 25.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_page
+        #   The next page token from a previous response.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!attribute statuses
+        #
+        #   @return [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>, nil]
+        optional :statuses, -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::PaymentStatus] }
+
+        # @!method initialize(customer_id:, invoice_id:, limit: nil, next_page: nil, statuses: nil, request_options: {})
+        #   @param customer_id [String]
+        #
+        #   @param invoice_id [String]
+        #
+        #   @param limit [Integer] The maximum number of payments to return. Defaults to 25.
+        #
+        #   @param next_page [String] The next page token from a previous response.
+        #
+        #   @param statuses [Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>]
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module PaymentStatus
+        extend MetronomeSDK::Internal::Type::Enum
+
+        PENDING = :pending
+        REQUIRES_INTERVENTION = :requires_intervention
+        PAID = :paid
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Settings#upsert_avalara_credentials
+      class SettingUpsertAvalaraCredentialsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute avalara_environment
+        #   The Avalara environment to use (SANDBOX or PRODUCTION).
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment]
+        required :avalara_environment,
+                 enum: -> { MetronomeSDK::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment }
+
+        # @!attribute avalara_password
+        #   The password for the Avalara account.
+        #
+        #   @return [String]
+        required :avalara_password, String
+
+        # @!attribute avalara_username
+        #   The username for the Avalara account.
+        #
+        #   @return [String]
+        required :avalara_username, String
+
+        # @!attribute delivery_method_ids
+        #   The delivery method IDs of the billing provider configurations to update, can be
+        #   found in the response of the `/listConfiguredBillingProviders` endpoint.
+        #
+        #   @return [Array<String>]
+        required :delivery_method_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(avalara_environment:, avalara_password:, avalara_username:, delivery_method_ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsParams} for more
+        #   details.
+        #
+        #   @param avalara_environment [Symbol, MetronomeSDK::Models::V1::SettingUpsertAvalaraCredentialsParams::AvalaraEnvironment] The Avalara environment to use (SANDBOX or PRODUCTION).
+        #
+        #   @param avalara_password [String] The password for the Avalara account.
+        #
+        #   @param avalara_username [String] The username for the Avalara account.
+        #
+        #   @param delivery_method_ids [Array<String>] The delivery method IDs of the billing provider configurations to update, can be
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # The Avalara environment to use (SANDBOX or PRODUCTION).
+        module AvalaraEnvironment
+          extend MetronomeSDK::Internal::Type::Enum
+
+          PRODUCTION = :PRODUCTION
+          SANDBOX = :SANDBOX
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Settings#upsert_avalara_credentials
+      class SettingUpsertAvalaraCredentialsResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!method initialize
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/settings/billing_provider_create_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        # @see MetronomeSDK::Resources::V1::Settings::BillingProviders#create
+        class BillingProviderCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute billing_provider
+          #   The billing provider set for this configuration.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderCreateParams::BillingProvider]
+          required :billing_provider,
+                   enum: -> { MetronomeSDK::V1::Settings::BillingProviderCreateParams::BillingProvider }
+
+          # @!attribute configuration
+          #   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.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :configuration, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+          # @!attribute delivery_method
+          #   The method to use for delivering invoices for this configuration.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderCreateParams::DeliveryMethod]
+          required :delivery_method,
+                   enum: -> { MetronomeSDK::V1::Settings::BillingProviderCreateParams::DeliveryMethod }
+
+          # @!method initialize(billing_provider:, configuration:, delivery_method:, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Settings::BillingProviderCreateParams} for more
+          #   details.
+          #
+          #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderCreateParams::BillingProvider] The billing provider set for this configuration.
+          #
+          #   @param configuration [Hash{Symbol=>Object}] Account-level configuration for the billing provider. The structure of this obje
+          #
+          #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderCreateParams::DeliveryMethod] The method to use for delivering invoices for this configuration.
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          # The billing provider set for this configuration.
+          module BillingProvider
+            extend MetronomeSDK::Internal::Type::Enum
+
+            AWS_MARKETPLACE = :aws_marketplace
+            AZURE_MARKETPLACE = :azure_marketplace
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The method to use for delivering invoices for this configuration.
+          module DeliveryMethod
+            extend MetronomeSDK::Internal::Type::Enum
+
+            DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
+            AWS_SQS = :aws_sqs
+            AWS_SNS = :aws_sns
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/settings/billing_provider_create_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        # @see MetronomeSDK::Resources::V1::Settings::BillingProviders#create
+        class BillingProviderCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data]
+          required :data, -> { MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse::Data]
+
+          # @see MetronomeSDK::Models::V1::Settings::BillingProviderCreateResponse#data
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute delivery_method_id
+            #
+            #   @return [String]
+            required :delivery_method_id, String
+
+            # @!method initialize(delivery_method_id:)
+            #   @param delivery_method_id [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/settings/billing_provider_list_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        # @see MetronomeSDK::Resources::V1::Settings::BillingProviders#list
+        class BillingProviderListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute next_page
+          #   The cursor to the next page of results
+          #
+          #   @return [String, nil]
+          optional :next_page, String, nil?: true
+
+          # @!method initialize(next_page: nil, request_options: {})
+          #   @param next_page [String, nil] The cursor to the next page of results
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/settings/billing_provider_list_response.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Settings
+        # @see MetronomeSDK::Resources::V1::Settings::BillingProviders#list
+        class BillingProviderListResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data>]
+          required :data,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data] }
+
+          # @!attribute next_page
+          #
+          #   @return [String, nil]
+          optional :next_page, String, nil?: true
+
+          # @!method initialize(data:, next_page: nil)
+          #   @param data [Array<MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data>]
+          #   @param next_page [String, nil]
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute billing_provider
+            #   The billing provider set for this configuration.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider]
+            required :billing_provider,
+                     enum: -> { MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider }
+
+            # @!attribute delivery_method
+            #   The method to use for delivering invoices to this customer.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod]
+            required :delivery_method,
+                     enum: -> { MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod }
+
+            # @!attribute delivery_method_configuration
+            #   Configuration for the delivery method. The structure of this object is specific
+            #   to the delivery method. Some configuration may be omitted for security reasons.
+            #
+            #   @return [Hash{Symbol=>Object}]
+            required :delivery_method_configuration,
+                     MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+            # @!attribute delivery_method_id
+            #   ID of the delivery method to use for this customer.
+            #
+            #   @return [String]
+            required :delivery_method_id, String
+
+            # @!method initialize(billing_provider:, delivery_method:, delivery_method_configuration:, delivery_method_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data} for more
+            #   details.
+            #
+            #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::BillingProvider] The billing provider set for this configuration.
+            #
+            #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data::DeliveryMethod] The method to use for delivering invoices to this customer.
+            #
+            #   @param delivery_method_configuration [Hash{Symbol=>Object}] Configuration for the delivery method. The structure of this object is specific
+            #
+            #   @param delivery_method_id [String] ID of the delivery method to use for this customer.
+
+            # The billing provider set for this configuration.
+            #
+            # @see MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data#billing_provider
+            module BillingProvider
+              extend MetronomeSDK::Internal::Type::Enum
+
+              AWS_MARKETPLACE = :aws_marketplace
+              STRIPE = :stripe
+              NETSUITE = :netsuite
+              CUSTOM = :custom
+              AZURE_MARKETPLACE = :azure_marketplace
+              QUICKBOOKS_ONLINE = :quickbooks_online
+              WORKDAY = :workday
+              GCP_MARKETPLACE = :gcp_marketplace
+              METRONOME = :metronome
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The method to use for delivering invoices to this customer.
+            #
+            # @see MetronomeSDK::Models::V1::Settings::BillingProviderListResponse::Data#delivery_method
+            module DeliveryMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
+              AWS_SQS = :aws_sqs
+              TACKLE = :tackle
+              AWS_SNS = :aws_sns
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb

@@ -41,6 +41,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for commit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute invoice_contract_id
         #   ID of contract to use for invoicing
         #
@@ -85,7 +91,7 @@ module MetronomeSDK
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCommitParams} for more details.
         #
@@ -99,6 +105,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
+        #
         #   @param invoice_contract_id [String] ID of contract to use for invoicing
         #
         #   @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]

data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb

@@ -39,6 +39,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for credit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute priority
         #   If multiple commits are applicable, the one with the lower priority will apply
         #   first.
@@ -72,7 +78,7 @@ module MetronomeSDK
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
+        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCreditParams} for more details.
         #
@@ -86,6 +92,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
+        #
         #   @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         #   @param product_id [String]