Update OpenAPI specification

stripe · Jan 10, 2024 · a1b3bdf · a1b3bdf
1 parent dfccb52
commit a1b3bdf
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 86 deletions.
diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json
@@ -3149,7 +3149,7 @@
             "type": "string"
           },
           "type": {
-            "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
+            "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
             "enum": [
               "adjustment",
               "advance",
@@ -3166,12 +3166,8 @@
               "issuing_authorization_release",
               "issuing_dispute",
               "issuing_transaction",
-              "obligation_inbound",
               "obligation_outbound",
-              "obligation_payout",
-              "obligation_payout_failure",
               "obligation_reversal_inbound",
-              "obligation_reversal_outbound",
               "payment",
               "payment_failure_refund",
               "payment_network_reserve_hold",
@@ -75789,7 +75785,7 @@
             "style": "form"
           },
           {
-            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
+            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
             "in": "query",
             "name": "type",
             "required": false,
@@ -154237,7 +154233,6 @@
                           "issuing_dispute",
                           "issuing_transaction",
                           "network_cost",
-                          "obligation",
                           "other_adjustment",
                           "partial_capture_reversal",
                           "payout",

diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml
@@ -3042,17 +3042,16 @@ components:
             `climate_order_refund`, `connect_collection_transfer`,
             `contribution`, `issuing_authorization_hold`,
             `issuing_authorization_release`, `issuing_dispute`,
-            `issuing_transaction`, `obligation_inbound`, `obligation_outbound`,
-            `obligation_reversal_inbound`, `obligation_reversal_outbound`,
-            `obligation_payout`, `obligation_payout_failure`, `payment`,
-            `payment_failure_refund`, `payment_network_reserve_hold`,
-            `payment_network_reserve_release`, `payment_refund`,
-            `payment_reversal`, `payment_unreconciled`, `payout`,
-            `payout_cancel`, `payout_failure`, `refund`, `refund_failure`,
-            `reserve_transaction`, `reserved_funds`, `stripe_fee`,
-            `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`,
-            `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn
-            more about [balance transaction types and what they
+            `issuing_transaction`, `obligation_outbound`,
+            `obligation_reversal_inbound`, `payment`, `payment_failure_refund`,
+            `payment_network_reserve_hold`, `payment_network_reserve_release`,
+            `payment_refund`, `payment_reversal`, `payment_unreconciled`,
+            `payout`, `payout_cancel`, `payout_failure`, `refund`,
+            `refund_failure`, `reserve_transaction`, `reserved_funds`,
+            `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`,
+            `transfer`, `transfer_cancel`, `transfer_failure`, or
+            `transfer_refund`. Learn more about [balance transaction types and
+            what they
             represent](https://stripe.com/docs/reports/balance-transaction-types).
             To classify transactions for accounting purposes, consider
             `reporting_category` instead.
@@ -3072,12 +3071,8 @@ components:
             - issuing_authorization_release
             - issuing_dispute
             - issuing_transaction
-            - obligation_inbound
             - obligation_outbound
-            - obligation_payout
-            - obligation_payout_failure
             - obligation_reversal_inbound
-            - obligation_reversal_outbound
             - payment
             - payment_failure_refund
             - payment_network_reserve_hold
@@ -68608,10 +68603,8 @@ paths:
             `climate_order_purchase`, `climate_order_refund`,
             `connect_collection_transfer`, `contribution`,
             `issuing_authorization_hold`, `issuing_authorization_release`,
-            `issuing_dispute`, `issuing_transaction`, `obligation_inbound`,
-            `obligation_outbound`, `obligation_reversal_inbound`,
-            `obligation_reversal_outbound`, `obligation_payout`,
-            `obligation_payout_failure`, `payment`, `payment_failure_refund`,
+            `issuing_dispute`, `issuing_transaction`, `obligation_outbound`,
+            `obligation_reversal_inbound`, `payment`, `payment_failure_refund`,
             `payment_network_reserve_hold`, `payment_network_reserve_release`,
             `payment_refund`, `payment_reversal`, `payment_unreconciled`,
             `payout`, `payout_cancel`, `payout_failure`, `refund`,
@@ -145061,7 +145054,6 @@ paths:
                         - issuing_dispute
                         - issuing_transaction
                         - network_cost
-                        - obligation
                         - other_adjustment
                         - partial_capture_reversal
                         - payout

diff --git a/openapi/spec3.json b/openapi/spec3.json
@@ -2368,7 +2368,7 @@
             "type": "string"
           },
           "type": {
-            "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
+            "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
             "enum": [
               "adjustment",
               "advance",
@@ -2385,12 +2385,8 @@
               "issuing_authorization_release",
               "issuing_dispute",
               "issuing_transaction",
-              "obligation_inbound",
               "obligation_outbound",
-              "obligation_payout",
-              "obligation_payout_failure",
               "obligation_reversal_inbound",
-              "obligation_reversal_outbound",
               "payment",
               "payment_failure_refund",
               "payment_network_reserve_hold",
@@ -55496,7 +55492,7 @@
             "style": "form"
           },
           {
-            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
+            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
             "in": "query",
             "name": "type",
             "required": false,
@@ -55765,7 +55761,7 @@
             "style": "form"
           },
           {
-            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
+            "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
             "in": "query",
             "name": "type",
             "required": false,
@@ -114301,7 +114297,6 @@
                           "issuing_dispute",
                           "issuing_transaction",
                           "network_cost",
-                          "obligation",
                           "other_adjustment",
                           "partial_capture_reversal",
                           "payout",