metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#add_charge
+        class InvoiceAddChargeParams < 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 charge_id
+          #   The Metronome ID of the charge to add to the invoice. Note that the charge must
+          #   be on a product that is not on the current plan, and the product must have only
+          #   fixed charges.
+          #
+          #   @return [String]
+          required :charge_id, String
+
+          # @!attribute customer_plan_id
+          #   The Metronome ID of the customer plan to add the charge to.
+          #
+          #   @return [String]
+          required :customer_plan_id, String
+
+          # @!attribute description
+          #
+          #   @return [String]
+          required :description, String
+
+          # @!attribute invoice_start_timestamp
+          #   The start_timestamp of the invoice to add the charge to.
+          #
+          #   @return [Time]
+          required :invoice_start_timestamp, Time
+
+          # @!attribute price
+          #   The price of the charge. This price will match the currency on the invoice, e.g.
+          #   USD cents.
+          #
+          #   @return [Float]
+          required :price, Float
+
+          # @!attribute quantity
+          #
+          #   @return [Float]
+          required :quantity, Float
+
+          # @!method initialize(customer_id:, charge_id:, customer_plan_id:, description:, invoice_start_timestamp:, price:, quantity:, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::InvoiceAddChargeParams} for more details.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param charge_id [String] The Metronome ID of the charge to add to the invoice. Note that the charge must
+          #   ...
+          #
+          #   @param customer_plan_id [String] The Metronome ID of the customer plan to add the charge to.
+          #
+          #   @param description [String]
+          #
+          #   @param invoice_start_timestamp [Time] The start_timestamp of the invoice to add the charge to.
+          #
+          #   @param price [Float] The price of the charge. This price will match the currency on the invoice, e.g.
+          #   ...
+          #
+          #   @param quantity [Float]
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#add_charge
+        class InvoiceAddChargeResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!method initialize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#list_breakdowns
+        class InvoiceListBreakdownsParams < 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 ending_before
+          #   RFC 3339 timestamp. Breakdowns will only be returned for time windows that end
+          #   on or before this time.
+          #
+          #   @return [Time]
+          required :ending_before, Time
+
+          # @!attribute starting_on
+          #   RFC 3339 timestamp. Breakdowns will only be returned for time windows that start
+          #   on or after this time.
+          #
+          #   @return [Time]
+          required :starting_on, Time
+
+          # @!attribute credit_type_id
+          #   Only return invoices for the specified credit type
+          #
+          #   @return [String, nil]
+          optional :credit_type_id, String
+
+          # @!attribute limit
+          #   Max number of results that should be returned. For daily breakdowns, the
+          #   response can return up to 35 days worth of breakdowns. For hourly breakdowns,
+          #   the response can return up to 24 hours. If there are more results, a cursor to
+          #   the next page is returned.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute next_page
+          #   Cursor that indicates where the next page of results should start.
+          #
+          #   @return [String, nil]
+          optional :next_page, String
+
+          # @!attribute skip_zero_qty_line_items
+          #   If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @return [Boolean, nil]
+          optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute sort
+          #   Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to
+          #   date_asc.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort, nil]
+          optional :sort, enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort }
+
+          # @!attribute status
+          #   Invoice status, e.g. DRAFT or FINALIZED
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute window_size
+          #   The granularity of the breakdowns to return. Defaults to day.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize, nil]
+          optional :window_size,
+                   enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize }
+
+          # @!method initialize(customer_id:, ending_before:, starting_on:, credit_type_id: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, status: nil, window_size: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams} for more
+          #   details.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param ending_before [Time] RFC 3339 timestamp. Breakdowns will only be returned for time windows that end o
+          #   ...
+          #
+          #   @param starting_on [Time] RFC 3339 timestamp. Breakdowns will only be returned for time windows that start
+          #   ...
+          #
+          #   @param credit_type_id [String] Only return invoices for the specified credit type
+          #
+          #   @param limit [Integer] Max number of results that should be returned. For daily breakdowns, the respons
+          #   ...
+          #
+          #   @param next_page [String] Cursor that indicates where the next page of results should start.
+          #
+          #   @param skip_zero_qty_line_items [Boolean] If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort] Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_a
+          #   ...
+          #
+          #   @param status [String] Invoice status, e.g. DRAFT or FINALIZED
+          #
+          #   @param window_size [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize] The granularity of the breakdowns to return. Defaults to day.
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          # Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to
+          # date_asc.
+          module Sort
+            extend MetronomeSDK::Internal::Type::Enum
+
+            DATE_ASC = :date_asc
+            DATE_DESC = :date_desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The granularity of the breakdowns to return. Defaults to day.
+          module WindowSize
+            extend MetronomeSDK::Internal::Type::Enum
+
+            HOUR = :HOUR
+            DAY = :DAY
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#list_breakdowns
+        class InvoiceListBreakdownsResponse < MetronomeSDK::Models::V1::Customers::Invoice
+          # @!attribute breakdown_end_timestamp
+          #
+          #   @return [Time]
+          required :breakdown_end_timestamp, Time
+
+          # @!attribute breakdown_start_timestamp
+          #
+          #   @return [Time]
+          required :breakdown_start_timestamp, Time
+
+          # @!method initialize(breakdown_end_timestamp:, breakdown_start_timestamp:)
+          #   @param breakdown_end_timestamp [Time]
+          #   @param breakdown_start_timestamp [Time]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#list
+        class InvoiceListParams < 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 credit_type_id
+          #   Only return invoices for the specified credit type
+          #
+          #   @return [String, nil]
+          optional :credit_type_id, String
+
+          # @!attribute ending_before
+          #   RFC 3339 timestamp (exclusive). Invoices will only be returned for billing
+          #   periods that end before this time.
+          #
+          #   @return [Time, nil]
+          optional :ending_before, Time
+
+          # @!attribute limit
+          #   Max number of results that should be returned
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!attribute next_page
+          #   Cursor that indicates where the next page of results should start.
+          #
+          #   @return [String, nil]
+          optional :next_page, String
+
+          # @!attribute skip_zero_qty_line_items
+          #   If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @return [Boolean, nil]
+          optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute sort
+          #   Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to
+          #   date_asc.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort, nil]
+          optional :sort, enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort }
+
+          # @!attribute starting_on
+          #   RFC 3339 timestamp (inclusive). Invoices will only be returned for billing
+          #   periods that start at or after this time.
+          #
+          #   @return [Time, nil]
+          optional :starting_on, Time
+
+          # @!attribute status
+          #   Invoice status, e.g. DRAFT, FINALIZED, or VOID
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(customer_id:, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::InvoiceListParams} for more details.
+          #
+          #   @param customer_id [String]
+          #
+          #   @param credit_type_id [String] Only return invoices for the specified credit type
+          #
+          #   @param ending_before [Time] RFC 3339 timestamp (exclusive). Invoices will only be returned for billing perio
+          #   ...
+          #
+          #   @param limit [Integer] Max number of results that should be returned
+          #
+          #   @param next_page [String] Cursor that indicates where the next page of results should start.
+          #
+          #   @param skip_zero_qty_line_items [Boolean] If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort] Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_a
+          #   ...
+          #
+          #   @param starting_on [Time] RFC 3339 timestamp (inclusive). Invoices will only be returned for billing perio
+          #   ...
+          #
+          #   @param status [String] Invoice status, e.g. DRAFT, FINALIZED, or VOID
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          # Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to
+          # date_asc.
+          module Sort
+            extend MetronomeSDK::Internal::Type::Enum
+
+            DATE_ASC = :date_asc
+            DATE_DESC = :date_desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Invoices#retrieve
+        class InvoiceRetrieveParams < 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 skip_zero_qty_line_items
+          #   If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @return [Boolean, nil]
+          optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(customer_id:, invoice_id:, skip_zero_qty_line_items: nil, request_options: {})
+          #   @param customer_id [String]
+          #
+          #   @param invoice_id [String]
+          #
+          #   @param skip_zero_qty_line_items [Boolean] If set, all zero quantity line items will be filtered out of the response
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::NamedSchedules#retrieve
+        class NamedScheduleRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #   ID of the customer whose named schedule is to be retrieved
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute schedule_name
+          #   The identifier for the schedule to be retrieved
+          #
+          #   @return [String]
+          required :schedule_name, String
+
+          # @!attribute covering_date
+          #   If provided, at most one schedule segment will be returned (the one that covers
+          #   this date). If not provided, all segments will be returned.
+          #
+          #   @return [Time, nil]
+          optional :covering_date, Time
+
+          # @!method initialize(customer_id:, schedule_name:, covering_date: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams} for more
+          #   details.
+          #
+          #   @param customer_id [String] ID of the customer whose named schedule is to be retrieved
+          #
+          #   @param schedule_name [String] The identifier for the schedule to be retrieved
+          #
+          #   @param covering_date [Time] If provided, at most one schedule segment will be returned (the one that covers
+          #   ...
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::NamedSchedules#retrieve
+        class NamedScheduleRetrieveResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse::Data>]
+          required :data,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse::Data] }
+
+          # @!method initialize(data:)
+          #   @param data [Array<MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse::Data>]
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!attribute value
+            #
+            #   @return [Object]
+            required :value, MetronomeSDK::Internal::Type::Unknown
+
+            # @!attribute ending_before
+            #
+            #   @return [Time, nil]
+            optional :ending_before, Time
+
+            # @!method initialize(starting_at:, value:, ending_before: nil)
+            #   @param starting_at [Time]
+            #   @param value [Object]
+            #   @param ending_before [Time]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::NamedSchedules#update
+        class NamedScheduleUpdateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #   ID of the customer whose named schedule is to be updated
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute schedule_name
+          #   The identifier for the schedule to be updated
+          #
+          #   @return [String]
+          required :schedule_name, String
+
+          # @!attribute starting_at
+          #
+          #   @return [Time]
+          required :starting_at, Time
+
+          # @!attribute value
+          #   The value to set for the named schedule. The structure of this object is
+          #   specific to the named schedule.
+          #
+          #   @return [Object]
+          required :value, MetronomeSDK::Internal::Type::Unknown
+
+          # @!attribute ending_before
+          #
+          #   @return [Time, nil]
+          optional :ending_before, Time
+
+          # @!method initialize(customer_id:, schedule_name:, starting_at:, value:, ending_before: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::Customers::NamedScheduleUpdateParams} for more
+          #   details.
+          #
+          #   @param customer_id [String] ID of the customer whose named schedule is to be updated
+          #
+          #   @param schedule_name [String] The identifier for the schedule to be updated
+          #
+          #   @param starting_at [Time]
+          #
+          #   @param value [Object] The value to set for the named schedule. The structure of this object is specifi
+          #   ...
+          #
+          #   @param ending_before [Time]
+          #
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end