diff --git a/openapi/spec3.beta.sdk.json b/openapi/spec3.beta.sdk.json index c276595e..ea135f52 100644 --- a/openapi/spec3.beta.sdk.json +++ b/openapi/spec3.beta.sdk.json @@ -12079,6 +12079,7 @@ "issuing_card.updated", "issuing_card_design.activated", "issuing_card_design.deactivated", + "issuing_card_design.rejected", "issuing_card_design.updated", "issuing_cardholder.created", "issuing_cardholder.updated", @@ -18625,6 +18626,9 @@ "issuing.card_bundle": { "description": "A Card Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.", "properties": { + "features": { + "$ref": "#/components/schemas/issuing_card_bundle_features" + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -18674,7 +18678,9 @@ ], "title": "IssuingCardBundle", "type": "object", - "x-expandableFields": [], + "x-expandableFields": [ + "features" + ], "x-resourceId": "issuing.card_bundle", "x-stripeOperations": [ { @@ -18720,6 +18726,35 @@ ] } }, + "card_logo": { + "anyOf": [ + { + "maxLength": 5000, + "type": "string" + }, + { + "$ref": "#/components/schemas/file" + } + ], + "description": "The file for the card logo, for use with card bundles that support card logos.", + "nullable": true, + "x-expansionResources": { + "oneOf": [ + { + "$ref": "#/components/schemas/file" + } + ] + } + }, + "carrier_text": { + "anyOf": [ + { + "$ref": "#/components/schemas/issuing_physical_card_design_carrier_text" + } + ], + "description": "Hash containing carrier text, for use with card bundles that support carrier text.", + "nullable": true + }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, @@ -18761,6 +18796,9 @@ ], "type": "string" }, + "rejection_reasons": { + "$ref": "#/components/schemas/issuing_physical_card_design_rejection_reasons" + }, "status": { "description": "Whether this card design can be used to create cards.", "enum": [ @@ -18774,18 +18812,24 @@ }, "required": [ "card_bundle", + "card_logo", + "carrier_text", "id", "lookup_key", "metadata", "name", "object", "preference", + "rejection_reasons", "status" ], "title": "IssuingPhysicalCardDesign", "type": "object", "x-expandableFields": [ - "card_bundle" + "card_bundle", + "card_logo", + "carrier_text", + "rejection_reasons" ], "x-resourceId": "issuing.card_design", "x-stripeOperations": [ @@ -18803,6 +18847,13 @@ "operation": "get", "path": "/v1/issuing/card_designs/{card_design}" }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/issuing/card_designs" + }, { "method_name": "update", "method_on": "service", @@ -18823,6 +18874,13 @@ "method_type": "custom", "operation": "post", "path": "/v1/test_helpers/issuing/card_designs/{card_design}/status/deactivate" + }, + { + "method_name": "reject_testmode", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/test_helpers/issuing/card_designs/{card_design}/status/reject" } ], "x-stripeResource": { @@ -20507,6 +20565,40 @@ "in_package": "" } }, + "issuing_card_bundle_features": { + "description": "", + "properties": { + "card_logo": { + "description": "The policy for how to use card logo images in a card design with this card bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + }, + "carrier_text": { + "description": "The policy for how to use carrier letter text in a card design with this card bundle.", + "enum": [ + "optional", + "required", + "unsupported" + ], + "type": "string" + } + }, + "required": [ + "card_logo", + "carrier_text" + ], + "title": "IssuingCardBundleFeatures", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "CardBundleFeatures", + "in_package": "" + } + }, "issuing_card_google_pay": { "description": "", "properties": { @@ -23029,6 +23121,99 @@ "in_package": "" } }, + "issuing_physical_card_design_carrier_text": { + "description": "", + "properties": { + "footer_body": { + "description": "The footer body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "footer_title": { + "description": "The footer title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_body": { + "description": "The header body text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + }, + "header_title": { + "description": "The header title text of the carrier letter.", + "maxLength": 5000, + "nullable": true, + "type": "string" + } + }, + "required": [ + "footer_body", + "footer_title", + "header_body", + "header_title" + ], + "title": "IssuingPhysicalCardDesignCarrierText", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "CarrierText", + "in_package": "" + } + }, + "issuing_physical_card_design_rejection_reasons": { + "description": "", + "properties": { + "card_logo": { + "description": "The reason(s) the card logo was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_binary_image", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "carrier_text": { + "description": "The reason(s) the carrier text was rejected.", + "items": { + "enum": [ + "geographic_location", + "inappropriate", + "network_name", + "non_fiat_currency", + "other", + "other_entity", + "promotional_material" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + } + }, + "required": [ + "card_logo", + "carrier_text" + ], + "title": "IssuingPhysicalCardDesignRejectionReasons", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "RejectionReasons", + "in_package": "" + } + }, "issuing_transaction_amount_details": { "description": "", "properties": { @@ -93636,6 +93821,135 @@ "description": "Error response." } } + }, + "post": { + "description": "
Creates a card design object.
", + "operationId": "PostIssuingCardDesigns", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "carrier_text": { + "explode": true, + "style": "deepObject" + }, + "expand": { + "explode": true, + "style": "deepObject" + }, + "metadata": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "card_bundle": { + "description": "The card bundle object belonging to this card design.", + "maxLength": 5000, + "type": "string" + }, + "card_logo": { + "description": "The file for the card logo, for use with card bundles that support card logos.", + "type": "string" + }, + "carrier_text": { + "description": "Hash containing carrier text, for use with card bundles that support carrier text.", + "properties": { + "footer_body": { + "description": "The footer body text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "footer_title": { + "description": "The footer title text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "header_body": { + "description": "The header body text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "header_title": { + "description": "The header title text of the carrier letter.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "carrier_text_param", + "type": "object" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "lookup_key": { + "description": "A lookup key used to retrieve card designs dynamically from a static string. This may be up to 200 characters.", + "maxLength": 200, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "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`.", + "type": "object" + }, + "name": { + "description": "Friendly display name.", + "maxLength": 200, + "type": "string" + }, + "preference": { + "description": "Whether this card design is used to create cards when one is not specified.", + "enum": [ + "default", + "none" + ], + "type": "string" + }, + "transfer_lookup_key": { + "description": "If set to true, will atomically remove the lookup key from the existing card design, and assign it to this card design.", + "type": "boolean" + } + }, + "required": [ + "card_bundle" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/issuing.card_design" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } } }, "/v1/issuing/card_designs/{card_design}": { @@ -93724,6 +94038,10 @@ "content": { "application/x-www-form-urlencoded": { "encoding": { + "carrier_text": { + "explode": true, + "style": "deepObject" + }, "expand": { "explode": true, "style": "deepObject" @@ -93736,6 +94054,42 @@ "schema": { "additionalProperties": false, "properties": { + "card_bundle": { + "description": "The card bundle object belonging to this card design.", + "maxLength": 5000, + "type": "string" + }, + "card_logo": { + "description": "The file for the card logo, for use with card bundles that support card logos.", + "type": "string" + }, + "carrier_text": { + "description": "Hash containing carrier text, for use with card bundles that support carrier text.", + "properties": { + "footer_body": { + "description": "The footer body text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "footer_title": { + "description": "The footer title text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "header_body": { + "description": "The header body text of the carrier letter.", + "maxLength": 5000, + "type": "string" + }, + "header_title": { + "description": "The header title text of the carrier letter.", + "maxLength": 5000, + "type": "string" + } + }, + "title": "carrier_text_param", + "type": "object" + }, "expand": { "description": "Specifies which fields in the response should be expanded.", "items": { @@ -156243,6 +156597,120 @@ } } }, + "/v1/test_helpers/issuing/card_designs/{card_design}/status/reject": { + "post": { + "description": "Updates the status
of the specified testmode card design object to rejected
.
Updates the shipping status of the specified Issuing Card
object to delivered
.
Creates a card design object.
+ operationId: PostIssuingCardDesigns + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + carrier_text: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + card_bundle: + description: The card bundle object belonging to this card design. + maxLength: 5000 + type: string + card_logo: + description: >- + The file for the card logo, for use with card bundles that + support card logos. + type: string + carrier_text: + description: >- + Hash containing carrier text, for use with card bundles that + support carrier text. + properties: + footer_body: + description: The footer body text of the carrier letter. + maxLength: 5000 + type: string + footer_title: + description: The footer title text of the carrier letter. + maxLength: 5000 + type: string + header_body: + description: The header body text of the carrier letter. + maxLength: 5000 + type: string + header_title: + description: The header title text of the carrier letter. + maxLength: 5000 + type: string + title: carrier_text_param + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + lookup_key: + description: >- + A lookup key used to retrieve card designs dynamically from + a static string. This may be up to 200 characters. + maxLength: 200 + type: string + metadata: + additionalProperties: + type: string + description: >- + 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`. + type: object + name: + description: Friendly display name. + maxLength: 200 + type: string + preference: + description: >- + Whether this card design is used to create cards when one is + not specified. + enum: + - default + - none + type: string + transfer_lookup_key: + description: >- + If set to true, will atomically remove the lookup key from + the existing card design, and assign it to this card design. + type: boolean + required: + - card_bundle + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.card_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/issuing/card_designs/{card_design}': get: description:Retrieves a card design object.
@@ -85252,6 +85507,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + carrier_text: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -85261,6 +85519,38 @@ paths: schema: additionalProperties: false properties: + card_bundle: + description: The card bundle object belonging to this card design. + maxLength: 5000 + type: string + card_logo: + description: >- + The file for the card logo, for use with card bundles that + support card logos. + type: string + carrier_text: + description: >- + Hash containing carrier text, for use with card bundles that + support carrier text. + properties: + footer_body: + description: The footer body text of the carrier letter. + maxLength: 5000 + type: string + footer_title: + description: The footer title text of the carrier letter. + maxLength: 5000 + type: string + header_body: + description: The header body text of the carrier letter. + maxLength: 5000 + type: string + header_title: + description: The header title text of the carrier letter. + maxLength: 5000 + type: string + title: carrier_text_param + type: object expand: description: Specifies which fields in the response should be expanded. items: @@ -146556,6 +146846,88 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/card_designs/{card_design}/status/reject': + post: + description: >- +Updates the status
of the specified testmode card design
+ object to rejected
.