8653696086

Committed 11 Apr 2024 09:49PM UTC coverage: 61.376% (-0.1%) from 61.521%

Build # 8653696086

Build Type

push

github

Committed by

ramya-stripe

Commit Message

Fix bad merge

Run Details

6 of 6 new or added lines in 1 file covered. (100.0%)

61 existing lines in 7 files now uncovered.

2417 of 3938 relevant lines covered (61.38%)

3.14 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/lib/Product.php

<?php

// File generated from our OpenAPI spec

namespace Stripe;

/**
 * Products describe the specific goods or services you offer to your customers.
 * For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
 * They can be used in conjunction with <a href="https://stripe.com/docs/api#prices">Prices</a> to configure pricing in Payment Links, Checkout, and Subscriptions.
 *
 * Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>,
 * <a href="https://stripe.com/docs/payment-links">share a Payment Link</a>,
 * <a href="https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront">accept payments with Checkout</a>,
 * and more about <a href="https://stripe.com/docs/products-prices/overview">Products and Prices</a>
 *
 * @property string $id Unique identifier for the object.
 * @property string $object String representing the object's type. Objects of the same type share the same value.
 * @property bool $active Whether the product is currently available for purchase.
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 * @property null|string|\Stripe\Price $default_price The ID of the <a href="https://stripe.com/docs/api/prices">Price</a> object that is the default price for this product.
 * @property null|string $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
 * @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
 * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
 * @property \Stripe\StripeObject[] $marketing_features A list of up to 15 marketing features for this product. These are displayed in <a href="https://stripe.com/docs/payments/checkout/pricing-table">pricing tables</a>.
 * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
 * @property string $name The product's name, meant to be displayable to the customer.
 * @property null|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
 * @property null|\Stripe\StripeObject $provisioning Provisioning configuration for this product.
 * @property null|bool $shippable Whether this product is shipped (i.e., physical goods).
 * @property null|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
 * @property null|string|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID.
 * @property string $type The type of the product. The product is either of type <code>good</code>, which is eligible for use with Orders and SKUs, or <code>service</code>, which is eligible for use with Subscriptions and Plans.
 * @property null|string $unit_label A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
 * @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
 * @property null|string $url A URL of a publicly-accessible webpage for this product.
 */
class Product extends ApiResource
{
    const OBJECT_NAME = 'product';

    use ApiOperations\All;
    use ApiOperations\Create;
    use ApiOperations\Delete;
    use ApiOperations\NestedResource;
    use ApiOperations\Retrieve;
    use ApiOperations\Search;
    use ApiOperations\Update;

    const TYPE_GOOD = 'good';
    const TYPE_SERVICE = 'service';

    /**
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SearchResult<\Stripe\Product> the product search results
     */
    public static function search($params = null, $opts = null)
    {
        $url = '/v1/products/search';

        return static::_requestPage($url, \Stripe\SearchResult::class, $params, $opts);
    }

    const PATH_FEATURES = '/features';

    /**
     * @param string $id the ID of the product on which to retrieve the product features
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Collection<\Stripe\ProductFeature> the list of product features
     */
    public static function allFeatures($id, $params = null, $opts = null)
    {
        return self::_allNestedResources($id, static::PATH_FEATURES, $params, $opts);
    }

    /**
     * @param string $id the ID of the product on which to create the product feature
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\ProductFeature
     */
    public static function createFeature($id, $params = null, $opts = null)
    {
        return self::_createNestedResource($id, static::PATH_FEATURES, $params, $opts);
    }

    /**
     * @param string $id the ID of the product to which the product feature belongs
     * @param string $featureId the ID of the product feature to delete
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\ProductFeature
     */
    public static function deleteFeature($id, $featureId, $params = null, $opts = null)
    {
        return self::_deleteNestedResource($id, static::PATH_FEATURES, $featureId, $params, $opts);
    }

