• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

stripe / stripe-php / 9308533534

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

push

github

web-flow
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

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/FinancialConnections/Session.php
1
<?php
2

3
// File generated from our OpenAPI spec
4

5
namespace Stripe\FinancialConnections;
6

7
/**
8
 * A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
9
 *
10
 * @property string $id Unique identifier for the object.
11
 * @property string $object String representing the object's type. Objects of the same type share the same value.
12
 * @property null|\Stripe\StripeObject $account_holder The account holder for whom accounts are collected in this session.
13
 * @property \Stripe\Collection<\Stripe\FinancialConnections\Account> $accounts The accounts that were collected as part of this Session.
14
 * @property string $client_secret A value that will be passed to the client to launch the authentication flow.
15
 * @property null|\Stripe\StripeObject $filters
16
 * @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.
17
 * @property string[] $permissions Permissions requested for accounts collected during this session.
18
 * @property null|string[] $prefetch Data features requested to be retrieved upon account creation.
19
 * @property null|string $return_url For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
20
 */
21
class Session extends \Stripe\ApiResource
22
{
23
    const OBJECT_NAME = 'financial_connections.session';
24

25
    /**
26
     * To launch the Financial Connections authorization flow, create a
27
     * <code>Session</code>. The session’s <code>client_secret</code> can be used to
28
     * launch the flow using Stripe.js.
29
     *
30
     * @param null|array $params
31
     * @param null|array|string $options
32
     *
33
     * @throws \Stripe\Exception\ApiErrorException if the request fails
34
     *
35
     * @return \Stripe\FinancialConnections\Session the created resource
36
     */
NEW
37
    public static function create($params = null, $options = null)
×
38
    {
NEW
39
        self::_validateParams($params);
×
NEW
40
        $url = static::classUrl();
×
41

NEW
42
        list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
×
NEW
43
        $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
×
NEW
44
        $obj->setLastResponse($response);
×
45

NEW
46
        return $obj;
×
47
    }
48

49
    /**
50
     * Retrieves the details of a Financial Connections <code>Session</code>.
51
     *
52
     * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
53
     * @param null|array|string $opts
54
     *
55
     * @throws \Stripe\Exception\ApiErrorException if the request fails
56
     *
57
     * @return \Stripe\FinancialConnections\Session
58
     */
NEW
59
    public static function retrieve($id, $opts = null)
×
60
    {
NEW
61
        $opts = \Stripe\Util\RequestOptions::parse($opts);
×
NEW
62
        $instance = new static($id, $opts);
×
NEW
63
        $instance->refresh();
×
64

NEW
65
        return $instance;
×
66
    }
67
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2024 Coveralls, Inc