6486516262

Committed 11 Oct 2023 06:25PM UTC coverage: 64.361% (-1.8%) from 66.134%

Build # 6486516262

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1588 from stripe/latest-codegen-beta

Update generated code for beta

Run Details

40 of 40 new or added lines in 3 files covered. (100.0%)

2429 of 3774 relevant lines covered (64.36%)

3.32 hits per line

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

66.67

/lib/SubscriptionSchedule.php

<?php

// File generated from our OpenAPI spec

namespace Stripe;

/**
 * A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
 *
 * Related guide: <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">Subscription schedules</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 null|string|\Stripe\StripeObject $application ID of the Connect Application that created the schedule.
 * @property null|string $billing_behavior Configures when the subscription schedule generates prorations for phase transitions. Possible values are <code>prorate_on_next_phase</code> or <code>prorate_up_front</code> with the default being <code>prorate_on_next_phase</code>. <code>prorate_on_next_phase</code> will apply phase changes and generate prorations at transition time.<code>prorate_up_front</code> will bill for all phases within the current billing cycle up front.
 * @property null|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
 * @property null|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 * @property null|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is <code>active</code>.
 * @property string|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
 * @property \Stripe\StripeObject $default_settings
 * @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are <code>release</code> or <code>cancel</code> with the default being <code>release</code>. <code>release</code> will end the subscription schedule and keep the underlying subscription running.<code>cancel</code> will end the subscription schedule and cancel the underlying subscription.
 * @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 null|\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 \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
 * @property null|\Stripe\StripeObject $prebilling Time period and invoice for a Subscription billed in advance.
 * @property null|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
 * @property null|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
 * @property string $status The present status of the subscription schedule. Possible values are <code>not_started</code>, <code>active</code>, <code>completed</code>, <code>released</code>, and <code>canceled</code>. You can read more about the different states in our <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">behavior guide</a>.
 * @property null|string|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
 * @property null|string|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.
 */
class SubscriptionSchedule extends ApiResource
{
    const OBJECT_NAME = 'subscription_schedule';

    use ApiOperations\All;
    use ApiOperations\Create;
    use ApiOperations\Retrieve;
    use ApiOperations\Update;

    const BILLING_BEHAVIOR_PRORATE_ON_NEXT_PHASE = 'prorate_on_next_phase';
    const BILLING_BEHAVIOR_PRORATE_UP_FRONT = 'prorate_up_front';

    const END_BEHAVIOR_CANCEL = 'cancel';
    const END_BEHAVIOR_NONE = 'none';
    const END_BEHAVIOR_RELEASE = 'release';
    const END_BEHAVIOR_RENEW = 'renew';

    const STATUS_ACTIVE = 'active';
    const STATUS_CANCELED = 'canceled';
    const STATUS_COMPLETED = 'completed';
    const STATUS_NOT_STARTED = 'not_started';
    const STATUS_RELEASED = 'released';

    /**
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule the amended subscription schedule
     */
    public function amend($params = null, $opts = null)
    {
        $url = $this->instanceUrl() . '/amend';
        list($response, $opts) = $this->_request('post', $url, $params, $opts);
        $this->refreshFrom($response, $opts);

        return $this;
    }

    /**
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule the canceled subscription schedule
     */
    public function cancel($params = null, $opts = null)
    {
        $url = $this->instanceUrl() . '/cancel';
        list($response, $opts) = $this->_request('post', $url, $params, $opts);
        $this->refreshFrom($response, $opts);

        return $this;
    }

