mega-pure-kit 0.0.1

data/stripe-19.3.0/lib/stripe/resources/billing/credit_balance_summary.rb

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Indicates the billing credit balance for billing credits granted to a customer.
+    class CreditBalanceSummary < SingletonAPIResource
+      OBJECT_NAME = "billing.credit_balance_summary"
+      def self.object_name
+        "billing.credit_balance_summary"
+      end
+
+      class Balance < ::Stripe::StripeObject
+        class AvailableBalance < ::Stripe::StripeObject
+          class Monetary < ::Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class LedgerBalance < ::Stripe::StripeObject
+          class Monetary < ::Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field available_balance
+        attr_reader :available_balance
+        # Attribute for field ledger_balance
+        attr_reader :ledger_balance
+
+        def self.inner_class_types
+          @inner_class_types = { available_balance: AvailableBalance, ledger_balance: LedgerBalance }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
+      attr_reader :balances
+      # The customer the balance is for.
+      attr_reader :customer
+      # The account the balance is for.
+      attr_reader :customer_account
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      def self.inner_class_types
+        @inner_class_types = { balances: Balance }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/billing/credit_balance_transaction.rb

@@ -0,0 +1,177 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
+    class CreditBalanceTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "billing.credit_balance_transaction"
+      def self.object_name
+        "billing.credit_balance_transaction"
+      end
+
+      class Credit < ::Stripe::StripeObject
+        class Amount < ::Stripe::StripeObject
+          class Monetary < ::Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditsApplicationInvoiceVoided < ::Stripe::StripeObject
+          # The invoice to which the reinstated billing credits were originally applied.
+          attr_reader :invoice
+          # The invoice line item to which the reinstated billing credits were originally applied.
+          attr_reader :invoice_line_item
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field amount
+        attr_reader :amount
+        # Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
+        attr_reader :credits_application_invoice_voided
+        # The type of credit transaction.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amount: Amount,
+            credits_application_invoice_voided: CreditsApplicationInvoiceVoided,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Debit < ::Stripe::StripeObject
+        class Amount < ::Stripe::StripeObject
+          class Monetary < ::Stripe::StripeObject
+            # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { monetary: Monetary }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditsApplied < ::Stripe::StripeObject
+          # The invoice to which the billing credits were applied.
+          attr_reader :invoice
+          # The invoice line item to which the billing credits were applied.
+          attr_reader :invoice_line_item
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field amount
+        attr_reader :amount
+        # Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
+        attr_reader :credits_applied
+        # The type of debit transaction.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { amount: Amount, credits_applied: CreditsApplied }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Credit details for this credit balance transaction. Only present if type is `credit`.
+      attr_reader :credit
+      # The credit grant associated with this credit balance transaction.
+      attr_reader :credit_grant
+      # Debit details for this credit balance transaction. Only present if type is `debit`.
+      attr_reader :debit
+      # The effective time of this credit balance transaction.
+      attr_reader :effective_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # ID of the test clock this credit balance transaction belongs to.
+      attr_reader :test_clock
+      # The type of credit balance transaction (credit or debit).
+      attr_reader :type
+
+      # Retrieve a list of credit balance transactions.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_balance_transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { credit: Credit, debit: Debit }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/billing/credit_grant.rb

@@ -0,0 +1,200 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit grant is an API resource that documents the allocation of some billing credits to a customer.
+    #
+    # Related guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)
+    class CreditGrant < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.credit_grant"
+      def self.object_name
+        "billing.credit_grant"
+      end
+
+      class Amount < ::Stripe::StripeObject
+        class Monetary < ::Stripe::StripeObject
+          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+          attr_reader :currency
+          # A positive integer representing the amount.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The monetary amount.
+        attr_reader :monetary
+        # The type of this amount. We currently only support `monetary` billing credits.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { monetary: Monetary }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ApplicabilityConfig < ::Stripe::StripeObject
+        class Scope < ::Stripe::StripeObject
+          class Price < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`.
+          attr_reader :price_type
+          # The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`.
+          attr_reader :prices
+
+          def self.inner_class_types
+            @inner_class_types = { prices: Price }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field scope
+        attr_reader :scope
+
+        def self.inner_class_types
+          @inner_class_types = { scope: Scope }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field amount
+      attr_reader :amount
+      # Attribute for field applicability_config
+      attr_reader :applicability_config
+      # The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
+      attr_reader :category
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # ID of the customer receiving the billing credits.
+      attr_reader :customer
+      # ID of the account representing the customer receiving the billing credits
+      attr_reader :customer_account
+      # The time when the billing credits become effective-when they're eligible for use.
+      attr_reader :effective_at
+      # The time when the billing credits expire. If not present, the billing credits don't expire.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # A descriptive name shown in dashboard.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.
+      attr_reader :priority
+      # ID of the test clock this credit grant belongs to.
+      attr_reader :test_clock
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
+      attr_reader :voided_at
+
+      # Creates a credit grant.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant.
+      def expire(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant.
+      def self.expire(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of credit grants.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a credit grant.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant.
+      def void_grant(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant.
+      def self.void_grant(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { amount: Amount, applicability_config: ApplicabilityConfig }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/stripe-19.3.0/lib/stripe/resources/billing/meter.rb

@@ -0,0 +1,178 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.
+    #
+    # Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
+    class Meter < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.meter"
+      def self.object_name
+        "billing.meter"
+      end
+
+      nested_resource_class_methods :event_summary,
+                                    operations: %i[list],
+                                    resource_plural: "event_summaries"
+
+      class CustomerMapping < ::Stripe::StripeObject
+        # The key in the meter event payload to use for mapping the event to a customer.
+        attr_reader :event_payload_key
+        # The method for mapping a meter event to a customer.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class DefaultAggregation < ::Stripe::StripeObject
+        # Specifies how events are aggregated.
+        attr_reader :formula
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusTransitions < ::Stripe::StripeObject
+        # The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
+        attr_reader :deactivated_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class ValueSettings < ::Stripe::StripeObject
+        # The key in the meter event payload to use as the value for this meter.
+        attr_reader :event_payload_key
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field customer_mapping
+      attr_reader :customer_mapping
+      # Attribute for field default_aggregation
+      attr_reader :default_aggregation
+      # The meter's name.
+      attr_reader :display_name
+      # The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
+      attr_reader :event_name
+      # The time window which meter events have been pre-aggregated for, if any.
+      attr_reader :event_time_window
+      # Unique identifier for the object.
+      attr_reader :id
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The meter's status.
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # Attribute for field value_settings
+      attr_reader :value_settings
+
+      # Creates a billing meter.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts)
+      end
+
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+      def deactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+      def self.deactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of billing meters.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/billing/meters", params: params, opts: opts)
+      end
+
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+      def reactivate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+      def self.reactivate(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates a billing meter.
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          customer_mapping: CustomerMapping,
+          default_aggregation: DefaultAggregation,
+          status_transitions: StatusTransitions,
+          value_settings: ValueSettings,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end