metronome-sdk 0.3.0 → 2.0.0

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#list
+      class Payment < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute amount_paid
+        #
+        #   @return [Float, nil]
+        optional :amount_paid, Float
+
+        # @!attribute contract_id
+        #
+        #   @return [String, nil]
+        optional :contract_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute error_message
+        #
+        #   @return [String, nil]
+        optional :error_message, String
+
+        # @!attribute fiat_credit_type
+        #
+        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+        optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String
+
+        # @!attribute payment_gateway
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway, nil]
+        optional :payment_gateway, -> { MetronomeSDK::V1::Payment::PaymentGateway }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PaymentStatus, nil]
+        optional :status, enum: -> { MetronomeSDK::V1::PaymentStatus }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id:, amount: nil, amount_paid: nil, contract_id: nil, created_at: nil, customer_id: nil, error_message: nil, fiat_credit_type: nil, invoice_id: nil, payment_gateway: nil, status: nil, updated_at: nil)
+        #   @param id [String]
+        #   @param amount [Float]
+        #   @param amount_paid [Float]
+        #   @param contract_id [String]
+        #   @param created_at [Time]
+        #   @param customer_id [String]
+        #   @param error_message [String]
+        #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
+        #   @param invoice_id [String]
+        #   @param payment_gateway [MetronomeSDK::Models::V1::Payment::PaymentGateway]
+        #   @param status [Symbol, MetronomeSDK::Models::V1::PaymentStatus]
+        #   @param updated_at [Time]
+
+        # @see MetronomeSDK::Models::V1::Payment#payment_gateway
+        class PaymentGateway < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute stripe
+          #
+          #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          required :stripe, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+          required :type, enum: -> { MetronomeSDK::V1::Payment::PaymentGateway::Type }
+
+          # @!method initialize(stripe:, type:)
+          #   @param stripe [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe]
+          #   @param type [Symbol, MetronomeSDK::Models::V1::Payment::PaymentGateway::Type]
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#stripe
+          class Stripe < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute payment_intent_id
+            #
+            #   @return [String]
+            required :payment_intent_id, String
+
+            # @!attribute error
+            #
+            #   @return [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error, nil]
+            optional :error, -> { MetronomeSDK::V1::Payment::PaymentGateway::Stripe::Error }
+
+            # @!method initialize(payment_intent_id:, error: nil)
+            #   @param payment_intent_id [String]
+            #   @param error [MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe::Error]
+
+            # @see MetronomeSDK::Models::V1::Payment::PaymentGateway::Stripe#error
+            class Error < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute code
+              #
+              #   @return [String, nil]
+              optional :code, String
+
+              # @!attribute decline_code
+              #
+              #   @return [String, nil]
+              optional :decline_code, String
+
+              # @!attribute type
+              #
+              #   @return [String, nil]
+              optional :type, String
+
+              # @!method initialize(code: nil, decline_code: nil, type: nil)
+              #   @param code [String]
+              #   @param decline_code [String]
+              #   @param type [String]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::Payment::PaymentGateway#type
+          module Type
+            extend MetronomeSDK::Internal::Type::Enum
+
+            STRIPE = :stripe
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!method initialize(customer_id:, invoice_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param invoice_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#attempt
+      class PaymentAttemptResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment]
+        required :data, -> { MetronomeSDK::V1::Payment }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Payment]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!method initialize(customer_id:, invoice_id:, request_options: {})
+        #   @param customer_id [String]
+        #   @param invoice_id [String]
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Payments#cancel
+      class PaymentCancelResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Payment]
+        required :data, -> { MetronomeSDK::V1::Payment }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Payment]
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -10,6 +10,7 @@ module MetronomeSDK
         required :id, String
 
         # @!attribute custom_fields
+        #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @return [Hash{Symbol=>String}]
         required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -33,10 +34,7 @@ module MetronomeSDK
         # @!attribute minimums
         #
         #   @return [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil]
-        optional :minimums,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum]
-                 }
+        optional :minimums, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum] }
 
         # @!attribute overage_rates
         #
@@ -46,11 +44,17 @@ module MetronomeSDK
 
         # @!method initialize(id:, custom_fields:, name:, credit_grants: nil, description: nil, minimums: nil, overage_rates: nil)
         #   @param id [String]
-        #   @param custom_fields [Hash{Symbol=>String}]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+        #
         #   @param name [String]
+        #
         #   @param credit_grants [Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>]
+        #
         #   @param description [String]
+        #
         #   @param minimums [Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>]
+        #
         #   @param overage_rates [Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>]
 
         class CreditGrant < MetronomeSDK::Internal::Type::BaseModel

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

@@ -21,6 +21,7 @@ module MetronomeSDK
         required :credit_type, -> { MetronomeSDK::CreditTypeData }
 
         # @!attribute custom_fields
+        #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @return [Hash{Symbol=>String}]
         required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -81,7 +82,7 @@ module MetronomeSDK
         #
         #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
         #
-        #   @param custom_fields [Hash{Symbol=>String}]
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @param name [String]
         #

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

@@ -27,6 +27,7 @@ module MetronomeSDK
           required :id, String
 
           # @!attribute custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}]
           required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -56,7 +57,7 @@ module MetronomeSDK
           # @!method initialize(id:, custom_fields:, customer_plan_id:, name:, starting_on:, ending_before: nil)
           #   @param id [String]
           #
-          #   @param custom_fields [Hash{Symbol=>String}]
+          #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param customer_plan_id [String]
           #

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

@@ -21,15 +21,19 @@ module MetronomeSDK
         required :name, String
 
         # @!attribute custom_fields
