9308533534

Committed 30 May 2024 08:07PM UTC coverage: 65.24% (-0.9%) from 66.176%

Build # 9308533534

Build Type

push

github

Committed by

web-flow

Commit Message

Added PHPDocs for `create`, `update`, `delete`, `all`, `retrieve` methods after moving them out of traits.  (#1701)

* Demagiced crudl operation

* Improvements from codegen#1452

* Updated override to fix indents

Run Details

1080 of 1682 new or added lines in 106 files covered. (64.21%)

15 existing lines in 3 files now uncovered.

3444 of 5279 relevant lines covered (65.24%)

2.29 hits per line

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

0.0

/lib/Identity/VerificationReport.php

<?php

// File generated from our OpenAPI spec

namespace Stripe\Identity;

/**
 * A VerificationReport is the result of an attempt to collect and verify data from a user.
 * The collection of verification checks performed is determined from the <code>type</code> and <code>options</code>
 * parameters used. You can find the result of each verification check performed in the
 * appropriate sub-resource: <code>document</code>, <code>id_number</code>, <code>selfie</code>.
 *
 * Each VerificationReport contains a copy of any data collected by the user as well as
 * reference IDs which can be used to access collected images through the <a href="https://stripe.com/docs/api/files">FileUpload</a>
 * API. To configure and create VerificationReports, use the
 * <a href="https://stripe.com/docs/api/identity/verification_sessions">VerificationSession</a> API.
 *
 * Related guides: <a href="https://stripe.com/docs/identity/verification-sessions#results">Accessing verification results</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 $client_reference_id A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
 * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
 * @property null|\Stripe\StripeObject $document Result from a document check
 * @property null|\Stripe\StripeObject $email Result from a email check
 * @property null|\Stripe\StripeObject $id_number Result from an id_number check
 * @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 $options
 * @property null|\Stripe\StripeObject $phone Result from a phone check
 * @property null|\Stripe\StripeObject $selfie Result from a selfie check
 * @property string $type Type of report.
 * @property null|string $verification_flow The configuration token of a Verification Flow from the dashboard.
 * @property null|string $verification_session ID of the VerificationSession that created this report.
 */
class VerificationReport extends \Stripe\ApiResource
{
    const OBJECT_NAME = 'identity.verification_report';

    const TYPE_DOCUMENT = 'document';
    const TYPE_ID_NUMBER = 'id_number';
    const TYPE_VERIFICATION_FLOW = 'verification_flow';

    /**
     * List all verification reports.
     *
     * @param null|array $params
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Collection<\Stripe\Identity\VerificationReport> of ApiResources
     */
    public static function all($params = null, $opts = null)
    {
        $url = static::classUrl();

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

    /**
     * Retrieves an existing VerificationReport.
     *
     * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
     * @param null|array|string $opts
     *
     * @throws \Stripe\Exception\ApiErrorException if the request fails
     *
     * @return \Stripe\Identity\VerificationReport
     */
    public static function retrieve($id, $opts = null)
    {
        $opts = \Stripe\Util\RequestOptions::parse($opts);
        $instance = new static($id, $opts);
        $instance->refresh();

        return $instance;
    }
}

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Identity;
6
7	/**
8	* A VerificationReport is the result of an attempt to collect and verify data from a user.
9	* The collection of verification checks performed is determined from the <code>type</code> and <code>options</code>
10	* parameters used. You can find the result of each verification check performed in the
11	* appropriate sub-resource: <code>document</code>, <code>id_number</code>, <code>selfie</code>.
12	*
13	* Each VerificationReport contains a copy of any data collected by the user as well as
14	* reference IDs which can be used to access collected images through the <a href="https://stripe.com/docs/api/files">FileUpload</a>
15	* API. To configure and create VerificationReports, use the
16	* <a href="https://stripe.com/docs/api/identity/verification_sessions">VerificationSession</a> API.
17	*
18	* Related guides: <a href="https://stripe.com/docs/identity/verification-sessions#results">Accessing verification results</a>.
19	*
20	* @property string $id Unique identifier for the object.
21	* @property string $object String representing the object's type. Objects of the same type share the same value.
22	* @property null\|string $client_reference_id A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
23	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
24	* @property null\|\Stripe\StripeObject $document Result from a document check
25	* @property null\|\Stripe\StripeObject $email Result from a email check
26	* @property null\|\Stripe\StripeObject $id_number Result from an id_number check
27	* @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.
28	* @property null\|\Stripe\StripeObject $options
29	* @property null\|\Stripe\StripeObject $phone Result from a phone check
30	* @property null\|\Stripe\StripeObject $selfie Result from a selfie check
31	* @property string $type Type of report.
32	* @property null\|string $verification_flow The configuration token of a Verification Flow from the dashboard.
33	* @property null\|string $verification_session ID of the VerificationSession that created this report.
34	*/
35	class VerificationReport extends \Stripe\ApiResource
36	{
37	const OBJECT_NAME = 'identity.verification_report';
38
39	const TYPE_DOCUMENT = 'document';
40	const TYPE_ID_NUMBER = 'id_number';
41	const TYPE_VERIFICATION_FLOW = 'verification_flow';
42
43	/**
44	* List all verification reports.
45	*
46	* @param null\|array $params
47	* @param null\|array\|string $opts
48	*
49	* @throws \Stripe\Exception\ApiErrorException if the request fails
50	*
51	* @return \Stripe\Collection<\Stripe\Identity\VerificationReport> of ApiResources
52	*/
NEW 53	public static function all($params = null, $opts = null)	×
54	{
NEW 55	$url = static::classUrl();	×
56
NEW 57	return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);	×
58	}
59
60	/**
61	* Retrieves an existing VerificationReport.
62	*
63	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
64	* @param null\|array\|string $opts
65	*
66	* @throws \Stripe\Exception\ApiErrorException if the request fails
67	*
68	* @return \Stripe\Identity\VerificationReport
69	*/
NEW 70	public static function retrieve($id, $opts = null)	×
71	{
NEW 72	$opts = \Stripe\Util\RequestOptions::parse($opts);	×
NEW 73	$instance = new static($id, $opts);	×
NEW 74	$instance->refresh();	×
75
NEW 76	return $instance;	×
77	}
78	}

stripe / stripe-php / 9308533534

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