    /**
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\SubscriptionSchedule the released subscription schedule
     */
    public function release($params = null, $opts = null)
    {
        $url = $this->instanceUrl() . '/release';
        list($response, $opts) = $this->_request('post', $url, $params, $opts);
        $this->refreshFrom($response, $opts);

        return $this;
    }
}

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe;
6
7	/**
8	* A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
9	*
10	* Related guide: <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">Subscription schedules</a>
11	*
12	* @property string $id Unique identifier for the object.
13	* @property string $object String representing the object's type. Objects of the same type share the same value.
14	* @property null\|string\|\Stripe\StripeObject $application ID of the Connect Application that created the schedule.
15	* @property null\|string $billing_behavior Configures when the subscription schedule generates prorations for phase transitions. Possible values are <code>prorate_on_next_phase</code> or <code>prorate_up_front</code> with the default being <code>prorate_on_next_phase</code>. <code>prorate_on_next_phase</code> will apply phase changes and generate prorations at transition time.<code>prorate_up_front</code> will bill for all phases within the current billing cycle up front.
16	* @property null\|int $canceled_at Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
17	* @property null\|int $completed_at Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
18	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
19	* @property null\|\Stripe\StripeObject $current_phase Object representing the start and end dates for the current phase of the subscription schedule, if it is <code>active</code>.
20	* @property string\|\Stripe\Customer $customer ID of the customer who owns the subscription schedule.
21	* @property \Stripe\StripeObject $default_settings
22	* @property string $end_behavior Behavior of the subscription schedule and underlying subscription when it ends. Possible values are <code>release</code> or <code>cancel</code> with the default being <code>release</code>. <code>release</code> will end the subscription schedule and keep the underlying subscription running.<code>cancel</code> will end the subscription schedule and cancel the underlying subscription.
23	* @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.
24	* @property null\|\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.
25	* @property \Stripe\StripeObject[] $phases Configuration for the subscription schedule's phases.
26	* @property null\|\Stripe\StripeObject $prebilling Time period and invoice for a Subscription billed in advance.
27	* @property null\|int $released_at Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
28	* @property null\|string $released_subscription ID of the subscription once managed by the subscription schedule (if it is released).
29	* @property string $status The present status of the subscription schedule. Possible values are <code>not_started</code>, <code>active</code>, <code>completed</code>, <code>released</code>, and <code>canceled</code>. You can read more about the different states in our <a href="https://stripe.com/docs/billing/subscriptions/subscription-schedules">behavior guide</a>.
30	* @property null\|string\|\Stripe\Subscription $subscription ID of the subscription managed by the subscription schedule.
31	* @property null\|string\|\Stripe\TestHelpers\TestClock $test_clock ID of the test clock this subscription schedule belongs to.
32	*/
33	class SubscriptionSchedule extends ApiResource
34	{
35	const OBJECT_NAME = 'subscription_schedule';
36
37	use ApiOperations\All;
38	use ApiOperations\Create;
39	use ApiOperations\Retrieve;
40	use ApiOperations\Update;
41
42	const BILLING_BEHAVIOR_PRORATE_ON_NEXT_PHASE = 'prorate_on_next_phase';
43	const BILLING_BEHAVIOR_PRORATE_UP_FRONT = 'prorate_up_front';
44
45	const END_BEHAVIOR_CANCEL = 'cancel';
46	const END_BEHAVIOR_NONE = 'none';
47	const END_BEHAVIOR_RELEASE = 'release';
48	const END_BEHAVIOR_RENEW = 'renew';
49
50	const STATUS_ACTIVE = 'active';
51	const STATUS_CANCELED = 'canceled';
52	const STATUS_COMPLETED = 'completed';
53	const STATUS_NOT_STARTED = 'not_started';
54	const STATUS_RELEASED = 'released';
55
56	/**
57	* @param null\|array $params
58	* @param null\|array\|string $opts
59	*
60	* @throws \Stripe\Exception\ApiErrorException if the request fails
61	*
62	* @return \Stripe\SubscriptionSchedule the amended subscription schedule
63	*/
64	public function amend($params = null, $opts = null)	×
65	{
66	$url = $this->instanceUrl() . '/amend';	×
67	list($response, $opts) = $this->_request('post', $url, $params, $opts);	×
68	$this->refreshFrom($response, $opts);	×
69
70	return $this;	×
71	}
72
73	/**
74	* @param null\|array $params
75	* @param null\|array\|string $opts
76	*
77	* @throws \Stripe\Exception\ApiErrorException if the request fails
78	*
79	* @return \Stripe\SubscriptionSchedule the canceled subscription schedule
80	*/
81	public function cancel($params = null, $opts = null)	1✔
82	{
83	$url = $this->instanceUrl() . '/cancel';	1✔
84	list($response, $opts) = $this->_request('post', $url, $params, $opts);	1✔
85	$this->refreshFrom($response, $opts);	1✔
86
87	return $this;	1✔
88	}
89
90	/**
91	* @param null\|array $params
92	* @param null\|array\|string $opts
93	*
94	* @throws \Stripe\Exception\ApiErrorException if the request fails
95	*
96	* @return \Stripe\SubscriptionSchedule the released subscription schedule
97	*/
98	public function release($params = null, $opts = null)	1✔
99	{
100	$url = $this->instanceUrl() . '/release';	1✔
101	list($response, $opts) = $this->_request('post', $url, $params, $opts);	1✔
102	$this->refreshFrom($response, $opts);	1✔
103
104	return $this;	1✔
105	}
106	}

stripe / stripe-php / 6486516262

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