stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/reporting/report_run.rb

@@ -3,11 +3,102 @@
 
 module Stripe
   module Reporting
+    # The Report Run object represents an instance of a report type generated with
+    # specific run parameters. Once the object is created, Stripe begins processing the report.
+    # When the report has finished running, it will give you a reference to a file
+    # where you can retrieve your results. For an overview, see
+    # [API Access to Reports](https://docs.stripe.com/reporting/statements/api).
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).
     class ReportRun < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "reporting.report_run"
+      def self.object_name
+        "reporting.report_run"
+      end
+
+      class Parameters < ::Stripe::StripeObject
+        # The set of output columns requested for inclusion in the report run.
+        attr_reader :columns
+        # Connected account ID by which to filter the report run.
+        attr_reader :connected_account
+        # Currency of objects to be included in the report run.
+        attr_reader :currency
+        # Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.
+        attr_reader :interval_end
+        # Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.
+        attr_reader :interval_start
+        # Payout ID by which to filter the report run.
+        attr_reader :payout
+        # Category of balance transactions to be included in the report run.
+        attr_reader :reporting_category
+        # Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.
+        attr_reader :timezone
+
+        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
+      # If something should go wrong during the run, a message about the failure (populated when
+      #  `status=failed`).
+      attr_reader :error
+      # Unique identifier for the object.
+      attr_reader :id
+      # `true` if the report is run on live mode data and `false` if it is run on test mode data.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Attribute for field parameters
+      attr_reader :parameters
+      # The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`.
+      attr_reader :report_type
+      # The file object representing the result of the report run (populated when
+      #  `status=succeeded`).
+      attr_reader :result
+      # Status of this report run. This will be `pending` when the run is initially created.
+      #  When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
+      #  Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.
+      attr_reader :status
+      # Timestamp at which this run successfully finished (populated when
+      #  `status=succeeded`). Measured in seconds since the Unix epoch.
+      attr_reader :succeeded_at
+
+      # Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/reporting/report_runs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Returns a list of Report Runs, with the most recent appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/reporting/report_runs",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { parameters: Parameters }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/reporting/report_type.rb

@@ -3,11 +3,58 @@
 
 module Stripe
   module Reporting
+    # The Report Type resource corresponds to a particular type of report, such as
+    # the "Activity summary" or "Itemized payouts" reports. These objects are
+    # identified by an ID belonging to a set of enumerated values. See
+    # [API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api)
+    # for those Report Type IDs, along with required and optional parameters.
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes).
     class ReportType < APIResource
-      extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "reporting.report_type"
+      def self.object_name
+        "reporting.report_type"
+      end
+
+      # Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
+      attr_reader :data_available_end
+      # Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
+      attr_reader :data_available_start
+      # List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
+      attr_reader :default_columns
+      # The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`.
+      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
+      # Human-readable name of the Report Type
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # When this Report Type was latest updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
+      attr_reader :version
+
+      # Returns a full list of Report Types.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/reporting/report_types",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/reserve/hold.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reserve
+    # ReserveHolds are used to place a temporary ReserveHold on a merchant's funds.
+    class Hold < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "reserve.hold"
+      def self.object_name
+        "reserve.hold"
+      end
+
+      class ReleaseSchedule < ::Stripe::StripeObject
+        # The time after which the ReserveHold is requested to be released.
+        attr_reader :release_after
+        # The time at which the ReserveHold is scheduled to be released, automatically set to midnight UTC of the day after `release_after`.
+        attr_reader :scheduled_release
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Amount reserved. A positive integer representing how much is reserved in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+      attr_reader :amount
+      # Amount in cents that can be released from this ReserveHold
+      attr_reader :amount_releasable
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Indicates which party created this ReserveHold.
+      attr_reader :created_by
+      # 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
+      # Unique identifier for the object.
+      attr_reader :id
+      # Whether there are any funds available to release on this ReserveHold. Note that if the ReserveHold is in the process of being released, this could be false, even though the funds haven't been fully released yet.
+      attr_reader :is_releasable
+      # 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 reason for the ReserveHold.
+      attr_reader :reason
+      # Attribute for field release_schedule
+      attr_reader :release_schedule
+      # The ReservePlan which produced this ReserveHold (i.e., resplan_123)
+      attr_reader :reserve_plan
+      # The Charge which funded this ReserveHold (e.g., ch_123)
+      attr_reader :source_charge
+      # Which source balance type this ReserveHold reserves funds from. One of `bank_account`, `card`, or `fpx`.
+      attr_reader :source_type
+
+      # Returns a list of ReserveHolds previously created. The ReserveHolds are returned in sorted order, with the most recent ReserveHolds appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/reserve/holds", params: params, opts: opts)
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { release_schedule: ReleaseSchedule }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/reserve/plan.rb

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reserve
+    # ReservePlans are used to automatically place holds on a merchant's funds until the plan expires. It takes a portion of each incoming Charge (including those resulting from a Transfer from a platform account).
+    class Plan < APIResource
+      OBJECT_NAME = "reserve.plan"
+      def self.object_name
+        "reserve.plan"
+      end
+
+      class FixedRelease < ::Stripe::StripeObject
+        # The time after which all reserved funds are requested for release.
+        attr_reader :release_after
+        # The time at which reserved funds are scheduled for release, automatically set to midnight UTC of the day after `release_after`.
+        attr_reader :scheduled_release
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RollingRelease < ::Stripe::StripeObject
+        # The number of days to reserve funds before releasing.
+        attr_reader :days_after_charge
+        # The time at which the ReservePlan expires.
+        attr_reader :expires_on
+
+        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
+      # Indicates which party created this ReservePlan.
+      attr_reader :created_by
+      # 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). An unset currency indicates that the plan applies to all currencies.
+      attr_reader :currency
+      # Time at which the ReservePlan was disabled.
+      attr_reader :disabled_at
+      # Attribute for field fixed_release
+      attr_reader :fixed_release
+      # 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 percent of each Charge to reserve.
+      attr_reader :percent
+      # Attribute for field rolling_release
+      attr_reader :rolling_release
+      # The current status of the ReservePlan. The ReservePlan only affects charges if it is `active`.
+      attr_reader :status
+      # The type of the ReservePlan.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { fixed_release: FixedRelease, rolling_release: RollingRelease }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/reserve/release.rb

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reserve
+    # ReserveReleases represent the release of funds from a ReserveHold.
+    class Release < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "reserve.release"
+      def self.object_name
+        "reserve.release"
+      end
+
+      class SourceTransaction < ::Stripe::StripeObject
+        # The ID of the dispute.
+        attr_reader :dispute
+        # The ID of the refund.
+        attr_reader :refund
+        # The type of source transaction.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Amount released. A positive integer representing how much is released in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+      attr_reader :amount
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Indicates which party created this ReserveRelease.
+      attr_reader :created_by
+      # 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
+      # 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 reason for the ReserveRelease, indicating why the funds were released.
+      attr_reader :reason
+      # The release timestamp of the funds.
+      attr_reader :released_at
+      # The ReserveHold this ReserveRelease is associated with.
+      attr_reader :reserve_hold
+      # The ReservePlan ID this ReserveRelease is associated with. This field is only populated if a ReserveRelease is created by a ReservePlan disable operation, or from a scheduled ReservedHold expiry.
+      attr_reader :reserve_plan
+      # Attribute for field source_transaction
+      attr_reader :source_transaction
+
+      # Returns a list of ReserveReleases previously created. The ReserveReleases are returned in sorted order, with the most recent ReserveReleases appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/reserve/releases",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { source_transaction: SourceTransaction }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/reserve_transaction.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ReserveTransaction < APIResource
+    OBJECT_NAME = "reserve_transaction"
+    def self.object_name
+      "reserve_transaction"
+    end
+
+    # Attribute for field amount
+    attr_reader :amount
+    # 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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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 = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end

data/lib/stripe/resources/reversal.rb

