metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Commits#list
+        class CommitListParams < 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 commit_id
+          #
+          #   @return [String, nil]
+          optional :commit_id, String
+
+          # @!attribute covering_date
+          #   Include only commits that have access schedules that "cover" the provided date
+          #
+          #   @return [Time, nil]
+          optional :covering_date, Time
+
+          # @!attribute effective_before
+          #   Include only commits that have any access before the provided date (exclusive)
+          #
+          #   @return [Time, nil]
+          optional :effective_before, Time
+
+          # @!attribute include_archived
+          #   Include archived commits and commits from archived contracts.
+          #
+          #   @return [Boolean, nil]
+          optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_balance
+          #   Include the balance in the response. Setting this flag may cause the query to be
+          #   slower.
+          #
+          #   @return [Boolean, nil]
+          optional :include_balance, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_contract_commits
+          #   Include commits on the contract level.
+          #
+          #   @return [Boolean, nil]
+          optional :include_contract_commits, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_ledgers
+          #   Include commit ledgers in the response. Setting this flag may cause the query to
+          #   be slower.
+          #
+          #   @return [Boolean, nil]
+          optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute next_page
+          #   The next page token from a previous response.
+          #
+          #   @return [String, nil]
+          optional :next_page, String
+
+          # @!attribute starting_at
+          #   Include only commits that have any access on or after the provided date
+          #
+          #   @return [Time, nil]
+          optional :starting_at, Time
+
+          # @!method initialize(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::CommitListParams} for more details.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param commit_id [String]
+          #
+          #   @param covering_date [Time] Include only commits that have access schedules that "cover" the provided date
+          #
+          #   @param effective_before [Time] Include only commits that have any access before the provided date (exclusive)
+          #
+          #   @param include_archived [Boolean] Include archived commits and commits from archived contracts.
+          #
+          #   @param include_balance [Boolean] Include the balance in the response. Setting this flag may cause the query to be
+          #   ...
+          #
+          #   @param include_contract_commits [Boolean] Include commits on the contract level.
+          #
+          #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
+          #   ...
+          #
+          #   @param next_page [String] The next page token from a previous response.
+          #
+          #   @param starting_at [Time] Include only commits that have any access on or after the provided date
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Commits#list
+        class CommitListResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<MetronomeSDK::Models::Commit>]
+          required :data, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Commit] }
+
+          # @!attribute next_page
+          #
+          #   @return [String, nil]
+          required :next_page, String, nil?: true
+
+          # @!method initialize(data:, next_page:)
+          #   @param data [Array<MetronomeSDK::Models::Commit>]
+          #   @param next_page [String, nil]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Commits#update_end_date
+        class CommitUpdateEndDateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute commit_id
+          #   ID of the commit to update. Only supports "PREPAID" commits.
+          #
+          #   @return [String]
+          required :commit_id, String
+
+          # @!attribute customer_id
+          #   ID of the customer whose commit is to be updated
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute access_ending_before
+          #   RFC 3339 timestamp indicating when access to the commit will end and it will no
+          #   longer be possible to draw it down (exclusive). If not provided, the access will
+          #   not be updated.
+          #
+          #   @return [Time, nil]
+          optional :access_ending_before, Time
+
+          # @!attribute invoices_ending_before
+          #   RFC 3339 timestamp indicating when the commit will stop being invoiced
+          #   (exclusive). If not provided, the invoice schedule will not be updated.
+          #
+          #   @return [Time, nil]
+          optional :invoices_ending_before, Time
+
+          # @!method initialize(commit_id:, customer_id:, access_ending_before: nil, invoices_ending_before: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateParams} for more
+          #   details.
+          #
+          #   @param commit_id [String] ID of the commit to update. Only supports "PREPAID" commits.
+          #
+          #   @param customer_id [String] ID of the customer whose commit is to be updated
+          #
+          #   @param access_ending_before [Time] RFC 3339 timestamp indicating when access to the commit will end and it will no
+          #   ...
+          #
+          #   @param invoices_ending_before [Time] RFC 3339 timestamp indicating when the commit will stop being invoiced (exclusiv
+          #   ...
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Commits#update_end_date
+        class CommitUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::Models::ID }
+
+          # @!method initialize(data:)
+          #   @param data [MetronomeSDK::Models::ID]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#create
+        class CreditCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute access_schedule
+          #   Schedule for distributing the credit to the customer.
+          #
+          #   @return [MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule]
+          required :access_schedule, -> { MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule }
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute priority
+          #   If multiple credits or commits are applicable, the one with the lower priority
+          #   will apply first.
+          #
+          #   @return [Float]
+          required :priority, Float
+
+          # @!attribute product_id
+          #
+          #   @return [String]
+          required :product_id, String
+
+          # @!attribute applicable_contract_ids
+          #   Which contract the credit applies to. If not provided, the credit applies to all
+          #   contracts.
+          #
+          #   @return [Array<String>, nil]
+          optional :applicable_contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute applicable_product_ids
+          #   Which products the credit applies to. If both applicable_product_ids and
+          #   applicable_product_tags are not provided, the credit applies to all products.
+          #
+          #   @return [Array<String>, nil]
+          optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute applicable_product_tags
+          #   Which tags the credit applies to. If both applicable_product_ids and
+          #   applicable_product_tags are not provided, the credit applies to all products.
+          #
+          #   @return [Array<String>, nil]
+          optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute description
+          #   Used only in UI/API. It is not exposed to end customers.
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute name
+          #   displayed on invoices
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute netsuite_sales_order_id
+          #   This field's availability is dependent on your client's configuration.
+          #
+          #   @return [String, nil]
+          optional :netsuite_sales_order_id, String
+
+          # @!attribute rate_type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType, nil]
+          optional :rate_type, enum: -> { MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType }
+
+          # @!attribute salesforce_opportunity_id
+          #   This field's availability is dependent on your client's configuration.
+          #
+          #   @return [String, nil]
+          optional :salesforce_opportunity_id, String
+
+          # @!attribute uniqueness_key
+          #   Prevents the creation of duplicates. If a request to create a commit or credit
+          #   is made with a uniqueness key that was previously used to create a commit or
+          #   credit, a new record will not be created and the request will fail with a 409
+          #   error.
+          #
+          #   @return [String, nil]
+          optional :uniqueness_key, String
+
+          # @!method initialize(access_schedule:, customer_id:, priority:, product_id:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, uniqueness_key: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::CreditCreateParams} for more details.
+          #
+          #   @param access_schedule [MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule] Schedule for distributing the credit to the customer.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
+          #   ...
+          #
+          #   @param product_id [String]
+          #
+          #   @param applicable_contract_ids [Array<String>] Which contract the credit applies to. If not provided, the credit applies to all
+          #   ...
+          #
+          #   @param applicable_product_ids [Array<String>] Which products the credit applies to. If both applicable_product_ids and applica
+          #   ...
+          #
+          #   @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
+          #   ...
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param description [String] Used only in UI/API. It is not exposed to end customers.
+          #
+          #   @param name [String] displayed on invoices
+          #
+          #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+          #
+          #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType]
+          #
+          #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
+          #
+          #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
+          #   ...
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute schedule_items
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem>]
+            required :schedule_items,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem] }
+
+            # @!attribute credit_type_id
+            #   Defaults to USD (cents) if not passed
+            #
+            #   @return [String, nil]
+            optional :credit_type_id, String
+
+            # @!method initialize(schedule_items:, credit_type_id: nil)
+            #   Schedule for distributing the credit to the customer.
+            #
+            #   @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem>]
+            #
+            #   @param credit_type_id [String] Defaults to USD (cents) if not passed
+
+            class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute amount
+              #
+              #   @return [Float]
+              required :amount, Float
+
+              # @!attribute ending_before
+              #   RFC 3339 timestamp (exclusive)
+              #
+              #   @return [Time]
+              required :ending_before, Time
+
+              # @!attribute starting_at
+              #   RFC 3339 timestamp (inclusive)
+              #
+              #   @return [Time]
+              required :starting_at, Time
+
+              # @!method initialize(amount:, ending_before:, starting_at:)
+              #   @param amount [Float]
+              #
+              #   @param ending_before [Time] RFC 3339 timestamp (exclusive)
+              #
+              #   @param starting_at [Time] RFC 3339 timestamp (inclusive)
+            end
+          end
+
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            COMMIT_RATE = :COMMIT_RATE
+            LIST_RATE = :LIST_RATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#create
+        class CreditCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::Models::ID }
+
+          # @!method initialize(data:)
+          #   @param data [MetronomeSDK::Models::ID]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#list
+        class CreditListParams < 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 covering_date
+          #   Return only credits that have access schedules that "cover" the provided date
+          #
+          #   @return [Time, nil]
+          optional :covering_date, Time
+
+          # @!attribute credit_id
+          #
+          #   @return [String, nil]
+          optional :credit_id, String
+
+          # @!attribute effective_before
+          #   Include only credits that have any access before the provided date (exclusive)
+          #
+          #   @return [Time, nil]
+          optional :effective_before, Time
+
+          # @!attribute include_archived
+          #   Include archived credits and credits from archived contracts.
+          #
+          #   @return [Boolean, nil]
+          optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_balance
+          #   Include the balance in the response. Setting this flag may cause the query to be
+          #   slower.
+          #
+          #   @return [Boolean, nil]
+          optional :include_balance, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_contract_credits
+          #   Include credits on the contract level.
+          #
+          #   @return [Boolean, nil]
+          optional :include_contract_credits, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute include_ledgers
+          #   Include credit ledgers in the response. Setting this flag may cause the query to
+          #   be slower.
+          #
+          #   @return [Boolean, nil]
+          optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute next_page
+          #   The next page token from a previous response.
+          #
+          #   @return [String, nil]
+          optional :next_page, String
+
+          # @!attribute starting_at
+          #   Include only credits that have any access on or after the provided date
+          #
+          #   @return [Time, nil]
+          optional :starting_at, Time
+
+          # @!method initialize(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::CreditListParams} for more details.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param covering_date [Time] Return only credits that have access schedules that "cover" the provided date
+          #
+          #   @param credit_id [String]
+          #
+          #   @param effective_before [Time] Include only credits that have any access before the provided date (exclusive)
+          #
+          #   @param include_archived [Boolean] Include archived credits and credits from archived contracts.
+          #
+          #   @param include_balance [Boolean] Include the balance in the response. Setting this flag may cause the query to be
+          #   ...
+          #
+          #   @param include_contract_credits [Boolean] Include credits on the contract level.
+          #
+          #   @param include_ledgers [Boolean] Include credit ledgers in the response. Setting this flag may cause the query to
+          #   ...
+          #
+          #   @param next_page [String] The next page token from a previous response.
+          #
+          #   @param starting_at [Time] Include only credits that have any access on or after the provided date
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#list
+        class CreditListResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<MetronomeSDK::Models::Credit>]
+          required :data, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Credit] }
+
+          # @!attribute next_page
+          #
+          #   @return [String, nil]
+          required :next_page, String, nil?: true
+
+          # @!method initialize(data:, next_page:)
+          #   @param data [Array<MetronomeSDK::Models::Credit>]
+          #   @param next_page [String, nil]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#update_end_date
+        class CreditUpdateEndDateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute access_ending_before
+          #   RFC 3339 timestamp indicating when access to the credit will end and it will no
+          #   longer be possible to draw it down (exclusive).
+          #
+          #   @return [Time]
+          required :access_ending_before, Time
+
+          # @!attribute credit_id
+          #   ID of the commit to update
+          #
+          #   @return [String]
+          required :credit_id, String
+
+          # @!attribute customer_id
+          #   ID of the customer whose credit is to be updated
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!method initialize(access_ending_before:, credit_id:, customer_id:, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateParams} for more
+          #   details.
+          #
+          #   @param access_ending_before [Time] RFC 3339 timestamp indicating when access to the credit will end and it will no
+          #   ...
+          #
+          #   @param credit_id [String] ID of the commit to update
+          #
+          #   @param customer_id [String] ID of the customer whose credit is to be updated
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Credits#update_end_date
+        class CreditUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::Models::ID }
+
+          # @!method initialize(data:)
+          #   @param data [MetronomeSDK::Models::ID]
+        end
+      end
+    end
+  end
+end