maxio-advanced-billing-sdk 5.0.0 → 5.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +41 -41
  3. data/lib/advanced_billing/controllers/advance_invoice_controller.rb +3 -3
  4. data/lib/advanced_billing/controllers/api_exports_controller.rb +9 -9
  5. data/lib/advanced_billing/controllers/base_controller.rb +1 -1
  6. data/lib/advanced_billing/controllers/billing_portal_controller.rb +4 -4
  7. data/lib/advanced_billing/controllers/component_price_points_controller.rb +11 -11
  8. data/lib/advanced_billing/controllers/components_controller.rb +12 -12
  9. data/lib/advanced_billing/controllers/coupons_controller.rb +14 -14
  10. data/lib/advanced_billing/controllers/custom_fields_controller.rb +9 -9
  11. data/lib/advanced_billing/controllers/customers_controller.rb +7 -7
  12. data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb +6 -6
  13. data/lib/advanced_billing/controllers/events_controller.rb +3 -3
  14. data/lib/advanced_billing/controllers/insights_controller.rb +4 -4
  15. data/lib/advanced_billing/controllers/invoices_controller.rb +17 -17
  16. data/lib/advanced_billing/controllers/offers_controller.rb +5 -5
  17. data/lib/advanced_billing/controllers/payment_profiles_controller.rb +12 -12
  18. data/lib/advanced_billing/controllers/product_families_controller.rb +4 -4
  19. data/lib/advanced_billing/controllers/product_price_points_controller.rb +11 -11
  20. data/lib/advanced_billing/controllers/products_controller.rb +6 -6
  21. data/lib/advanced_billing/controllers/proforma_invoices_controller.rb +9 -9
  22. data/lib/advanced_billing/controllers/reason_codes_controller.rb +5 -5
  23. data/lib/advanced_billing/controllers/referral_codes_controller.rb +1 -1
  24. data/lib/advanced_billing/controllers/sales_commissions_controller.rb +3 -3
  25. data/lib/advanced_billing/controllers/sites_controller.rb +3 -3
  26. data/lib/advanced_billing/controllers/subscription_components_controller.rb +17 -17
  27. data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb +4 -4
  28. data/lib/advanced_billing/controllers/subscription_group_status_controller.rb +4 -4
  29. data/lib/advanced_billing/controllers/subscription_groups_controller.rb +9 -9
  30. data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb +6 -6
  31. data/lib/advanced_billing/controllers/subscription_notes_controller.rb +5 -5
  32. data/lib/advanced_billing/controllers/subscription_products_controller.rb +2 -2
  33. data/lib/advanced_billing/controllers/subscription_status_controller.rb +10 -10
  34. data/lib/advanced_billing/controllers/subscriptions_controller.rb +12 -12
  35. data/lib/advanced_billing/controllers/webhooks_controller.rb +6 -6
  36. data/lib/advanced_billing/models/cancellation_method.rb +4 -1
  37. data/lib/advanced_billing/models/create_invoice_payment.rb +17 -3
  38. data/lib/advanced_billing/models/customer.rb +29 -2
  39. data/lib/advanced_billing/models/customer_attributes.rb +16 -0
  40. data/lib/advanced_billing/models/invoice_payment.rb +24 -1
  41. data/lib/advanced_billing/models/list_products_filter.rb +12 -2
  42. data/lib/advanced_billing/models/update_subscription.rb +25 -1
  43. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e1d65f08cf91f9e362201f98d75c1155c766ed03a45e1c70c1baa0f3a7e551a2
4
- data.tar.gz: bb434c0a91c11b861e60376bd550c3a820a64f9c2608412a5aa47530cbddb22f
3
+ metadata.gz: '0998f7475d282f79076687d394753aa4a1a9f5b8c61e1a227bcb8d1e00eaa329'
4
+ data.tar.gz: 63d52a07e75005a9469322d3d750e26c6d9a552a1f4d0858e7b9b9f0b8a4b9a5
5
5
  SHA512:
