File Coverage

lib/Net/API/Stripe/Connect/Account/Relationship.pm
Criterion Covered Total %
statement 19 25 76.0
branch n/a
condition n/a
subroutine 7 13 53.8
pod 6 6 100.0
total 32 44 72.7


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Connect/Account/Relationship.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Connect::Account::Relationship;
11             BEGIN
12             {
13 2     2   21153560 use strict;
  2         12  
  2         71  
14 2     2   12 use warnings;
  2         4  
  2         55  
15 2     2   9 use parent qw( Net::API::Stripe::Generic );
  2         5  
  2         11  
16 2     2   138 use vars qw( $VERSION );
  2         5  
  2         145  
17 2     2   41 our( $VERSION ) = 'v0.100.0';
18             };
19              
20 2     2   11 use strict;
  2         8  
  2         38  
21 2     2   8 use warnings;
  2         5  
  2         317  
22              
23 0     0 1   sub director { return( shift->_set_get_boolean( 'director', @_ ) ); }
24              
25 0     0 1   sub executive { return( shift->_set_get_boolean( 'executive', @_ ) ); }
26              
27 0     0 1   sub owner { return( shift->_set_get_boolean( 'owner', @_ ) ); }
28              
29 0     0 1   sub percent_ownership { return( shift->_set_get_number( 'percent_ownership', @_ ) ); }
30              
31 0     0 1   sub representative { return( shift->_set_get_boolean( 'representative', @_ ) ); }
32              
33 0     0 1   sub title { return( shift->_set_get_scalar( 'title', @_ ) ); }
34              
35             1;
36              
37             __END__
38              
39             =encoding utf8
40              
41             =head1 NAME
42              
43             Net::API::Stripe::Connect::Account::Relationship - A Stripe Account Relationship Object
44              
45             =head1 SYNOPSIS
46              
47             my $rel = $stripe->person->relationship({
48             director => $stripe->true,
49             executive => $stripe->true,
50             owner => $stripe->true,
51             percent_ownership => 33,
52             representative => $stripe->true,
53             title => 'Representative Director',
54             });
55              
56             =head1 VERSION
57              
58             v0.100.0
59              
60             =head1 DESCRIPTION
61              
62             Describes the person’s relationship to the account.
63              
64             =head1 CONSTRUCTOR
65              
66             =head2 new( %ARG )
67              
68             Creates a new L<Net::API::Stripe::Connect::Account::Relationship> object.
69             It may also take an hash like arguments, that also are method of the same name.
70              
71             This is instantiated from the method B<relationship> in module L<Net::API::Stripe::Connect::Person>
72              
73             =head1 METHODS
74              
75             =head2 director boolean
76              
77             Whether the person is a director of the account’s legal entity. Currently only required for accounts in the EU. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.
78              
79             =head2 executive boolean
80              
81             Whether the person has significant responsibility to control, manage, or direct the organization.
82              
83             =head2 owner boolean
84              
85             Whether the person is an owner of the account’s legal entity.
86              
87             =head2 percent_ownership decimal
88              
89             The percent owned by the person of the account’s legal entity.
90              
91             =head2 representative boolean
92              
93             Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.
94              
95             =head2 title string
96              
97             The person’s title (e.g., CEO, Support Engineer).
98              
99             =head1 API SAMPLE
100              
101             {
102             "id": "person_fake123456789",
103             "object": "person",
104             "account": "acct_fake123456789",
105             "created": 1571602397,
106             "dob": {
107             "day": null,
108             "month": null,
109             "year": null
110             },
111             "first_name_kana": null,
112             "first_name_kanji": null,
113             "gender": null,
114             "last_name_kana": null,
115             "last_name_kanji": null,
116             "metadata": {},
117             "relationship": {
118             "director": false,
119             "executive": false,
120             "owner": false,
121             "percent_ownership": null,
122             "representative": false,
123             "title": null
124             },
125             "requirements": {
126             "currently_due": [],
127             "eventually_due": [],
128             "past_due": [],
129             "pending_verification": []
130             },
131             "verification": {
132             "additional_document": {
133             "back": null,
134             "details": null,
135             "details_code": null,
136             "front": null
137             },
138             "details": null,
139             "details_code": null,
140             "document": {
141             "back": null,
142             "details": null,
143             "details_code": null,
144             "front": null
145             },
146             "status": "unverified"
147             }
148             }
149              
150             =head1 HISTORY
151              
152             =head2 v0.1
153              
154             Initial version
155              
156             =head1 AUTHOR
157              
158             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
159              
160             =head1 SEE ALSO
161              
162             Stripe API documentation:
163              
164             L<https://stripe.com/docs/api/persons/object>
165              
166             =head1 COPYRIGHT & LICENSE
167              
168             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
169              
170             You can use, copy, modify and redistribute this package and associated
171             files under the same terms as Perl itself.
172              
173             =cut