+        #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @return [Hash{Symbol=>String}, nil]
         optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
 
         # @!method initialize(id:, description:, name:, custom_fields: nil)
         #   @param id [String]
+        #
         #   @param description [String]
+        #
         #   @param name [String]
-        #   @param custom_fields [Hash{Symbol=>String}]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       end
     end
   end

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

@@ -11,10 +11,7 @@ module MetronomeSDK
         # @!attribute usage
         #
         #   @return [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>, nil]
-        optional :usage,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageIngestParams::Usage]
-                 }
+        optional :usage, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageIngestParams::Usage] }
 
         # @!method initialize(usage: nil, request_options: {})
         #   @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]

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

@@ -38,9 +38,7 @@ module MetronomeSDK
         #
         #   @return [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>, nil]
         optional :billable_metrics,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric]
-                 }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric] }
 
         # @!attribute customer_ids
         #   A list of Metronome customer IDs to fetch usage for. If absent, usage for all

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

@@ -5,77 +5,60 @@ module MetronomeSDK
     module V1
       # @see MetronomeSDK::Resources::V1::Usage#list
       class UsageListResponse < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute data
+        # @!attribute billable_metric_id
         #
-        #   @return [Array<MetronomeSDK::Models::V1::UsageListResponse::Data>]
-        required :data,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::UsageListResponse::Data] }
+        #   @return [String]
+        required :billable_metric_id, String
 
-        # @!attribute next_page
+        # @!attribute billable_metric_name
         #
-        #   @return [String, nil]
-        required :next_page, String, nil?: true
+        #   @return [String]
+        required :billable_metric_name, String
 
-        # @!method initialize(data:, next_page:)
-        #   @param data [Array<MetronomeSDK::Models::V1::UsageListResponse::Data>]
-        #   @param next_page [String, nil]
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute billable_metric_id
-          #
-          #   @return [String]
-          required :billable_metric_id, String
-
-          # @!attribute billable_metric_name
-          #
-          #   @return [String]
-          required :billable_metric_name, String
-
-          # @!attribute customer_id
-          #
-          #   @return [String]
-          required :customer_id, String
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
 
-          # @!attribute end_timestamp
-          #
-          #   @return [Time]
-          required :end_timestamp, Time
+        # @!attribute end_timestamp
+        #
+        #   @return [Time]
+        required :end_timestamp, Time
 
-          # @!attribute start_timestamp
-          #
-          #   @return [Time]
-          required :start_timestamp, Time
+        # @!attribute start_timestamp
+        #
+        #   @return [Time]
+        required :start_timestamp, Time
 
-          # @!attribute value
-          #
-          #   @return [Float, nil]
-          required :value, Float, nil?: true
+        # @!attribute value
+        #
+        #   @return [Float, nil]
+        required :value, Float, nil?: true
 
-          # @!attribute groups
-          #   Values will be either a number or null. Null indicates that there were no
-          #   matches for the group_by value.
-          #
-          #   @return [Hash{Symbol=>Float, nil}, nil]
-          optional :groups, MetronomeSDK::Internal::Type::HashOf[Float, nil?: true]
+        # @!attribute groups
+        #   Values will be either a number or null. Null indicates that there were no
+        #   matches for the group_by value.
+        #
+        #   @return [Hash{Symbol=>Float, nil}, nil]
+        optional :groups, MetronomeSDK::Internal::Type::HashOf[Float, nil?: true]
 
-          # @!method initialize(billable_metric_id:, billable_metric_name:, customer_id:, end_timestamp:, start_timestamp:, value:, groups: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::Models::V1::UsageListResponse::Data} for more details.
-          #
-          #   @param billable_metric_id [String]
-          #
-          #   @param billable_metric_name [String]
-          #
-          #   @param customer_id [String]
-          #
-          #   @param end_timestamp [Time]
-          #
-          #   @param start_timestamp [Time]
-          #
-          #   @param value [Float, nil]
-          #
-          #   @param groups [Hash{Symbol=>Float, nil}] Values will be either a number or null. Null indicates that there were no matche
-        end
+        # @!method initialize(billable_metric_id:, billable_metric_name:, customer_id:, end_timestamp:, start_timestamp:, value:, groups: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::UsageListResponse} for more details.
+        #
+        #   @param billable_metric_id [String]
+        #
+        #   @param billable_metric_name [String]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param end_timestamp [Time]
+        #
+        #   @param start_timestamp [Time]
+        #
+        #   @param value [Float, nil]
+        #
+        #   @param groups [Hash{Symbol=>Float, nil}] Values will be either a number or null. Null indicates that there were no matche
       end
     end
   end

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

@@ -124,6 +124,7 @@ module MetronomeSDK
           optional :archived_at, Time
 
           # @!attribute custom_fields
+          #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @return [Hash{Symbol=>String}, nil]
           optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -151,8 +152,7 @@ module MetronomeSDK
           #   represents a set of properties used to slice events into distinct buckets.
           #
           #   @return [Array<Array<String>>, nil]
-          optional :group_keys,
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+          optional :group_keys, MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
 
           # @!attribute property_filters
           #   A list of filters to match events to this billable metric. Each filter defines a
@@ -160,10 +160,7 @@ module MetronomeSDK
           #   billable metric.
           #
           #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
-          optional :property_filters,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter]
-                   }
+          optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }
 
           # @!attribute sql
           #   The SQL query associated with the billable metric
@@ -190,7 +187,7 @@ module MetronomeSDK
           #
           #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
           #
-          #   @param custom_fields [Hash{Symbol=>String}]
+          #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
           #