File Coverage

lib/Net/API/Stripe/Financial/Connections/Session.pm
Criterion Covered Total %
statement 7 16 43.7
branch n/a
condition n/a
subroutine 3 12 25.0
pod 9 9 100.0
total 19 37 51.3


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Financial/Connections/Session.pm
3             ## Version v0.1.0
4             ## Copyright(c) 2022 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2022/10/29
7             ## Modified 2022/10/29
8             ##
9             ##----------------------------------------------------------------------------
10             BEGIN
11             {
12             use strict;
13 2     2   24223954 use parent qw( Net::API::Stripe::Generic );
  2         13  
  2         69  
14 2     2   11 our( $VERSION ) = 'v0.1.0';
  2         5  
  2         10  
15 2     2   591 };
16              
17              
18 0     0 1    
19              
20 0     0 1    
21              
22 0     0 1   { countries => { type => "array" } }, @_ ) ); }
23              
24 0     0 1    
25              
26 0     0 1    
27             1;
28 0     0 1   # NOTE: POD
29              
30             =encoding utf8
31 0     0 1    
32             =head1 NAME
33 0     0 1    
34             Net::API::Stripe::Financial::Connections::Session - The Session object
35 0     0 1    
36             =head1 SYNOPSIS
37              
38             =head1 VERSION
39              
40             v0.1.0
41              
42             =head1 DESCRIPTION
43              
44             A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.
45              
46              
47             =head1 METHODS
48              
49             =head2 id string
50              
51             Unique identifier for the object.
52              
53             =head2 object string
54              
55             String representing the object's type. Objects of the same type share the same value.
56              
57             =head2 account_holder object
58              
59             The account holder for whom accounts are collected in this session.
60              
61             This is a L<Net::API::Stripe::Payment::Source> object.
62              
63             =head2 accounts object
64              
65             The accounts that were collected as part of this Session.
66              
67             This is a L<Net::API::Stripe::List> object.
68              
69             =head2 client_secret string
70              
71             A value that will be passed to the client to launch the authentication flow.
72              
73             =head2 filters hash
74              
75             Filters applied to this session that restrict the kinds of accounts to collect.
76              
77             It has the following properties:
78              
79             =over 4
80              
81             =item C<countries> string_array
82              
83             List of countries from which to filter accounts.
84              
85             =back
86              
87             =head2 livemode boolean
88              
89             Has the value C<true> if the object exists in live mode or the value C<false> if the object exists in test mode.
90              
91             =head2 permissions array
92              
93             Permissions requested for accounts collected during this session.
94              
95             =head2 return_url string
96              
97             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.
98              
99             =head1 API SAMPLE
100              
101             [
102             {
103             "accountholder" : {
104             "account" : "acct_1KdUF8RhmIBPIfCO",
105             "type" : "account"
106             },
107             "client_secret" : "fcsess_client_secret_PZri8EdhlStQTdnecntKdjnx",
108             "filters" : {
109             "countries" : [
110             "US"
111             ]
112             },
113             "id" : "fcsess_1LE8to2eZvKYlo2CeCL5ftCO",
114             "linked_accounts" : {
115             "data" : [],
116             "has_more" : 0,
117             "object" : "list",
118             "url" : "/v1/linked_accounts"
119             },
120             "livemode" : 0,
121             "object" : "link_account_session",
122             "permissions" : [
123             "ownership",
124             "payment_method"
125             ]
126             }
127             ]
128              
129             =head1 HISTORY
130              
131             =head2 v0.1.0
132              
133             Initial version
134              
135             =head1 AUTHOR
136              
137             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
138              
139             =head1 SEE ALSO
140              
141             L<Stripe API documentation|https://stripe.com/docs/api/financial_connections/session>
142              
143             =head1 COPYRIGHT & LICENSE
144              
145             Copyright (c) 2019-2022 DEGUEST Pte. Ltd.
146              
147             You can use, copy, modify and redistribute this package and associated
148             files under the same terms as Perl itself.
149              
150             =cut