Skip to content

Commit

Permalink
Update OpenAPI specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@stripe-openapi
stripe-openapi[bot] committed Aug 2, 2023
1 parent 9b2a8bc commit ad2afdd
Show file tree
Hide file tree
Showing 2 changed files with 484 additions and 6 deletions.
278 changes: 274 additions & 4 deletions openapi/spec3.beta.sdk.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18188,6 +18188,13 @@
"method_type": "custom",
"operation": "post",
"path": "/v1/test_helpers/issuing/cards/{card}/shipping/fail"
},
{
"method_name": "submit_card",
"method_on": "service",
"method_type": "custom",
"operation": "post",
"path": "/v1/test_helpers/issuing/cards/{card}/shipping/submit"
}
],
"x-stripeResource": {
Expand Down Expand Up @@ -20116,6 +20123,15 @@
"address": {
"$ref": "#/components/schemas/address"
},
"address_validation": {
"anyOf": [
{
"$ref": "#/components/schemas/issuing_card_shipping_address_validation"
}
],
"description": "Address validation details for the shipment.",
"nullable": true
},
"carrier": {
"description": "The delivery company that shipped a card.",
"enum": [
Expand Down Expand Up @@ -20176,11 +20192,11 @@
"failure",
"pending",
"returned",
"shipped"
"shipped",
"submitted"
],
"nullable": true,
"type": "string",
"x-stripeBypassValidation": true
"type": "string"
},
"tracking_number": {
"description": "A tracking number for a card shipment.",
Expand Down Expand Up @@ -20221,13 +20237,61 @@
"type": "object",
"x-expandableFields": [
"address",
"address_validation",
"customs"
],
"x-stripeResource": {
"class_name": "Shipping",
"in_package": ""
}
},
"issuing_card_shipping_address_validation": {
"description": "",
"properties": {
"mode": {
"description": "The address validation capabilities to use.",
"enum": [
"disabled",
"normalization_only",
"validation_and_normalization"
],
"type": "string"
},
"normalized_address": {
"anyOf": [
{
"$ref": "#/components/schemas/address"
}
],
"description": "The normalized shipping address.",
"nullable": true
},
"result": {
"description": "The validation result for the shipping address.",
"enum": [
"indeterminate",
"likely_deliverable",
"likely_undeliverable"
],
"nullable": true,
"type": "string"
}
},
"required": [
"mode",
"normalized_address",
"result"
],
"title": "IssuingCardShippingAddressValidation",
"type": "object",
"x-expandableFields": [
"normalized_address"
],
"x-stripeResource": {
"class_name": "AddressValidation",
"in_package": ""
}
},
"issuing_card_shipping_customs": {
"description": "",
"properties": {
Expand Down Expand Up @@ -58696,7 +58760,7 @@
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
"title": "Stripe API",
"version": "2022-11-15; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; tax_calc_beta=v3; tax_txns_beta=v2; tax_regs_beta=v2; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; payment_method_configs_api_beta=v1; specify_payment_method_config_beta=v1",
"version": "2022-11-15; embedded_connect_beta=v2; server_side_confirmation_beta=v1; orders_beta=v4; gift_cards_beta=v1; tax_calc_beta=v3; tax_txns_beta=v2; tax_regs_beta=v2; unified_accounts_beta=v1; terminal_collect_inputs_beta=v1; terminal_collect_confirm_beta=v1; retrieve_tax_forms_beta=v1; financial_connections_transactions_beta=v1; payment_method_configs_api_beta=v1; specify_payment_method_config_beta=v1; address_validation_beta=v1",
"x-stripeSpecFilename": "spec3.beta.sdk"
},
"openapi": "3.0.0",
Expand Down Expand Up @@ -95059,6 +95123,25 @@
"title": "required_address",
"type": "object"
},
"address_validation": {
"description": "Address validation settings.",
"properties": {
"mode": {
"description": "The address validation capabilities to use.",
"enum": [
"disabled",
"normalization_only",
"validation_and_normalization"
],
"type": "string"
}
},
"required": [
"mode"
],
"title": "address_validation_param",
"type": "object"
},
"customs": {
"description": "Customs information for the shipment.",
"properties": {
Expand Down Expand Up @@ -96211,6 +96294,10 @@
"explode": true,
"style": "deepObject"
},
"shipping": {
"explode": true,
"style": "deepObject"
},
"spending_controls": {
"explode": true,
"style": "deepObject"
Expand Down Expand Up @@ -96265,6 +96352,122 @@
"title": "encrypted_pin_param",
"type": "object"
},
"shipping": {
"description": "Updated shipping information for the card.",
"properties": {
"address": {
"description": "The address that the card is shipped to.",
"properties": {
"city": {
"description": "City, district, suburb, town, or village.",
"maxLength": 5000,
"type": "string"
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
"maxLength": 5000,
"type": "string"
},
"line1": {
"description": "Address line 1 (e.g., street, PO Box, or company name).",
"maxLength": 5000,
"type": "string"
},
"line2": {
"description": "Address line 2 (e.g., apartment, suite, unit, or building).",
"maxLength": 5000,
"type": "string"
},
"postal_code": {
"description": "ZIP or postal code.",
"maxLength": 5000,
"type": "string"
},
"state": {
"description": "State, county, province, or region.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"city",
"country",
"line1",
"postal_code"
],
"title": "required_address",
"type": "object"
},
"address_validation": {
"description": "Address validation settings.",
"properties": {
"mode": {
"description": "The address validation capabilities to use.",
"enum": [
"disabled",
"normalization_only",
"validation_and_normalization"
],
"type": "string"
}
},
"required": [
"mode"
],
"title": "address_validation_param",
"type": "object"
},
"customs": {
"description": "Customs information for the shipment.",
"properties": {
"eori_number": {
"description": "The Economic Operators Registration and Identification (EORI) number to use for Customs. Required for bulk shipments to Europe.",
"maxLength": 5000,
"type": "string"
}
},
"title": "customs_param",
"type": "object"
},
"name": {
"description": "The name printed on the shipping label when shipping the card.",
"maxLength": 5000,
"type": "string"
},
"phone_number": {
"description": "Phone number of the recipient of the shipment.",
"type": "string"
},
"require_signature": {
"description": "Whether a signature is required for card delivery.",
"type": "boolean"
},
"service": {
"description": "Shipment service.",
"enum": [
"express",
"priority",
"standard"
],
"type": "string",
"x-stripeBypassValidation": true
},
"type": {
"description": "Packaging options.",
"enum": [
"bulk",
"individual"
],
"type": "string"
}
},
"required": [
"address",
"name"
],
"title": "shipping_specs",
"type": "object"
},
"spending_controls": {
"description": "Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.",
"properties": {
Expand Down Expand Up @@ -153941,6 +154144,73 @@
}
}
},
"/v1/test_helpers/issuing/cards/{card}/shipping/submit": {
"post": {
"description": "<p>Updates the shipping status of the specified Issuing <code>Card</code> object to <code>submitted</code>.</p>",
"operationId": "PostTestHelpersIssuingCardsCardShippingSubmit",
"parameters": [
{
"in": "path",
"name": "card",
"required": true,
"schema": {
"maxLength": 5000,
"type": "string"
},
"style": "simple"
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
"expand": {
"explode": true,
"style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
"maxLength": 5000,
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/issuing.card"
}
}
},
"description": "Successful response."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
},
"description": "Error response."
}
}
}
},
"/v1/test_helpers/refunds/{refund}/expire": {
"post": {
"description": "<p>Expire a refund with a status of <code>requires_action</code>.</p>",
Expand Down
Loading

0 comments on commit ad2afdd

Please sign in to comment.