« lib/WebService/Braintree/Subscription/Status.pm
↑ Summary
lib/WebService/Braintree/Transaction/CreatedUsing.pm »
| 1 | # vim: sw=4 ts=4 ft=perl | ||
| 2 | |||
| 3 | package WebService::Braintree::SubscriptionSearch; | ||
| 4 | 22 | $WebService::Braintree::SubscriptionSearch::VERSION = '1.7'; | |
| 5 | 22 | ▶ | use 5.010_001; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 6 | 22 | ▶ | use strictures 1; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 7 | |||
| 8 | =head1 NAME | ||
| 9 | |||
| 10 | WebService::Braintree::SubscriptionSearch | ||
| 11 | |||
| 12 | =head1 PURPOSE | ||
| 13 | |||
| 14 | This class represents a search for subscriptions. | ||
| 15 | |||
| 16 | This class should never be instantiated directly. Instead, you will access | ||
| 17 | objects of this class through the search interface. | ||
| 18 | |||
| 19 | =cut | ||
| 20 | |||
| 21 | 22 | ▶ | use Moo; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 22 | 22 | with 'WebService::Braintree::Role::AdvancedSearch'; | |
| 23 | |||
| 24 | 22 | ▶ | use constant FIELDS => []; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 25 | |||
| 26 | 22 | ▶ | use WebService::Braintree::Subscription::Status; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 27 | |||
| 28 | =head1 FIELDS | ||
| 29 | |||
| 30 | =cut | ||
| 31 | |||
| 32 | =head2 address_country_name | ||
| 33 | |||
| 34 | This is a L<text field|WebService::Braintree::AdvancedSearchNodes/"Text Field">. It will restrict the search to a specific country name. | ||
| 35 | |||
| 36 | =cut | ||
| 37 | |||
| 38 | 22 | __PACKAGE__->text_field('address_country_name'); | |
| 39 | |||
| 40 | =head2 billing_cycles_remaining | ||
| 41 | |||
| 42 | This is a L<range field|WebService::Braintree::AdvancedSearchNodes/"Range Field">. It will restrict the search to subscriptions created between the two values. | ||
| 43 | |||
| 44 | =cut | ||
| 45 | |||
| 46 | 22 | __PACKAGE__->range_field('billing_cycles_remaining'); | |
| 47 | |||
| 48 | =head2 days_past_due | ||
| 49 | |||
| 50 | This is a L<range field|WebService::Braintree::AdvancedSearchNodes/"Range Field">. It will restrict the search to subscriptions created between the two values. | ||
| 51 | |||
| 52 | =cut | ||
| 53 | |||
| 54 | 22 | __PACKAGE__->range_field('days_past_due'); | |
| 55 | |||
| 56 | =head2 id | ||
| 57 | |||
| 58 | This is a L<text field|WebService::Braintree::AdvancedSearchNodes/"Text Field">. It will restrict the search to a specific id. | ||
| 59 | |||
| 60 | =cut | ||
| 61 | |||
| 62 | 22 | __PACKAGE__->text_field('id'); | |
| 63 | |||
| 64 | =head2 ids | ||
| 65 | |||
| 66 | This is a L<multiple-values field|WebService::Braintree::AdvancedSearchNodes/"Multiple Values Field">. It will restrict the search to a list of specific ids. | ||
| 67 | |||
| 68 | =cut | ||
| 69 | |||
| 70 | 22 | __PACKAGE__->multiple_values_field('ids'); | |
| 71 | |||
| 72 | =head2 in_trial_period | ||
| 73 | |||
| 74 | This is a L<multiple-values field|WebService::Braintree::AdvancedSearchNodes/"Multiple Values Field">. It will restrict the search to the provided list. | ||
| 75 | |||
| 76 | =cut | ||
| 77 | |||
| 78 | 22 | __PACKAGE__->multiple_values_field('in_trial_period'); | |
| 79 | |||
| 80 | =head2 merchant_account_id | ||
| 81 | |||
| 82 | This is a L<multiple-values field|WebService::Braintree::AdvancedSearchNodes/"Multiple Values Field">. It will restrict the search to the provided list. | ||
| 83 | |||
| 84 | =cut | ||
| 85 | |||
| 86 | 22 | __PACKAGE__->multiple_values_field('merchant_account_id'); | |
| 87 | |||
| 88 | =head2 next_billing_date | ||
| 89 | |||
| 90 | This is a L<range field|WebService::Braintree::AdvancedSearchNodes/"Range Field">. It will restrict the search to subscriptions created between the two values. | ||
| 91 | |||
| 92 | =cut | ||
| 93 | |||
| 94 | 22 | __PACKAGE__->range_field('next_billing_date'); | |
| 95 | |||
| 96 | =head2 plan_id | ||
| 97 | |||
| 98 | This is a L<text field|WebService::Braintree::AdvancedSearchNodes/"Text Field">. It will restrict the search to a specific id. | ||
| 99 | |||
| 100 | =cut | ||
| 101 | |||
| 102 | 22 | __PACKAGE__->text_field('plan_id'); | |
| 103 | |||
| 104 | =head2 price | ||
| 105 | |||
| 106 | This is a L<range field|WebService::Braintree::AdvancedSearchNodes/"Range Field">. It will restrict the search to subscriptions created between the two values. | ||
| 107 | |||
| 108 | =cut | ||
| 109 | |||
| 110 | 22 | __PACKAGE__->range_field('price'); | |
| 111 | |||
| 112 | =head2 status | ||
| 113 | |||
| 114 | This is a L<multiple-values field|WebService::Braintree::AdvancedSearchNodes/"Multiple Values Field">. It will restrict the search to the provided list. | ||
| 115 | |||
| 116 | This list is restricted to the values defined by L<WebService::Braintree::Subscription::Status/All> | ||
| 117 | |||
| 118 | =cut | ||
| 119 | |||
| 120 | 22 | __PACKAGE__->multiple_values_field('status', WebService::Braintree::Subscription::Status::All); | |
| 121 | |||
| 122 | =head2 transaction_id | ||
| 123 | |||
| 124 | This is a L<text field|WebService::Braintree::AdvancedSearchNodes/"Text Field">. It will restrict the search to a specific id. | ||
| 125 | |||
| 126 | =cut | ||
| 127 | |||
| 128 | 22 | __PACKAGE__->text_field('transaction_id'); | |
| 129 | |||
| 130 | 22 | __PACKAGE__->meta->make_immutable; | |
| 131 | |||
| 132 | 22 | 1; | |
| 133 | __END__ | ||