metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi

@@ -39,6 +39,25 @@ module MetronomeSDK
             sig { returns(Time) }
             attr_accessor :starting_at
 
+            # Optional. Frequency to bill subscriptions with. Required for subscription type
+            # products with Flat rate.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol
+                )
+              )
+            end
+            attr_reader :billing_frequency
+
+            sig do
+              params(
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol
+              ).void
+            end
+            attr_writer :billing_frequency
+
             # A distinct rate on the rate card. You can choose to use this rate rather than
             # list rate when consuming a credit or commit.
             sig do
@@ -138,6 +157,8 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
                 starting_at: Time,
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
                 commit_rate:
                   MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash,
                 credit_type_id: String,
@@ -161,6 +182,9 @@ module MetronomeSDK
               rate_type:,
               # inclusive effective date
               starting_at:,
+              # Optional. Frequency to bill subscriptions with. Required for subscription type
+              # products with Flat rate.
+              billing_frequency: nil,
               # A distinct rate on the rate card. You can choose to use this rate rather than
               # list rate when consuming a credit or commit.
               commit_rate: nil,
@@ -204,6 +228,8 @@ module MetronomeSDK
                   rate_type:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
                   starting_at: Time,
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
                   commit_rate:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate,
                   credit_type_id: String,
@@ -271,6 +297,52 @@ module MetronomeSDK
               end
             end
 
