stripe 18.3.0.pre.alpha.1 → 18.3.0

data/lib/stripe/params/v2/test_helpers/financial_address_credit_params.rb

@@ -1,34 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    module TestHelpers
-      class FinancialAddressCreditParams < ::Stripe::RequestParams
-        class Amount < ::Stripe::RequestParams
-          # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
-          attr_accessor :value
-          # 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_accessor :currency
-
-          def initialize(value: nil, currency: nil)
-            @value = value
-            @currency = currency
-          end
-        end
-        # Object containing the amount value and currency to credit.
-        attr_accessor :amount
-        # Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
-        attr_accessor :network
-        # String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
-        attr_accessor :statement_descriptor
-
-        def initialize(amount: nil, network: nil, statement_descriptor: nil)
-          @amount = amount
-          @network = network
-          @statement_descriptor = statement_descriptor
-        end
-      end
-    end
-  end
-end

data/lib/stripe/params/v2/test_helpers/financial_address_generate_microdeposits_params.rb

@@ -1,10 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    module TestHelpers
-      class FinancialAddressGenerateMicrodepositsParams < ::Stripe::RequestParams; end
-    end
-  end
-end

data/lib/stripe/params/v2/test_helpers/money_management_recipient_verifications_params.rb

@@ -1,24 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module V2
-    module TestHelpers
-      class MoneyManagementRecipientVerificationsParams < ::Stripe::RequestParams
-        # Expected match level of the RecipientVerification to be created: `match`, `close_match`, `no_match`, `unavailable`.
-        # For `close_match`, the simulated response appends "close_match" to the provided name in match_result_details.matched_name.
-        attr_accessor :match_result
-        # ID of the payout method.
-        attr_accessor :payout_method
-        # ID of the recipient account. Required if the recipient distinct from the sender. Leave empty if the recipient and sender are the same entity (i.e. for me-to-me payouts).
-        attr_accessor :recipient
-
-        def initialize(match_result: nil, payout_method: nil, recipient: nil)
-          @match_result = match_result
-          @payout_method = payout_method
-          @recipient = recipient
-        end
-      end
-    end
-  end
-end

data/lib/stripe/resources/account_notice.rb

