stripe 13.3.0 → 13.4.0.pre.beta.2

data/lib/stripe/services/payment_record_service.rb

@@ -0,0 +1,542 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordService < StripeService
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class ReportPaymentAttemptParams < Stripe::RequestParams
+      class Failed < Stripe::RequestParams
+        # When the reported payment failed. Measured in seconds since the Unix epoch.
+        attr_accessor :failed_at
+
+        def initialize(failed_at: nil)
+          @failed_at = failed_at
+        end
+      end
+
+      class Guaranteed < Stripe::RequestParams
+        # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+        attr_accessor :guaranteed_at
+
+        def initialize(guaranteed_at: nil)
+          @guaranteed_at = guaranteed_at
+        end
+      end
+
+      class PaymentMethodDetails < Stripe::RequestParams
+        class BillingDetails < Stripe::RequestParams
+          class Address < Stripe::RequestParams
+            # City, district, suburb, town, or village.
+            attr_accessor :city
+            # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+            attr_accessor :country
+            # Address line 1 (e.g., street, PO Box, or company name).
+            attr_accessor :line1
+            # Address line 2 (e.g., apartment, suite, unit, or building).
+            attr_accessor :line2
+            # ZIP or postal code.
+            attr_accessor :postal_code
+            # State, county, province, or region.
+            attr_accessor :state
+
+            def initialize(
+              city: nil,
+              country: nil,
+              line1: nil,
+              line2: nil,
+              postal_code: nil,
+              state: nil
+            )
+              @city = city
+              @country = country
+              @line1 = line1
+              @line2 = line2
+              @postal_code = postal_code
+              @state = state
+            end
+          end
+          # The billing address associated with the method of payment.
+          attr_accessor :address
+          # The billing email associated with the method of payment.
+          attr_accessor :email
+          # The billing name associated with the method of payment.
+          attr_accessor :name
+          # The billing phone number associated with the method of payment.
+          attr_accessor :phone
+
+          def initialize(address: nil, email: nil, name: nil, phone: nil)
+            @address = address
+            @email = email
+            @name = name
+            @phone = phone
+          end
+        end
+
+        class Custom < Stripe::RequestParams
+          # Display name for the custom (user-defined) payment method type used to make this payment.
+          attr_accessor :display_name
+          # The custom payment method type associated with this payment.
+          attr_accessor :type
+
+          def initialize(display_name: nil, type: nil)
+            @display_name = display_name
+            @type = type
+          end
+        end
+        # The billing details associated with the method of payment.
+        attr_accessor :billing_details
+        # Information about the custom (user-defined) payment method used to make this payment.
+        attr_accessor :custom
+        # ID of the Stripe Payment Method used to make this payment.
+        attr_accessor :payment_method
+        # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+        attr_accessor :type
+
+        def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+          @billing_details = billing_details
+          @custom = custom
+          @payment_method = payment_method
+          @type = type
+        end
+      end
+
+      class ShippingDetails < Stripe::RequestParams
+        class Address < Stripe::RequestParams
+          # City, district, suburb, town, or village.
+          attr_accessor :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_accessor :country
+          # Address line 1 (e.g., street, PO Box, or company name).
+          attr_accessor :line1
+          # Address line 2 (e.g., apartment, suite, unit, or building).
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The physical shipping address.
+        attr_accessor :address
+        # The shipping recipient's name.
+        attr_accessor :name
+        # The shipping recipient's phone number.
+        attr_accessor :phone
+
+        def initialize(address: nil, name: nil, phone: nil)
+          @address = address
+          @name = name
+          @phone = phone
+        end
+      end
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Information about the payment attempt failure.
+      attr_accessor :failed
+      # Information about the payment attempt guarantee.
+      attr_accessor :guaranteed
+      # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+      attr_accessor :initiated_at
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # The outcome of the reported payment.
+      attr_accessor :outcome
+      # Information about the Payment Method debited for this payment.
+      attr_accessor :payment_method_details
+      # Shipping information for this payment.
+      attr_accessor :shipping_details
+
+      def initialize(
+        description: nil,
+        expand: nil,
+        failed: nil,
+        guaranteed: nil,
+        initiated_at: nil,
+        metadata: nil,
+        outcome: nil,
+        payment_method_details: nil,
+        shipping_details: nil
+      )
+        @description = description
+        @expand = expand
+        @failed = failed
+        @guaranteed = guaranteed
+        @initiated_at = initiated_at
+        @metadata = metadata
+        @outcome = outcome
+        @payment_method_details = payment_method_details
+        @shipping_details = shipping_details
+      end
+    end
+
+    class ReportPaymentAttemptCanceledParams < Stripe::RequestParams
+      # When the reported payment was canceled. Measured in seconds since the Unix epoch.
+      attr_accessor :canceled_at
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Attribute for param field metadata
+      attr_accessor :metadata
+
+      def initialize(canceled_at: nil, expand: nil, metadata: nil)
+        @canceled_at = canceled_at
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+
+    class ReportPaymentAttemptFailedParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # When the reported payment failed. Measured in seconds since the Unix epoch.
+      attr_accessor :failed_at
+      # Attribute for param field metadata
+      attr_accessor :metadata
+
+      def initialize(expand: nil, failed_at: nil, metadata: nil)
+        @expand = expand
+        @failed_at = failed_at
+        @metadata = metadata
+      end
+    end
+
+    class ReportPaymentAttemptGuaranteedParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+      attr_accessor :guaranteed_at
+      # Attribute for param field metadata
+      attr_accessor :metadata
+
+      def initialize(expand: nil, guaranteed_at: nil, metadata: nil)
+        @expand = expand
+        @guaranteed_at = guaranteed_at
+        @metadata = metadata
+      end
+    end
+
+    class ReportPaymentParams < Stripe::RequestParams
+      class AmountRequested < Stripe::RequestParams
+        # 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
+        # A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+        attr_accessor :value
+
+        def initialize(currency: nil, value: nil)
+          @currency = currency
+          @value = value
+        end
+      end
+
+      class CustomerDetails < Stripe::RequestParams
+        # The customer who made the payment.
+        attr_accessor :customer
+        # The customer's phone number.
+        attr_accessor :email
+        # The customer's name.
+        attr_accessor :name
+        # The customer's phone number.
+        attr_accessor :phone
+
+        def initialize(customer: nil, email: nil, name: nil, phone: nil)
+          @customer = customer
+          @email = email
+          @name = name
+          @phone = phone
+        end
+      end
+
+      class Failed < Stripe::RequestParams
+        # When the reported payment failed. Measured in seconds since the Unix epoch.
+        attr_accessor :failed_at
+
+        def initialize(failed_at: nil)
+          @failed_at = failed_at
+        end
+      end
+
+      class Guaranteed < Stripe::RequestParams
+        # When the reported payment was guaranteed. Measured in seconds since the Unix epoch.
+        attr_accessor :guaranteed_at
+
+        def initialize(guaranteed_at: nil)
+          @guaranteed_at = guaranteed_at
+        end
+      end
+
+      class PaymentMethodDetails < Stripe::RequestParams
+        class BillingDetails < Stripe::RequestParams
+          class Address < Stripe::RequestParams
+            # City, district, suburb, town, or village.
+            attr_accessor :city
+            # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+            attr_accessor :country
+            # Address line 1 (e.g., street, PO Box, or company name).
+            attr_accessor :line1
+            # Address line 2 (e.g., apartment, suite, unit, or building).
+            attr_accessor :line2
+            # ZIP or postal code.
+            attr_accessor :postal_code
+            # State, county, province, or region.
+            attr_accessor :state
+
+            def initialize(
+              city: nil,
+              country: nil,
+              line1: nil,
+              line2: nil,
+              postal_code: nil,
+              state: nil
+            )
+              @city = city
+              @country = country
+              @line1 = line1
+              @line2 = line2
+              @postal_code = postal_code
+              @state = state
+            end
+          end
+          # The billing address associated with the method of payment.
+          attr_accessor :address
+          # The billing email associated with the method of payment.
+          attr_accessor :email
+          # The billing name associated with the method of payment.
+          attr_accessor :name
+          # The billing phone number associated with the method of payment.
+          attr_accessor :phone
+
+          def initialize(address: nil, email: nil, name: nil, phone: nil)
+            @address = address
+            @email = email
+            @name = name
+            @phone = phone
+          end
+        end
+
+        class Custom < Stripe::RequestParams
+          # Display name for the custom (user-defined) payment method type used to make this payment.
+          attr_accessor :display_name
+          # The custom payment method type associated with this payment.
+          attr_accessor :type
+
+          def initialize(display_name: nil, type: nil)
+            @display_name = display_name
+            @type = type
+          end
+        end
+        # The billing details associated with the method of payment.
+        attr_accessor :billing_details
+        # Information about the custom (user-defined) payment method used to make this payment.
+        attr_accessor :custom
+        # ID of the Stripe Payment Method used to make this payment.
+        attr_accessor :payment_method
+        # The type of the payment method details. An additional hash is included on the payment_method_details with a name matching this value. It contains additional information specific to the type.
+        attr_accessor :type
+
+        def initialize(billing_details: nil, custom: nil, payment_method: nil, type: nil)
+          @billing_details = billing_details
+          @custom = custom
+          @payment_method = payment_method
+          @type = type
+        end
+      end
+
+      class ShippingDetails < Stripe::RequestParams
+        class Address < Stripe::RequestParams
+          # City, district, suburb, town, or village.
+          attr_accessor :city
+          # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+          attr_accessor :country
+          # Address line 1 (e.g., street, PO Box, or company name).
+          attr_accessor :line1
+          # Address line 2 (e.g., apartment, suite, unit, or building).
+          attr_accessor :line2
+          # ZIP or postal code.
+          attr_accessor :postal_code
+          # State, county, province, or region.
+          attr_accessor :state
+
+          def initialize(
+            city: nil,
+            country: nil,
+            line1: nil,
+            line2: nil,
+            postal_code: nil,
+            state: nil
+          )
+            @city = city
+            @country = country
+            @line1 = line1
+            @line2 = line2
+            @postal_code = postal_code
+            @state = state
+          end
+        end
+        # The physical shipping address.
+        attr_accessor :address
+        # The shipping recipient's name.
+        attr_accessor :name
+        # The shipping recipient's phone number.
+        attr_accessor :phone
+
+        def initialize(address: nil, name: nil, phone: nil)
+          @address = address
+          @name = name
+          @phone = phone
+        end
+      end
+      # The amount you intend to collect for this payment.
+      attr_accessor :amount_requested
+      # Customer information for this payment.
+      attr_accessor :customer_details
+      # Indicates whether the customer was present in your checkout flow during this payment.
+      attr_accessor :customer_presence
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Information about the payment attempt failure.
+      attr_accessor :failed
+      # Information about the payment attempt guarantee.
+      attr_accessor :guaranteed
+      # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+      attr_accessor :initiated_at
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # The outcome of the reported payment.
+      attr_accessor :outcome
+      # Information about the Payment Method debited for this payment.
+      attr_accessor :payment_method_details
+      # An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+      attr_accessor :payment_reference
+      # Shipping information for this payment.
+      attr_accessor :shipping_details
+
+      def initialize(
+        amount_requested: nil,
+        customer_details: nil,
+        customer_presence: nil,
+        description: nil,
+        expand: nil,
+        failed: nil,
+        guaranteed: nil,
+        initiated_at: nil,
+        metadata: nil,
+        outcome: nil,
+        payment_method_details: nil,
+        payment_reference: nil,
+        shipping_details: nil
+      )
+        @amount_requested = amount_requested
+        @customer_details = customer_details
+        @customer_presence = customer_presence
+        @description = description
+        @expand = expand
+        @failed = failed
+        @guaranteed = guaranteed
+        @initiated_at = initiated_at
+        @metadata = metadata
+        @outcome = outcome
+        @payment_method_details = payment_method_details
+        @payment_reference = payment_reference
+        @shipping_details = shipping_details
+      end
+    end
+
+    # Report a new Payment Record. You may report a Payment Record as it is
+    #  initialized and later report updates through the other report_* methods, or report Payment
+    #  Records in a terminal state directly, through this method.
+    def report_payment(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/payment_records/report_payment",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Report a new payment attempt on the specified Payment Record. A new payment
+    #  attempt can only be specified if all other payment attempts are canceled or failed.
+    def report_payment_attempt(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_records/%<id>s/report_payment_attempt", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Report that the most recent payment attempt on the specified Payment Record
+    #  was canceled.
+    def report_payment_attempt_canceled(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_records/%<id>s/report_payment_attempt_canceled", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Report that the most recent payment attempt on the specified Payment Record
+    #  failed or errored.
+    def report_payment_attempt_failed(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_records/%<id>s/report_payment_attempt_failed", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Report that the most recent payment attempt on the specified Payment Record
+    #  was guaranteed.
+    def report_payment_attempt_guaranteed(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_records/%<id>s/report_payment_attempt_guaranteed", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a Payment Record with the given ID
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/payment_records/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/payout_service.rb

@@ -3,6 +3,165 @@
 
 module Stripe
   class PayoutService < StripeService
+    class ListParams < Stripe::RequestParams
+      class ArrivalDate < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return payouts that are expected to arrive during the given date interval.
+      attr_accessor :arrival_date
+      # Only return payouts that were created during the given date interval.
+      attr_accessor :created
+      # The ID of an external account - only return payouts sent to this external account.
+      attr_accessor :destination
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+      # Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.
+      attr_accessor :status
+
+      def initialize(
+        arrival_date: nil,
+        created: nil,
+        destination: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @arrival_date = arrival_date
+        @created = created
+        @destination = destination
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # A positive integer in cents representing how much to payout.
+      attr_accessor :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_accessor :currency
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_accessor :description
+      # The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
+      attr_accessor :destination
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # The method used to send this payout, which is `standard` or `instant`. We support `instant` for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).
+      attr_accessor :method
+      # The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
+      attr_accessor :source_type
+      # A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.
+      attr_accessor :statement_descriptor
+
+      def initialize(
+        amount: nil,
+        currency: nil,
+        description: nil,
+        destination: nil,
+        expand: nil,
+        metadata: nil,
+        method: nil,
+        source_type: nil,
+        statement_descriptor: nil
+      )
+        @amount = amount
+        @currency = currency
+        @description = description
+        @destination = destination
+        @expand = expand
+        @metadata = metadata
+        @method = method
+        @source_type = source_type
+        @statement_descriptor = statement_descriptor
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, metadata: nil)
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+
+    class CancelParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class ReverseParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+
+      def initialize(expand: nil, metadata: nil)
+        @expand = expand
+        @metadata = metadata
+      end
+    end
+
     # You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.
     def cancel(payout, params = {}, opts = {})
       request(