+            # Optional. Frequency to bill subscriptions with. Required for subscription type
+            # products with Flat rate.
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTHLY =
+                T.let(
+                  :MONTHLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :QUARTERLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :ANNUAL,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              WEEKLY =
+                T.let(
+                  :WEEKLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi

@@ -118,6 +118,25 @@ module MetronomeSDK
                   )
                 end
 
+              # Subscription rates matching the billing frequency will be included in the
+              # response.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol
+                  )
+                )
+              end
+              attr_reader :billing_frequency
+
+              sig do
+                params(
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol
+                ).void
+              end
+              attr_writer :billing_frequency
+
               # List of pricing group key value pairs, rates containing the matching key / value
               # pairs will be included in the response.
               sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -155,6 +174,8 @@ module MetronomeSDK
 
               sig do
                 params(
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol,
                   partial_pricing_group_values: T::Hash[Symbol, String],
                   pricing_group_values: T::Hash[Symbol, String],
                   product_id: String,
@@ -162,6 +183,9 @@ module MetronomeSDK
                 ).returns(T.attached_class)
               end
               def self.new(
+                # Subscription rates matching the billing frequency will be included in the
+                # response.
+                billing_frequency: nil,
                 # List of pricing group key value pairs, rates containing the matching key / value
                 # pairs will be included in the response.
                 partial_pricing_group_values: nil,
@@ -179,6 +203,8 @@ module MetronomeSDK
               sig do
                 override.returns(
                   {
+                    billing_frequency:
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol,
                     partial_pricing_group_values: T::Hash[Symbol, String],
                     pricing_group_values: T::Hash[Symbol, String],
                     product_id: String,
@@ -188,6 +214,52 @@ module MetronomeSDK
               end
               def to_hash
               end
+
+              # Subscription rates matching the billing frequency will be included in the
+              # response.
+              module BillingFrequency
+                extend MetronomeSDK::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                MONTHLY =
+                  T.let(
+                    :MONTHLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                QUARTERLY =
+                  T.let(
+                    :QUARTERLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                ANNUAL =
+                  T.let(
+                    :ANNUAL,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                WEEKLY =
+                  T.let(
+                    :WEEKLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
             end
           end
         end

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi

@@ -38,6 +38,23 @@ module MetronomeSDK
             sig { returns(Time) }
             attr_accessor :starting_at
 
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :billing_frequency
+
+            sig do
+              params(
+                billing_frequency:
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::OrSymbol
+              ).void
+            end
+            attr_writer :billing_frequency
+
             # A distinct rate on the rate card. You can choose to use this rate rather than
             # list rate when consuming a credit or commit.
             sig do
@@ -78,6 +95,8 @@ module MetronomeSDK
                 product_tags: T::Array[String],
                 rate: MetronomeSDK::Rate::OrHash,
                 starting_at: Time,
+                billing_frequency:
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::OrSymbol,
                 commit_rate:
                   MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate::OrHash,
                 ending_before: Time,
@@ -92,6 +111,7 @@ module MetronomeSDK
               product_tags:,
               rate:,
               starting_at:,
+              billing_frequency: nil,
               # A distinct rate on the rate card. You can choose to use this rate rather than
               # list rate when consuming a credit or commit.
               commit_rate: nil,
@@ -110,6 +130,8 @@ module MetronomeSDK
                   product_tags: T::Array[String],
                   rate: MetronomeSDK::Rate,
                   starting_at: Time,
+                  billing_frequency:
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol,
                   commit_rate:
                     MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::CommitRate,
                   ending_before: Time,
@@ -120,6 +142,50 @@ module MetronomeSDK
             def to_hash
             end
 
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTHLY =
+                T.let(
+                  :MONTHLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :QUARTERLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :ANNUAL,
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                )
+              WEEKLY =
+                T.let(
+                  :WEEKLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateListResponse::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do

data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi

@@ -22,6 +22,23 @@ module MetronomeSDK
         sig { params(next_page: String).void }
         attr_writer :next_page
 
+        # Ledgers sort order by date, asc or desc. Defaults to asc.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::OrSymbol
+            )
+          )
+        end
+        attr_reader :sort
+
+        sig do
+          params(
+            sort: MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::OrSymbol
+          ).void
+        end
+        attr_writer :sort
+
         # A list of Metronome credit type IDs to fetch ledger entries for. If absent,
         # ledger entries for all credit types will be returned.
         sig { returns(T.nilable(T::Array[String])) }
@@ -59,6 +76,8 @@ module MetronomeSDK
         sig do
           params(
             next_page: String,
+            sort:
+              MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::OrSymbol,
             credit_type_ids: T::Array[String],
             customer_ids: T::Array[String],
             ending_before: Time,
@@ -69,6 +88,8 @@ module MetronomeSDK
         def self.new(
           # Cursor that indicates where the next page of results should start.
           next_page: nil,
+          # Ledgers sort order by date, asc or desc. Defaults to asc.
+          sort: nil,
           # A list of Metronome credit type IDs to fetch ledger entries for. If absent,
           # ledger entries for all credit types will be returned.
           credit_type_ids: nil,
@@ -91,6 +112,8 @@ module MetronomeSDK
           override.returns(
             {
               next_page: String,
+              sort:
+                MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::OrSymbol,
               credit_type_ids: T::Array[String],
               customer_ids: T::Array[String],
               ending_before: Time,
@@ -101,6 +124,41 @@ module MetronomeSDK
         end
         def to_hash
         end
+
+        # Ledgers sort order by date, asc or desc. Defaults to asc.
+        module Sort
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::V1::CreditGrantListEntriesParams::Sort
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ASC =
+            T.let(
+              :asc,
+              MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::TaggedSymbol
+            )
+          DESC =
+            T.let(
+              :desc,
+              MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::CreditGrantListEntriesParams::Sort::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerPreviewEventsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::CustomerPreviewEventsParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            T::Array[MetronomeSDK::V1::CustomerPreviewEventsParams::Event]
+          )
+        end
+        attr_accessor :events
+
+        # If set to "replace", the preview will be generated as if those were the only
+        # events for the specified customer. If set to "merge", the events will be merged
+        # with any existing events for the specified customer. Defaults to "replace".
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol
+            )
+          )
+        end
+        attr_reader :mode
+
+        sig do
+          params(
+            mode: MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol
+          ).void
+        end
+        attr_writer :mode
+
+        # If set, all zero quantity line items will be filtered out of the response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :skip_zero_qty_line_items
+
+        sig { params(skip_zero_qty_line_items: T::Boolean).void }
+        attr_writer :skip_zero_qty_line_items
+
+        sig do
+          params(
+            customer_id: String,
+            events:
+              T::Array[
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Event::OrHash
+              ],
+            mode: MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol,
+            skip_zero_qty_line_items: T::Boolean,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          customer_id:,
+          events:,
+          # If set to "replace", the preview will be generated as if those were the only
+          # events for the specified customer. If set to "merge", the events will be merged
+          # with any existing events for the specified customer. Defaults to "replace".
+          mode: nil,
+          # If set, all zero quantity line items will be filtered out of the response.
+          skip_zero_qty_line_items: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              events:
+                T::Array[MetronomeSDK::V1::CustomerPreviewEventsParams::Event],
+              mode:
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol,
+              skip_zero_qty_line_items: T::Boolean,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Event < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Event,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :event_type
+
+          # This has no effect for preview events, but may be set for consistency with Event
+          # objects. They will be processed even if they do not match the customer's ID or
+          # ingest aliases.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_id
+
+          sig { params(customer_id: String).void }
+          attr_writer :customer_id
+
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :properties
+
+          sig { params(properties: T::Hash[Symbol, T.anything]).void }
+          attr_writer :properties
+
+          # RFC 3339 formatted. If not provided, the current time will be used.
+          sig { returns(T.nilable(String)) }
+          attr_reader :timestamp
+
+          sig { params(timestamp: String).void }
+          attr_writer :timestamp
+
+          # This has no effect for preview events, but may be set for consistency with Event
+          # objects. Duplicate transaction_ids are NOT filtered out, even within the same
+          # request.
+          sig { returns(T.nilable(String)) }
+          attr_reader :transaction_id
+
+          sig { params(transaction_id: String).void }
+          attr_writer :transaction_id
+
+          sig do
+            params(
+              event_type: String,
+              customer_id: String,
+              properties: T::Hash[Symbol, T.anything],
+              timestamp: String,
+              transaction_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            event_type:,
+            # This has no effect for preview events, but may be set for consistency with Event
+            # objects. They will be processed even if they do not match the customer's ID or
+            # ingest aliases.
+            customer_id: nil,
+            properties: nil,
+            # RFC 3339 formatted. If not provided, the current time will be used.
+            timestamp: nil,
+            # This has no effect for preview events, but may be set for consistency with Event
+            # objects. Duplicate transaction_ids are NOT filtered out, even within the same
+            # request.
+            transaction_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                event_type: String,
+                customer_id: String,
+                properties: T::Hash[Symbol, T.anything],
+                timestamp: String,
+                transaction_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # If set to "replace", the preview will be generated as if those were the only
+        # events for the specified customer. If set to "merge", the events will be merged
+        # with any existing events for the specified customer. Defaults to "replace".
+        module Mode
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, MetronomeSDK::V1::CustomerPreviewEventsParams::Mode)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REPLACE =
+            T.let(
+              :replace,
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+            )
+          MERGE =
+            T.let(
+              :merge,
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerPreviewEventsResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CustomerPreviewEventsResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(MetronomeSDK::V1::Customers::Invoice) }
+        attr_reader :data
+
+        sig { params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: MetronomeSDK::V1::Customers::Invoice }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi

@@ -66,6 +66,13 @@ module MetronomeSDK
             sig { params(aws_expiration_date: Time).void }
             attr_writer :aws_expiration_date
 
+            # True if the aws_product_code is a SAAS subscription product, false otherwise.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :aws_is_subscription_product
+
+            sig { params(aws_is_subscription_product: T::Boolean).void }
+            attr_writer :aws_is_subscription_product
+
             sig { returns(T.nilable(String)) }
             attr_reader :aws_product_code
 
@@ -156,6 +163,7 @@ module MetronomeSDK
             sig do
               params(
                 aws_expiration_date: Time,
+                aws_is_subscription_product: T::Boolean,
                 aws_product_code: String,
                 aws_region:
                   MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::AwsRegion::OrSymbol,
@@ -174,6 +182,8 @@ module MetronomeSDK
               # can be retrieved from
               # [AWS's GetEntitlements API](https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html).
               aws_expiration_date: nil,
+              # True if the aws_product_code is a SAAS subscription product, false otherwise.
+              aws_is_subscription_product: nil,
               aws_product_code: nil,
               aws_region: nil,
               # Subscription term start/end date for the customer. The expected format is RFC
@@ -195,6 +205,7 @@ module MetronomeSDK
               override.returns(
                 {
                   aws_expiration_date: Time,
+                  aws_is_subscription_product: T::Boolean,
                   aws_product_code: String,
                   aws_region:
                     MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::AwsRegion::TaggedSymbol,