@@ -1,94 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
-  #
-  # See the [guide to send notices](https://docs.stripe.com/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
-  class AccountNotice < APIResource
-    extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Save
-
-    OBJECT_NAME = "account_notice"
-    def self.object_name
-      "account_notice"
-    end
-
-    class Email < ::Stripe::StripeObject
-      # Content of the email in plain text. The copy must match exactly the language that Stripe Compliance has approved for use.
-      attr_reader :plain_text
-      # Email address of the recipient.
-      attr_reader :recipient
-      # Subject of the email.
-      attr_reader :subject
-
-      def self.inner_class_types
-        @inner_class_types = {}
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class LinkedObjects < ::Stripe::StripeObject
-      # Associated [Capability](https://docs.stripe.com/api/capabilities)
-      attr_reader :capability
-      # Associated [Credit Underwriting Record](https://docs.stripe.com/api/issuing/credit_underwriting_record)
-      attr_reader :issuing_credit_underwriting_record
-      # Associated [Issuing Dispute](https://docs.stripe.com/api/issuing/disputes)
-      attr_reader :issuing_dispute
-
-      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
-    # When present, the deadline for sending the notice to meet the relevant regulations.
-    attr_reader :deadline
-    # Information about the email when sent.
-    attr_reader :email
-    # Unique identifier for the object.
-    attr_reader :id
-    # Information about objects related to the notice.
-    attr_reader :linked_objects
-    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-    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
-    # String representing the object's type. Objects of the same type share the same value.
-    attr_reader :object
-    # Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://docs.stripe.com/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
-    attr_reader :reason
-    # Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
-    attr_reader :sent_at
-
-    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
-    def self.list(params = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/account_notices", params: params, opts: opts)
-    end
-
-    # Updates an AccountNotice object.
-    def self.update(account_notice, params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    def self.inner_class_types
-      @inner_class_types = { email: Email, linked_objects: LinkedObjects }
-    end
-
-    def self.field_remappings
-      @field_remappings = {}
-    end
-  end
-end

data/lib/stripe/resources/balance_transfer.rb

@@ -1,139 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # Balance transfers represent funds moving between balance types on your Stripe account.
-  # They currently support moving funds between your Stripe balance and your [Issuing](https://docs.stripe.com/issuing) balance and between your [Allocated Funds](https://docs.stripe.com/connect/funds-segregation) balance and your Stripe balance.
-  class BalanceTransfer < APIResource
-    extend Stripe::APIOperations::Create
-
-    OBJECT_NAME = "balance_transfer"
-    def self.object_name
-      "balance_transfer"
-    end
-
-    class DestinationBalance < ::Stripe::StripeObject
-      class Issuing < ::Stripe::StripeObject
-        # Identifier for the balance_transaction that increased the destination balance.
-        attr_reader :balance_transaction
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
-      class Payments < ::Stripe::StripeObject
-        # Identifier for the balance_transaction that increased the destination balance.
-        attr_reader :balance_transaction
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # Attribute for field issuing
-      attr_reader :issuing
-      # Attribute for field payments
-      attr_reader :payments
-      # Destination balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
-      attr_reader :type
-
-      def self.inner_class_types
-        @inner_class_types = { issuing: Issuing, payments: Payments }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-
-    class SourceBalance < ::Stripe::StripeObject
-      class Issuing < ::Stripe::StripeObject
-        # Identifier for the balance_transaction that decreased the source balance.
-        attr_reader :balance_transaction
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-
-      class Payments < ::Stripe::StripeObject
-        # Identifier for the balance_transaction that decreased the source balance.
-        attr_reader :balance_transaction
-        # The payments balance type that this BalanceTransfer pulled funds from. One of `card`, `fpx`, or `bank_account`.
-        attr_reader :source_type
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # Attribute for field issuing
-      attr_reader :issuing
-      # Attribute for field payments
-      attr_reader :payments
-      # Source balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
-      attr_reader :type
-
-      def self.inner_class_types
-        @inner_class_types = { issuing: Issuing, payments: Payments }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-    # A positive integer representing how much was transferred in the smallest currency unit.
-    attr_reader :amount
-    # Time at which the object was created. Measured in seconds since the Unix epoch.
-    attr_reader :created
-    # 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
-    # The balance that funds were transferred to.
-    attr_reader :destination_balance
-    # A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
-    attr_reader :hosted_regulatory_receipt_url
-    # Unique identifier for the object.
-    attr_reader :id
-    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-    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
-    # String representing the object's type. Objects of the same type share the same value.
-    attr_reader :object
-    # The balance that funds were transferred from. One of `card`, `fpx`, or `bank_account`.
-    attr_reader :source_balance
-
-    # Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
-    def self.create(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: "/v1/balance_transfers",
-        params: params,
-        opts: opts
-      )
-    end
-
-    def self.inner_class_types
-      @inner_class_types = { destination_balance: DestinationBalance, source_balance: SourceBalance }
-    end
-
-    def self.field_remappings
-      @field_remappings = {}
-    end
-  end
-end

data/lib/stripe/resources/billing/analytics/meter_usage.rb

@@ -1,33 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Billing
-    module Analytics
-      # A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
-      class MeterUsage < SingletonAPIResource
-        OBJECT_NAME = "billing.analytics.meter_usage"
-        def self.object_name
-          "billing.analytics.meter_usage"
-        end
-
-        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-        attr_reader :livemode
-        # String representing the object's type. Objects of the same type share the same value.
-        attr_reader :object
-        # The timestamp to indicate data freshness, measured in seconds since the Unix epoch.
-        attr_reader :refreshed_at
-        # Attribute for field rows
-        attr_reader :rows
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-    end
-  end
-end

data/lib/stripe/resources/billing/analytics/meter_usage_row.rb

@@ -1,40 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Billing
-    module Analytics
-      class MeterUsageRow < APIResource
-        OBJECT_NAME = "billing.analytics.meter_usage_row"
-        def self.object_name
-          "billing.analytics.meter_usage_row"
-        end
-
-        # A set of key-value pairs representing the dimensions of the meter usage.
-        attr_reader :dimensions
-        # Timestamp indicating the end of the bucket. Measured in seconds since the Unix epoch.
-        attr_reader :ends_at
-        # Unique identifier for the object.
-        attr_reader :id
-        # The unique identifier for the meter. Null if no meters were provided and usage was aggregated across all meters.
-        attr_reader :meter
-        # String representing the object's type. Objects of the same type share the same value.
-        attr_reader :object
-        # Timestamp indicating the start of the bucket. Measured in seconds since the Unix epoch.
-        attr_reader :starts_at
-        # A set of key-value pairs representing the tenants of the meter usage.
-        attr_reader :tenants
-        # The aggregated meter usage value for the specified bucket.
-        attr_reader :value
-
-        def self.inner_class_types
-          @inner_class_types = {}
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-    end
-  end
-end

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

@@ -1,183 +0,0 @@
-# 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
-      # 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
-      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
-      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

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

@@ -1,82 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Capital
-    # A financing summary object describes a connected account's financing status in real time.
-    # A financing status is either `accepted`, `delivered`, or `none`.
-    # You can read the status of your connected accounts.
-    class FinancingSummary < SingletonAPIResource
-      OBJECT_NAME = "capital.financing_summary"
-      def self.object_name
-        "capital.financing_summary"
-      end
-
-      class Details < ::Stripe::StripeObject
-        class CurrentRepaymentInterval < ::Stripe::StripeObject
-          # The time at which the minimum payment amount will be due. If not met through withholding, the Connected account's linked bank account or account balance will be debited.
-          # Given in seconds since unix epoch.
-          attr_reader :due_at
-          # The amount that has already been paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
-          attr_reader :paid_amount
-          # The amount that is yet to be paid in the current repayment interval, in minor units. For example, 100 USD is represented as 10000.
-          attr_reader :remaining_amount
-
-          def self.inner_class_types
-            @inner_class_types = {}
-          end
-
-          def self.field_remappings
-            @field_remappings = {}
-          end
-        end
-        # Amount of financing offered, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :advance_amount
-        # The time at which the funds were paid out to the connected account's Stripe balance. Given in milliseconds since unix epoch.
-        attr_reader :advance_paid_out_at
-        # Currency that the financing offer is transacted in. For example, `usd`.
-        attr_reader :currency
-        # The chronologically current repayment interval for the financing offer.
-        attr_reader :current_repayment_interval
-        # Fixed fee amount, in minor units. For example, 100 USD is represented as 10000.
-        attr_reader :fee_amount
-        # The amount the Connected account has paid toward the financing debt so far, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :paid_amount
-        # The balance remaining to be paid on the financing, in minor units. For example, 1,000 USD is represented as 100000.
-        attr_reader :remaining_amount
-        # The time at which Capital will begin withholding from payments. Given in seconds since unix epoch.
-        attr_reader :repayments_begin_at
-        # Per-transaction rate at which Stripe withholds funds to repay the financing.
-        attr_reader :withhold_rate
-
-        def self.inner_class_types
-          @inner_class_types = { current_repayment_interval: CurrentRepaymentInterval }
-        end
-
-        def self.field_remappings
-          @field_remappings = {}
-        end
-      end
-      # Additional information about the financing summary. Describes currency, advance amount,
-      # fee amount, withhold rate, remaining amount, paid amount, current repayment interval,
-      # repayment start date, and advance payout date.
-      #
-      # Only present for financing offers with the `paid_out` status.
-      attr_reader :details
-      # The unique identifier of the Financing Offer object that corresponds to the Financing Summary object.
-      attr_reader :financing_offer
-      # The object type: financing_summary
-      attr_reader :object
-      # The financing status of the connected account.
-      attr_reader :status
-
-      def self.inner_class_types
-        @inner_class_types = { details: Details }
-      end
-
-      def self.field_remappings
-        @field_remappings = {}
-      end
-    end
-  end
-end