6
- metadata.gz: '0957ea9006feffaffb79299c10f9c4e14747c265cdd2e0a7b07bfb01a9f0d05f8457d5c41769c15e009c338e065d6a216c930fbec26aa92bf6367cb3d3a45b98'
7
- data.tar.gz: d8012a63f8e16fea5a0d4da51dbf89059d9f3d2097b81673ae7314f743f60aae965f2b00ee228dd4a1f476e57a92cdfea32fc01d9d2709233dff89b3fa24949b
6
+ metadata.gz: 36549cdceb833bd48a9a9d7f5a7abd8f18a9258370a23b080f1e2763bdec72fa96e7c215a0aed7b798b32b8be3f2692e72c43394dd02afcbf43d5d82bfa73b16
7
+ data.tar.gz: 59c557dddc1fd7bc04e786f25c8a941764f51f787621d2b0fecd9e7d0017ac393ce79e2eda023ac6bee0beee34c26db57f5b029cedef2b6d4abd5ba2be6601cf
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 5.0.0
33
+ gem install maxio-advanced-billing-sdk -v 5.2.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', '5.0.0'
39
+ gem 'maxio-advanced-billing-sdk', '5.2.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/5.0.0).
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/5.2.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/5.0.0/doc/client.md)
46
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.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/5.0.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
64
+ | `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
65
65
 
66
66
  The API client can be initialized as follows:
67
67
 
@@ -92,46 +92,46 @@ 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/5.0.0/doc/auth/basic-authentication.md)
95
+ * [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/auth/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/5.0.0/doc/controllers/api-exports.md)
100
- * [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/advance-invoice.md)
101
- * [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/billing-portal.md)
102
- * [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/component-price-points.md)
103
- * [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/custom-fields.md)
104
- * [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/events-based-billing-segments.md)
105
- * [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/payment-profiles.md)
106
- * [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/product-families.md)
107
- * [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/product-price-points.md)
108
- * [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/proforma-invoices.md)
109
- * [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/reason-codes.md)
110
- * [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/referral-codes.md)
111
- * [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/sales-commissions.md)
112
- * [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-components.md)
113
- * [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-groups.md)
114
- * [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-group-invoice-account.md)
115
- * [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-group-status.md)
116
- * [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-invoice-account.md)
117
- * [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-notes.md)
118
- * [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-products.md)
119
- * [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscription-status.md)
120
- * [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/coupons.md)
121
- * [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/components.md)
122
- * [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/customers.md)
123
- * [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/events.md)
124
- * [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/insights.md)
125
- * [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/invoices.md)
126
- * [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/offers.md)
127
- * [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/products.md)
128
- * [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/sites.md)
129
- * [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/subscriptions.md)
130
- * [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/controllers/webhooks.md)
99
+ * [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/api-exports.md)
100
+ * [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/advance-invoice.md)
101
+ * [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/billing-portal.md)
102
+ * [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/component-price-points.md)
103
+ * [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/custom-fields.md)
104
+ * [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/events-based-billing-segments.md)
105
+ * [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/payment-profiles.md)
106
+ * [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/product-families.md)
107
+ * [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/product-price-points.md)
108
+ * [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/proforma-invoices.md)
109
+ * [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/reason-codes.md)
110
+ * [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/referral-codes.md)
111
+ * [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/sales-commissions.md)
112
+ * [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-components.md)
113
+ * [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-groups.md)
114
+ * [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-group-invoice-account.md)
115
+ * [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-group-status.md)
116
+ * [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-invoice-account.md)
117
+ * [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-notes.md)
118
+ * [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-products.md)
119
+ * [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscription-status.md)
120
+ * [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/coupons.md)
121
+ * [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/components.md)
122
+ * [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/customers.md)
123
+ * [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/events.md)
124
+ * [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/insights.md)
125
+ * [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/invoices.md)
126
+ * [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/offers.md)
127
+ * [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/products.md)
128
+ * [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/sites.md)
129
+ * [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/subscriptions.md)
130
+ * [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/controllers/webhooks.md)
131
131
 
132
132
  ## Classes Documentation
133
133
 
134
- * [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/utility-classes.md)
135
- * [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/http-response.md)
136
- * [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.0.0/doc/http-request.md)
134
+ * [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/utility-classes.md)
135
+ * [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/http-response.md)
136
+ * [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/5.2.0/doc/http-request.md)
137
137
 
data/lib/advanced_billing/controllers/advance_invoice_controller.rb CHANGED
@@ -26,7 +26,7 @@ module AdvancedBilling
26
26
  # @param [Integer] subscription_id Required parameter: The Chargify id of
27
27
  # the subscription
28
28
  # @param [IssueAdvanceInvoiceRequest] body Optional parameter: Example:
29
- # @return [Invoice] response from the API call
29
+ # @return [Invoice] response from the API call.
30
30
  def issue_advance_invoice(subscription_id,
31
31
  body: nil)
32
32
  new_api_call_builder
@@ -59,7 +59,7 @@ module AdvancedBilling
59
59
  # advance invoice per subscription per billing cycle.
60
60
  # @param [Integer] subscription_id Required parameter: The Chargify id of
61
61
  # the subscription
62
- # @return [Invoice] response from the API call
62
+ # @return [Invoice] response from the API call.
63
63
  def read_advance_invoice(subscription_id)
64
64
  new_api_call_builder
65
65
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -88,7 +88,7 @@ module AdvancedBilling
88
88
  # @param [Integer] subscription_id Required parameter: The Chargify id of
89
89
  # the subscription
90
90
  # @param [VoidInvoiceRequest] body Optional parameter: Example:
91
- # @return [Invoice] response from the API call
91
+ # @return [Invoice] response from the API call.
92
92
  def void_advance_invoice(subscription_id,
93
93
  body: nil)
94
94
  new_api_call_builder
data/lib/advanced_billing/controllers/api_exports_controller.rb CHANGED
@@ -24,7 +24,7 @@ module AdvancedBilling
24
24
  # passing in a page parameter. Retrieve the next page by adding ?page=2 to
25
25
  # the query string. If there are no results to return, then an empty result
26
26
  # set will be returned. Use in query `page=1`.
27
- # @return [Array[ProformaInvoice]] response from the API call
27
+ # @return [Array[ProformaInvoice]] response from the API call.
28
28
  def list_exported_proforma_invoices(options = {})
29
29
  new_api_call_builder
30
30
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -65,7 +65,7 @@ module AdvancedBilling
65
65
  # passing in a page parameter. Retrieve the next page by adding ?page=2 to
66
66
  # the query string. If there are no results to return, then an empty result
67
67
  # set will be returned. Use in query `page=1`.
68
- # @return [Array[Invoice]] response from the API call
68
+ # @return [Array[Invoice]] response from the API call.
69
69
  def list_exported_invoices(options = {})
70
70
  new_api_call_builder
71
71
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -106,7 +106,7 @@ module AdvancedBilling
106
106
  # passing in a page parameter. Retrieve the next page by adding ?page=2 to
107
107
  # the query string. If there are no results to return, then an empty result
108
108
  # set will be returned. Use in query `page=1`.
109
- # @return [Array[Subscription]] response from the API call
109
+ # @return [Array[Subscription]] response from the API call.
110
110
  def list_exported_subscriptions(options = {})
111
111
  new_api_call_builder
112
112
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -131,7 +131,7 @@ module AdvancedBilling
131
131
 
132
132
  # This API creates a proforma invoices export and returns a batchjob object.
133
133
  # It is only available for Relationship Invoicing architecture.
134
- # @return [BatchJobResponse] response from the API call
134
+ # @return [BatchJobResponse] response from the API call.
135
135
  def export_proforma_invoices
136
136
  new_api_call_builder
137
137
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -153,7 +153,7 @@ module AdvancedBilling
153
153
  end
154
154
 
155
155
  # This API creates an invoices export and returns a batchjob object.
156
- # @return [BatchJobResponse] response from the API call
156
+ # @return [BatchJobResponse] response from the API call.
157
157
  def export_invoices
158
158
  new_api_call_builder
159
159
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -175,7 +175,7 @@ module AdvancedBilling
175
175
  end
176
176
 
177
177
  # This API creates a subscriptions export and returns a batchjob object.
178
- # @return [BatchJobResponse] response from the API call
178
+ # @return [BatchJobResponse] response from the API call.
179
179
  def export_subscriptions
180
180
  new_api_call_builder
181
181
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -195,7 +195,7 @@ module AdvancedBilling
195
195
 
196
196
  # This API returns a batchjob object for proforma invoices export.
197
197
  # @param [String] batch_id Required parameter: Id of a Batch Job.
198
- # @return [BatchJobResponse] response from the API call
198
+ # @return [BatchJobResponse] response from the API call.
199
199
  def read_proforma_invoices_export(batch_id)
200
200
  new_api_call_builder
201
201
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -217,7 +217,7 @@ module AdvancedBilling
217
217
 
218
218
  # This API returns a batchjob object for invoices export.
219
219
  # @param [String] batch_id Required parameter: Id of a Batch Job.
220
- # @return [BatchJobResponse] response from the API call
220
+ # @return [BatchJobResponse] response from the API call.
221
221
  def read_invoices_export(batch_id)
222
222
  new_api_call_builder
223
223
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -239,7 +239,7 @@ module AdvancedBilling
239
239
 
240
240
  # This API returns a batchjob object for subscriptions export.
241
241
  # @param [String] batch_id Required parameter: Id of a Batch Job.
242
- # @return [BatchJobResponse] response from the API call
242
+ # @return [BatchJobResponse] response from the API call.
243
243
  def read_subscriptions_export(batch_id)
244
244
  new_api_call_builder
245
245
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/advanced_billing/controllers/base_controller.rb CHANGED
@@ -10,7 +10,7 @@ module AdvancedBilling
10
10
  attr_accessor :config, :http_call_back
11
11
 
12
12
  def self.user_agent
13
- 'AB SDK Ruby:5.0.0 on OS {os-info}'
13
+ 'AB SDK Ruby:5.2.0 on OS {os-info}'
14
14
  end
15
15
 
16
16
  def self.user_agent_parameters
data/lib/advanced_billing/controllers/billing_portal_controller.rb CHANGED
@@ -37,7 +37,7 @@ module AdvancedBilling
37
37
  # @param [AutoInvite] auto_invite Optional parameter: When set to 1, an
38
38
  # Invitation email will be sent to the Customer. When set to 0, or not sent,
39
39
  # an email will not be sent. Use in query: `auto_invite=1`.
40
- # @return [CustomerResponse] response from the API call
40
+ # @return [CustomerResponse] response from the API call.
41
41
  def enable_billing_portal_for_customer(customer_id,
42
42
  auto_invite: nil)
43
43
  new_api_call_builder
@@ -74,7 +74,7 @@ module AdvancedBilling
74
74
  # further Management URL requests (with a response code `429`)
75
75
  # @param [Integer] customer_id Required parameter: The Chargify id of the
76
76
  # customer
77
- # @return [PortalManagementLink] response from the API call
77
+ # @return [PortalManagementLink] response from the API call.
78
78
  def read_billing_portal_link(customer_id)
79
79
  new_api_call_builder
80
80
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -112,7 +112,7 @@ module AdvancedBilling
112
112
  # This endpoint will only return a JSON response.
113
113
  # @param [Integer] customer_id Required parameter: The Chargify id of the
114
114
  # customer
115
- # @return [ResentInvitation] response from the API call
115
+ # @return [ResentInvitation] response from the API call.
116
116
  def resend_billing_portal_invitation(customer_id)
117
117
  new_api_call_builder
118
118
  .request(new_request_builder(HttpMethodEnum::POST,
@@ -143,7 +143,7 @@ module AdvancedBilling
143
143
  # This endpoint will only return a JSON response.
144
144
  # @param [Integer] customer_id Required parameter: The Chargify id of the
145
145
  # customer
146
- # @return [RevokedInvitation] response from the API call
146
+ # @return [RevokedInvitation] response from the API call.
147
147
  def revoke_billing_portal_access(customer_id)
148
148
  new_api_call_builder
149
149
  .request(new_request_builder(HttpMethodEnum::DELETE,
data/lib/advanced_billing/controllers/component_price_points_controller.rb CHANGED
@@ -19,7 +19,7 @@ module AdvancedBilling
19
19
  # of the component to which the price point belongs
20
20
  # @param [Integer] price_point_id Required parameter: The Advanced Billing
21
21
  # id of the price point
22
- # @return [ComponentResponse] response from the API call
22
+ # @return [ComponentResponse] response from the API call.
23
23
  def promote_component_price_point_to_default(component_id,
24
24
  price_point_id)
25
25
  new_api_call_builder
@@ -46,7 +46,7 @@ module AdvancedBilling
46
46
  # of the component
47
47
  # @param [CreateComponentPricePointRequest] body Optional parameter:
48
48
  # Example:
49
- # @return [ComponentPricePointResponse] response from the API call
49
+ # @return [ComponentPricePointResponse] response from the API call.
50
50
  def create_component_price_point(component_id,
51
51
  body: nil)
52
52
  new_api_call_builder
@@ -95,7 +95,7 @@ module AdvancedBilling
95
95
  # Use in query `per_page=200`.
96
96
  # @param [Array[PricePointType]] filter_type Optional parameter: Use in
97
97
  # query: `filter[type]=catalog,default`.
98
- # @return [ComponentPricePointsResponse] response from the API call
98
+ # @return [ComponentPricePointsResponse] response from the API call.
99
99
  def list_component_price_points(options = {})
100
100
  new_api_call_builder
101
101
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -123,7 +123,7 @@ module AdvancedBilling
123
123
  # of the component for which you want to fetch price points.
124
124
  # @param [CreateComponentPricePointsRequest] body Optional parameter:
125
125
  # Example:
126
- # @return [ComponentPricePointsResponse] response from the API call
126
+ # @return [ComponentPricePointsResponse] response from the API call.
127
127
  def bulk_create_component_price_points(component_id,
128
128
  body: nil)
129
129
  new_api_call_builder
@@ -162,7 +162,7 @@ module AdvancedBilling
162
162
  # `handle:example-price_point-handle` for a string handle.
163
163
  # @param [UpdateComponentPricePointRequest] body Optional parameter:
164
164
  # Example:
165
- # @return [ComponentPricePointResponse] response from the API call
165
+ # @return [ComponentPricePointResponse] response from the API call.
166
166
  def update_component_price_point(component_id,
167
167
  price_point_id,
168
168
  body: nil)
@@ -210,7 +210,7 @@ module AdvancedBilling
210
210
  # handle of the price point. When using the handle, it must be prefixed with
211
211
  # `handle:`. Example: `123` for an integer ID, or
212
212
  # `handle:example-price_point-handle` for a string handle.
213
- # @return [ComponentPricePointResponse] response from the API call
213
+ # @return [ComponentPricePointResponse] response from the API call.
214
214
  def read_component_price_point(component_id,
215
215
  price_point_id)
216
216
  new_api_call_builder
@@ -250,7 +250,7 @@ module AdvancedBilling
250
250
  # handle of the price point. When using the handle, it must be prefixed with
251
251
  # `handle:`. Example: `123` for an integer ID, or
252
252
  # `handle:example-price_point-handle` for a string handle.
253
- # @return [ComponentPricePointResponse] response from the API call
253
+ # @return [ComponentPricePointResponse] response from the API call.
254
254
  def archive_component_price_point(component_id,
255
255
  price_point_id)
256
256
  new_api_call_builder
@@ -288,7 +288,7 @@ module AdvancedBilling
288
288
  # of the component to which the price point belongs
289
289
  # @param [Integer] price_point_id Required parameter: The Advanced Billing
290
290
  # id of the price point
291
- # @return [ComponentPricePointResponse] response from the API call
291
+ # @return [ComponentPricePointResponse] response from the API call.
292
292
  def unarchive_component_price_point(component_id,
293
293
  price_point_id)
294
294
  new_api_call_builder
@@ -319,7 +319,7 @@ module AdvancedBilling
319
319
  # @param [Integer] price_point_id Required parameter: The Advanced Billing
320
320
  # id of the price point
321
321
  # @param [CreateCurrencyPricesRequest] body Optional parameter: Example:
322
- # @return [ComponentCurrencyPricesResponse] response from the API call
322
+ # @return [ComponentCurrencyPricesResponse] response from the API call.
323
323
  def create_currency_prices(price_point_id,
324
324
  body: nil)
325
325
  new_api_call_builder
@@ -349,7 +349,7 @@ module AdvancedBilling
349
349
  # @param [Integer] price_point_id Required parameter: The Advanced Billing
350
350
  # id of the price point
351
351
  # @param [UpdateCurrencyPricesRequest] body Optional parameter: Example:
352
- # @return [ComponentCurrencyPricesResponse] response from the API call
352
+ # @return [ComponentCurrencyPricesResponse] response from the API call.
353
353
  def update_currency_prices(price_point_id,
354
354
  body: nil)
355
355
  new_api_call_builder
@@ -393,7 +393,7 @@ module AdvancedBilling
393
393
  # in which results are returned. Use in query `direction=asc`.
394
394
  # @param [ListPricePointsFilter] filter Optional parameter: Filter to use
395
395
  # for List PricePoints operations
396
- # @return [ListComponentsPricePointsResponse] response from the API call
396
+ # @return [ListComponentsPricePointsResponse] response from the API call.
397
397
  def list_all_component_price_points(options = {})
398
398
  new_api_call_builder
399
399
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/advanced_billing/controllers/components_controller.rb CHANGED
@@ -23,7 +23,7 @@ module AdvancedBilling
23
23
  # @param [String] product_family_id Required parameter: Either the product
24
24
  # family's id or its handle prefixed with `handle:`
25
25
  # @param [CreateMeteredComponent] body Optional parameter: Example:
26
- # @return [ComponentResponse] response from the API call
26
+ # @return [ComponentResponse] response from the API call.
27
27
  def create_metered_component(product_family_id,
28
28
  body: nil)
29
29
  new_api_call_builder
@@ -72,7 +72,7 @@ module AdvancedBilling
72
72
  # @param [String] product_family_id Required parameter: Either the product
73
73
  # family's id or its handle prefixed with `handle:`
74
74
  # @param [CreateQuantityBasedComponent] body Optional parameter: Example:
75
- # @return [ComponentResponse] response from the API call
75
+ # @return [ComponentResponse] response from the API call.
76
76
  def create_quantity_based_component(product_family_id,
77
77
  body: nil)
78
78
  new_api_call_builder
@@ -111,7 +111,7 @@ module AdvancedBilling
111
111
  # @param [String] product_family_id Required parameter: Either the product
112
112
  # family's id or its handle prefixed with `handle:`
113
113
  # @param [CreateOnOffComponent] body Optional parameter: Example:
114
- # @return [ComponentResponse] response from the API call
114
+ # @return [ComponentResponse] response from the API call.
115
115
  def create_on_off_component(product_family_id,
116
116
  body: nil)
117
117
  new_api_call_builder
@@ -154,7 +154,7 @@ module AdvancedBilling
154
154
  # @param [String] product_family_id Required parameter: Either the product
155
155
  # family's id or its handle prefixed with `handle:`
156
156
  # @param [CreatePrepaidComponent] body Optional parameter: Example:
157
- # @return [ComponentResponse] response from the API call
157
+ # @return [ComponentResponse] response from the API call.
158
158
  def create_prepaid_usage_component(product_family_id,
159
159
  body: nil)
160
160
  new_api_call_builder
@@ -200,7 +200,7 @@ module AdvancedBilling
200
200
  # @param [String] product_family_id Required parameter: Either the product
201
201
  # family's id or its handle prefixed with `handle:`
202
202
  # @param [CreateEBBComponent] body Optional parameter: Example:
203
- # @return [ComponentResponse] response from the API call
203
+ # @return [ComponentResponse] response from the API call.
204
204
  def create_event_based_component(product_family_id,
205
205
  body: nil)
206
206
  new_api_call_builder
@@ -233,7 +233,7 @@ module AdvancedBilling
233
233
  # don't have to save or reference the IDs we generate.
234
234
  # @param [String] handle Required parameter: The handle of the component to
235
235
  # find
236
- # @return [ComponentResponse] response from the API call
236
+ # @return [ComponentResponse] response from the API call.
237
237
  def find_component(handle)
238
238
  new_api_call_builder
239
239
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -258,7 +258,7 @@ module AdvancedBilling
258
258
  # @param [String] component_id Required parameter: Either the Advanced
259
259
  # Billing id of the component or the handle for the component prefixed with
260
260
  # `handle:`
261
- # @return [ComponentResponse] response from the API call
261
+ # @return [ComponentResponse] response from the API call.
262
262
  def read_component(product_family_id,
263
263
  component_id)
264
264
  new_api_call_builder
@@ -288,7 +288,7 @@ module AdvancedBilling
288
288
  # Billing id of the component or the handle for the component prefixed with
289
289
  # `handle:`
290
290
  # @param [UpdateComponentRequest] body Optional parameter: Example:
291
- # @return [ComponentResponse] response from the API call
291
+ # @return [ComponentResponse] response from the API call.
292
292
  def update_product_family_component(product_family_id,
293
293
  component_id,
294
294
  body: nil)
@@ -325,7 +325,7 @@ module AdvancedBilling
325
325
  # @param [String] component_id Required parameter: Either the Advanced
326
326
  # Billing id of the component or the handle for the component prefixed with
327
327
  # `handle:`
328
- # @return [Component] response from the API call
328
+ # @return [Component] response from the API call.
329
329
  def archive_component(product_family_id,
330
330
  component_id)
331
331
  new_api_call_builder
@@ -387,7 +387,7 @@ module AdvancedBilling
387
387
  # Use in query `per_page=200`.
388
388
  # @param [ListComponentsFilter] filter Optional parameter: Filter to use for
389
389
  # List Components operations
390
- # @return [Array[ComponentResponse]] response from the API call
390
+ # @return [Array[ComponentResponse]] response from the API call.
391
391
  def list_components(options = {})
392
392
  new_api_call_builder
393
393
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -418,7 +418,7 @@ module AdvancedBilling
418
418
  # @param [String] component_id Required parameter: The id or handle of the
419
419
  # component
420
420
  # @param [UpdateComponentRequest] body Optional parameter: Example:
421
- # @return [ComponentResponse] response from the API call
421
+ # @return [ComponentResponse] response from the API call.
422
422
  def update_component(component_id,
423
423
  body: nil)
424
424
  new_api_call_builder
@@ -484,7 +484,7 @@ module AdvancedBilling
484
484
  # components with a timestamp at or after exact time provided in query. You
485
485
  # can specify timezone in query - otherwise your site's time zone will be
486
486
  # used. If provided, this parameter will be used instead of start_date.
487
- # @return [Array[ComponentResponse]] response from the API call
487
+ # @return [Array[ComponentResponse]] response from the API call.
488
488
  def list_components_for_product_family(options = {})
489
489
  new_api_call_builder
490
490
  .request(new_request_builder(HttpMethodEnum::GET,
data/lib/advanced_billing/controllers/coupons_controller.rb CHANGED
@@ -28,7 +28,7 @@ module AdvancedBilling
28
28
  # @param [Integer] product_family_id Required parameter: The Advanced
29
29
  # Billing id of the product family to which the coupon belongs
30
30
  # @param [CreateOrUpdateCoupon] body Optional parameter: Example:
31
- # @return [CouponResponse] response from the API call
31
+ # @return [CouponResponse] response from the API call.
32
32
  def create_coupon(product_family_id,
33
33
  body: nil)
34
34
  new_api_call_builder
@@ -77,7 +77,7 @@ module AdvancedBilling
77
77
  # level, you can optionally pass the `?currency_prices=true` query param to
78
78
  # include an array of currency price data in the response. Use in query
79
79
  # `currency_prices=true`.
80
- # @return [Array[CouponResponse]] response from the API call
80
+ # @return [Array[CouponResponse]] response from the API call.
81
81
  def list_coupons_for_product_family(options = {})
82
82
  new_api_call_builder
83
83
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -110,7 +110,7 @@ module AdvancedBilling
110
110
  # @param [Integer] product_family_id Optional parameter: The Advanced
111
111
  # Billing id of the product family to which the coupon belongs
112
112
  # @param [String] code Optional parameter: The code of the coupon
113
- # @return [CouponResponse] response from the API call
113
+ # @return [CouponResponse] response from the API call.
114
114
  def find_coupon(product_family_id: nil,
115
115
  code: nil)
116
116
  new_api_call_builder
@@ -142,7 +142,7 @@ module AdvancedBilling
142
142
  # Billing id of the product family to which the coupon belongs
143
143
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
144
144
  # the coupon
145
- # @return [CouponResponse] response from the API call
145
+ # @return [CouponResponse] response from the API call.
146
146
  def read_coupon(product_family_id,
147
147
  coupon_id)
148
148
  new_api_call_builder
@@ -175,7 +175,7 @@ module AdvancedBilling
175
175
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
176
176
  # the coupon
177
177
  # @param [CreateOrUpdateCoupon] body Optional parameter: Example:
178
- # @return [CouponResponse] response from the API call
178
+ # @return [CouponResponse] response from the API call.
179
179
  def update_coupon(product_family_id,
180
180
  coupon_id,
181
181
  body: nil)
@@ -209,7 +209,7 @@ module AdvancedBilling
209
209
  # Billing id of the product family to which the coupon belongs
210
210
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
211
211
  # the coupon
212
- # @return [CouponResponse] response from the API call
212
+ # @return [CouponResponse] response from the API call.
213
213
  def archive_coupon(product_family_id,
214
214
  coupon_id)
215
215
  new_api_call_builder
@@ -252,7 +252,7 @@ module AdvancedBilling
252
252
  # level, you can optionally pass the `?currency_prices=true` query param to
253
253
  # include an array of currency price data in the response. Use in query
254
254
  # `currency_prices=true`.
255
- # @return [Array[CouponResponse]] response from the API call
255
+ # @return [Array[CouponResponse]] response from the API call.
256
256
  def list_coupons(options = {})
257
257
  new_api_call_builder
258
258
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -278,7 +278,7 @@ module AdvancedBilling
278
278
  # Billing id of the product family to which the coupon belongs
279
279
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
280
280
  # the coupon
281
- # @return [Array[CouponUsage]] response from the API call
281
+ # @return [Array[CouponUsage]] response from the API call.
282
282
  def read_coupon_usage(product_family_id,
283
283
  coupon_id)
284
284
  new_api_call_builder
@@ -329,7 +329,7 @@ module AdvancedBilling
329
329
  # @param [String] code Required parameter: The code of the coupon
330
330
  # @param [Integer] product_family_id Optional parameter: The Advanced
331
331
  # Billing id of the product family to which the coupon belongs
332
- # @return [CouponResponse] response from the API call
332
+ # @return [CouponResponse] response from the API call.
333
333
  def validate_coupon(code,
334
334
  product_family_id: nil)
335
335
  new_api_call_builder
@@ -360,7 +360,7 @@ module AdvancedBilling
360
360
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
361
361
  # the coupon
362
362
  # @param [CouponCurrencyRequest] body Optional parameter: Example:
363
- # @return [CouponCurrencyResponse] response from the API call
363
+ # @return [CouponCurrencyResponse] response from the API call.
364
364
  def create_or_update_coupon_currency_prices(coupon_id,
365
365
  body: nil)
366
366
  new_api_call_builder
@@ -422,7 +422,7 @@ module AdvancedBilling
422
422
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
423
423
  # the coupon
424
424
  # @param [CouponSubcodes] body Optional parameter: Example:
425
- # @return [CouponSubcodesResponse] response from the API call
425
+ # @return [CouponSubcodesResponse] response from the API call.
426
426
  def create_coupon_subcodes(coupon_id,
427
427
  body: nil)
428
428
  new_api_call_builder
@@ -458,7 +458,7 @@ module AdvancedBilling
458
458
  # many records to fetch in each request. Default value is 20. The maximum
459
459
  # allowed values is 200; any per_page value over 200 will be changed to 200.
460
460
  # Use in query `per_page=200`.
461
- # @return [CouponSubcodes] response from the API call
461
+ # @return [CouponSubcodes] response from the API call.
462
462
  def list_coupon_subcodes(options = {})
463
463
  new_api_call_builder
464
464
  .request(new_request_builder(HttpMethodEnum::GET,
@@ -489,7 +489,7 @@ module AdvancedBilling
489
489
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
490
490
  # the coupon
491
491
  # @param [CouponSubcodes] body Optional parameter: Example:
492
- # @return [CouponSubcodesResponse] response from the API call
492
+ # @return [CouponSubcodesResponse] response from the API call.
493
493
  def update_coupon_subcodes(coupon_id,
494
494
  body: nil)
495
495
  new_api_call_builder
@@ -533,7 +533,7 @@ module AdvancedBilling
533
533
  # @param [Integer] coupon_id Required parameter: The Advanced Billing id of
534
534
  # the coupon to which the subcode belongs
535
535
  # @param [String] subcode Required parameter: The subcode of the coupon
536
- # @return [void] response from the API call
536
+ # @return [void] response from the API call.
537
537
  def delete_coupon_subcode(coupon_id,
538
538
  subcode)
539
539
  new_api_call_builder