    /**
     * @param string $id the ID of the product to which the product feature belongs
     * @param string $featureId the ID of the product feature to retrieve
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\ProductFeature
     */
    public static function retrieveFeature($id, $featureId, $params = null, $opts = null)
    {
        return self::_retrieveNestedResource($id, static::PATH_FEATURES, $featureId, $params, $opts);
    }
}

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* Products describe the specific goods or services you offer to your customers.
9	* For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
10	* They can be used in conjunction with <a href="https://stripe.com/docs/api#prices">Prices</a> to configure pricing in Payment Links, Checkout, and Subscriptions.
11	*
12	* Related guides: <a href="https://stripe.com/docs/billing/subscriptions/set-up-subscription">Set up a subscription</a>,
13	* <a href="https://stripe.com/docs/payment-links">share a Payment Link</a>,
14	* <a href="https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront">accept payments with Checkout</a>,
15	* and more about <a href="https://stripe.com/docs/products-prices/overview">Products and Prices</a>
16	*
17	* @property string $id Unique identifier for the object.
18	* @property string $object String representing the object's type. Objects of the same type share the same value.
19	* @property bool $active Whether the product is currently available for purchase.
20	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
21	* @property null\|string\|\Stripe\Price $default_price The ID of the <a href="https://stripe.com/docs/api/prices">Price</a> object that is the default price for this product.
22	* @property null\|string $description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
23	* @property string[] $images A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
24	* @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
25	* @property \Stripe\StripeObject[] $marketing_features A list of up to 15 marketing features for this product. These are displayed in <a href="https://stripe.com/docs/payments/checkout/pricing-table">pricing tables</a>.
26	* @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
27	* @property string $name The product's name, meant to be displayable to the customer.
28	* @property null\|\Stripe\StripeObject $package_dimensions The dimensions of this product for shipping purposes.
29	* @property null\|\Stripe\StripeObject $provisioning Provisioning configuration for this product.
30	* @property null\|bool $shippable Whether this product is shipped (i.e., physical goods).
31	* @property null\|string $statement_descriptor Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.
32	* @property null\|string\|\Stripe\TaxCode $tax_code A <a href="https://stripe.com/docs/tax/tax-categories">tax code</a> ID.
33	* @property string $type The type of the product. The product is either of type <code>good</code>, which is eligible for use with Orders and SKUs, or <code>service</code>, which is eligible for use with Subscriptions and Plans.
34	* @property null\|string $unit_label A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
35	* @property int $updated Time at which the object was last updated. Measured in seconds since the Unix epoch.
36	* @property null\|string $url A URL of a publicly-accessible webpage for this product.
37	*/
38	class Product extends ApiResource
39	{
40	const OBJECT_NAME = 'product';
41
42	use ApiOperations\All;
43	use ApiOperations\Create;
44	use ApiOperations\Delete;
45	use ApiOperations\NestedResource;
46	use ApiOperations\Retrieve;
47	use ApiOperations\Search;
48	use ApiOperations\Update;
49
50	const TYPE_GOOD = 'good';
51	const TYPE_SERVICE = 'service';
52
53	/**
54	* @param null\|array $params
55	* @param null\|array\|string $opts
56	*
57	* @throws \Stripe\Exception\ApiErrorException if the request fails
58	*
59	* @return \Stripe\SearchResult<\Stripe\Product> the product search results
60	*/
61	public static function search($params = null, $opts = null)	×
62	{
63	$url = '/v1/products/search';	×
64
65	return static::_requestPage($url, \Stripe\SearchResult::class, $params, $opts);	×
66	}
67
68	const PATH_FEATURES = '/features';
69
70	/**
71	* @param string $id the ID of the product on which to retrieve the product features
72	* @param null\|array $params
73	* @param null\|array\|string $opts
74	*
75	* @throws \Stripe\Exception\ApiErrorException if the request fails
76	*
77	* @return \Stripe\Collection<\Stripe\ProductFeature> the list of product features
78	*/
79	public static function allFeatures($id, $params = null, $opts = null)	×
80	{
81	return self::_allNestedResources($id, static::PATH_FEATURES, $params, $opts);	×
82	}
83
84	/**
85	* @param string $id the ID of the product on which to create the product feature
86	* @param null\|array $params
87	* @param null\|array\|string $opts
88	*
89	* @throws \Stripe\Exception\ApiErrorException if the request fails
90	*
91	* @return \Stripe\ProductFeature
92	*/
93	public static function createFeature($id, $params = null, $opts = null)	×
94	{
95	return self::_createNestedResource($id, static::PATH_FEATURES, $params, $opts);	×
96	}
97
98	/**
99	* @param string $id the ID of the product to which the product feature belongs
100	* @param string $featureId the ID of the product feature to delete
101	* @param null\|array $params
102	* @param null\|array\|string $opts
103	*
104	* @throws \Stripe\Exception\ApiErrorException if the request fails
105	*
106	* @return \Stripe\ProductFeature
107	*/
108	public static function deleteFeature($id, $featureId, $params = null, $opts = null)	×
109	{
110	return self::_deleteNestedResource($id, static::PATH_FEATURES, $featureId, $params, $opts);	×
111	}
112
113	/**
114	* @param string $id the ID of the product to which the product feature belongs
115	* @param string $featureId the ID of the product feature to retrieve
116	* @param null\|array $params
117	* @param null\|array\|string $opts
118	*
119	* @throws \Stripe\Exception\ApiErrorException if the request fails
120	*
121	* @return \Stripe\ProductFeature
122	*/
UNCOV 123	public static function retrieveFeature($id, $featureId, $params = null, $opts = null)	×
124	{
UNCOV 125	return self::_retrieveNestedResource($id, static::PATH_FEATURES, $featureId, $params, $opts);	×
126	}
127	}

stripe / stripe-php / 8653696086

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous