File Coverage

lib/Net/API/Stripe/Order/StatusTransitions.pm
Criterion Covered Total %
statement 19 23 82.6
branch n/a
condition n/a
subroutine 7 11 63.6
pod 4 4 100.0
total 30 38 78.9


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Order/StatusTransitions.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 1     1   1049 use warnings;
  1         3  
  1         34  
14 1     1   6 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         34  
15 1     1   5 use vars qw( $VERSION );
  1         2  
  1         6  
16 1     1   75 our( $VERSION ) = 'v0.100.0';
  1         2  
  1         57  
17 1     1   19 };
18              
19             use strict;
20 1     1   6 use warnings;
  1         2  
  1         40  
21 1     1   8  
  1         2  
  1         164  
22              
23 0     0 1    
24              
25 0     0 1    
26             1;
27 0     0 1    
28              
29 0     0 1   =encoding utf8
30              
31             =head1 NAME
32              
33             Net::API::Stripe::Order::StatusTransitions - A Stripe Order Status Transitions Object
34              
35             =head1 SYNOPSIS
36              
37             my $st = $order->status_transitions({
38             canceled => undef,
39             fulfiled => '2020-04-12',
40             paid => '2020-04-30',
41             returned => undef,
42             });
43              
44             =head1 VERSION
45              
46             v0.100.0
47              
48             =head1 DESCRIPTION
49              
50             The timestamps at which the order status was updated.
51              
52             This is instantiated by method B<status_transitions> in module L<Net::API::Stripe::Order>
53              
54             =head1 CONSTRUCTOR
55              
56             =head2 new( %ARG )
57              
58             Creates a new L<Net::API::Stripe::Order::StatusTransitions> object.
59             It may also take an hash like arguments, that also are method of the same name.
60              
61             =head1 METHODS
62              
63             =head2 canceled timestamp
64              
65             When set, this returns a C<DateTime> object.
66              
67             =head2 fulfiled timestamp
68              
69             When set, this returns a C<DateTime> object.
70              
71             =head2 paid timestamp
72              
73             When set, this returns a C<DateTime> object.
74              
75             =head2 returned timestamp
76              
77             When set, this returns a C<DateTime> object.
78              
79             =head1 API SAMPLE
80              
81             {
82             "id": "or_fake123456789",
83             "object": "order",
84             "amount": 1500,
85             "amount_returned": null,
86             "application": null,
87             "application_fee": null,
88             "charge": null,
89             "created": 1571480453,
90             "currency": "jpy",
91             "customer": null,
92             "email": null,
93             "items": [
94             {
95             "object": "order_item",
96             "amount": 1500,
97             "currency": "jpy",
98             "description": "T-shirt",
99             "parent": "sk_fake123456789",
100             "quantity": null,
101             "type": "sku"
102             }
103             ],
104             "livemode": false,
105             "metadata": {},
106             "returns": {
107             "object": "list",
108             "data": [],
109             "has_more": false,
110             "url": "/v1/order_returns?order=or_fake123456789"
111             },
112             "selected_shipping_method": null,
113             "shipping": {
114             "address": {
115             "city": "Anytown",
116             "country": "US",
117             "line1": "1234 Main street",
118             "line2": null,
119             "postal_code": "123456",
120             "state": null
121             },
122             "carrier": null,
123             "name": "Jenny Rosen",
124             "phone": null,
125             "tracking_number": null
126             },
127             "shipping_methods": null,
128             "status": "created",
129             "status_transitions": {
130             "canceled": null,
131             "fulfiled": null,
132             "paid": null,
133             "returned": null
134             },
135             "updated": 1571480453
136             }
137              
138             =head1 HISTORY
139              
140             =head2 v0.1
141              
142             Initial version
143              
144             =head1 AUTHOR
145              
146             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
147              
148             =head1 SEE ALSO
149              
150             Stripe API documentation:
151              
152             L<https://stripe.com/docs/api/orders/object>
153              
154             =head1 COPYRIGHT & LICENSE
155              
156             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
157              
158             You can use, copy, modify and redistribute this package and associated
159             files under the same terms as Perl itself.
160              
161             =cut