stripe 13.3.0 → 13.4.0.pre.beta.2

data/lib/stripe/resources/payout.rb

@@ -20,6 +20,224 @@ module Stripe
       "payout"
     end
 
+    class TraceId < Stripe::StripeObject
+      # Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.
+      attr_reader :status
+      # The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.
+      attr_reader :value
+    end
+
+    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
+    # The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.
+    attr_reader :amount
+    # The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.
+    attr_reader :application_fee
+    # The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.
+    attr_reader :application_fee_amount
+    # Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.
+    attr_reader :arrival_date
+    # Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).
+    attr_reader :automatic
+    # ID of the balance transaction that describes the impact of this payout 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
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    attr_reader :description
+    # ID of the bank account or card the payout is sent to.
+    attr_reader :destination
+    # If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.
+    attr_reader :failure_balance_transaction
+    # Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).
+    attr_reader :failure_code
+    # Message that provides the reason for a payout failure, if available.
+    attr_reader :failure_message
+    # 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://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.
+    attr_reader :metadata
+    # The method used to send this payout, which can be `standard` or `instant`. `instant` is supported 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_reader :method
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # If the payout reverses another, this is the ID of the original payout.
+    attr_reader :original_payout
+    # If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
+    attr_reader :reconciliation_status
+    # If the payout reverses, this is the ID of the payout that reverses this payout.
+    attr_reader :reversed_by
+    # The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.
+    attr_reader :source_type
+    # Extra information about a payout that displays on the user's bank statement.
+    attr_reader :statement_descriptor
+    # Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.
+    attr_reader :status
+    # A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.
+    attr_reader :trace_id
+    # Can be `bank_account` or `card`.
+    attr_reader :type
+
     # 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(params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/person.rb

@@ -15,6 +15,269 @@ module Stripe
       "person"
     end
 
