stripe 19.4.0 → 19.5.0.pre.alpha.2

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

@@ -14,6 +14,49 @@ module Stripe
 
       class Credit < ::Stripe::StripeObject
         class Amount < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { value: :decimal_string }
+            end
+          end
+
           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
@@ -28,18 +71,26 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
             @field_remappings = {}
           end
+
+          def self.field_encodings
+            @field_encodings = {
+              custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } },
+            }
+          end
         end
 
         class CreditsApplicationInvoiceVoided < ::Stripe::StripeObject
@@ -73,10 +124,62 @@ module Stripe
         def self.field_remappings
           @field_remappings = {}
         end
+
+        def self.field_encodings
+          @field_encodings = {
+            amount: {
+              kind: :object,
+              fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
+            },
+          }
+        end
       end
 
       class Debit < ::Stripe::StripeObject
         class Amount < ::Stripe::StripeObject
+          class CustomPricingUnit < ::Stripe::StripeObject
+            class CustomPricingUnitDetails < ::Stripe::StripeObject
+              # Time at which the object was created. Measured in seconds since the Unix epoch.
+              attr_reader :created
+              # The name of the custom pricing unit.
+              attr_reader :display_name
+              # Unique identifier for the object.
+              attr_reader :id
+              # A lookup key for the custom pricing unit.
+              attr_reader :lookup_key
+              # 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
+              # The status of the custom pricing unit.
+              attr_reader :status
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The custom pricing unit object.
+            attr_reader :custom_pricing_unit_details
+            # Unique identifier for the object.
+            attr_reader :id
+            # A positive integer representing the amount.
+            attr_reader :value
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { value: :decimal_string }
+            end
+          end
+
           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
@@ -91,18 +194,26 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # The custom pricing unit amount.
+          attr_reader :custom_pricing_unit
           # 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 }
+            @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
           end
 
           def self.field_remappings
             @field_remappings = {}
           end
+
+          def self.field_encodings
+            @field_encodings = {
+              custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } },
+            }
+          end
         end
 
         class CreditsApplied < ::Stripe::StripeObject
@@ -133,6 +244,15 @@ module Stripe
         def self.field_remappings
           @field_remappings = {}
         end
+
+        def self.field_encodings
+          @field_encodings = {
+            amount: {
+              kind: :object,
+              fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
+            },
+          }
+        end
       end
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
@@ -172,6 +292,29 @@ module Stripe
       def self.field_remappings
         @field_remappings = {}
       end
+
+      def self.field_encodings
+        @field_encodings = {
+          credit: {
+            kind: :object,
+            fields: {
+              amount: {
+                kind: :object,
+                fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
+              },
+            },
+          },
+          debit: {
+            kind: :object,
+            fields: {
+              amount: {
+                kind: :object,
+                fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
+              },
+            },
+          },
+        }
+      end
     end
   end
 end

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

@@ -17,6 +17,49 @@ module Stripe
       end
 
       class Amount < ::Stripe::StripeObject
+        class CustomPricingUnit < ::Stripe::StripeObject
+          class CustomPricingUnitDetails < ::Stripe::StripeObject
+            # Time at which the object was created. Measured in seconds since the Unix epoch.
+            attr_reader :created
+            # The name of the custom pricing unit.
+            attr_reader :display_name
+            # Unique identifier for the object.
+            attr_reader :id
+            # A lookup key for the custom pricing unit.
+            attr_reader :lookup_key
+            # 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
+            # The status of the custom pricing unit.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The custom pricing unit object.
+          attr_reader :custom_pricing_unit_details
+          # Unique identifier for the object.
+          attr_reader :id
+          # A positive integer representing the amount.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = { custom_pricing_unit_details: CustomPricingUnitDetails }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { value: :decimal_string }
+          end
+        end
+
         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
@@ -31,22 +74,43 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # The custom pricing unit amount.
+        attr_reader :custom_pricing_unit
         # 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 }
+          @inner_class_types = { custom_pricing_unit: CustomPricingUnit, monetary: Monetary }
         end
 
         def self.field_remappings
           @field_remappings = {}
         end
+
+        def self.field_encodings
+          @field_encodings = {
+            custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } },
+          }
+        end
       end
 
       class ApplicabilityConfig < ::Stripe::StripeObject
         class Scope < ::Stripe::StripeObject
+          class BillableItem < ::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
+
           class Price < ::Stripe::StripeObject
             # Unique identifier for the object.
             attr_reader :id
@@ -59,13 +123,30 @@ module Stripe
               @field_remappings = {}
             end
           end
+
+          class RateCard < ::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 billable items that credit grants can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+          attr_reader :billable_items
           # 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
+          # The rate cards that credit grants can apply to. The credit grant applies to any metered item billed under one of these rate cards. Cannot be used in combination with `price_type`, `prices`, or `billable_items`.
+          attr_reader :rate_cards
 
           def self.inner_class_types
-            @inner_class_types = { prices: Price }
+            @inner_class_types = { billable_items: BillableItem, prices: Price, rate_cards: RateCard }
           end
 
           def self.field_remappings
@@ -195,6 +276,15 @@ module Stripe
       def self.field_remappings
         @field_remappings = {}
       end
+
+      def self.field_encodings
+        @field_encodings = {
+          amount: {
+            kind: :object,
+            fields: { custom_pricing_unit: { kind: :object, fields: { value: :decimal_string } } },
+          },
+        }
+      end
     end
   end
 end

