Update OpenAPI specification

stripe · Jan 22, 2024 · 89f85ff · 89f85ff
1 parent 5d7e3cf
commit 89f85ff
Show file tree

Hide file tree

Showing 6 changed files with 183 additions and 12 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -67391,6 +67391,10 @@
           "content": {
             "application/x-www-form-urlencoded": {
               "encoding": {
+                "collection_options": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "expand": {
                   "explode": true,
                   "style": "deepObject"
@@ -67405,13 +67409,39 @@
                     "type": "string"
                   },
                   "collect": {
-                    "description": "Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.",
+                    "description": "The collect parameter is deprecated. Use `collection_options` instead.",
                     "enum": [
                       "currently_due",
                       "eventually_due"
                     ],
                     "type": "string"
                   },
+                  "collection_options": {
+                    "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.",
+                    "properties": {
+                      "fields": {
+                        "description": "Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.",
+                        "enum": [
+                          "currently_due",
+                          "eventually_due"
+                        ],
+                        "type": "string"
+                      },
+                      "future_requirements": {
+                        "description": "Options for collecting future_requirements in Connect Onboarding",
+                        "enum": [
+                          "include",
+                          "omit"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "fields"
+                    ],
+                    "title": "collection_options_params",
+                    "type": "object"
+                  },
                   "expand": {
                     "description": "Specifies which fields in the response should be expanded.",
                     "items": {

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -60693,6 +60693,9 @@ paths:
         content:
           application/x-www-form-urlencoded:
             encoding:
+              collection_options:
+                explode: true
+                style: deepObject
               expand:
                 explode: true
                 style: deepObject
@@ -60705,13 +60708,41 @@ paths:
                   type: string
                 collect:
                   description: >-
-                    Which information the platform needs to collect from the
-                    user. One of `currently_due` or `eventually_due`. Default is
-                    `currently_due`.
+                    The collect parameter is deprecated. Use
+                    `collection_options` instead.
                   enum:
                     - currently_due
                     - eventually_due
                   type: string
+                collection_options:
+                  description: >-
+                    Specifies the requirements that Stripe collects from
+                    connected accounts in the Connect Onboarding flow.
+                  properties:
+                    fields:
+                      description: >-
+                        Specifies whether the platform collects only
+                        currently_due requirements (`currently_due`) or both
+                        currently_due and eventually_due requirements
+                        (`eventually_due`). If you don't specify
+                        `collection_options`, the default value is
+                        `currently_due`.
+                      enum:
+                        - currently_due
+                        - eventually_due
+                      type: string
+                    future_requirements:
+                      description: >-
+                        Options for collecting future_requirements in Connect
+                        Onboarding
+                      enum:
+                        - include
+                        - omit
+                      type: string
+                  required:
+                    - fields
+                  title: collection_options_params
+                  type: object
                 expand:
                   description: Specifies which fields in the response should be expanded.
                   items:

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -46133,6 +46133,10 @@
           "content": {
             "application/x-www-form-urlencoded": {
               "encoding": {
+                "collection_options": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "expand": {
                   "explode": true,
                   "style": "deepObject"
@@ -46147,13 +46151,37 @@
                     "type": "string"
                   },
                   "collect": {
-                    "description": "Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.",
+                    "description": "The collect parameter is deprecated. Use `collection_options` instead.",
                     "enum": [
                       "currently_due",
                       "eventually_due"
                     ],
                     "type": "string"
                   },
+                  "collection_options": {
+                    "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.",
+                    "properties": {
+                      "fields": {
+                        "enum": [
+                          "currently_due",
+                          "eventually_due"
+                        ],
+                        "type": "string"
+                      },
+                      "future_requirements": {
+                        "enum": [
+                          "include",
+                          "omit"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "fields"
+                    ],
+                    "title": "collection_options_params",
+                    "type": "object"
+                  },
                   "expand": {
                     "description": "Specifies which fields in the response should be expanded.",
                     "items": {

diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json
@@ -57027,6 +57027,10 @@
           "content": {
             "application/x-www-form-urlencoded": {
               "encoding": {
+                "collection_options": {
+                  "explode": true,
+                  "style": "deepObject"
+                },
                 "expand": {
                   "explode": true,
                   "style": "deepObject"
@@ -57041,13 +57045,39 @@
                     "type": "string"
                   },
                   "collect": {
-                    "description": "Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`.",
+                    "description": "The collect parameter is deprecated. Use `collection_options` instead.",
                     "enum": [
                       "currently_due",
                       "eventually_due"
                     ],
                     "type": "string"
                   },
+                  "collection_options": {
+                    "description": "Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.",
+                    "properties": {
+                      "fields": {
+                        "description": "Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.",
+                        "enum": [
+                          "currently_due",
+                          "eventually_due"
+                        ],
+                        "type": "string"
+                      },
+                      "future_requirements": {
+                        "description": "Options for collecting future_requirements in Connect Onboarding",
+                        "enum": [
+                          "include",
+                          "omit"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "fields"
+                    ],
+                    "title": "collection_options_params",
+                    "type": "object"
+                  },
                   "expand": {
                     "description": "Specifies which fields in the response should be expanded.",
                     "items": {

diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml
@@ -51713,6 +51713,9 @@ paths:
         content:
           application/x-www-form-urlencoded:
             encoding:
+              collection_options:
+                explode: true
+                style: deepObject
               expand:
                 explode: true
                 style: deepObject
@@ -51725,13 +51728,41 @@ paths:
                   type: string
                 collect:
                   description: >-
-                    Which information the platform needs to collect from the
-                    user. One of `currently_due` or `eventually_due`. Default is
-                    `currently_due`.
+                    The collect parameter is deprecated. Use
+                    `collection_options` instead.
                   enum:
                     - currently_due
                     - eventually_due
                   type: string
+                collection_options:
+                  description: >-
+                    Specifies the requirements that Stripe collects from
+                    connected accounts in the Connect Onboarding flow.
+                  properties:
+                    fields:
+                      description: >-
+                        Specifies whether the platform collects only
+                        currently_due requirements (`currently_due`) or both
+                        currently_due and eventually_due requirements
+                        (`eventually_due`). If you don't specify
+                        `collection_options`, the default value is
+                        `currently_due`.
+                      enum:
+                        - currently_due
+                        - eventually_due
+                      type: string
+                    future_requirements:
+                      description: >-
+                        Options for collecting future_requirements in Connect
+                        Onboarding
+                      enum:
+                        - include
+                        - omit
+                      type: string
+                  required:
+                    - fields
+                  title: collection_options_params
+                  type: object
                 expand:
                   description: Specifies which fields in the response should be expanded.
                   items:

diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml
@@ -43258,6 +43258,9 @@ paths:
         content:
           application/x-www-form-urlencoded:
             encoding:
+              collection_options:
+                explode: true
+                style: deepObject
               expand:
                 explode: true
                 style: deepObject
@@ -43270,13 +43273,31 @@ paths:
                   type: string
                 collect:
                   description: >-
-                    Which information the platform needs to collect from the
-                    user. One of `currently_due` or `eventually_due`. Default is
-                    `currently_due`.
+                    The collect parameter is deprecated. Use
+                    `collection_options` instead.
                   enum:
                     - currently_due
                     - eventually_due
                   type: string
+                collection_options:
+                  description: >-
+                    Specifies the requirements that Stripe collects from
+                    connected accounts in the Connect Onboarding flow.
+                  properties:
+                    fields:
+                      enum:
+                        - currently_due
+                        - eventually_due
+                      type: string
+                    future_requirements:
+                      enum:
+                        - include
+                        - omit
+                      type: string
+                  required:
+                    - fields
+                  title: collection_options_params
+                  type: object
                 expand:
                   description: Specifies which fields in the response should be expanded.
                   items: