From 57902007232db2f83ce8b16afc473646738f8e0c Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Wed, 20 Mar 2024 17:43:33 +0000 Subject: [PATCH] Update OpenAPI for 03864d6dbb160bb9c17223729a543b8771def95f --- embedded/openapi/spec3.beta.sdk.json | 391 ++++++++++++++++++++++++++- embedded/openapi/spec3.json | 14 +- 2 files changed, 387 insertions(+), 18 deletions(-) diff --git a/embedded/openapi/spec3.beta.sdk.json b/embedded/openapi/spec3.beta.sdk.json index 9213e710..00dbf5bc 100644 --- a/embedded/openapi/spec3.beta.sdk.json +++ b/embedded/openapi/spec3.beta.sdk.json @@ -14026,6 +14026,43 @@ "in_package": "" } }, + "deleted_product_feature": { + "description": "", + "properties": { + "deleted": { + "description": "Always true for a deleted object", + "enum": [ + true + ], + "type": "boolean" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "deleted", + "id", + "object" + ], + "title": "DeletedProductFeature", + "type": "object", + "x-expandableFields": [], + "x-resourceId": "deleted_product_feature", + "x-stripeResource": { + "class_name": "DeletedProductFeature", + "in_package": "" + } + }, "deleted_radar.value_list": { "description": "", "properties": { @@ -46729,9 +46766,9 @@ "type": "string" }, "features": { - "description": "A list of up to 15 features for this product. Entries using `name` are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { - "$ref": "#/components/schemas/product_feature" + "$ref": "#/components/schemas/product_marketing_feature" }, "type": "array" }, @@ -46975,6 +47012,70 @@ } }, "product_feature": { + "description": "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.", + "properties": { + "entitlement_feature": { + "$ref": "#/components/schemas/entitlements.feature" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "product_feature" + ], + "type": "string" + } + }, + "required": [ + "entitlement_feature", + "id", + "livemode", + "object" + ], + "title": "ProductFeature", + "type": "object", + "x-expandableFields": [ + "entitlement_feature" + ], + "x-resourceId": "product_feature", + "x-stripeOperations": [ + { + "method_name": "delete", + "method_on": "service", + "method_type": "delete", + "operation": "delete", + "path": "/v1/products/{product}/features/{id}" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/products/{product}/features" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/products/{product}/features" + } + ], + "x-stripeResource": { + "class_name": "ProductFeature", + "has_collection_class": true, + "in_package": "" + } + }, + "product_marketing_feature": { "description": "", "properties": { "feature": { @@ -46987,7 +47088,6 @@ "$ref": "#/components/schemas/entitlements.feature" } ], - "description": "The ID of the [Feature](docs/api/entitlements/feature) object. This property is mutually-exclusive with `name`; either one must be specified, but not both.", "x-expansionResources": { "oneOf": [ { @@ -46997,12 +47097,12 @@ } }, "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, - "title": "ProductFeature", + "title": "ProductMarketingFeature", "type": "object", "x-expandableFields": [ "feature" @@ -155034,16 +155134,15 @@ "type": "array" }, "features": { - "description": "A list of up to 15 features for this product. Entries using `name` are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { "feature": { - "description": "The ID of the [Feature](docs/api/entitlements/feature) object. This property is mutually-exclusive with `name`; either one must be specified, but not both.", "maxLength": 5000, "type": "string" }, "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } @@ -155572,12 +155671,11 @@ "items": { "properties": { "feature": { - "description": "The ID of the [Feature](docs/api/entitlements/feature) object. This property is mutually-exclusive with `name`; either one must be specified, but not both.", "maxLength": 5000, "type": "string" }, "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } @@ -155597,7 +155695,7 @@ "type": "string" } ], - "description": "A list of up to 15 features for this product. Entries using `name` are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." }, "images": { "anyOf": [ @@ -155760,6 +155858,277 @@ } } }, + "/v1/products/{product}/features": { + "get": { + "description": "

Retrieve a list of features for a product

", + "operationId": "GetProductsProductFeatures", + "parameters": [ + { + "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/product_feature" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "EntitlementsResourceProductFeatureList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "

Creates a product_feature, which represents a feature attachment to a product

", + "operationId": "PostProductsProductFeatures", + "parameters": [ + { + "in": "path", + "name": "product", + "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": { + "entitlement_feature": { + "description": "The ID of the [Feature](docs/api/entitlements/feature) object attached to this product.", + "maxLength": 5000, + "type": "string" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "entitlement_feature" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/product_feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/products/{product}/features/{id}": { + "delete": { + "description": "

Deletes the feature attachment to a product

", + "operationId": "DeleteProductsProductFeaturesId", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + }, + { + "in": "path", + "name": "product", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleted_product_feature" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/promotion_codes": { "get": { "description": "

Returns a list of your promotion codes.

", diff --git a/embedded/openapi/spec3.json b/embedded/openapi/spec3.json index 00cc439f..42648ee8 100644 --- a/embedded/openapi/spec3.json +++ b/embedded/openapi/spec3.json @@ -32879,9 +32879,9 @@ "type": "string" }, "features": { - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { - "$ref": "#/components/schemas/product_feature" + "$ref": "#/components/schemas/product_marketing_feature" }, "type": "array" }, @@ -33002,16 +33002,16 @@ ], "x-resourceId": "product" }, - "product_feature": { + "product_marketing_feature": { "description": "", "properties": { "name": { - "description": "The feature's name. Up to 80 characters long.", + "description": "The marketing feature name. Up to 80 characters long.", "maxLength": 5000, "type": "string" } }, - "title": "ProductFeature", + "title": "ProductMarketingFeature", "type": "object", "x-expandableFields": [] }, @@ -112514,7 +112514,7 @@ "type": "array" }, "features": { - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).", "items": { "properties": { "name": { @@ -113002,7 +113002,7 @@ "type": "string" } ], - "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." + "description": "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)." }, "images": { "anyOf": [