stripe 19.1.0 → 19.2.0

data/lib/stripe/resources/v2/commerce/product_catalog_import.rb

@@ -0,0 +1,274 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Commerce
+      # The ProductCatalogImport object tracks the long-running background process that handles uploading, processing and validation.
+      class ProductCatalogImport < APIResource
+        OBJECT_NAME = "v2.commerce.product_catalog_import"
+        def self.object_name
+          "v2.commerce.product_catalog_import"
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class AwaitingUpload < ::Stripe::StripeObject
+            class UploadUrl < ::Stripe::StripeObject
+              # The timestamp when the upload URL expires.
+              attr_reader :expires_at
+              # The pre-signed URL for uploading the catalog file.
+              attr_reader :url
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The pre-signed URL information for uploading the catalog file.
+            attr_reader :upload_url
+
+            def self.inner_class_types
+              @inner_class_types = { upload_url: UploadUrl }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Failed < ::Stripe::StripeObject
+            # The error code for this product catalog processing failure.
+            attr_reader :code
+            # A message explaining why the import failed.
+            attr_reader :failure_message
+            # The error type for this product catalog processing failure.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Processing < ::Stripe::StripeObject
+            # The number of records that failed to process so far.
+            attr_reader :error_count
+            # The number of records processed so far.
+            attr_reader :success_count
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { error_count: :int64_string, success_count: :int64_string }
+            end
+          end
+
+          class Succeeded < ::Stripe::StripeObject
+            # The total number of records processed.
+            attr_reader :success_count
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = { success_count: :int64_string }
+            end
+          end
+
+          class SucceededWithErrors < ::Stripe::StripeObject
+            class ErrorFile < ::Stripe::StripeObject
+              class DownloadUrl < ::Stripe::StripeObject
+                # The timestamp when the download URL expires.
+                attr_reader :expires_at
+                # The pre-signed URL for downloading the error file.
+                attr_reader :url
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # The MIME type of the error file.
+              attr_reader :content_type
+              # The pre-signed URL information for downloading the error file.
+              attr_reader :download_url
+              # The size of the error file in bytes.
+              attr_reader :size
+
+              def self.inner_class_types
+                @inner_class_types = { download_url: DownloadUrl }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+
+              def self.field_encodings
+                @field_encodings = { size: :int64_string }
+              end
+            end
+
+            class Sample < ::Stripe::StripeObject
+              # A description of what went wrong with this record.
+              attr_reader :error_message
+              # The name of the field that caused the error.
+              attr_reader :field
+              # The identifier of the record that failed to process.
+              attr_reader :id
+              # The row number in the import file where the error occurred.
+              attr_reader :row
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+
+              def self.field_encodings
+                @field_encodings = { row: :int64_string }
+              end
+            end
+            # The total number of records that failed to process.
+            attr_reader :error_count
+            # A file containing details about all errors that occurred.
+            attr_reader :error_file
+            # A sample of errors that occurred during processing.
+            attr_reader :samples
+            # The total number of records processed.
+            attr_reader :success_count
+
+            def self.inner_class_types
+              @inner_class_types = { error_file: ErrorFile, samples: Sample }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+
+            def self.field_encodings
+              @field_encodings = {
+                error_count: :int64_string,
+                error_file: { kind: :object, fields: { size: :int64_string } },
+                samples: { kind: :array, element: { kind: :object, fields: { row: :int64_string } } },
+                success_count: :int64_string,
+              }
+            end
+          end
+          # Details when the import is awaiting file upload.
+          attr_reader :awaiting_upload
+          # Details when the import didn't complete.
+          attr_reader :failed
+          # Details when the import is processing.
+          attr_reader :processing
+          # Details when the import has succeeded.
+          attr_reader :succeeded
+          # Details when the import completed but some records failed to process.
+          attr_reader :succeeded_with_errors
+
+          def self.inner_class_types
+            @inner_class_types = {
+              awaiting_upload: AwaitingUpload,
+              failed: Failed,
+              processing: Processing,
+              succeeded: Succeeded,
+              succeeded_with_errors: SucceededWithErrors,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              processing: {
+                kind: :object,
+                fields: { error_count: :int64_string, success_count: :int64_string },
+              },
+              succeeded: { kind: :object, fields: { success_count: :int64_string } },
+              succeeded_with_errors: {
+                kind: :object,
+                fields: {
+                  error_count: :int64_string,
+                  error_file: { kind: :object, fields: { size: :int64_string } },
+                  samples: { kind: :array, element: { kind: :object, fields: { row: :int64_string } } },
+                  success_count: :int64_string,
+                },
+              },
+            }
+          end
+        end
+        # The time this ProductCatalogImport was created.
+        attr_reader :created
+        # The type of feed data being imported into the product catalog.
+        attr_reader :feed_type
+        # The unique identifier for this ProductCatalogImport.
+        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
+        # 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 of the object field.
+        attr_reader :object
+        # The current status of this ProductCatalogImport.
+        attr_reader :status
+        # Details about the current import status.
+        attr_reader :status_details
+
+        def self.inner_class_types
+          @inner_class_types = { status_details: StatusDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+
+        def self.field_encodings
+          @field_encodings = {
+            status_details: {
+              kind: :object,
+              fields: {
+                processing: {
+                  kind: :object,
+                  fields: { error_count: :int64_string, success_count: :int64_string },
+                },
+                succeeded: { kind: :object, fields: { success_count: :int64_string } },
+                succeeded_with_errors: {
+                  kind: :object,
+                  fields: {
+                    error_count: :int64_string,
+                    error_file: { kind: :object, fields: { size: :int64_string } },
+                    samples: { kind: :array, element: { kind: :object, fields: { row: :int64_string } } },
+                    success_count: :int64_string,
+                  },
+                },
+              },
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/core/account.rb

@@ -4,9 +4,8 @@
 module Stripe
   module V2
     module Core
-      # An Account v2 object represents a company, individual, or other entity that interacts with a platform on Stripe. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer.
-      # The Accounts v2 API supports both the Global Payouts preview feature and the Connect-Billing integration preview feature. However, a particular Account can only access one of them.
-      # The Connect-Billing integration preview feature allows an Account v2 to pay subscription fees to a platform. An Account v1 required a separate Customer object to pay subscription fees.
+      # An Account v2 object represents a company, individual, or other entity that your Stripe integration interacts with. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer.
+      # The Accounts v2 API is broadly available to Connect platforms, and to other users in preview. The Accounts v2 API also supports the Global Payouts preview feature.
       class Account < APIResource
         OBJECT_NAME = "v2.core.account"
         def self.object_name
@@ -98,7 +97,7 @@ module Stripe
                   @field_remappings = {}
                 end
               end
-              # ID of a PaymentMethod attached to the customer account to use as the default for invoices and subscriptions.
+              # The ID of a `PaymentMethod` attached to this Account's `customer` configuration, used as the default payment method for invoices and subscriptions.
               attr_reader :default_payment_method
               # Default invoice settings for the customer account.
               attr_reader :invoice
@@ -2039,7 +2038,7 @@ module Stripe
               @field_remappings = {}
             end
           end
-          # The Customer Configuration allows the Account to be used in inbound payment flows.
+          # The Customer Configuration allows the Account to be used in inbound payment flows (i.e. customer-facing payment and billing flows).
           attr_reader :customer
           # Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set.
           attr_reader :merchant
@@ -2583,13 +2582,27 @@ module Stripe
               end
 
               class ProofOfRegistration < ::Stripe::StripeObject
+                class Signer < ::Stripe::StripeObject
+                  # Person signing the document.
+                  attr_reader :person
+
+                  def self.inner_class_types
+                    @inner_class_types = {}
+                  end
+
+                  def self.field_remappings
+                    @field_remappings = {}
+                  end
+                end
                 # One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
                 attr_reader :files
+                # Person that is signing the document.
+                attr_reader :signer
                 # The format of the document. Currently supports `files` only.
                 attr_reader :type
 
                 def self.inner_class_types
-                  @inner_class_types = {}
+                  @inner_class_types = { signer: Signer }
                 end
 
                 def self.field_remappings
@@ -2598,13 +2611,27 @@ module Stripe
               end
 
               class ProofOfUltimateBeneficialOwnership < ::Stripe::StripeObject
+                class Signer < ::Stripe::StripeObject
+                  # Person signing the document.
+                  attr_reader :person
+
+                  def self.inner_class_types
+                    @inner_class_types = {}
+                  end
+
+                  def self.field_remappings
+                    @field_remappings = {}
+                  end
+                end
                 # One or more document IDs returned by a [file upload](https://docs.stripe.com/api/persons/update#create_file) with a purpose value of `account_requirement`.
                 attr_reader :files
+                # Person that is signing the document.
+                attr_reader :signer
                 # The format of the document. Currently supports `files` only.
                 attr_reader :type
 
                 def self.inner_class_types
-                  @inner_class_types = {}
+                  @inner_class_types = { signer: Signer }
                 end
 
                 def self.field_remappings
@@ -3257,7 +3284,7 @@ module Stripe
             attr_reader :date_of_birth
             # Documents that may be submitted to satisfy various informational requests.
             attr_reader :documents
-            # The individual's email address.
+            # The individual's email address. You can only set this field when the Account is configured as a `merchant` or `recipient`. Use `contact_email` as the primary contact email for this Account.
             attr_reader :email
             # The individual's first name.
             attr_reader :given_name
@@ -3319,7 +3346,7 @@ module Stripe
           attr_reader :business_details
           # The country in which the account holder resides, or in which the business is legally established. This should be an [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
           attr_reader :country
-          # The entity type.
+          # The entity type represented by the Account. Ensure this field is accurate before adding configurations that rely on identity information, as it determines which identity fields apply and how the Account is validated.
           attr_reader :entity_type
           # Information about the individual represented by the Account. This property is `null` unless `entity_type` is set to `individual`.
           attr_reader :individual
@@ -3524,7 +3551,7 @@ module Stripe
         attr_reader :closed
         # An Account represents a company, individual, or other entity that a user interacts with. Accounts store identity information and one or more configurations that enable product-specific capabilities. You can assign configurations at creation or add them later.
         attr_reader :configuration
-        # The default contact email address for the Account. Required when configuring the account as a merchant or recipient.
+        # The primary contact email address for the Account.
         attr_reader :contact_email
         # The default contact phone for the Account.
         attr_reader :contact_phone

data/lib/stripe/resources/v2/core/account_token.rb

@@ -4,7 +4,7 @@
 module Stripe
   module V2
     module Core
-      # Account tokens are single-use tokens which tokenize company/individual/business information, and are used for creating or updating an Account.
+      # Account tokens are single-use tokens which tokenize an account's contact_email, display_name, contact_phone, and identity.
       class AccountToken < APIResource
         OBJECT_NAME = "v2.core.account_token"
         def self.object_name

data/lib/stripe/resources/v2/core/event.rb

@@ -5,6 +5,7 @@ module Stripe
   module V2
     module Core
       # Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](https://docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](https://docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](https://docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.
+      # You can access events through the [Retrieve Event API](https://docs.stripe.com/api/v2/core/events/retrieve) for 30 days.
       class Event < APIResource
         OBJECT_NAME = "v2.core.event"
         def self.object_name

data/lib/stripe/resources/v2/core/event_destination.rb

@@ -28,6 +28,27 @@ module Stripe
           end
         end
 
+        class AzureEventGrid < ::Stripe::StripeObject
+          # The name of the Azure partner topic.
+          attr_reader :azure_partner_topic_name
+          # The status of the Azure partner topic.
+          attr_reader :azure_partner_topic_status
+          # The Azure region.
+          attr_reader :azure_region
+          # The name of the Azure resource group.
+          attr_reader :azure_resource_group_name
+          # The Azure subscription ID.
+          attr_reader :azure_subscription_id
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class StatusDetails < ::Stripe::StripeObject
           class Disabled < ::Stripe::StripeObject
             # Reason event destination has been disabled.
@@ -69,6 +90,8 @@ module Stripe
         end
         # Amazon EventBridge configuration.
         attr_reader :amazon_eventbridge
+        # Azure Event Grid configuration.
+        attr_reader :azure_event_grid
         # Time at which the object was created.
         attr_reader :created
         # An optional description of what the event destination is used for.
@@ -109,6 +132,7 @@ module Stripe
         def self.inner_class_types
           @inner_class_types = {
             amazon_eventbridge: AmazonEventbridge,
+            azure_event_grid: AzureEventGrid,
             status_details: StatusDetails,
             webhook_endpoint: WebhookEndpoint,
           }