The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

JDEGUEST / Net-API-Stripe-v1.0.4 / lib / Net / API / Stripe / Order / SKU / Inventory.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
—
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

              
##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/Order/SKU/Inventory.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
## Created 2019/11/02
## Modified 2020/05/15
## 
##----------------------------------------------------------------------------
package Net::API::Stripe::Order::SKU::Inventory;
BEGIN
{
    use strict;
    use parent qw( Net::API::Stripe::Generic );
    our( $VERSION ) = 'v0.100.0';
};
sub quantity { shift->_set_get_scalar( 'quantity', @_ ); }
sub type { shift->_set_get_scalar( 'type', @_ ); }
sub value { shift->_set_get_scalar( 'value', @_ ); }
1;
__END__
=encoding utf8
=head1 NAME
Net::API::Stripe::Order::SKU::Inventory - A Stripe SKU Inventory Object
=head1 SYNOPSIS
    my $inv = $stripe->sku->inventory({
        quantity => 2,
        type => 'infinite',
        value => undef,
    });
=head1 VERSION
    v0.100.0
=head1 DESCRIPTION
Description of the SKU’s inventory.
This is instantiated by method B<inventory> in module L<Net::API::Stripe::Order::SKU>
=head1 CONSTRUCTOR
=over 4
=item B<new>( %ARG )
Creates a new L<Net::API::Stripe::Order::SKU::Inventory> object.
It may also take an hash like arguments, that also are method of the same name.
=back
=head1 METHODS
=over 4
=item B<quantity> positive integer or zero
The count of inventory available. Will be present if and only if type is finite.
=item B<type> string
Inventory type. Possible values are finite, bucket (not quantified), and infinite.
=item B<value> string
An indicator of the inventory available. Possible values are in_stock, limited, and out_of_stock. Will be present if and only if type is bucket.
=back
=head1 API SAMPLE
        {
          "id": "sku_fake123456789",
          "object": "sku",
          "active": true,
          "attributes": {
                "size": "Medium",
                "gender": "Unisex"
          },
          "created": 1571480453,
          "currency": "jpy",
          "image": null,
          "inventory": {
                "quantity": 50,
                "type": "finite",
                "value": null
          },
          "livemode": false,
          "metadata": {},
          "package_dimensions": null,
          "price": 1500,
          "product": "prod_fake123456789",
          "updated": 1571480453
        }
=head1 HISTORY
=head2 v0.1
Initial version
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 SEE ALSO
Stripe API documentation:
L<https://stripe.com/docs/api>
=head1 COPYRIGHT & LICENSE
Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated
files under the same terms as Perl itself.
=cut