@@ -2,15 +2,51 @@
 # frozen_string_literal: true
 
 module Stripe
+  # [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a
+  # connected account, either entirely or partially, and can also specify whether
+  # to refund any related application fees. Transfer reversals add to the
+  # platform's balance and subtract from the destination account's balance.
+  #
+  # Reversing a transfer that was made for a [destination
+  # charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
+  # the charge. It is possible to reverse a
+  # [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options)
+  # transfer only if the destination account has enough balance to cover the
+  # reversal.
+  #
+  # Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers)
   class Reversal < APIResource
-    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "transfer_reversal"
+    def self.object_name
+      "transfer_reversal"
+    end
+
+    # Amount, in cents (or local equivalent).
+    attr_reader :amount
+    # Balance transaction that describes the impact on your account balance.
+    attr_reader :balance_transaction
+    # 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
+    # Linked payment refund for the transfer reversal.
+    attr_reader :destination_payment_refund
+    # Unique identifier for the object.
+    attr_reader :id
+    # 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
+    # ID of the refund responsible for the transfer reversal.
+    attr_reader :source_refund
+    # ID of the transfer that was reversed.
+    attr_reader :transfer
 
     def resource_url
       "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals" \
-      "/#{CGI.escape(id)}"
+        "/#{CGI.escape(id)}"
     end
 
     def self.update(_id, _params = nil, _opts = nil)
@@ -26,5 +62,13 @@ module Stripe
             "a reversal using `Transfer.retrieve_reversal('transfer_id', " \
             "'reversal_id'`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/review.rb

@@ -2,20 +2,117 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Reviews can be used to supplement automated fraud detection with human expertise.
+  #
+  # Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments
+  # [here](https://docs.stripe.com/radar/reviews).
   class Review < APIResource
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "review"
+    def self.object_name
+      "review"
+    end
+
+    class IpAddressLocation < ::Stripe::StripeObject
+      # The city where the payment originated.
+      attr_reader :city
+      # Two-letter ISO code representing the country where the payment originated.
+      attr_reader :country
+      # The geographic latitude where the payment originated.
+      attr_reader :latitude
+      # The geographic longitude where the payment originated.
+      attr_reader :longitude
+      # The state/county/province/region where the payment originated.
+      attr_reader :region
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Session < ::Stripe::StripeObject
+      # The browser used in this browser session (e.g., `Chrome`).
+      attr_reader :browser
+      # Information about the device used for the browser session (e.g., `Samsung SM-G930T`).
+      attr_reader :device
+      # The platform for the browser session (e.g., `Macintosh`).
+      attr_reader :platform
+      # The version for the browser session (e.g., `61.0.3163.100`).
+      attr_reader :version
 
-    custom_method :approve, http_verb: :post
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
 
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The ZIP or postal code of the card used, if applicable.
+    attr_reader :billing_zip
+    # The charge associated with this review.
+    attr_reader :charge
+    # The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
+    attr_reader :closed_reason
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    attr_reader :id
+    # The IP address where the payment originated.
+    attr_reader :ip_address
+    # Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
+    attr_reader :ip_address_location
+    # 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
+    # If `true`, the review needs action.
+    attr_reader :open
+    # The reason the review was opened. One of `rule` or `manual`.
+    attr_reader :opened_reason
+    # The PaymentIntent ID associated with this review, if one exists.
+    attr_reader :payment_intent
+    # The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`.
+    attr_reader :reason
+    # Information related to the browsing session of the user who initiated the payment.
+    attr_reader :session
+
+    # Approves a Review object, closing it and removing it from the list of reviews.
     def approve(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/approve",
+        path: format("/v1/reviews/%<review>s/approve", { review: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
+
+    # Approves a Review object, closing it and removing it from the list of reviews.
+    def self.approve(review, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/reviews/%<review>s/approve", { review: CGI.escape(review) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of Review objects that have open set to true. 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/reviews", params: params, opts: opts)
+    end
+
+    def self.inner_class_types
+      @inner_class_types = { ip_address_location: IpAddressLocation, session: Session }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end