metronome-sdk 0.1.0.pre.alpha.1

data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs

@@ -0,0 +1,155 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type credit_grant_list_response =
+        {
+          id: String,
+          balance: MetronomeSDK::Models::V1::CreditGrantListResponse::Balance,
+          custom_fields: ::Hash[Symbol, String],
+          customer_id: String,
+          deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
+          effective_at: Time,
+          expires_at: Time,
+          grant_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount,
+          name: String,
+          paid_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount,
+          pending_deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
+          priority: Float,
+          credit_grant_type: String?,
+          invoice_id: String?,
+          products: ::Array[MetronomeSDK::Models::V1::CreditGrantListResponse::Product],
+          reason: String?,
+          uniqueness_key: String?
+        }
+
+      class CreditGrantListResponse < MetronomeSDK::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor balance: MetronomeSDK::Models::V1::CreditGrantListResponse::Balance
+
+        attr_accessor custom_fields: ::Hash[Symbol, String]
+
+        attr_accessor customer_id: String
+
+        attr_accessor deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry]
+
+        attr_accessor effective_at: Time
+
+        attr_accessor expires_at: Time
+
+        attr_accessor grant_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount
+
+        attr_accessor name: String
+
+        attr_accessor paid_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount
+
+        attr_accessor pending_deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry]
+
+        attr_accessor priority: Float
+
+        attr_accessor credit_grant_type: String?
+
+        attr_accessor invoice_id: String?
+
+        attr_reader products: ::Array[MetronomeSDK::Models::V1::CreditGrantListResponse::Product]?
+
+        def products=: (
+          ::Array[MetronomeSDK::Models::V1::CreditGrantListResponse::Product]
+        ) -> ::Array[MetronomeSDK::Models::V1::CreditGrantListResponse::Product]
+
+        attr_accessor reason: String?
+
+        attr_accessor uniqueness_key: String?
+
+        def initialize: (
+          id: String,
+          balance: MetronomeSDK::Models::V1::CreditGrantListResponse::Balance,
+          custom_fields: ::Hash[Symbol, String],
+          customer_id: String,
+          deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
+          effective_at: Time,
+          expires_at: Time,
+          grant_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount,
+          name: String,
+          paid_amount: MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount,
+          pending_deductions: ::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
+          priority: Float,
+          ?credit_grant_type: String?,
+          ?invoice_id: String?,
+          ?products: ::Array[MetronomeSDK::Models::V1::CreditGrantListResponse::Product],
+          ?reason: String?,
+          ?uniqueness_key: String?
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::credit_grant_list_response
+
+        type balance =
+          {
+            effective_at: Time,
+            excluding_pending: Float,
+            including_pending: Float
+          }
+
+        class Balance < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor effective_at: Time
+
+          attr_accessor excluding_pending: Float
+
+          attr_accessor including_pending: Float
+
+          def initialize: (
+            effective_at: Time,
+            excluding_pending: Float,
+            including_pending: Float
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::CreditGrantListResponse::balance
+        end
+
+        type grant_amount =
+          { amount: Float, credit_type: MetronomeSDK::Models::CreditTypeData }
+
+        class GrantAmount < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor amount: Float
+
+          attr_accessor credit_type: MetronomeSDK::Models::CreditTypeData
+
+          def initialize: (
+            amount: Float,
+            credit_type: MetronomeSDK::Models::CreditTypeData
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::CreditGrantListResponse::grant_amount
+        end
+
+        type paid_amount =
+          { amount: Float, credit_type: MetronomeSDK::Models::CreditTypeData }
+
+        class PaidAmount < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor amount: Float
+
+          attr_accessor credit_type: MetronomeSDK::Models::CreditTypeData
+
+          def initialize: (
+            amount: Float,
+            credit_type: MetronomeSDK::Models::CreditTypeData
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::CreditGrantListResponse::paid_amount
+        end
+
+        type product = { id: String, name: String }
+
+        class Product < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor name: String
+
+          def initialize: (id: String, name: String) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::CreditGrantListResponse::product
+        end
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs

@@ -0,0 +1,37 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type credit_grant_void_params =
+        {
+          id: String,
+          release_uniqueness_key: bool,
+          void_credit_purchase_invoice: bool
+        }
+        & MetronomeSDK::Internal::Type::request_parameters
+
+      class CreditGrantVoidParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader release_uniqueness_key: bool?
+
+        def release_uniqueness_key=: (bool) -> bool
+
+        attr_reader void_credit_purchase_invoice: bool?
+
+        def void_credit_purchase_invoice=: (bool) -> bool
+
+        def initialize: (
+          id: String,
+          ?release_uniqueness_key: bool,
+          ?void_credit_purchase_invoice: bool,
+          ?request_options: MetronomeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::credit_grant_void_params
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs

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

data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs

@@ -0,0 +1,44 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type credit_ledger_entry =
+        {
+          amount: Float,
+          created_by: String,
+          credit_grant_id: String,
+          effective_at: Time,
+          reason: String,
+          running_balance: Float,
+          invoice_id: String?
+        }
+
+      class CreditLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+        attr_accessor amount: Float
+
+        attr_accessor created_by: String
+
+        attr_accessor credit_grant_id: String
+
+        attr_accessor effective_at: Time
+
+        attr_accessor reason: String
+
+        attr_accessor running_balance: Float
+
+        attr_accessor invoice_id: String?
+
+        def initialize: (
+          amount: Float,
+          created_by: String,
+          credit_grant_id: String,
+          effective_at: Time,
+          reason: String,
+          running_balance: Float,
+          ?invoice_id: String?
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::credit_ledger_entry
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs

@@ -0,0 +1,78 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type custom_field_add_key_params =
+        {
+          enforce_uniqueness: bool,
+          entity: MetronomeSDK::Models::V1::CustomFieldAddKeyParams::entity,
+          key: String
+        }
+        & MetronomeSDK::Internal::Type::request_parameters
+
+      class CustomFieldAddKeyParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        attr_accessor enforce_uniqueness: bool
+
+        attr_accessor entity: MetronomeSDK::Models::V1::CustomFieldAddKeyParams::entity
+
+        attr_accessor key: String
+
+        def initialize: (
+          enforce_uniqueness: bool,
+          entity: MetronomeSDK::Models::V1::CustomFieldAddKeyParams::entity,
+          key: String,
+          ?request_options: MetronomeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::custom_field_add_key_params
+
+        type entity =
+          :alert
+          | :billable_metric
+          | :charge
+          | :commit
+          | :contract_credit
+          | :contract_product
+          | :contract
+          | :credit_grant
+          | :customer_plan
+          | :customer
+          | :discount
+          | :invoice
+          | :plan
+          | :professional_service
+          | :product
+          | :rate_card
+          | :scheduled_charge
+          | :subscription
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ALERT: :alert
+          BILLABLE_METRIC: :billable_metric
+          CHARGE: :charge
+          COMMIT: :commit
+          CONTRACT_CREDIT: :contract_credit
+          CONTRACT_PRODUCT: :contract_product
+          CONTRACT: :contract
+          CREDIT_GRANT: :credit_grant
+          CUSTOMER_PLAN: :customer_plan
+          CUSTOMER: :customer
+          DISCOUNT: :discount
+          INVOICE: :invoice
+          PLAN: :plan
+          PROFESSIONAL_SERVICE: :professional_service
+          PRODUCT: :product
+          RATE_CARD: :rate_card
+          SCHEDULED_CHARGE: :scheduled_charge
+          SUBSCRIPTION: :subscription
+
+          def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomFieldAddKeyParams::entity]
+        end
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs

@@ -0,0 +1,78 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type custom_field_delete_values_params =
+        {
+          entity: MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::entity,
+          entity_id: String,
+          keys: ::Array[String]
+        }
+        & MetronomeSDK::Internal::Type::request_parameters
+
+      class CustomFieldDeleteValuesParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        attr_accessor entity: MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::entity
+
+        attr_accessor entity_id: String
+
+        attr_accessor keys: ::Array[String]
+
+        def initialize: (
+          entity: MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::entity,
+          entity_id: String,
+          keys: ::Array[String],
+          ?request_options: MetronomeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::custom_field_delete_values_params
+
+        type entity =
+          :alert
+          | :billable_metric
+          | :charge
+          | :commit
+          | :contract_credit
+          | :contract_product
+          | :contract
+          | :credit_grant
+          | :customer_plan
+          | :customer
+          | :discount
+          | :invoice
+          | :plan
+          | :professional_service
+          | :product
+          | :rate_card
+          | :scheduled_charge
+          | :subscription
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ALERT: :alert
+          BILLABLE_METRIC: :billable_metric
+          CHARGE: :charge
+          COMMIT: :commit
+          CONTRACT_CREDIT: :contract_credit
+          CONTRACT_PRODUCT: :contract_product
+          CONTRACT: :contract
+          CREDIT_GRANT: :credit_grant
+          CUSTOMER_PLAN: :customer_plan
+          CUSTOMER: :customer
+          DISCOUNT: :discount
+          INVOICE: :invoice
+          PLAN: :plan
+          PROFESSIONAL_SERVICE: :professional_service
+          PRODUCT: :product
+          RATE_CARD: :rate_card
+          SCHEDULED_CHARGE: :scheduled_charge
+          SUBSCRIPTION: :subscription
+
+          def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::entity]
+        end
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs

@@ -0,0 +1,80 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type custom_field_list_keys_params =
+        {
+          next_page: String,
+          entities: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity]
+        }
+        & MetronomeSDK::Internal::Type::request_parameters
+
+      class CustomFieldListKeysParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        attr_reader next_page: String?
+
+        def next_page=: (String) -> String
+
+        attr_reader entities: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity]?
+
+        def entities=: (
+          ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity]
+        ) -> ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity]
+
+        def initialize: (
+          ?next_page: String,
+          ?entities: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity],
+          ?request_options: MetronomeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::custom_field_list_keys_params
+
+        type entity =
+          :alert
+          | :billable_metric
+          | :charge
+          | :commit
+          | :contract_credit
+          | :contract_product
+          | :contract
+          | :credit_grant
+          | :customer_plan
+          | :customer
+          | :discount
+          | :invoice
+          | :plan
+          | :professional_service
+          | :product
+          | :rate_card
+          | :scheduled_charge
+          | :subscription
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ALERT: :alert
+          BILLABLE_METRIC: :billable_metric
+          CHARGE: :charge
+          COMMIT: :commit
+          CONTRACT_CREDIT: :contract_credit
+          CONTRACT_PRODUCT: :contract_product
+          CONTRACT: :contract
+          CREDIT_GRANT: :credit_grant
+          CUSTOMER_PLAN: :customer_plan
+          CUSTOMER: :customer
+          DISCOUNT: :discount
+          INVOICE: :invoice
+          PLAN: :plan
+          PROFESSIONAL_SERVICE: :professional_service
+          PRODUCT: :product
+          RATE_CARD: :rate_card
+          SCHEDULED_CHARGE: :scheduled_charge
+          SUBSCRIPTION: :subscription
+
+          def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::entity]
+        end
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs

@@ -0,0 +1,92 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type custom_field_list_keys_response =
+        {
+          data: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data],
+          next_page: String?
+        }
+
+      class CustomFieldListKeysResponse < MetronomeSDK::Internal::Type::BaseModel
+        attr_accessor data: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data]
+
+        attr_accessor next_page: String?
+
+        def initialize: (
+          data: ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data],
+          next_page: String?
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::custom_field_list_keys_response
+
+        type data =
+          {
+            enforce_uniqueness: bool,
+            entity: MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::entity,
+            key: String
+          }
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor enforce_uniqueness: bool
+
+          attr_accessor entity: MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::entity
+
+          attr_accessor key: String
+
+          def initialize: (
+            enforce_uniqueness: bool,
+            entity: MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::entity,
+            key: String
+          ) -> void
+
+          def to_hash: -> MetronomeSDK::Models::V1::CustomFieldListKeysResponse::data
+
+          type entity =
+            :alert
+            | :billable_metric
+            | :charge
+            | :commit
+            | :contract_credit
+            | :contract_product
+            | :contract
+            | :credit_grant
+            | :customer_plan
+            | :customer
+            | :discount
+            | :invoice
+            | :plan
+            | :professional_service
+            | :product
+            | :rate_card
+            | :scheduled_charge
+            | :subscription
+
+          module Entity
+            extend MetronomeSDK::Internal::Type::Enum
+
+            ALERT: :alert
+            BILLABLE_METRIC: :billable_metric
+            CHARGE: :charge
+            COMMIT: :commit
+            CONTRACT_CREDIT: :contract_credit
+            CONTRACT_PRODUCT: :contract_product
+            CONTRACT: :contract
+            CREDIT_GRANT: :credit_grant
+            CUSTOMER_PLAN: :customer_plan
+            CUSTOMER: :customer
+            DISCOUNT: :discount
+            INVOICE: :invoice
+            PLAN: :plan
+            PROFESSIONAL_SERVICE: :professional_service
+            PRODUCT: :product
+            RATE_CARD: :rate_card
+            SCHEDULED_CHARGE: :scheduled_charge
+            SUBSCRIPTION: :subscription
+
+            def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomFieldListKeysResponse::Data::entity]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs

@@ -0,0 +1,74 @@
+module MetronomeSDK
+  module Models
+    module V1
+      type custom_field_remove_key_params =
+        {
+          entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::entity,
+          key: String
+        }
+        & MetronomeSDK::Internal::Type::request_parameters
+
+      class CustomFieldRemoveKeyParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        attr_accessor entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::entity
+
+        attr_accessor key: String
+
+        def initialize: (
+          entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::entity,
+          key: String,
+          ?request_options: MetronomeSDK::request_opts
+        ) -> void
+
+        def to_hash: -> MetronomeSDK::Models::V1::custom_field_remove_key_params
+
+        type entity =
+          :alert
+          | :billable_metric
+          | :charge
+          | :commit
+          | :contract_credit
+          | :contract_product
+          | :contract
+          | :credit_grant
+          | :customer_plan
+          | :customer
+          | :discount
+          | :invoice
+          | :plan
+          | :professional_service
+          | :product
+          | :rate_card
+          | :scheduled_charge
+          | :subscription
+
+        module Entity
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ALERT: :alert
+          BILLABLE_METRIC: :billable_metric
+          CHARGE: :charge
+          COMMIT: :commit
+          CONTRACT_CREDIT: :contract_credit
+          CONTRACT_PRODUCT: :contract_product
+          CONTRACT: :contract
+          CREDIT_GRANT: :credit_grant
+          CUSTOMER_PLAN: :customer_plan
+          CUSTOMER: :customer
+          DISCOUNT: :discount
+          INVOICE: :invoice
+          PLAN: :plan
+          PROFESSIONAL_SERVICE: :professional_service
+          PRODUCT: :product
+          RATE_CARD: :rate_card
+          SCHEDULED_CHARGE: :scheduled_charge
+          SUBSCRIPTION: :subscription
+
+          def self?.values: -> ::Array[MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::entity]
+        end
+      end
+    end
+  end
+end