data/lib/stripe/resources/billing/feedback_options.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A resource for the feedback options model (for custom cancellation reasons)
+    class FeedbackOptions < APIResource
+      OBJECT_NAME = "billing.feedback_options"
+      def self.object_name
+        "billing.feedback_options"
+      end
+
+      class StatusTransitions < ::Stripe::StripeObject
+        # The time the feedback option 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
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_reader :description
+      # 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 feedback option's status.
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+
+      def self.inner_class_types
+        @inner_class_types = { status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -80,6 +80,8 @@ module Stripe
       attr_reader :customer_mapping
       # Attribute for field default_aggregation
       attr_reader :default_aggregation
+      # Set of keys that will be used to group meter events by.
+      attr_reader :dimension_payload_keys
       # 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.

data/lib/stripe/resources/billing/meter_event_summary.rb

@@ -15,6 +15,8 @@ module Stripe
 
       # Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
       attr_reader :aggregated_value
+      # Key-value pairs of dimension values for event summaries with grouping on dimensions.
+      attr_reader :dimensions
       # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
       attr_reader :end_time
       # Unique identifier for the object.

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -79,6 +79,8 @@ module Stripe
           class CancellationReason < ::Stripe::StripeObject
             # Whether the feature is enabled.
             attr_reader :enabled
+            # The IDs of custom feedback options configured for this cancellation reason.
+            attr_reader :feedback_options
             # Which cancellation reasons will be given as options to the customer.
             attr_reader :options
 

data/lib/stripe/resources/capability.rb

@@ -71,6 +71,35 @@ module Stripe
       end
     end
 
+    class Protections < ::Stripe::StripeObject
+      class PspMigration < ::Stripe::StripeObject
+        # Time at which the protection expires. Measured in seconds since the Unix epoch.
+        attr_reader :expires_at
+        # Time at which the protection was requested. Measured in seconds since the Unix epoch.
+        attr_reader :requested_at
+        # The status of the capability protection.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field psp_migration
+      attr_reader :psp_migration
+
+      def self.inner_class_types
+        @inner_class_types = { psp_migration: PspMigration }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class Requirements < ::Stripe::StripeObject
       class Alternative < ::Stripe::StripeObject
         # Fields that can be provided to resolve all fields in `original_fields_due`.
@@ -136,6 +165,8 @@ module Stripe
     attr_reader :id
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
+    # Attribute for field protections
+    attr_reader :protections
     # Whether the capability has been requested.
     attr_reader :requested
     # Time at which the capability was requested. Measured in seconds since the Unix epoch.
@@ -169,7 +200,11 @@ module Stripe
     end
 
     def self.inner_class_types
-      @inner_class_types = { future_requirements: FutureRequirements, requirements: Requirements }
+      @inner_class_types = {
+        future_requirements: FutureRequirements,
+        protections: Protections,
+        requirements: Requirements,
+      }
     end
 
     def self.field_remappings

data/lib/stripe/resources/capital/financing_offer.rb

@@ -0,0 +1,185 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_offer"
+      def self.object_name
+        "capital.financing_offer"
+      end
+
+      class AcceptedTerms < ::Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+        attr_reader :advance_amount
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount amount on remaining premium for the existing loan at payout time.
+        attr_reader :previous_financing_fee_discount_amount
+        # Per-transaction rate at which Stripe withholds funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class OfferedTerms < ::Stripe::StripeObject
+        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
+        attr_reader :advance_amount
+        # Describes the type of user the offer is being extended to.
+        attr_reader :campaign_type
+        # Currency that the financing offer is transacted in. For example, `usd`.
+        attr_reader :currency
+        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
+        attr_reader :fee_amount
+        # Populated when the `product_type` of the `financingoffer` is `refill`.
+        # Represents the discount rate percentage on remaining fee on the existing loan. When the `financing_offer`
+        # is paid out, the `previous_financing_fee_discount_amount` will be computed as the multiple of this rate
+        # and the remaining fee.
+        attr_reader :previous_financing_fee_discount_rate
+        # Per-transaction rate at which Stripe withholds funds to repay the financing.
+        attr_reader :withhold_rate
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # the terms accepted by the Connected account, which may differ from those
+      # offered.
+      attr_reader :accepted_terms
+      # The ID of the merchant associated with this financing object.
+      attr_reader :account
+      # The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
+      attr_reader :charged_off_at
+      # Time at which the offer was created. Given in seconds since unix epoch.
+      attr_reader :created
+      # The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the [marketing docs](https://docs.stripe.com/capital/marketing).
+      attr_reader :disclaimer_variant
+      # Time at which the offer expires. Given in seconds since unix epoch.
+      attr_reader :expires_after
+      # The type of financing being offered.
+      attr_reader :financing_type
+      # A unique identifier for the financing 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
+      # The object type: financing_offer.
+      attr_reader :object
+      # This is an object representing the terms of an offer of financing from
+      # Stripe Capital to a Connected account. This resource represents
+      # both the terms offered to the Connected account.
+      attr_reader :offered_terms
+      # Financing product identifier.
+      attr_reader :product_type
+      # The ID of the financing offer that replaced this offer.
+      attr_reader :replacement
+      # The ID of the financing offer that this offer is a replacement for.
+      attr_reader :replacement_for
+      # The current status of the offer.
+      attr_reader :status
+      # See [financing_type](https://docs.stripe.com/api/capital/connect_financing_object#financing_offer_object-financing_type).
+      attr_reader :type
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def self.mark_delivered(financing_offer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = FinancingOffer
+        def self.resource_class
+          "FinancingOffer"
+        end
+
+        # Creates a test financing offer for a connected account.
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/capital/financing_offers",
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def self.refill(financing_offer, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(financing_offer) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refills a test financing offer for a connected account.
+        def refill(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/capital/financing_offers/%<financing_offer>s/refill", { financing_offer: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { accepted_terms: AcceptedTerms, offered_terms: OfferedTerms }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end