+    class AdditionalTosAcceptances < Stripe::StripeObject
+      class Account < Stripe::StripeObject
+        # The Unix timestamp marking when the legal guardian accepted the service agreement.
+        attr_reader :date
+        # The IP address from which the legal guardian accepted the service agreement.
+        attr_reader :ip
+        # The user agent of the browser from which the legal guardian accepted the service agreement.
+        attr_reader :user_agent
+      end
+      # Details on the legal guardian's acceptance of the main Stripe service agreement.
+      attr_reader :account
+    end
+
+    class Address < Stripe::StripeObject
+      # City, district, suburb, town, or village.
+      attr_reader :city
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Address line 1 (e.g., street, PO Box, or company name).
+      attr_reader :line1
+      # Address line 2 (e.g., apartment, suite, unit, or building).
+      attr_reader :line2
+      # ZIP or postal code.
+      attr_reader :postal_code
+      # State, county, province, or region.
+      attr_reader :state
+    end
+
+    class AddressKana < Stripe::StripeObject
+      # City/Ward.
+      attr_reader :city
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Block/Building number.
+      attr_reader :line1
+      # Building details.
+      attr_reader :line2
+      # ZIP or postal code.
+      attr_reader :postal_code
+      # Prefecture.
+      attr_reader :state
+      # Town/cho-me.
+      attr_reader :town
+    end
+
+    class AddressKanji < Stripe::StripeObject
+      # City/Ward.
+      attr_reader :city
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Block/Building number.
+      attr_reader :line1
+      # Building details.
+      attr_reader :line2
+      # ZIP or postal code.
+      attr_reader :postal_code
+      # Prefecture.
+      attr_reader :state
+      # Town/cho-me.
+      attr_reader :town
+    end
+
+    class Dob < Stripe::StripeObject
+      # The day of birth, between 1 and 31.
+      attr_reader :day
+      # The month of birth, between 1 and 12.
+      attr_reader :month
+      # The four-digit year of birth.
+      attr_reader :year
+    end
+
+    class FutureRequirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        attr_reader :original_fields_due
+      end
+
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      attr_reader :alternatives
+      # Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.
+      attr_reader :eventually_due
+      # Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+    end
+
+    class RegisteredAddress < Stripe::StripeObject
+      # City, district, suburb, town, or village.
+      attr_reader :city
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Address line 1 (e.g., street, PO Box, or company name).
+      attr_reader :line1
+      # Address line 2 (e.g., apartment, suite, unit, or building).
+      attr_reader :line2
+      # ZIP or postal code.
+      attr_reader :postal_code
+      # State, county, province, or region.
+      attr_reader :state
+    end
+
+    class Relationship < Stripe::StripeObject
+      # Whether the person is the authorizer of the account's representative.
+      attr_reader :authorizer
+      # Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
+      attr_reader :director
+      # Whether the person has significant responsibility to control, manage, or direct the organization.
+      attr_reader :executive
+      # Whether the person is the legal guardian of the account's representative.
+      attr_reader :legal_guardian
+      # Whether the person is an owner of the account’s legal entity.
+      attr_reader :owner
+      # The percent owned by the person of the account's legal entity.
+      attr_reader :percent_ownership
+      # Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
+      attr_reader :representative
+      # The person's title (e.g., CEO, Support Engineer).
+      attr_reader :title
+    end
+
+    class Requirements < Stripe::StripeObject
+      class Alternative < Stripe::StripeObject
+        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        attr_reader :alternative_fields_due
+        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        attr_reader :original_fields_due
+      end
+
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+      end
+      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      attr_reader :alternatives
+      # Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.
+      attr_reader :eventually_due
+      # Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+    end
+
+    class Verification < Stripe::StripeObject
+      class AdditionalDocument < Stripe::StripeObject
+        # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+        attr_reader :back
+        # A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
+        attr_reader :details
+        # One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.
+        attr_reader :details_code
+        # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+        attr_reader :front
+      end
+
+      class Document < Stripe::StripeObject
+        # The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+        attr_reader :back
+        # A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".
+        attr_reader :details
+        # One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.
+        attr_reader :details_code
+        # The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.
+        attr_reader :front
+      end
+      # A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
+      attr_reader :additional_document
+      # A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".
+      attr_reader :details
+      # One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.
+      attr_reader :details_code
+      # Attribute for field document
+      attr_reader :document
+      # The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`.
+      attr_reader :status
+    end
+    # The account the person is associated with.
+    attr_reader :account
+    # Attribute for field additional_tos_acceptances
+    attr_reader :additional_tos_acceptances
+    # Attribute for field address
+    attr_reader :address
+    # The Kana variation of the person's address (Japan only).
+    attr_reader :address_kana
+    # The Kanji variation of the person's address (Japan only).
+    attr_reader :address_kanji
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Attribute for field dob
+    attr_reader :dob
+    # The person's email address.
+    attr_reader :email
+    # The person's first name.
+    attr_reader :first_name
+    # The Kana variation of the person's first name (Japan only).
+    attr_reader :first_name_kana
+    # The Kanji variation of the person's first name (Japan only).
+    attr_reader :first_name_kanji
+    # A list of alternate names or aliases that the person is known by.
+    attr_reader :full_name_aliases
+    # Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
+    attr_reader :future_requirements
+    # The person's gender.
+    attr_reader :gender
+    # Unique identifier for the object.
+    attr_reader :id
+    # Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).
+    attr_reader :id_number_provided
+    # Whether the person's `id_number_secondary` was provided.
+    attr_reader :id_number_secondary_provided
+    # The person's last name.
+    attr_reader :last_name
+    # The Kana variation of the person's last name (Japan only).
+    attr_reader :last_name_kana
+    # The Kanji variation of the person's last name (Japan only).
+    attr_reader :last_name_kanji
+    # The person's maiden name.
+    attr_reader :maiden_name
+    # 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.
+    attr_reader :metadata
+    # The country where the person is a national.
+    attr_reader :nationality
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The person's phone number.
+    attr_reader :phone
+    # Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
+    attr_reader :political_exposure
+    # Attribute for field registered_address
+    attr_reader :registered_address
+    # Attribute for field relationship
+    attr_reader :relationship
+    # Information about the requirements for this person, including what information needs to be collected, and by when.
+    attr_reader :requirements
+    # Whether the last four digits of the person's Social Security number have been provided (U.S. only).
+    attr_reader :ssn_last_4_provided
+    # Attribute for field verification
+    attr_reader :verification
+    # Always true for a deleted object
+    attr_reader :deleted
+
     def resource_url
       if !respond_to?(:account) || account.nil?
         raise NotImplementedError,