metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,317 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_create_params =
+          {
+            access_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule,
+            customer_id: String,
+            priority: Float,
+            product_id: String,
+            type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::type_,
+            applicable_contract_ids: ::Array[String],
+            applicable_product_ids: ::Array[String],
+            applicable_product_tags: ::Array[String],
+            custom_fields: ::Hash[Symbol, String],
+            description: String,
+            invoice_contract_id: String,
+            invoice_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule,
+            name: String,
+            netsuite_sales_order_id: String,
+            rate_type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type,
+            salesforce_opportunity_id: String,
+            uniqueness_key: String
+          }
+          & MetronomeSDK::Internal::Type::request_parameters
+
+        class CommitCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          attr_accessor access_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule
+
+          attr_accessor customer_id: String
+
+          attr_accessor priority: Float
+
+          attr_accessor product_id: String
+
+          attr_accessor type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::type_
+
+          attr_reader applicable_contract_ids: ::Array[String]?
+
+          def applicable_contract_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader applicable_product_ids: ::Array[String]?
+
+          def applicable_product_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader applicable_product_tags: ::Array[String]?
+
+          def applicable_product_tags=: (::Array[String]) -> ::Array[String]
+
+          attr_reader custom_fields: ::Hash[Symbol, String]?
+
+          def custom_fields=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+          attr_reader description: String?
+
+          def description=: (String) -> String
+
+          attr_reader invoice_contract_id: String?
+
+          def invoice_contract_id=: (String) -> String
+
+          attr_reader invoice_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule?
+
+          def invoice_schedule=: (
+            MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule
+          ) -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader netsuite_sales_order_id: String?
+
+          def netsuite_sales_order_id=: (String) -> String
+
+          attr_reader rate_type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type?
+
+          def rate_type=: (
+            MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type
+          ) -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type
+
+          attr_reader salesforce_opportunity_id: String?
+
+          def salesforce_opportunity_id=: (String) -> String
+
+          attr_reader uniqueness_key: String?
+
+          def uniqueness_key=: (String) -> String
+
+          def initialize: (
+            access_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule,
+            customer_id: String,
+            priority: Float,
+            product_id: String,
+            type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::type_,
+            ?applicable_contract_ids: ::Array[String],
+            ?applicable_product_ids: ::Array[String],
+            ?applicable_product_tags: ::Array[String],
+            ?custom_fields: ::Hash[Symbol, String],
+            ?description: String,
+            ?invoice_contract_id: String,
+            ?invoice_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule,
+            ?name: String,
+            ?netsuite_sales_order_id: String,
+            ?rate_type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type,
+            ?salesforce_opportunity_id: String,
+            ?uniqueness_key: String,
+            ?request_options: MetronomeSDK::request_opts
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_create_params
+
+          type access_schedule =
+            {
+              schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem],
+              credit_type_id: String
+            }
+
+          class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
+            attr_accessor schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem]
+
+            attr_reader credit_type_id: String?
+
+            def credit_type_id=: (String) -> String
+
+            def initialize: (
+              schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem],
+              ?credit_type_id: String
+            ) -> void
+
+            def to_hash: -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::access_schedule
+
+            type schedule_item =
+              { amount: Float, ending_before: Time, starting_at: Time }
+
+            class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+              attr_accessor amount: Float
+
+              attr_accessor ending_before: Time
+
+              attr_accessor starting_at: Time
+
+              def initialize: (
+                amount: Float,
+                ending_before: Time,
+                starting_at: Time
+              ) -> void
+
+              def to_hash: -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::schedule_item
+            end
+          end
+
+          type type_ = :PREPAID | :POSTPAID
+
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            PREPAID: :PREPAID
+            POSTPAID: :POSTPAID
+
+            def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::type_]
+          end
+
+          type invoice_schedule =
+            {
+              credit_type_id: String,
+              recurring_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule,
+              schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
+            }
+
+          class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
+            attr_reader credit_type_id: String?
+
+            def credit_type_id=: (String) -> String
+
+            attr_reader recurring_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule?
+
+            def recurring_schedule=: (
+              MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule
+            ) -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule
+
+            attr_reader schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]?
+
+            def schedule_items=: (
+              ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
+            ) -> ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
+
+            def initialize: (
+              ?credit_type_id: String,
+              ?recurring_schedule: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule,
+              ?schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
+            ) -> void
+
+            def to_hash: -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::invoice_schedule
+
+            type recurring_schedule =
+              {
+                amount_distribution: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::amount_distribution,
+                ending_before: Time,
+                frequency: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::frequency,
+                starting_at: Time,
+                amount: Float,
+                quantity: Float,
+                unit_price: Float
+              }
+
+            class RecurringSchedule < MetronomeSDK::Internal::Type::BaseModel
+              attr_accessor amount_distribution: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::amount_distribution
+
+              attr_accessor ending_before: Time
+
+              attr_accessor frequency: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::frequency
+
+              attr_accessor starting_at: Time
+
+              attr_reader amount: Float?
+
+              def amount=: (Float) -> Float
+
+              attr_reader quantity: Float?
+
+              def quantity=: (Float) -> Float
+
+              attr_reader unit_price: Float?
+
+              def unit_price=: (Float) -> Float
+
+              def initialize: (
+                amount_distribution: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::amount_distribution,
+                ending_before: Time,
+                frequency: MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::frequency,
+                starting_at: Time,
+                ?amount: Float,
+                ?quantity: Float,
+                ?unit_price: Float
+              ) -> void
+
+              def to_hash: -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::recurring_schedule
+
+              type amount_distribution = :DIVIDED | :DIVIDED_ROUNDED | :EACH
+
+              module AmountDistribution
+                extend MetronomeSDK::Internal::Type::Enum
+
+                DIVIDED: :DIVIDED
+                DIVIDED_ROUNDED: :DIVIDED_ROUNDED
+                EACH: :EACH
+
+                def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::amount_distribution]
+              end
+
+              type frequency = :MONTHLY | :QUARTERLY | :SEMI_ANNUAL | :ANNUAL
+
+              module Frequency
+                extend MetronomeSDK::Internal::Type::Enum
+
+                MONTHLY: :MONTHLY
+                QUARTERLY: :QUARTERLY
+                SEMI_ANNUAL: :SEMI_ANNUAL
+                ANNUAL: :ANNUAL
+
+                def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::frequency]
+              end
+            end
+
+            type schedule_item =
+              {
+                timestamp: Time,
+                amount: Float,
+                quantity: Float,
+                unit_price: Float
+              }
+
+            class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+              attr_accessor timestamp: Time
+
+              attr_reader amount: Float?
+
+              def amount=: (Float) -> Float
+
+              attr_reader quantity: Float?
+
+              def quantity=: (Float) -> Float
+
+              attr_reader unit_price: Float?
+
+              def unit_price=: (Float) -> Float
+
+              def initialize: (
+                timestamp: Time,
+                ?amount: Float,
+                ?quantity: Float,
+                ?unit_price: Float
+              ) -> void
+
+              def to_hash: -> MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::schedule_item
+            end
+          end
+
+          type rate_type = :COMMIT_RATE | :LIST_RATE
+
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            COMMIT_RATE: :COMMIT_RATE
+            LIST_RATE: :LIST_RATE
+
+            def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CommitCreateParams::rate_type]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_create_response = { data: MetronomeSDK::Models::ID }
+
+        class CommitCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor data: MetronomeSDK::Models::ID
+
+          def initialize: (data: MetronomeSDK::Models::ID) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_create_response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_list_params =
+          {
+            customer_id: String,
+            commit_id: String,
+            covering_date: Time,
+            effective_before: Time,
+            include_archived: bool,
+            include_balance: bool,
+            include_contract_commits: bool,
+            include_ledgers: bool,
+            next_page: String,
+            starting_at: Time
+          }
+          & MetronomeSDK::Internal::Type::request_parameters
+
+        class CommitListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          attr_accessor customer_id: String
+
+          attr_reader commit_id: String?
+
+          def commit_id=: (String) -> String
+
+          attr_reader covering_date: Time?
+
+          def covering_date=: (Time) -> Time
+
+          attr_reader effective_before: Time?
+
+          def effective_before=: (Time) -> Time
+
+          attr_reader include_archived: bool?
+
+          def include_archived=: (bool) -> bool
+
+          attr_reader include_balance: bool?
+
+          def include_balance=: (bool) -> bool
+
+          attr_reader include_contract_commits: bool?
+
+          def include_contract_commits=: (bool) -> bool
+
+          attr_reader include_ledgers: bool?
+
+          def include_ledgers=: (bool) -> bool
+
+          attr_reader next_page: String?
+
+          def next_page=: (String) -> String
+
+          attr_reader starting_at: Time?
+
+          def starting_at=: (Time) -> Time
+
+          def initialize: (
+            customer_id: String,
+            ?commit_id: String,
+            ?covering_date: Time,
+            ?effective_before: Time,
+            ?include_archived: bool,
+            ?include_balance: bool,
+            ?include_contract_commits: bool,
+            ?include_ledgers: bool,
+            ?next_page: String,
+            ?starting_at: Time,
+            ?request_options: MetronomeSDK::request_opts
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_list_params
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_list_response =
+          { data: ::Array[MetronomeSDK::Models::Commit], next_page: String? }
+
+        class CommitListResponse < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor data: ::Array[MetronomeSDK::Models::Commit]
+
+          attr_accessor next_page: String?
+
+          def initialize: (
+            data: ::Array[MetronomeSDK::Models::Commit],
+            next_page: String?
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_list_response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_update_end_date_params =
+          {
+            commit_id: String,
+            customer_id: String,
+            access_ending_before: Time,
+            invoices_ending_before: Time
+          }
+          & MetronomeSDK::Internal::Type::request_parameters
+
+        class CommitUpdateEndDateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          attr_accessor commit_id: String
+
+          attr_accessor customer_id: String
+
+          attr_reader access_ending_before: Time?
+
+          def access_ending_before=: (Time) -> Time
+
+          attr_reader invoices_ending_before: Time?
+
+          def invoices_ending_before=: (Time) -> Time
+
+          def initialize: (
+            commit_id: String,
+            customer_id: String,
+            ?access_ending_before: Time,
+            ?invoices_ending_before: Time,
+            ?request_options: MetronomeSDK::request_opts
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_update_end_date_params
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type commit_update_end_date_response =
+          { data: MetronomeSDK::Models::ID }
+
+        class CommitUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor data: MetronomeSDK::Models::ID
+
+          def initialize: (data: MetronomeSDK::Models::ID) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::commit_update_end_date_response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type credit_create_params =
+          {
+            access_schedule: MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
+            customer_id: String,
+            priority: Float,
+            product_id: String,
+            applicable_contract_ids: ::Array[String],
+            applicable_product_ids: ::Array[String],
+            applicable_product_tags: ::Array[String],
+            custom_fields: ::Hash[Symbol, String],
+            description: String,
+            name: String,
+            netsuite_sales_order_id: String,
+            rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type,
+            salesforce_opportunity_id: String,
+            uniqueness_key: String
+          }
+          & MetronomeSDK::Internal::Type::request_parameters
+
+        class CreditCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          attr_accessor access_schedule: MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule
+
+          attr_accessor customer_id: String
+
+          attr_accessor priority: Float
+
+          attr_accessor product_id: String
+
+          attr_reader applicable_contract_ids: ::Array[String]?
+
+          def applicable_contract_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader applicable_product_ids: ::Array[String]?
+
+          def applicable_product_ids=: (::Array[String]) -> ::Array[String]
+
+          attr_reader applicable_product_tags: ::Array[String]?
+
+          def applicable_product_tags=: (::Array[String]) -> ::Array[String]
+
+          attr_reader custom_fields: ::Hash[Symbol, String]?
+
+          def custom_fields=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+          attr_reader description: String?
+
+          def description=: (String) -> String
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          attr_reader netsuite_sales_order_id: String?
+
+          def netsuite_sales_order_id=: (String) -> String
+
+          attr_reader rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type?
+
+          def rate_type=: (
+            MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type
+          ) -> MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type
+
+          attr_reader salesforce_opportunity_id: String?
+
+          def salesforce_opportunity_id=: (String) -> String
+
+          attr_reader uniqueness_key: String?
+
+          def uniqueness_key=: (String) -> String
+
+          def initialize: (
+            access_schedule: MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
+            customer_id: String,
+            priority: Float,
+            product_id: String,
+            ?applicable_contract_ids: ::Array[String],
+            ?applicable_product_ids: ::Array[String],
+            ?applicable_product_tags: ::Array[String],
+            ?custom_fields: ::Hash[Symbol, String],
+            ?description: String,
+            ?name: String,
+            ?netsuite_sales_order_id: String,
+            ?rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type,
+            ?salesforce_opportunity_id: String,
+            ?uniqueness_key: String,
+            ?request_options: MetronomeSDK::request_opts
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::credit_create_params
+
+          type access_schedule =
+            {
+              schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem],
+              credit_type_id: String
+            }
+
+          class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
+            attr_accessor schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem]
+
+            attr_reader credit_type_id: String?
+
+            def credit_type_id=: (String) -> String
+
+            def initialize: (
+              schedule_items: ::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem],
+              ?credit_type_id: String
+            ) -> void
+
+            def to_hash: -> MetronomeSDK::Models::V1::Customers::CreditCreateParams::access_schedule
+
+            type schedule_item =
+              { amount: Float, ending_before: Time, starting_at: Time }
+
+            class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+              attr_accessor amount: Float
+
+              attr_accessor ending_before: Time
+
+              attr_accessor starting_at: Time
+
+              def initialize: (
+                amount: Float,
+                ending_before: Time,
+                starting_at: Time
+              ) -> void
+
+              def to_hash: -> MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::schedule_item
+            end
+          end
+
+          type rate_type = :COMMIT_RATE | :LIST_RATE
+
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            COMMIT_RATE: :COMMIT_RATE
+            LIST_RATE: :LIST_RATE
+
+            def self?.values: -> ::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::rate_type]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        type credit_create_response = { data: MetronomeSDK::Models::ID }
+
+        class CreditCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor data: MetronomeSDK::Models::ID
+
+          def initialize: (data: MetronomeSDK::Models::ID) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::Customers::credit_create_response
+        end
+      end
+    end
+  end
+end