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