maxio-advanced-billing-sdk 2.0.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +40 -40
- data/lib/advanced_billing/controllers/advance_invoice_controller.rb +6 -4
- data/lib/advanced_billing/controllers/base_controller.rb +1 -1
- data/lib/advanced_billing/controllers/components_controller.rb +9 -58
- data/lib/advanced_billing/controllers/coupons_controller.rb +6 -115
- data/lib/advanced_billing/controllers/custom_fields_controller.rb +4 -4
- data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb +5 -22
- data/lib/advanced_billing/controllers/insights_controller.rb +3 -4
- data/lib/advanced_billing/controllers/invoices_controller.rb +11 -0
- data/lib/advanced_billing/controllers/payment_profiles_controller.rb +26 -0
- data/lib/advanced_billing/controllers/product_families_controller.rb +5 -14
- data/lib/advanced_billing/controllers/product_price_points_controller.rb +3 -40
- data/lib/advanced_billing/controllers/products_controller.rb +5 -14
- data/lib/advanced_billing/controllers/subscription_components_controller.rb +16 -66
- data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb +5 -15
- data/lib/advanced_billing/controllers/subscription_groups_controller.rb +6 -6
- data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb +13 -20
- data/lib/advanced_billing/controllers/subscriptions_controller.rb +49 -14
- data/lib/advanced_billing/models/ach_agreement.rb +10 -0
- data/lib/advanced_billing/models/address_change.rb +0 -22
- data/lib/advanced_billing/models/agreement_acceptance.rb +10 -0
- data/lib/advanced_billing/models/allocation.rb +1 -3
- data/lib/advanced_billing/models/applied_credit_note_data.rb +10 -0
- data/lib/advanced_billing/models/apply_credit_note_event.rb +139 -0
- data/lib/advanced_billing/models/apply_credit_note_event_data.rb +3 -1
- data/lib/advanced_billing/models/apply_debit_note_event.rb +139 -0
- data/lib/advanced_billing/models/apply_debit_note_event_data.rb +36 -2
- data/lib/advanced_billing/models/apply_payment_event.rb +139 -0
- data/lib/advanced_billing/models/apply_payment_event_data.rb +21 -7
- data/lib/advanced_billing/models/backport_invoice_event.rb +139 -0
- data/lib/advanced_billing/models/bank_account_attributes.rb +10 -0
- data/lib/advanced_billing/models/billing_manifest.rb +5 -1
- data/lib/advanced_billing/models/billing_schedule.rb +10 -0
- data/lib/advanced_billing/models/change_chargeback_status_event.rb +141 -0
- data/lib/advanced_billing/models/change_chargeback_status_event_data.rb +73 -0
- data/lib/advanced_billing/models/change_invoice_collection_method_event.rb +141 -0
- data/lib/advanced_billing/models/change_invoice_status_event.rb +141 -0
- data/lib/advanced_billing/models/change_invoice_status_event_data.rb +131 -0
- data/lib/advanced_billing/models/chargeback_status.rb +29 -0
- data/lib/advanced_billing/models/component.rb +3 -13
- data/lib/advanced_billing/models/component_cost_data.rb +10 -0
- data/lib/advanced_billing/models/component_cost_data_rate_tier.rb +10 -0
- data/lib/advanced_billing/models/component_custom_price.rb +10 -0
- data/lib/advanced_billing/models/component_price_point.rb +2 -13
- data/lib/advanced_billing/models/component_price_point_item.rb +10 -0
- data/lib/advanced_billing/models/coupon.rb +4 -14
- data/lib/advanced_billing/models/create_component_price_point.rb +6 -2
- data/lib/advanced_billing/models/create_component_price_point_request.rb +1 -1
- data/lib/advanced_billing/models/create_component_price_points_request.rb +1 -1
- data/lib/advanced_billing/models/create_credit_note_event.rb +139 -0
- data/lib/advanced_billing/models/create_debit_note_event.rb +139 -0
- data/lib/advanced_billing/models/create_invoice_payment_application.rb +22 -0
- data/lib/advanced_billing/models/create_multi_invoice_payment.rb +6 -2
- data/lib/advanced_billing/models/create_offer_component.rb +11 -0
- data/lib/advanced_billing/models/create_payment_profile.rb +4 -4
- data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb +10 -4
- data/lib/advanced_billing/models/create_product_family.rb +14 -4
- data/lib/advanced_billing/models/create_subscription.rb +2 -2
- data/lib/advanced_billing/models/credit_card_attributes.rb +10 -0
- data/lib/advanced_billing/models/credit_note_application.rb +10 -0
- data/lib/advanced_billing/models/credit_note_line_item.rb +10 -0
- data/lib/advanced_billing/models/customer.rb +13 -1
- data/lib/advanced_billing/models/customer_attributes.rb +10 -0
- data/lib/advanced_billing/models/customer_change.rb +7 -22
- data/lib/advanced_billing/models/customer_custom_fields_change.rb +0 -22
- data/lib/advanced_billing/models/customer_payer_change.rb +0 -22
- data/lib/advanced_billing/models/debit_note.rb +351 -0
- data/lib/advanced_billing/models/debit_note_role.rb +23 -0
- data/lib/advanced_billing/models/debit_note_status.rb +29 -0
- data/lib/advanced_billing/models/deduct_service_credit.rb +10 -16
- data/lib/advanced_billing/models/dunner_data.rb +38 -0
- data/lib/advanced_billing/models/dunning_step_data.rb +34 -0
- data/lib/advanced_billing/models/dunning_step_reached.rb +12 -6
- data/lib/advanced_billing/models/failed_payment_event.rb +139 -0
- data/lib/advanced_billing/models/failed_payment_event_data.rb +132 -0
- data/lib/advanced_billing/models/group_billing.rb +10 -0
- data/lib/advanced_billing/models/group_settings.rb +4 -2
- data/lib/advanced_billing/models/group_target.rb +14 -0
- data/lib/advanced_billing/models/historic_usage.rb +109 -0
- data/lib/advanced_billing/models/include_null_or_not_null.rb +23 -0
- data/lib/advanced_billing/models/invoice.rb +18 -8
- data/lib/advanced_billing/models/invoice_address.rb +10 -0
- data/lib/advanced_billing/models/invoice_balance_item.rb +10 -0
- data/lib/advanced_billing/models/invoice_credit.rb +10 -0
- data/lib/advanced_billing/models/invoice_custom_field.rb +10 -0
- data/lib/advanced_billing/models/invoice_customer.rb +10 -0
- data/lib/advanced_billing/models/invoice_discount.rb +10 -0
- data/lib/advanced_billing/models/invoice_discount_breakout.rb +10 -0
- data/lib/advanced_billing/models/invoice_display_settings.rb +10 -0
- data/lib/advanced_billing/models/invoice_event_type.rb +3 -0
- data/lib/advanced_billing/models/invoice_issued.rb +6 -2
- data/lib/advanced_billing/models/invoice_line_item.rb +3 -3
- data/lib/advanced_billing/models/invoice_line_item_event_data.rb +10 -0
- data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb +10 -0
- data/lib/advanced_billing/models/invoice_payer.rb +10 -0
- data/lib/advanced_billing/models/invoice_payment.rb +10 -0
- data/lib/advanced_billing/models/invoice_payment_method.rb +10 -0
- data/lib/advanced_billing/models/invoice_pre_payment.rb +0 -10
- data/lib/advanced_billing/models/invoice_previous_balance.rb +10 -0
- data/lib/advanced_billing/models/invoice_refund.rb +10 -0
- data/lib/advanced_billing/models/invoice_seller.rb +10 -0
- data/lib/advanced_billing/models/invoice_status.rb +2 -2
- data/lib/advanced_billing/models/invoice_tax.rb +10 -0
- data/lib/advanced_billing/models/invoice_tax_breakout.rb +10 -0
- data/lib/advanced_billing/models/invoice_tax_component_breakout.rb +10 -0
- data/lib/advanced_billing/models/issue_invoice_event.rb +139 -0
- data/lib/advanced_billing/models/issue_invoice_event_data.rb +6 -6
- data/lib/advanced_billing/models/issue_service_credit.rb +10 -16
- data/lib/advanced_billing/models/item_price_point_changed.rb +8 -4
- data/lib/advanced_billing/models/item_price_point_data.rb +10 -0
- data/lib/advanced_billing/models/list_components_filter.rb +74 -0
- data/lib/advanced_billing/models/list_coupons_filter.rb +168 -0
- data/lib/advanced_billing/models/list_invoice_events_response.rb +14 -11
- data/lib/advanced_billing/models/{refund_prepayment_aggregated_error.rb → list_mrr_filter.rb} +14 -12
- data/lib/advanced_billing/models/{list_subscription_group_prepayment_date_field.rb → list_prepayment_date_field.rb} +4 -4
- data/lib/advanced_billing/models/list_prepayments_filter.rb +88 -0
- data/lib/advanced_billing/models/list_price_points_filter.rb +163 -0
- data/lib/advanced_billing/models/list_products_filter.rb +81 -0
- data/lib/advanced_billing/models/list_segments_filter.rb +103 -0
- data/lib/advanced_billing/models/list_subscription_components_filter.rb +74 -0
- data/lib/advanced_billing/models/list_subscription_components_for_site_filter.rb +84 -0
- data/lib/advanced_billing/models/list_subscription_components_include.rb +4 -1
- data/lib/advanced_billing/models/metafield_scope.rb +10 -0
- data/lib/advanced_billing/models/nested_subscription_group.rb +0 -10
- data/lib/advanced_billing/models/origin_invoice.rb +10 -0
- data/lib/advanced_billing/models/overage_pricing.rb +14 -0
- data/lib/advanced_billing/models/paid_invoice.rb +2 -2
- data/lib/advanced_billing/models/payer_attributes.rb +10 -0
- data/lib/advanced_billing/models/prepaid_component_price_point.rb +10 -0
- data/lib/advanced_billing/models/prepaid_product_price_point_filter.rb +56 -0
- data/lib/advanced_billing/models/prepaid_usage.rb +6 -2
- data/lib/advanced_billing/models/prepaid_usage_allocation_detail.rb +10 -0
- data/lib/advanced_billing/models/product.rb +5 -16
- data/lib/advanced_billing/models/product_price_point.rb +9 -0
- data/lib/advanced_billing/models/proforma_invoice.rb +2 -2
- data/lib/advanced_billing/models/proforma_invoice_issued.rb +6 -2
- data/lib/advanced_billing/models/reactivation_billing.rb +10 -0
- data/lib/advanced_billing/models/record_payment_response.rb +1 -13
- data/lib/advanced_billing/models/refund_invoice_event.rb +139 -0
- data/lib/advanced_billing/models/refund_invoice_event_data.rb +4 -2
- data/lib/advanced_billing/models/refund_invoice_request.rb +1 -1
- data/lib/advanced_billing/models/refund_prepayment.rb +3 -1
- data/lib/advanced_billing/models/remove_payment_event.rb +139 -0
- data/lib/advanced_billing/models/remove_payment_event_data.rb +1 -1
- data/lib/advanced_billing/models/segment_price.rb +10 -0
- data/lib/advanced_billing/models/subscription.rb +10 -16
- data/lib/advanced_billing/models/subscription_component.rb +26 -7
- data/lib/advanced_billing/models/subscription_component_subscription.rb +10 -0
- data/lib/advanced_billing/models/subscription_filter.rb +153 -0
- data/lib/advanced_billing/models/subscription_group.rb +2 -2
- data/lib/advanced_billing/models/subscription_group_bank_account.rb +10 -0
- data/lib/advanced_billing/models/subscription_group_component_custom_price.rb +10 -0
- data/lib/advanced_billing/models/subscription_group_prepayment_response.rb +3 -1
- data/lib/advanced_billing/models/subscription_group_signup.rb +2 -2
- data/lib/advanced_billing/models/subscription_group_signup_failure.rb +4 -2
- data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb +10 -0
- data/lib/advanced_billing/models/subscription_group_signup_item.rb +10 -0
- data/lib/advanced_billing/models/subscription_group_signup_response.rb +2 -2
- data/lib/advanced_billing/models/subscription_group_signup_success.rb +8 -4
- data/lib/advanced_billing/models/subscription_group_signup_success_data.rb +50 -0
- data/lib/advanced_billing/models/update_customer.rb +12 -0
- data/lib/advanced_billing/models/update_subscription_component.rb +10 -0
- data/lib/advanced_billing/models/upsert_prepaid_configuration.rb +10 -0
- data/lib/advanced_billing/models/usage.rb +3 -1
- data/lib/advanced_billing/models/void_invoice_event.rb +139 -0
- data/lib/advanced_billing/models/void_invoice_event_data.rb +8 -7
- data/lib/advanced_billing/models/void_remainder_event.rb +139 -0
- data/lib/advanced_billing/models/void_remainder_event_data.rb +4 -2
- data/lib/advanced_billing/utilities/union_type_lookup.rb +69 -199
- data/lib/advanced_billing.rb +42 -18
- metadata +38 -17
- data/lib/advanced_billing/exceptions/refund_prepayment_aggregated_errors_response_exception.rb +0 -33
- data/lib/advanced_billing/models/billing_address.rb +0 -117
- data/lib/advanced_billing/models/credit_note1.rb +0 -419
- data/lib/advanced_billing/models/customer1.rb +0 -125
- data/lib/advanced_billing/models/invoice_event.rb +0 -124
- data/lib/advanced_billing/models/invoice_event_data.rb +0 -447
- data/lib/advanced_billing/models/invoice_event_payment.rb +0 -168
- data/lib/advanced_billing/models/invoice_event_payment1.rb +0 -160
- data/lib/advanced_billing/models/prepayment_aggregated_error.rb +0 -81
- data/lib/advanced_billing/models/price_point.rb +0 -216
- data/lib/advanced_billing/models/refund.rb +0 -138
- data/lib/advanced_billing/models/seller.rb +0 -92
- data/lib/advanced_billing/models/shipping_address.rb +0 -117
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 32c5dafe5bea02b9f4b9e58fe9b135ae484bfe4e621cddafc46492ef9cb46a84
|
4
|
+
data.tar.gz: 7b375ac0ccb8c59f1573f84bbf40886793981ad28f87727fda0342cda3c35e3d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f69877c24f4051ea86da5af356846d3ef5a36bbd7ee147453434488f72eaf0453a9b068013b8f4137d238e7ef168b3e5f1092a8c09a417e6954be648b9c8b273
|
7
|
+
data.tar.gz: c0d84c7e8e61fd733a10a470eff219c6c1eb5f7165df687abc49a895c66db85dbaeb3be563f0dbc7ec3e6e843a2f6a2d248d79411e776eeaa472d08f9ddb5619
|
data/README.md
CHANGED
@@ -30,20 +30,20 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
|
|
30
30
|
Install the gem from the command line:
|
31
31
|
|
32
32
|
```ruby
|
33
|
-
gem install maxio-advanced-billing-sdk -v
|
33
|
+
gem install maxio-advanced-billing-sdk -v 3.0.0
|
34
34
|
```
|
35
35
|
|
36
36
|
Or add the gem to your Gemfile and run `bundle`:
|
37
37
|
|
38
38
|
```ruby
|
39
|
-
gem 'maxio-advanced-billing-sdk', '
|
39
|
+
gem 'maxio-advanced-billing-sdk', '3.0.0'
|
40
40
|
```
|
41
41
|
|
42
|
-
For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/
|
42
|
+
For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/3.0.0).
|
43
43
|
|
44
44
|
## Initialize the API Client
|
45
45
|
|
46
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
46
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/client.md)
|
47
47
|
|
48
48
|
The following parameters are configurable for the API Client:
|
49
49
|
|
@@ -61,7 +61,7 @@ The following parameters are configurable for the API Client:
|
|
61
61
|
| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
62
62
|
| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
63
63
|
| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
64
|
-
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
64
|
+
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md) | The credential object for Basic Authentication |
|
65
65
|
|
66
66
|
The API client can be initialized as follows:
|
67
67
|
|
@@ -92,45 +92,45 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
92
92
|
|
93
93
|
This API uses the following authentication schemes.
|
94
94
|
|
95
|
-
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
95
|
+
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/$a/https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/basic-authentication.md)
|
96
96
|
|
97
97
|
## List of APIs
|
98
98
|
|
99
|
-
* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
100
|
-
* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
101
|
-
* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
102
|
-
* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
103
|
-
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
104
|
-
* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
105
|
-
* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
106
|
-
* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
107
|
-
* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
108
|
-
* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
109
|
-
* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
110
|
-
* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
111
|
-
* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
112
|
-
* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
113
|
-
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
114
|
-
* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
115
|
-
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
116
|
-
* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
117
|
-
* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
118
|
-
* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
119
|
-
* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
120
|
-
* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
121
|
-
* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
122
|
-
* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
123
|
-
* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
124
|
-
* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
125
|
-
* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
126
|
-
* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
127
|
-
* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
128
|
-
* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
129
|
-
* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
99
|
+
* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/api-exports.md)
|
100
|
+
* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/advance-invoice.md)
|
101
|
+
* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/billing-portal.md)
|
102
|
+
* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/custom-fields.md)
|
103
|
+
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events-based-billing-segments.md)
|
104
|
+
* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/payment-profiles.md)
|
105
|
+
* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-families.md)
|
106
|
+
* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/product-price-points.md)
|
107
|
+
* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/proforma-invoices.md)
|
108
|
+
* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/reason-codes.md)
|
109
|
+
* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/referral-codes.md)
|
110
|
+
* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sales-commissions.md)
|
111
|
+
* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-components.md)
|
112
|
+
* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-groups.md)
|
113
|
+
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-invoice-account.md)
|
114
|
+
* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-group-status.md)
|
115
|
+
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-invoice-account.md)
|
116
|
+
* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-notes.md)
|
117
|
+
* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-products.md)
|
118
|
+
* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscription-status.md)
|
119
|
+
* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/coupons.md)
|
120
|
+
* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/components.md)
|
121
|
+
* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/customers.md)
|
122
|
+
* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/events.md)
|
123
|
+
* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/insights.md)
|
124
|
+
* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/invoices.md)
|
125
|
+
* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/offers.md)
|
126
|
+
* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/products.md)
|
127
|
+
* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/sites.md)
|
128
|
+
* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/subscriptions.md)
|
129
|
+
* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/controllers/webhooks.md)
|
130
130
|
|
131
131
|
## Classes Documentation
|
132
132
|
|
133
|
-
* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
134
|
-
* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
135
|
-
* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
133
|
+
* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/utility-classes.md)
|
134
|
+
* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-response.md)
|
135
|
+
* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/3.0.0/doc/http-request.md)
|
136
136
|
|
@@ -7,10 +7,12 @@ module AdvancedBilling
|
|
7
7
|
# AdvanceInvoiceController
|
8
8
|
class AdvanceInvoiceController < BaseController
|
9
9
|
# Generate an invoice in advance for a subscription's next renewal date.
|
10
|
-
# [Please see our
|
11
|
-
#
|
12
|
-
#
|
13
|
-
#
|
10
|
+
# [Please see our
|
11
|
+
# docs](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404811062541-I
|
12
|
+
# ssue-Invoice-In-Advance) for more information on advance invoices,
|
13
|
+
# including eligibility on generating one; for the most part, they function
|
14
|
+
# like any other invoice, except they are issued early and have special
|
15
|
+
# behavior upon being voided.
|
14
16
|
# A subscription may only have one advance invoice per billing period.
|
15
17
|
# Attempting to issue an advance invoice when one already exists will return
|
16
18
|
# an error.
|
@@ -382,13 +382,8 @@ module AdvancedBilling
|
|
382
382
|
# many records to fetch in each request. Default value is 20. The maximum
|
383
383
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
384
384
|
# Use in query `per_page=200`.
|
385
|
-
# @param [
|
386
|
-
#
|
387
|
-
# `filter[ids]=1,2,3`.
|
388
|
-
# @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
|
389
|
-
# parameter: Allows fetching components with matching use_site_exchange_rate
|
390
|
-
# based on provided value (refers to default price point). Use in query
|
391
|
-
# `filter[use_site_exchange_rate]=true`.
|
385
|
+
# @param [ListComponentsFilter] filter Optional parameter: Filter to use for
|
386
|
+
# List Components operations
|
392
387
|
# @return [Array[ComponentResponse]] response from the API call
|
393
388
|
def list_components(options = {})
|
394
389
|
new_api_call_builder
|
@@ -403,8 +398,7 @@ module AdvancedBilling
|
|
403
398
|
.query_param(new_parameter(options['include_archived'], key: 'include_archived'))
|
404
399
|
.query_param(new_parameter(options['page'], key: 'page'))
|
405
400
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
406
|
-
.query_param(new_parameter(options['
|
407
|
-
.query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
|
401
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
408
402
|
.header_param(new_parameter('application/json', key: 'accept'))
|
409
403
|
.auth(Single.new('BasicAuth'))
|
410
404
|
.array_serialization_format(ArraySerializationFormat::CSV))
|
@@ -486,9 +480,6 @@ module AdvancedBilling
|
|
486
480
|
# the product family
|
487
481
|
# @param [TrueClass | FalseClass] include_archived Optional parameter:
|
488
482
|
# Include archived items.
|
489
|
-
# @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
|
490
|
-
# components with matching id based on provided value. Use in query
|
491
|
-
# `filter[ids]=1,2`.
|
492
483
|
# @param [Integer] page Optional parameter: Result records are organized in
|
493
484
|
# pages. By default, the first page of results is displayed. The page
|
494
485
|
# parameter specifies a page number of results to fetch. You can start
|
@@ -500,6 +491,8 @@ module AdvancedBilling
|
|
500
491
|
# many records to fetch in each request. Default value is 20. The maximum
|
501
492
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
502
493
|
# Use in query `per_page=200`.
|
494
|
+
# @param [ListComponentsFilter] filter Optional parameter: Filter to use for
|
495
|
+
# List Components operations
|
503
496
|
# @param [BasicDateField] date_field Optional parameter: The type of filter
|
504
497
|
# you would like to apply to your search. Use in query
|
505
498
|
# `date_field=created_at`.
|
@@ -522,10 +515,6 @@ module AdvancedBilling
|
|
522
515
|
# components with a timestamp at or after exact time provided in query. You
|
523
516
|
# can specify timezone in query - otherwise your site's time zone will be
|
524
517
|
# used. If provided, this parameter will be used instead of start_date.
|
525
|
-
# @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
|
526
|
-
# parameter: Allows fetching components with matching use_site_exchange_rate
|
527
|
-
# based on provided value (refers to default price point). Use in query
|
528
|
-
# `filter[use_site_exchange_rate]=true`.
|
529
518
|
# @return [Array[ComponentResponse]] response from the API call
|
530
519
|
def list_components_for_product_family(options = {})
|
531
520
|
new_api_call_builder
|
@@ -536,15 +525,14 @@ module AdvancedBilling
|
|
536
525
|
.is_required(true)
|
537
526
|
.should_encode(true))
|
538
527
|
.query_param(new_parameter(options['include_archived'], key: 'include_archived'))
|
539
|
-
.query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
|
540
528
|
.query_param(new_parameter(options['page'], key: 'page'))
|
541
529
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
530
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
542
531
|
.query_param(new_parameter(options['date_field'], key: 'date_field'))
|
543
532
|
.query_param(new_parameter(options['end_date'], key: 'end_date'))
|
544
533
|
.query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
|
545
534
|
.query_param(new_parameter(options['start_date'], key: 'start_date'))
|
546
535
|
.query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
|
547
|
-
.query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
|
548
536
|
.header_param(new_parameter('application/json', key: 'accept'))
|
549
537
|
.auth(Single.new('BasicAuth'))
|
550
538
|
.array_serialization_format(ArraySerializationFormat::CSV))
|
@@ -826,19 +814,6 @@ module AdvancedBilling
|
|
826
814
|
|
827
815
|
# This method allows to retrieve a list of Components Price Points belonging
|
828
816
|
# to a Site.
|
829
|
-
# @param [BasicDateField] filter_date_field Optional parameter: The type of
|
830
|
-
# filter you would like to apply to your search. Use in query:
|
831
|
-
# `filter[date_field]=created_at`.
|
832
|
-
# @param [Date] filter_end_date Optional parameter: The end date (format
|
833
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns price points with
|
834
|
-
# a timestamp up to and including 11:59:59PM in your site’s time zone on the
|
835
|
-
# date specified.
|
836
|
-
# @param [DateTime] filter_end_datetime Optional parameter: The end date and
|
837
|
-
# time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
838
|
-
# Returns price points with a timestamp at or before exact time provided in
|
839
|
-
# query. You can specify timezone in query - otherwise your site's time zone
|
840
|
-
# will be used. If provided, this parameter will be used instead of
|
841
|
-
# end_date.
|
842
817
|
# @param [ListComponentsPricePointsInclude] include Optional parameter:
|
843
818
|
# Allows including additional data in the response. Use in query:
|
844
819
|
# `include=currency_prices`.
|
@@ -853,45 +828,21 @@ module AdvancedBilling
|
|
853
828
|
# many records to fetch in each request. Default value is 20. The maximum
|
854
829
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
855
830
|
# Use in query `per_page=200`.
|
856
|
-
# @param [Date] filter_start_date Optional parameter: The start date (format
|
857
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns price points with
|
858
|
-
# a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
|
859
|
-
# the date specified.
|
860
|
-
# @param [DateTime] filter_start_datetime Optional parameter: The start date
|
861
|
-
# and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
862
|
-
# Returns price points with a timestamp at or after exact time provided in
|
863
|
-
# query. You can specify timezone in query - otherwise your site's time zone
|
864
|
-
# will be used. If provided, this parameter will be used instead of
|
865
|
-
# start_date.
|
866
|
-
# @param [Array[PricePointType]] filter_type Optional parameter: Allows
|
867
|
-
# fetching price points with matching type. Use in query:
|
868
|
-
# `filter[type]=custom,catalog`.
|
869
831
|
# @param [SortingDirection] direction Optional parameter: Controls the order
|
870
832
|
# in which results are returned. Use in query `direction=asc`.
|
871
|
-
# @param [
|
872
|
-
#
|
873
|
-
# `filter[ids]=1,2,3`.
|
874
|
-
# @param [IncludeNotNull] filter_archived_at Optional parameter: Allows
|
875
|
-
# fetching price points only if archived_at is present or not. Use in query:
|
876
|
-
# `filter[archived_at]=not_null`.
|
833
|
+
# @param [ListPricePointsFilter] filter Optional parameter: Filter to use
|
834
|
+
# for List PricePoints operations
|
877
835
|
# @return [ListComponentsPricePointsResponse] response from the API call
|
878
836
|
def list_all_component_price_points(options = {})
|
879
837
|
new_api_call_builder
|
880
838
|
.request(new_request_builder(HttpMethodEnum::GET,
|
881
839
|
'/components_price_points.json',
|
882
840
|
Server::DEFAULT)
|
883
|
-
.query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
|
884
|
-
.query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
|
885
|
-
.query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
|
886
841
|
.query_param(new_parameter(options['include'], key: 'include'))
|
887
842
|
.query_param(new_parameter(options['page'], key: 'page'))
|
888
843
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
889
|
-
.query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
|
890
|
-
.query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
|
891
|
-
.query_param(new_parameter(options['filter_type'], key: 'filter[type]'))
|
892
844
|
.query_param(new_parameter(options['direction'], key: 'direction'))
|
893
|
-
.query_param(new_parameter(options['
|
894
|
-
.query_param(new_parameter(options['filter_archived_at'], key: 'filter[archived_at]'))
|
845
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
895
846
|
.header_param(new_parameter('application/json', key: 'accept'))
|
896
847
|
.auth(Single.new('BasicAuth'))
|
897
848
|
.array_serialization_format(ArraySerializationFormat::CSV))
|
@@ -70,44 +70,13 @@ module AdvancedBilling
|
|
70
70
|
# many records to fetch in each request. Default value is 30. The maximum
|
71
71
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
72
72
|
# Use in query `per_page=200`.
|
73
|
-
# @param [
|
74
|
-
#
|
75
|
-
# `filter[date_field]=created_at`.
|
76
|
-
# @param [Date] filter_end_date Optional parameter: The end date (format
|
77
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns coupons with a
|
78
|
-
# timestamp up to and including 11:59:59PM in your site’s time zone on the
|
79
|
-
# date specified. Use in query `filter[date_field]=2011-12-15`.
|
80
|
-
# @param [DateTime] filter_end_datetime Optional parameter: The end date and
|
81
|
-
# time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
82
|
-
# Returns coupons with a timestamp at or before exact time provided in
|
83
|
-
# query. You can specify timezone in query - otherwise your site's time zone
|
84
|
-
# will be used. If provided, this parameter will be used instead of
|
85
|
-
# end_date. Use in query `?filter[end_datetime]=2011-12-1T10:15:30+01:00`.
|
86
|
-
# @param [Date] filter_start_date Optional parameter: The start date (format
|
87
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns coupons with a
|
88
|
-
# timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
|
89
|
-
# the date specified. Use in query `filter[start_date]=2011-12-17`.
|
90
|
-
# @param [DateTime] filter_start_datetime Optional parameter: The start date
|
91
|
-
# and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
92
|
-
# Returns coupons with a timestamp at or after exact time provided in query.
|
93
|
-
# You can specify timezone in query - otherwise your site's time zone will
|
94
|
-
# be used. If provided, this parameter will be used instead of start_date.
|
95
|
-
# Use in query `filter[start_datetime]=2011-12-19T10:15:30+01:00`.
|
96
|
-
# @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
|
97
|
-
# coupons with matching id based on provided values. Use in query
|
98
|
-
# `filter[ids]=1,2,3`.
|
99
|
-
# @param [Array[String]] filter_codes Optional parameter: Allows fetching
|
100
|
-
# coupons with matching codes based on provided values. Use in query
|
101
|
-
# `filter[codes]=free,free_trial`.
|
73
|
+
# @param [ListCouponsFilter] filter Optional parameter: Filter to use for
|
74
|
+
# List Coupons operations
|
102
75
|
# @param [TrueClass | FalseClass] currency_prices Optional parameter: When
|
103
76
|
# fetching coupons, if you have defined multiple currencies at the site
|
104
77
|
# level, you can optionally pass the `?currency_prices=true` query param to
|
105
78
|
# include an array of currency price data in the response. Use in query
|
106
79
|
# `currency_prices=true`.
|
107
|
-
# @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
|
108
|
-
# parameter: Allows fetching coupons with matching use_site_exchange_rate
|
109
|
-
# based on provided value. Use in query
|
110
|
-
# `filter[use_site_exchange_rate]=true`.
|
111
80
|
# @return [Array[CouponResponse]] response from the API call
|
112
81
|
def list_coupons_for_product_family(options = {})
|
113
82
|
new_api_call_builder
|
@@ -119,15 +88,8 @@ module AdvancedBilling
|
|
119
88
|
.should_encode(true))
|
120
89
|
.query_param(new_parameter(options['page'], key: 'page'))
|
121
90
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
122
|
-
.query_param(new_parameter(options['
|
123
|
-
.query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
|
124
|
-
.query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
|
125
|
-
.query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
|
126
|
-
.query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
|
127
|
-
.query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
|
128
|
-
.query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
|
91
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
129
92
|
.query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
|
130
|
-
.query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
|
131
93
|
.header_param(new_parameter('application/json', key: 'accept'))
|
132
94
|
.auth(Single.new('BasicAuth'))
|
133
95
|
.array_serialization_format(ArraySerializationFormat::CSV))
|
@@ -283,72 +245,13 @@ module AdvancedBilling
|
|
283
245
|
# many records to fetch in each request. Default value is 30. The maximum
|
284
246
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
285
247
|
# Use in query `per_page=200`.
|
286
|
-
# @param [
|
287
|
-
#
|
288
|
-
# instead to achieve the same result. The type of filter you would like to
|
289
|
-
# apply to your search.
|
290
|
-
# @param [Date] start_date Optional parameter: The field was deprecated: on
|
291
|
-
# January 20, 2022. We recommend using filter[start_date] instead to achieve
|
292
|
-
# the same result. The start date (format YYYY-MM-DD) with which to filter
|
293
|
-
# the date_field. Returns coupons with a timestamp at or after midnight
|
294
|
-
# (12:00:00 AM) in your site’s time zone on the date specified.
|
295
|
-
# @param [Date] end_date Optional parameter: The field was deprecated: on
|
296
|
-
# January 20, 2022. We recommend using filter[end_date] instead to achieve
|
297
|
-
# the same result. The end date (format YYYY-MM-DD) with which to filter the
|
298
|
-
# date_field. Returns coupons with a timestamp up to and including
|
299
|
-
# 11:59:59PM in your site’s time zone on the date specified.
|
300
|
-
# @param [DateTime] start_datetime Optional parameter: The field was
|
301
|
-
# deprecated: on January 20, 2022. We recommend using filter[start_datetime]
|
302
|
-
# instead to achieve the same result. The start date and time (format
|
303
|
-
# YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons
|
304
|
-
# with a timestamp at or after exact time provided in query. You can specify
|
305
|
-
# timezone in query - otherwise your site's time zone will be used. If
|
306
|
-
# provided, this parameter will be used instead of start_date.
|
307
|
-
# @param [DateTime] end_datetime Optional parameter: The field was
|
308
|
-
# deprecated: on January 20, 2022. We recommend using filter[end_datetime]
|
309
|
-
# instead to achieve the same result. The end date and time (format
|
310
|
-
# YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons
|
311
|
-
# with a timestamp at or before exact time provided in query. You can
|
312
|
-
# specify timezone in query - otherwise your site's time zone will be used.
|
313
|
-
# If provided, this parameter will be used instead of end_date.
|
314
|
-
# @param [Array[Integer]] filter_ids Optional parameter: Allows fetching
|
315
|
-
# coupons with matching id based on provided values. Use in query
|
316
|
-
# `filter[ids]=1,2,3`.
|
317
|
-
# @param [Array[String]] filter_codes Optional parameter: Allows fetching
|
318
|
-
# coupons with matching code based on provided values. Use in query
|
319
|
-
# `filter[ids]=1,2,3`.
|
248
|
+
# @param [ListCouponsFilter] filter Optional parameter: Filter to use for
|
249
|
+
# List Coupons operations
|
320
250
|
# @param [TrueClass | FalseClass] currency_prices Optional parameter: When
|
321
251
|
# fetching coupons, if you have defined multiple currencies at the site
|
322
252
|
# level, you can optionally pass the `?currency_prices=true` query param to
|
323
253
|
# include an array of currency price data in the response. Use in query
|
324
254
|
# `currency_prices=true`.
|
325
|
-
# @param [Date] filter_end_date Optional parameter: The end date (format
|
326
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns coupons with a
|
327
|
-
# timestamp up to and including 11:59:59PM in your site’s time zone on the
|
328
|
-
# date specified. Use in query `filter[end_date]=2011-12-17`.
|
329
|
-
# @param [DateTime] filter_end_datetime Optional parameter: The end date and
|
330
|
-
# time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
331
|
-
# Returns coupons with a timestamp at or before exact time provided in
|
332
|
-
# query. You can specify timezone in query - otherwise your site's time zone
|
333
|
-
# will be used. If provided, this parameter will be used instead of
|
334
|
-
# end_date. Use in query `filter[end_datetime]=2011-12-19T10:15:30+01:00`.
|
335
|
-
# @param [Date] filter_start_date Optional parameter: The start date (format
|
336
|
-
# YYYY-MM-DD) with which to filter the date_field. Returns coupons with a
|
337
|
-
# timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
|
338
|
-
# the date specified. Use in query `filter[start_date]=2011-12-19`.
|
339
|
-
# @param [DateTime] filter_start_datetime Optional parameter: The start date
|
340
|
-
# and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
|
341
|
-
# Returns coupons with a timestamp at or after exact time provided in query.
|
342
|
-
# You can specify timezone in query - otherwise your site's time zone will
|
343
|
-
# be used. If provided, this parameter will be used instead of start_date.
|
344
|
-
# Use in query `filter[start_datetime]=2011-12-19T10:15:30+01:00`.
|
345
|
-
# @param [BasicDateField] filter_date_field Optional parameter: The type of
|
346
|
-
# filter you would like to apply to your search. Use in query
|
347
|
-
# `filter[date_field]=updated_at`.
|
348
|
-
# @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
|
349
|
-
# parameter: Allows fetching coupons with matching use_site_exchange_rate
|
350
|
-
# based on provided value. Use in query
|
351
|
-
# `filter[use_site_exchange_rate]=true`.
|
352
255
|
# @return [Array[CouponResponse]] response from the API call
|
353
256
|
def list_coupons(options = {})
|
354
257
|
new_api_call_builder
|
@@ -357,20 +260,8 @@ module AdvancedBilling
|
|
357
260
|
Server::DEFAULT)
|
358
261
|
.query_param(new_parameter(options['page'], key: 'page'))
|
359
262
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
360
|
-
.query_param(new_parameter(options['
|
361
|
-
.query_param(new_parameter(options['start_date'], key: 'start_date'))
|
362
|
-
.query_param(new_parameter(options['end_date'], key: 'end_date'))
|
363
|
-
.query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
|
364
|
-
.query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
|
365
|
-
.query_param(new_parameter(options['filter_ids'], key: 'filter[ids]'))
|
366
|
-
.query_param(new_parameter(options['filter_codes'], key: 'filter[codes]'))
|
263
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
367
264
|
.query_param(new_parameter(options['currency_prices'], key: 'currency_prices'))
|
368
|
-
.query_param(new_parameter(options['filter_end_date'], key: 'filter[end_date]'))
|
369
|
-
.query_param(new_parameter(options['filter_end_datetime'], key: 'filter[end_datetime]'))
|
370
|
-
.query_param(new_parameter(options['filter_start_date'], key: 'filter[start_date]'))
|
371
|
-
.query_param(new_parameter(options['filter_start_datetime'], key: 'filter[start_datetime]'))
|
372
|
-
.query_param(new_parameter(options['filter_date_field'], key: 'filter[date_field]'))
|
373
|
-
.query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
|
374
265
|
.header_param(new_parameter('application/json', key: 'accept'))
|
375
266
|
.auth(Single.new('BasicAuth'))
|
376
267
|
.array_serialization_format(ArraySerializationFormat::CSV))
|
@@ -354,9 +354,9 @@ module AdvancedBilling
|
|
354
354
|
.is_required(true)
|
355
355
|
.should_encode(true))
|
356
356
|
.query_param(new_parameter(name, key: 'name'))
|
357
|
-
.query_param(new_parameter(names, key: 'names
|
357
|
+
.query_param(new_parameter(names, key: 'names'))
|
358
358
|
.auth(Single.new('BasicAuth'))
|
359
|
-
.array_serialization_format(ArraySerializationFormat::
|
359
|
+
.array_serialization_format(ArraySerializationFormat::UN_INDEXED))
|
360
360
|
.response(new_response_handler
|
361
361
|
.is_response_void(true)
|
362
362
|
.local_error_template('404',
|
@@ -434,11 +434,11 @@ module AdvancedBilling
|
|
434
434
|
.query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
|
435
435
|
.query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
|
436
436
|
.query_param(new_parameter(options['with_deleted'], key: 'with_deleted'))
|
437
|
-
.query_param(new_parameter(options['resource_ids'], key: 'resource_ids
|
437
|
+
.query_param(new_parameter(options['resource_ids'], key: 'resource_ids'))
|
438
438
|
.query_param(new_parameter(options['direction'], key: 'direction'))
|
439
439
|
.header_param(new_parameter('application/json', key: 'accept'))
|
440
440
|
.auth(Single.new('BasicAuth'))
|
441
|
-
.array_serialization_format(ArraySerializationFormat::
|
441
|
+
.array_serialization_format(ArraySerializationFormat::UN_INDEXED))
|
442
442
|
.response(new_response_handler
|
443
443
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
444
444
|
.deserialize_into(PaginatedMetadata.method(:from_hash)))
|
@@ -71,23 +71,8 @@ module AdvancedBilling
|
|
71
71
|
# many records to fetch in each request. Default value is 30. The maximum
|
72
72
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
73
73
|
# Use in query `per_page=200`.
|
74
|
-
# @param [
|
75
|
-
#
|
76
|
-
# to `segment_property_1` on attached Metric. If empty string is passed,
|
77
|
-
# this filter would be rejected. Use in query
|
78
|
-
# `filter[segment_property_1_value]=EU`.
|
79
|
-
# @param [String] filter_segment_property_2_value Optional parameter: The
|
80
|
-
# value passed here would be used to filter segments. Pass a value related
|
81
|
-
# to `segment_property_2` on attached Metric. If empty string is passed,
|
82
|
-
# this filter would be rejected.
|
83
|
-
# @param [String] filter_segment_property_3_value Optional parameter: The
|
84
|
-
# value passed here would be used to filter segments. Pass a value related
|
85
|
-
# to `segment_property_3` on attached Metric. If empty string is passed,
|
86
|
-
# this filter would be rejected.
|
87
|
-
# @param [String] filter_segment_property_4_value Optional parameter: The
|
88
|
-
# value passed here would be used to filter segments. Pass a value related
|
89
|
-
# to `segment_property_4` on attached Metric. If empty string is passed,
|
90
|
-
# this filter would be rejected.
|
74
|
+
# @param [ListSegmentsFilter] filter Optional parameter: Filter to use for
|
75
|
+
# List Segments for a Price Point operation
|
91
76
|
# @return [ListSegmentsResponse] response from the API call
|
92
77
|
def list_segments_for_price_point(options = {})
|
93
78
|
new_api_call_builder
|
@@ -102,12 +87,10 @@ module AdvancedBilling
|
|
102
87
|
.should_encode(true))
|
103
88
|
.query_param(new_parameter(options['page'], key: 'page'))
|
104
89
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
105
|
-
.query_param(new_parameter(options['
|
106
|
-
.query_param(new_parameter(options['filter_segment_property_2_value'], key: 'filter[segment_property_2_value]'))
|
107
|
-
.query_param(new_parameter(options['filter_segment_property_3_value'], key: 'filter[segment_property_3_value]'))
|
108
|
-
.query_param(new_parameter(options['filter_segment_property_4_value'], key: 'filter[segment_property_4_value]'))
|
90
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
109
91
|
.header_param(new_parameter('application/json', key: 'accept'))
|
110
|
-
.auth(Single.new('BasicAuth'))
|
92
|
+
.auth(Single.new('BasicAuth'))
|
93
|
+
.array_serialization_format(ArraySerializationFormat::CSV))
|
111
94
|
.response(new_response_handler
|
112
95
|
.deserializer(APIHelper.method(:custom_type_deserializer))
|
113
96
|
.deserialize_into(ListSegmentsResponse.method(:from_hash))
|
@@ -112,9 +112,8 @@ module AdvancedBilling
|
|
112
112
|
|
113
113
|
# This endpoint returns your site's current MRR, including plan and usage
|
114
114
|
# breakouts split per subscription.
|
115
|
-
# @param [
|
116
|
-
#
|
117
|
-
# `filter[subscription_ids]=1,2,3`.
|
115
|
+
# @param [ListMrrFilter] filter Optional parameter: Filter to use for List
|
116
|
+
# MRR per subscription operation
|
118
117
|
# @param [String] at_time Optional parameter: Submit a timestamp in ISO8601
|
119
118
|
# format to request MRR for a historic time. Use in query:
|
120
119
|
# `at_time=2022-01-10T10:00:00-05:00`.
|
@@ -140,7 +139,7 @@ module AdvancedBilling
|
|
140
139
|
.request(new_request_builder(HttpMethodEnum::GET,
|
141
140
|
'/subscriptions_mrr.json',
|
142
141
|
Server::DEFAULT)
|
143
|
-
.query_param(new_parameter(options['
|
142
|
+
.query_param(new_parameter(options['filter'], key: 'filter'))
|
144
143
|
.query_param(new_parameter(options['at_time'], key: 'at_time'))
|
145
144
|
.query_param(new_parameter(options['page'], key: 'page'))
|
146
145
|
.query_param(new_parameter(options['per_page'], key: 'per_page'))
|
@@ -154,6 +154,17 @@ module AdvancedBilling
|
|
154
154
|
end
|
155
155
|
|
156
156
|
# Use this endpoint to retrieve the details for an invoice.
|
157
|
+
# ## PDF Invoice retrieval
|
158
|
+
# Individual PDF Invoices can be retrieved by using the "Accept" header
|
159
|
+
# application/pdf or appending .pdf as the format portion of the URL:
|
160
|
+
# ```curl -u <api_key>:x -H
|
161
|
+
# Accept:application/pdf -H
|
162
|
+
# https://acme.chargify.com/invoices/inv_8gd8tdhtd3hgr.pdf > output_file.pdf
|
163
|
+
# URL: `https://<subdomain>.chargify.com/invoices/<uid>.<format>`
|
164
|
+
# Method: GET
|
165
|
+
# Required parameters: `uid`
|
166
|
+
# Response: A single Invoice.
|
167
|
+
# ```
|
157
168
|
# @param [String] uid Required parameter: The unique identifier for the
|
158
169
|
# invoice, this does not refer to the public facing invoice number.
|
159
170
|
# @return [Invoice] response from the API call
|
@@ -220,6 +220,32 @@ module AdvancedBilling
|
|
220
220
|
# }
|
221
221
|
# }
|
222
222
|
# ```
|
223
|
+
# ## Stripe BACS Direct Debit
|
224
|
+
# Contact the support team to enable this payment method.
|
225
|
+
# For more information on Stripe BACS Direct Debit, please view the
|
226
|
+
# following resources:
|
227
|
+
# + [Full documentation on Stripe BACS Direct
|
228
|
+
# Debit](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405050826765-
|
229
|
+
# Stripe-SEPA-and-BECS-Direct-Debit)
|
230
|
+
# ### Stripe BACS Direct Debit Payment Profiles
|
231
|
+
# The following example creates a customer, bank account and mandate in
|
232
|
+
# Stripe:
|
233
|
+
# ```json
|
234
|
+
# {
|
235
|
+
# "payment_profile": {
|
236
|
+
# "customer_id": "24907598",
|
237
|
+
# "bank_name": "British bank",
|
238
|
+
# "bank_branch_code": "108800",
|
239
|
+
# "bank_account_number": "00012345"
|
240
|
+
# "payment_type": "bank_account",
|
241
|
+
# "billing_address": "Test",
|
242
|
+
# "billing_city": "London",
|
243
|
+
# "billing_state": "LND",
|
244
|
+
# "billing_zip": "12345",
|
245
|
+
# "billing_country": "GB"
|
246
|
+
# }
|
247
|
+
# }
|
248
|
+
# ```
|
223
249
|
# ## 3D Secure - Checkout
|
224
250
|
# It may happen that a payment needs 3D Secure Authentication when the
|
225
251
|
# payment profile is created; this is referred to in our help docs as a
|