maxio-advanced-billing-sdk 5.0.0 → 5.1.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 +41 -41
- data/lib/advanced_billing/controllers/advance_invoice_controller.rb +3 -3
- data/lib/advanced_billing/controllers/api_exports_controller.rb +9 -9
- data/lib/advanced_billing/controllers/base_controller.rb +1 -1
- data/lib/advanced_billing/controllers/billing_portal_controller.rb +4 -4
- data/lib/advanced_billing/controllers/component_price_points_controller.rb +11 -11
- data/lib/advanced_billing/controllers/components_controller.rb +12 -12
- data/lib/advanced_billing/controllers/coupons_controller.rb +14 -14
- data/lib/advanced_billing/controllers/custom_fields_controller.rb +9 -9
- data/lib/advanced_billing/controllers/customers_controller.rb +7 -7
- data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb +6 -6
- data/lib/advanced_billing/controllers/events_controller.rb +3 -3
- data/lib/advanced_billing/controllers/insights_controller.rb +4 -4
- data/lib/advanced_billing/controllers/invoices_controller.rb +17 -17
- data/lib/advanced_billing/controllers/offers_controller.rb +5 -5
- data/lib/advanced_billing/controllers/payment_profiles_controller.rb +12 -12
- data/lib/advanced_billing/controllers/product_families_controller.rb +4 -4
- data/lib/advanced_billing/controllers/product_price_points_controller.rb +11 -11
- data/lib/advanced_billing/controllers/products_controller.rb +6 -6
- data/lib/advanced_billing/controllers/proforma_invoices_controller.rb +9 -9
- data/lib/advanced_billing/controllers/reason_codes_controller.rb +5 -5
- data/lib/advanced_billing/controllers/referral_codes_controller.rb +1 -1
- data/lib/advanced_billing/controllers/sales_commissions_controller.rb +3 -3
- data/lib/advanced_billing/controllers/sites_controller.rb +3 -3
- data/lib/advanced_billing/controllers/subscription_components_controller.rb +17 -17
- data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb +4 -4
- data/lib/advanced_billing/controllers/subscription_group_status_controller.rb +4 -4
- data/lib/advanced_billing/controllers/subscription_groups_controller.rb +9 -9
- data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb +6 -6
- data/lib/advanced_billing/controllers/subscription_notes_controller.rb +5 -5
- data/lib/advanced_billing/controllers/subscription_products_controller.rb +2 -2
- data/lib/advanced_billing/controllers/subscription_status_controller.rb +10 -10
- data/lib/advanced_billing/controllers/subscriptions_controller.rb +12 -12
- data/lib/advanced_billing/controllers/webhooks_controller.rb +6 -6
- data/lib/advanced_billing/models/cancellation_method.rb +4 -1
- data/lib/advanced_billing/models/list_products_filter.rb +12 -2
- metadata +2 -2
@@ -14,7 +14,7 @@ module AdvancedBilling
|
|
14
14
|
# `handle:`
|
15
15
|
# @param [CreateProductPricePointRequest] body Optional parameter:
|
16
16
|
# Example:
|
17
|
-
# @return [ProductPricePointResponse] response from the API call
|
17
|
+
# @return [ProductPricePointResponse] response from the API call.
|
18
18
|
def create_product_price_point(product_id,
|
19
19
|
body: nil)
|
20
20
|
new_api_call_builder
|
@@ -67,7 +67,7 @@ module AdvancedBilling
|
|
67
67
|
# it will return all of the defined prices for each currency.
|
68
68
|
# @param [Array[PricePointType]] filter_type Optional parameter: Use in
|
69
69
|
# query: `filter[type]=catalog,default`.
|
70
|
-
# @return [ListProductPricePointsResponse] response from the API call
|
70
|
+
# @return [ListProductPricePointsResponse] response from the API call.
|
71
71
|
def list_product_price_points(options = {})
|
72
72
|
new_api_call_builder
|
73
73
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -105,7 +105,7 @@ module AdvancedBilling
|
|
105
105
|
# `handle:example-product-price-point-handle` for a string handle.
|
106
106
|
# @param [UpdateProductPricePointRequest] body Optional parameter:
|
107
107
|
# Example:
|
108
|
-
# @return [ProductPricePointResponse] response from the API call
|
108
|
+
# @return [ProductPricePointResponse] response from the API call.
|
109
109
|
def update_product_price_point(product_id,
|
110
110
|
price_point_id,
|
111
111
|
body: nil)
|
@@ -155,7 +155,7 @@ module AdvancedBilling
|
|
155
155
|
# product price point is set to use_site_exchange_rate: true, it will return
|
156
156
|
# pricing based on the current exchange rate. If the flag is set to false,
|
157
157
|
# it will return all of the defined prices for each currency.
|
158
|
-
# @return [ProductPricePointResponse] response from the API call
|
158
|
+
# @return [ProductPricePointResponse] response from the API call.
|
159
159
|
def read_product_price_point(product_id,
|
160
160
|
price_point_id,
|
161
161
|
currency_prices: nil)
|
@@ -195,7 +195,7 @@ module AdvancedBilling
|
|
195
195
|
# handle of the price point. When using the handle, it must be prefixed with
|
196
196
|
# `handle:`. Example: `123` for an integer ID, or
|
197
197
|
# `handle:example-product-price-point-handle` for a string handle.
|
198
|
-
# @return [ProductPricePointResponse] response from the API call
|
198
|
+
# @return [ProductPricePointResponse] response from the API call.
|
199
199
|
def archive_product_price_point(product_id,
|
200
200
|
price_point_id)
|
201
201
|
new_api_call_builder
|
@@ -233,7 +233,7 @@ module AdvancedBilling
|
|
233
233
|
# the product to which the price point belongs
|
234
234
|
# @param [Integer] price_point_id Required parameter: The Advanced Billing
|
235
235
|
# id of the product price point
|
236
|
-
# @return [ProductPricePointResponse] response from the API call
|
236
|
+
# @return [ProductPricePointResponse] response from the API call.
|
237
237
|
def unarchive_product_price_point(product_id,
|
238
238
|
price_point_id)
|
239
239
|
new_api_call_builder
|
@@ -262,7 +262,7 @@ module AdvancedBilling
|
|
262
262
|
# the product to which the price point belongs
|
263
263
|
# @param [Integer] price_point_id Required parameter: The Advanced Billing
|
264
264
|
# id of the product price point
|
265
|
-
# @return [ProductResponse] response from the API call
|
265
|
+
# @return [ProductResponse] response from the API call.
|
266
266
|
def promote_product_price_point_to_default(product_id,
|
267
267
|
price_point_id)
|
268
268
|
new_api_call_builder
|
@@ -288,7 +288,7 @@ module AdvancedBilling
|
|
288
288
|
# the product to which the price points belong
|
289
289
|
# @param [BulkCreateProductPricePointsRequest] body Optional parameter:
|
290
290
|
# Example:
|
291
|
-
# @return [BulkCreateProductPricePointsResponse] response from the API call
|
291
|
+
# @return [BulkCreateProductPricePointsResponse] response from the API call.
|
292
292
|
def bulk_create_product_price_points(product_id,
|
293
293
|
body: nil)
|
294
294
|
new_api_call_builder
|
@@ -324,7 +324,7 @@ module AdvancedBilling
|
|
324
324
|
# Billing id of the product price point
|
325
325
|
# @param [CreateProductCurrencyPricesRequest] body Optional parameter:
|
326
326
|
# Example:
|
327
|
-
# @return [CurrencyPricesResponse] response from the API call
|
327
|
+
# @return [CurrencyPricesResponse] response from the API call.
|
328
328
|
def create_product_currency_prices(product_price_point_id,
|
329
329
|
body: nil)
|
330
330
|
new_api_call_builder
|
@@ -359,7 +359,7 @@ module AdvancedBilling
|
|
359
359
|
# @param [Integer] product_price_point_id Required parameter: The Advanced
|
360
360
|
# Billing id of the product price point
|
361
361
|
# @param [UpdateCurrencyPricesRequest] body Optional parameter: Example:
|
362
|
-
# @return [CurrencyPricesResponse] response from the API call
|
362
|
+
# @return [CurrencyPricesResponse] response from the API call.
|
363
363
|
def update_product_currency_prices(product_price_point_id,
|
364
364
|
body: nil)
|
365
365
|
new_api_call_builder
|
@@ -404,7 +404,7 @@ module AdvancedBilling
|
|
404
404
|
# many records to fetch in each request. Default value is 20. The maximum
|
405
405
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
406
406
|
# Use in query `per_page=200`.
|
407
|
-
# @return [ListProductPricePointsResponse] response from the API call
|
407
|
+
# @return [ListProductPricePointsResponse] response from the API call.
|
408
408
|
def list_all_product_price_points(options = {})
|
409
409
|
new_api_call_builder
|
410
410
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -16,7 +16,7 @@ module AdvancedBilling
|
|
16
16
|
# @param [String] product_family_id Required parameter: Either the product
|
17
17
|
# family's id or its handle prefixed with `handle:`
|
18
18
|
# @param [CreateOrUpdateProductRequest] body Optional parameter: Example:
|
19
|
-
# @return [ProductResponse] response from the API call
|
19
|
+
# @return [ProductResponse] response from the API call.
|
20
20
|
def create_product(product_family_id,
|
21
21
|
body: nil)
|
22
22
|
new_api_call_builder
|
@@ -45,7 +45,7 @@ module AdvancedBilling
|
|
45
45
|
# you've created in Advanced Billing.
|
46
46
|
# @param [Integer] product_id Required parameter: The Advanced Billing id of
|
47
47
|
# the product
|
48
|
-
# @return [ProductResponse] response from the API call
|
48
|
+
# @return [ProductResponse] response from the API call.
|
49
49
|
def read_product(product_id)
|
50
50
|
new_api_call_builder
|
51
51
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -73,7 +73,7 @@ module AdvancedBilling
|
|
73
73
|
# @param [Integer] product_id Required parameter: The Advanced Billing id of
|
74
74
|
# the product
|
75
75
|
# @param [CreateOrUpdateProductRequest] body Optional parameter: Example:
|
76
|
-
# @return [ProductResponse] response from the API call
|
76
|
+
# @return [ProductResponse] response from the API call.
|
77
77
|
def update_product(product_id,
|
78
78
|
body: nil)
|
79
79
|
new_api_call_builder
|
@@ -105,7 +105,7 @@ module AdvancedBilling
|
|
105
105
|
# Billing Portal, as well as disable Public Signup Pages for the product.
|
106
106
|
# @param [Integer] product_id Required parameter: The Advanced Billing id of
|
107
107
|
# the product
|
108
|
-
# @return [ProductResponse] response from the API call
|
108
|
+
# @return [ProductResponse] response from the API call.
|
109
109
|
def archive_product(product_id)
|
110
110
|
new_api_call_builder
|
111
111
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -128,7 +128,7 @@ module AdvancedBilling
|
|
128
128
|
|
129
129
|
# This method allows to retrieve a Product object by its `api_handle`.
|
130
130
|
# @param [String] api_handle Required parameter: The handle of the product
|
131
|
-
# @return [ProductResponse] response from the API call
|
131
|
+
# @return [ProductResponse] response from the API call.
|
132
132
|
def read_product_by_handle(api_handle)
|
133
133
|
new_api_call_builder
|
134
134
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -186,7 +186,7 @@ module AdvancedBilling
|
|
186
186
|
# @param [ListProductsInclude] include Optional parameter: Allows including
|
187
187
|
# additional data in the response. Use in query
|
188
188
|
# `include=prepaid_product_price_point`.
|
189
|
-
# @return [Array[ProductResponse]] response from the API call
|
189
|
+
# @return [Array[ProductResponse]] response from the API call.
|
190
190
|
def list_products(options = {})
|
191
191
|
new_api_call_builder
|
192
192
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -19,7 +19,7 @@ module AdvancedBilling
|
|
19
19
|
# be in a live state.
|
20
20
|
# @param [String] uid Required parameter: The uid of the subscription
|
21
21
|
# group
|
22
|
-
# @return [void] response from the API call
|
22
|
+
# @return [void] response from the API call.
|
23
23
|
def create_consolidated_proforma_invoice(uid)
|
24
24
|
new_api_call_builder
|
25
25
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -58,7 +58,7 @@ module AdvancedBilling
|
|
58
58
|
# payments data
|
59
59
|
# @param [TrueClass | FalseClass] custom_fields Optional parameter: Include
|
60
60
|
# custom fields data
|
61
|
-
# @return [ListProformaInvoicesResponse] response from the API call
|
61
|
+
# @return [ListProformaInvoicesResponse] response from the API call.
|
62
62
|
def list_subscription_group_proforma_invoices(options = {})
|
63
63
|
new_api_call_builder
|
64
64
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -89,7 +89,7 @@ module AdvancedBilling
|
|
89
89
|
# Proforma invoices are only available on Relationship Invoicing sites.
|
90
90
|
# @param [String] proforma_invoice_uid Required parameter: The uid of the
|
91
91
|
# proforma invoice
|
92
|
-
# @return [ProformaInvoice] response from the API call
|
92
|
+
# @return [ProformaInvoice] response from the API call.
|
93
93
|
def read_proforma_invoice(proforma_invoice_uid)
|
94
94
|
new_api_call_builder
|
95
95
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -120,7 +120,7 @@ module AdvancedBilling
|
|
120
120
|
# not be prepaid, and must be in a live state.
|
121
121
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
122
122
|
# the subscription
|
123
|
-
# @return [ProformaInvoice] response from the API call
|
123
|
+
# @return [ProformaInvoice] response from the API call.
|
124
124
|
def create_proforma_invoice(subscription_id)
|
125
125
|
new_api_call_builder
|
126
126
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -179,7 +179,7 @@ module AdvancedBilling
|
|
179
179
|
# payments data
|
180
180
|
# @param [TrueClass | FalseClass] custom_fields Optional parameter: Include
|
181
181
|
# custom fields data
|
182
|
-
# @return [ListProformaInvoicesResponse] response from the API call
|
182
|
+
# @return [ListProformaInvoicesResponse] response from the API call.
|
183
183
|
def list_proforma_invoices(options = {})
|
184
184
|
new_api_call_builder
|
185
185
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -220,7 +220,7 @@ module AdvancedBilling
|
|
220
220
|
# @param [String] proforma_invoice_uid Required parameter: The uid of the
|
221
221
|
# proforma invoice
|
222
222
|
# @param [VoidInvoiceRequest] body Optional parameter: Example:
|
223
|
-
# @return [ProformaInvoice] response from the API call
|
223
|
+
# @return [ProformaInvoice] response from the API call.
|
224
224
|
def void_proforma_invoice(proforma_invoice_uid,
|
225
225
|
body: nil)
|
226
226
|
new_api_call_builder
|
@@ -267,7 +267,7 @@ module AdvancedBilling
|
|
267
267
|
# subscription's upcoming renewal has changed.
|
268
268
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
269
269
|
# the subscription
|
270
|
-
# @return [ProformaInvoice] response from the API call
|
270
|
+
# @return [ProformaInvoice] response from the API call.
|
271
271
|
def preview_proforma_invoice(subscription_id)
|
272
272
|
new_api_call_builder
|
273
273
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -306,7 +306,7 @@ module AdvancedBilling
|
|
306
306
|
# customer_id to easily find their proforma invoices, since the
|
307
307
|
# subscription_id will always be blank.
|
308
308
|
# @param [CreateSubscriptionRequest] body Optional parameter: Example:
|
309
|
-
# @return [ProformaInvoice] response from the API call
|
309
|
+
# @return [ProformaInvoice] response from the API call.
|
310
310
|
def create_signup_proforma_invoice(body: nil)
|
311
311
|
new_api_call_builder
|
312
312
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -348,7 +348,7 @@ module AdvancedBilling
|
|
348
348
|
# Choose to include a proforma invoice preview for the first renewal. Use in
|
349
349
|
# query `include=next_proforma_invoice`.
|
350
350
|
# @param [CreateSubscriptionRequest] body Optional parameter: Example:
|
351
|
-
# @return [SignupProformaPreviewResponse] response from the API call
|
351
|
+
# @return [SignupProformaPreviewResponse] response from the API call.
|
352
352
|
def preview_signup_proforma_invoice(include: nil,
|
353
353
|
body: nil)
|
354
354
|
new_api_call_builder
|
@@ -22,7 +22,7 @@ module AdvancedBilling
|
|
22
22
|
# This method gives a merchant the option to create a reason codes for a
|
23
23
|
# given Site.
|
24
24
|
# @param [CreateReasonCodeRequest] body Optional parameter: Example:
|
25
|
-
# @return [ReasonCodeResponse] response from the API call
|
25
|
+
# @return [ReasonCodeResponse] response from the API call.
|
26
26
|
def create_reason_code(body: nil)
|
27
27
|
new_api_call_builder
|
28
28
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -56,7 +56,7 @@ module AdvancedBilling
|
|
56
56
|
# many records to fetch in each request. Default value is 20. The maximum
|
57
57
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
58
58
|
# Use in query `per_page=200`.
|
59
|
-
# @return [Array[ReasonCodeResponse]] response from the API call
|
59
|
+
# @return [Array[ReasonCodeResponse]] response from the API call.
|
60
60
|
def list_reason_codes(options = {})
|
61
61
|
new_api_call_builder
|
62
62
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -77,7 +77,7 @@ module AdvancedBilling
|
|
77
77
|
# code for a given Site by providing the unique numerical ID of the code.
|
78
78
|
# @param [Integer] reason_code_id Required parameter: The Advanced Billing
|
79
79
|
# id of the reason code
|
80
|
-
# @return [ReasonCodeResponse] response from the API call
|
80
|
+
# @return [ReasonCodeResponse] response from the API call.
|
81
81
|
def read_reason_code(reason_code_id)
|
82
82
|
new_api_call_builder
|
83
83
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -102,7 +102,7 @@ module AdvancedBilling
|
|
102
102
|
# @param [Integer] reason_code_id Required parameter: The Advanced Billing
|
103
103
|
# id of the reason code
|
104
104
|
# @param [UpdateReasonCodeRequest] body Optional parameter: Example:
|
105
|
-
# @return [ReasonCodeResponse] response from the API call
|
105
|
+
# @return [ReasonCodeResponse] response from the API call.
|
106
106
|
def update_reason_code(reason_code_id,
|
107
107
|
body: nil)
|
108
108
|
new_api_call_builder
|
@@ -131,7 +131,7 @@ module AdvancedBilling
|
|
131
131
|
# not reversable.
|
132
132
|
# @param [Integer] reason_code_id Required parameter: The Advanced Billing
|
133
133
|
# id of the reason code
|
134
|
-
# @return [ReasonCodesJsonResponse] response from the API call
|
134
|
+
# @return [ReasonCodesJsonResponse] response from the API call.
|
135
135
|
def delete_reason_code(reason_code_id)
|
136
136
|
new_api_call_builder
|
137
137
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -20,7 +20,7 @@ module AdvancedBilling
|
|
20
20
|
# response will be returned.
|
21
21
|
# @param [String] code Required parameter: The referral code you are trying
|
22
22
|
# to validate
|
23
|
-
# @return [ReferralValidationResponse] response from the API call
|
23
|
+
# @return [ReferralValidationResponse] response from the API call.
|
24
24
|
def validate_referral_code(code)
|
25
25
|
new_api_call_builder
|
26
26
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -41,7 +41,7 @@ module AdvancedBilling
|
|
41
41
|
# set will be returned. Use in query `page=1`.
|
42
42
|
# @param [Integer] per_page Optional parameter: This parameter indicates how
|
43
43
|
# many records to fetch in each request. Default value is 100.
|
44
|
-
# @return [Array[SaleRepSettings]] response from the API call
|
44
|
+
# @return [Array[SaleRepSettings]] response from the API call.
|
45
45
|
def list_sales_commission_settings(options = {})
|
46
46
|
new_api_call_builder
|
47
47
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -98,7 +98,7 @@ module AdvancedBilling
|
|
98
98
|
# set will be returned. Use in query `page=1`.
|
99
99
|
# @param [Integer] per_page Optional parameter: This parameter indicates how
|
100
100
|
# many records to fetch in each request. Default value is 100.
|
101
|
-
# @return [Array[ListSaleRepItem]] response from the API call
|
101
|
+
# @return [Array[ListSaleRepItem]] response from the API call.
|
102
102
|
def list_sales_reps(options = {})
|
103
103
|
new_api_call_builder
|
104
104
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -157,7 +157,7 @@ module AdvancedBilling
|
|
157
157
|
# set will be returned. Use in query `page=1`.
|
158
158
|
# @param [Integer] per_page Optional parameter: This parameter indicates how
|
159
159
|
# many records to fetch in each request. Default value is 100.
|
160
|
-
# @return [SaleRep] response from the API call
|
160
|
+
# @return [SaleRep] response from the API call.
|
161
161
|
def read_sales_rep(seller_id,
|
162
162
|
sales_rep_id,
|
163
163
|
authorization: 'Bearer <<apiKey>>',
|
@@ -21,7 +21,7 @@ module AdvancedBilling
|
|
21
21
|
# [Who Pays & Customer
|
22
22
|
# Hierarchy](https://maxio.zendesk.com/hc/en-us/articles/24252185211533-Cust
|
23
23
|
# omer-Hierarchies-WhoPays)
|
24
|
-
# @return [SiteResponse] response from the API call
|
24
|
+
# @return [SiteResponse] response from the API call.
|
25
25
|
def read_site
|
26
26
|
new_api_call_builder
|
27
27
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -47,7 +47,7 @@ module AdvancedBilling
|
|
47
47
|
# `customers`: Will clear only customers and related subscriptions (leaving
|
48
48
|
# the products untouched) for the site. Revenue will also be reset to 0.
|
49
49
|
# Use in query `cleanup_scope=all`.
|
50
|
-
# @return [void] response from the API call
|
50
|
+
# @return [void] response from the API call.
|
51
51
|
def clear_site(cleanup_scope: CleanupScope::ALL)
|
52
52
|
new_api_call_builder
|
53
53
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -72,7 +72,7 @@ module AdvancedBilling
|
|
72
72
|
# many records to fetch in each request. Default value is 20. The maximum
|
73
73
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
74
74
|
# Use in query `per_page=200`.
|
75
|
-
# @return [ListPublicKeysResponse] response from the API call
|
75
|
+
# @return [ListPublicKeysResponse] response from the API call.
|
76
76
|
def list_chargify_js_public_keys(options = {})
|
77
77
|
new_api_call_builder
|
78
78
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -13,7 +13,7 @@ module AdvancedBilling
|
|
13
13
|
# @param [Integer] component_id Required parameter: The Advanced Billing id
|
14
14
|
# of the component. Alternatively, the component's handle prefixed by
|
15
15
|
# `handle:`
|
16
|
-
# @return [SubscriptionComponentResponse] response from the API call
|
16
|
+
# @return [SubscriptionComponentResponse] response from the API call.
|
17
17
|
def read_subscription_component(subscription_id,
|
18
18
|
component_id)
|
19
19
|
new_api_call_builder
|
@@ -84,7 +84,7 @@ module AdvancedBilling
|
|
84
84
|
# set to true, it returns only components that are currently in use.
|
85
85
|
# However, if it's set to false or not provided, it returns all components
|
86
86
|
# connected with the subscription.
|
87
|
-
# @return [Array[SubscriptionComponentResponse]] response from the API call
|
87
|
+
# @return [Array[SubscriptionComponentResponse]] response from the API call.
|
88
88
|
def list_subscription_components(options = {})
|
89
89
|
new_api_call_builder
|
90
90
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -125,7 +125,7 @@ module AdvancedBilling
|
|
125
125
|
# the subscription
|
126
126
|
# @param [BulkComponentsPricePointAssignment] body Optional parameter:
|
127
127
|
# Example:
|
128
|
-
# @return [BulkComponentsPricePointAssignment] response from the API call
|
128
|
+
# @return [BulkComponentsPricePointAssignment] response from the API call.
|
129
129
|
def bulk_update_subscription_components_price_points(subscription_id,
|
130
130
|
body: nil)
|
131
131
|
new_api_call_builder
|
@@ -155,7 +155,7 @@ module AdvancedBilling
|
|
155
155
|
# components, even ones that have not been allocated yet.
|
156
156
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
157
157
|
# the subscription
|
158
|
-
# @return [SubscriptionResponse] response from the API call
|
158
|
+
# @return [SubscriptionResponse] response from the API call.
|
159
159
|
def bulk_reset_subscription_components_price_points(subscription_id)
|
160
160
|
new_api_call_builder
|
161
161
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -244,7 +244,7 @@ module AdvancedBilling
|
|
244
244
|
# @param [Integer] component_id Required parameter: The Advanced Billing id
|
245
245
|
# of the component
|
246
246
|
# @param [CreateAllocationRequest] body Optional parameter: Example:
|
247
|
-
# @return [AllocationResponse] response from the API call
|
247
|
+
# @return [AllocationResponse] response from the API call.
|
248
248
|
def allocate_component(subscription_id,
|
249
249
|
component_id,
|
250
250
|
body: nil)
|
@@ -302,7 +302,7 @@ module AdvancedBilling
|
|
302
302
|
# passing in a page parameter. Retrieve the next page by adding ?page=2 to
|
303
303
|
# the query string. If there are no results to return, then an empty result
|
304
304
|
# set will be returned. Use in query `page=1`.
|
305
|
-
# @return [Array[AllocationResponse]] response from the API call
|
305
|
+
# @return [Array[AllocationResponse]] response from the API call.
|
306
306
|
def list_allocations(subscription_id,
|
307
307
|
component_id,
|
308
308
|
page: 1)
|
@@ -343,7 +343,7 @@ module AdvancedBilling
|
|
343
343
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
344
344
|
# the subscription
|
345
345
|
# @param [AllocateComponents] body Optional parameter: Example:
|
346
|
-
# @return [Array[AllocationResponse]] response from the API call
|
346
|
+
# @return [Array[AllocationResponse]] response from the API call.
|
347
347
|
def allocate_components(subscription_id,
|
348
348
|
body: nil)
|
349
349
|
new_api_call_builder
|
@@ -387,7 +387,7 @@ module AdvancedBilling
|
|
387
387
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
388
388
|
# the subscription
|
389
389
|
# @param [PreviewAllocationsRequest] body Optional parameter: Example:
|
390
|
-
# @return [AllocationPreviewResponse] response from the API call
|
390
|
+
# @return [AllocationPreviewResponse] response from the API call.
|
391
391
|
def preview_allocations(subscription_id,
|
392
392
|
body: nil)
|
393
393
|
new_api_call_builder
|
@@ -434,7 +434,7 @@ module AdvancedBilling
|
|
434
434
|
# of the allocation
|
435
435
|
# @param [UpdateAllocationExpirationDate] body Optional parameter:
|
436
436
|
# Example:
|
437
|
-
# @return [void] response from the API call
|
437
|
+
# @return [void] response from the API call.
|
438
438
|
def update_prepaid_usage_allocation_expiration_date(subscription_id,
|
439
439
|
component_id,
|
440
440
|
allocation_id,
|
@@ -490,7 +490,7 @@ module AdvancedBilling
|
|
490
490
|
# @param [Integer] allocation_id Required parameter: The Advanced Billing id
|
491
491
|
# of the allocation
|
492
492
|
# @param [CreditSchemeRequest] body Optional parameter: Example:
|
493
|
-
# @return [void] response from the API call
|
493
|
+
# @return [void] response from the API call.
|
494
494
|
def delete_prepaid_usage_allocation(subscription_id,
|
495
495
|
component_id,
|
496
496
|
allocation_id,
|
@@ -599,7 +599,7 @@ module AdvancedBilling
|
|
599
599
|
# Advanced Billing id for the component or the component's handle prefixed
|
600
600
|
# by `handle:`
|
601
601
|
# @param [CreateUsageRequest] body Optional parameter: Example:
|
602
|
-
# @return [UsageResponse] response from the API call
|
602
|
+
# @return [UsageResponse] response from the API call.
|
603
603
|
def create_usage(subscription_id,
|
604
604
|
component_id,
|
605
605
|
body: nil)
|
@@ -674,7 +674,7 @@ module AdvancedBilling
|
|
674
674
|
# many records to fetch in each request. Default value is 20. The maximum
|
675
675
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
676
676
|
# Use in query `per_page=200`.
|
677
|
-
# @return [Array[UsageResponse]] response from the API call
|
677
|
+
# @return [Array[UsageResponse]] response from the API call.
|
678
678
|
def list_usages(options = {})
|
679
679
|
new_api_call_builder
|
680
680
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -723,7 +723,7 @@ module AdvancedBilling
|
|
723
723
|
# @param [Integer] component_id Required parameter: The Advanced Billing id
|
724
724
|
# of the component
|
725
725
|
# @param [ActivateEventBasedComponent] body Optional parameter: Example:
|
726
|
-
# @return [void] response from the API call
|
726
|
+
# @return [void] response from the API call.
|
727
727
|
def activate_event_based_component(subscription_id,
|
728
728
|
component_id,
|
729
729
|
body: nil)
|
@@ -753,7 +753,7 @@ module AdvancedBilling
|
|
753
753
|
# id of the subscription
|
754
754
|
# @param [Integer] component_id Required parameter: The Advanced Billing id
|
755
755
|
# of the component
|
756
|
-
# @return [void] response from the API call
|
756
|
+
# @return [void] response from the API call.
|
757
757
|
def deactivate_event_based_component(subscription_id,
|
758
758
|
component_id)
|
759
759
|
new_api_call_builder
|
@@ -798,7 +798,7 @@ module AdvancedBilling
|
|
798
798
|
# Keen project as an Advanced Billing event data-store, use this parameter
|
799
799
|
# to indicate the data-store.
|
800
800
|
# @param [EBBEvent] body Optional parameter: Example:
|
801
|
-
# @return [void] response from the API call
|
801
|
+
# @return [void] response from the API call.
|
802
802
|
def record_event(subdomain,
|
803
803
|
api_handle,
|
804
804
|
store_uid: nil,
|
@@ -836,7 +836,7 @@ module AdvancedBilling
|
|
836
836
|
# Keen project as an Advanced Billing event data-store, use this parameter
|
837
837
|
# to indicate the data-store.
|
838
838
|
# @param [Array[EBBEvent]] body Optional parameter: Example:
|
839
|
-
# @return [void] response from the API call
|
839
|
+
# @return [void] response from the API call.
|
840
840
|
def bulk_record_events(subdomain,
|
841
841
|
api_handle,
|
842
842
|
store_uid: nil,
|
@@ -915,7 +915,7 @@ module AdvancedBilling
|
|
915
915
|
# @param [ListSubscriptionComponentsInclude] include Optional parameter:
|
916
916
|
# Allows including additional data in the response. Use in query
|
917
917
|
# `include=subscription,historic_usages`.
|
918
|
-
# @return [ListSubscriptionComponentsResponse] response from the API call
|
918
|
+
# @return [ListSubscriptionComponentsResponse] response from the API call.
|
919
919
|
def list_subscription_components_for_site(options = {})
|
920
920
|
new_api_call_builder
|
921
921
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -14,7 +14,7 @@ module AdvancedBilling
|
|
14
14
|
# group
|
15
15
|
# @param [SubscriptionGroupPrepaymentRequest] body Optional parameter:
|
16
16
|
# Example:
|
17
|
-
# @return [SubscriptionGroupPrepaymentResponse] response from the API call
|
17
|
+
# @return [SubscriptionGroupPrepaymentResponse] response from the API call.
|
18
18
|
def create_subscription_group_prepayment(uid,
|
19
19
|
body: nil)
|
20
20
|
new_api_call_builder
|
@@ -55,7 +55,7 @@ module AdvancedBilling
|
|
55
55
|
# Use in query `per_page=200`.
|
56
56
|
# @param [ListPrepaymentsFilter] filter Optional parameter: Filter to use
|
57
57
|
# for List Prepayments operations
|
58
|
-
# @return [ListSubscriptionGroupPrepaymentResponse] response from the API call
|
58
|
+
# @return [ListSubscriptionGroupPrepaymentResponse] response from the API call.
|
59
59
|
def list_prepayments_for_subscription_group(options = {})
|
60
60
|
new_api_call_builder
|
61
61
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -86,7 +86,7 @@ module AdvancedBilling
|
|
86
86
|
# @param [String] uid Required parameter: The uid of the subscription
|
87
87
|
# group
|
88
88
|
# @param [IssueServiceCreditRequest] body Optional parameter: Example:
|
89
|
-
# @return [ServiceCreditResponse] response from the API call
|
89
|
+
# @return [ServiceCreditResponse] response from the API call.
|
90
90
|
def issue_subscription_group_service_credit(uid,
|
91
91
|
body: nil)
|
92
92
|
new_api_call_builder
|
@@ -117,7 +117,7 @@ module AdvancedBilling
|
|
117
117
|
# @param [String] uid Required parameter: The uid of the subscription
|
118
118
|
# group
|
119
119
|
# @param [DeductServiceCreditRequest] body Optional parameter: Example:
|
120
|
-
# @return [ServiceCredit] response from the API call
|
120
|
+
# @return [ServiceCredit] response from the API call.
|
121
121
|
def deduct_subscription_group_service_credit(uid,
|
122
122
|
body: nil)
|
123
123
|
new_api_call_builder
|
@@ -18,7 +18,7 @@ module AdvancedBilling
|
|
18
18
|
# group
|
19
19
|
# @param [CancelGroupedSubscriptionsRequest] body Optional parameter:
|
20
20
|
# Example:
|
21
|
-
# @return [void] response from the API call
|
21
|
+
# @return [void] response from the API call.
|
22
22
|
def cancel_subscriptions_in_group(uid,
|
23
23
|
body: nil)
|
24
24
|
new_api_call_builder
|
@@ -48,7 +48,7 @@ module AdvancedBilling
|
|
48
48
|
# successfully cancel them, and the group must not be in a "past_due" state.
|
49
49
|
# @param [String] uid Required parameter: The uid of the subscription
|
50
50
|
# group
|
51
|
-
# @return [void] response from the API call
|
51
|
+
# @return [void] response from the API call.
|
52
52
|
def initiate_delayed_cancellation_for_group(uid)
|
53
53
|
new_api_call_builder
|
54
54
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -73,7 +73,7 @@ module AdvancedBilling
|
|
73
73
|
# member in the group.
|
74
74
|
# @param [String] uid Required parameter: The uid of the subscription
|
75
75
|
# group
|
76
|
-
# @return [void] response from the API call
|
76
|
+
# @return [void] response from the API call.
|
77
77
|
def cancel_delayed_cancellation_for_group(uid)
|
78
78
|
new_api_call_builder
|
79
79
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -129,7 +129,7 @@ module AdvancedBilling
|
|
129
129
|
# group
|
130
130
|
# @param [ReactivateSubscriptionGroupRequest] body Optional parameter:
|
131
131
|
# Example:
|
132
|
-
# @return [ReactivateSubscriptionGroupResponse] response from the API call
|
132
|
+
# @return [ReactivateSubscriptionGroupResponse] response from the API call.
|
133
133
|
def reactivate_subscription_group(uid,
|
134
134
|
body: nil)
|
135
135
|
new_api_call_builder
|
@@ -19,7 +19,7 @@ module AdvancedBilling
|
|
19
19
|
# `product_handle` or `offer_id`. You can also use `custom_price` instead.
|
20
20
|
# @param [SubscriptionGroupSignupRequest] body Optional parameter:
|
21
21
|
# Example:
|
22
|
-
# @return [SubscriptionGroupSignupResponse] response from the API call
|
22
|
+
# @return [SubscriptionGroupSignupResponse] response from the API call.
|
23
23
|
def signup_with_subscription_group(body: nil)
|
24
24
|
new_api_call_builder
|
25
25
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -43,7 +43,7 @@ module AdvancedBilling
|
|
43
43
|
# Creates a subscription group with given members.
|
44
44
|
# @param [CreateSubscriptionGroupRequest] body Optional parameter:
|
45
45
|
# Example:
|
46
|
-
# @return [SubscriptionGroupResponse] response from the API call
|
46
|
+
# @return [SubscriptionGroupResponse] response from the API call.
|
47
47
|
def create_subscription_group(body: nil)
|
48
48
|
new_api_call_builder
|
49
49
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -85,7 +85,7 @@ module AdvancedBilling
|
|
85
85
|
# A list of additional information to include in the response. The following
|
86
86
|
# values are supported: - `account_balances`: Account balance information
|
87
87
|
# for the subscription groups. Use in query: `include[]=account_balances`
|
88
|
-
# @return [ListSubscriptionGroupsResponse] response from the API call
|
88
|
+
# @return [ListSubscriptionGroupsResponse] response from the API call.
|
89
89
|
def list_subscription_groups(options = {})
|
90
90
|
new_api_call_builder
|
91
91
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -114,7 +114,7 @@ module AdvancedBilling
|
|
114
114
|
# @param [Array[SubscriptionGroupInclude]] include Optional parameter:
|
115
115
|
# Allows including additional data in the response. Use in query:
|
116
116
|
# `include[]=current_billing_amount_in_cents`.
|
117
|
-
# @return [FullSubscriptionGroupResponse] response from the API call
|
117
|
+
# @return [FullSubscriptionGroupResponse] response from the API call.
|
118
118
|
def read_subscription_group(uid,
|
119
119
|
include: nil)
|
120
120
|
new_api_call_builder
|
@@ -143,7 +143,7 @@ module AdvancedBilling
|
|
143
143
|
# group
|
144
144
|
# @param [UpdateSubscriptionGroupRequest] body Optional parameter:
|
145
145
|
# Example:
|
146
|
-
# @return [SubscriptionGroupResponse] response from the API call
|
146
|
+
# @return [SubscriptionGroupResponse] response from the API call.
|
147
147
|
def update_subscription_group_members(uid,
|
148
148
|
body: nil)
|
149
149
|
new_api_call_builder
|
@@ -172,7 +172,7 @@ module AdvancedBilling
|
|
172
172
|
# Only groups without members can be deleted
|
173
173
|
# @param [String] uid Required parameter: The uid of the subscription
|
174
174
|
# group
|
175
|
-
# @return [DeleteSubscriptionGroupResponse] response from the API call
|
175
|
+
# @return [DeleteSubscriptionGroupResponse] response from the API call.
|
176
176
|
def delete_subscription_group(uid)
|
177
177
|
new_api_call_builder
|
178
178
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -196,7 +196,7 @@ module AdvancedBilling
|
|
196
196
|
# If the subscription is not in a group endpoint will return 404 code.
|
197
197
|
# @param [String] subscription_id Required parameter: The Advanced Billing
|
198
198
|
# id of the subscription associated with the subscription group
|
199
|
-
# @return [FullSubscriptionGroupResponse] response from the API call
|
199
|
+
# @return [FullSubscriptionGroupResponse] response from the API call.
|
200
200
|
def find_subscription_group(subscription_id)
|
201
201
|
new_api_call_builder
|
202
202
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -248,7 +248,7 @@ module AdvancedBilling
|
|
248
248
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
249
249
|
# the subscription
|
250
250
|
# @param [AddSubscriptionToAGroup] body Optional parameter: Example:
|
251
|
-
# @return [SubscriptionGroupResponse] response from the API call
|
251
|
+
# @return [SubscriptionGroupResponse] response from the API call.
|
252
252
|
def add_subscription_to_group(subscription_id,
|
253
253
|
body: nil)
|
254
254
|
new_api_call_builder
|
@@ -277,7 +277,7 @@ module AdvancedBilling
|
|
277
277
|
# remove existing subscription from subscription group.
|
278
278
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
279
279
|
# the subscription
|
280
|
-
# @return [void] response from the API call
|
280
|
+
# @return [void] response from the API call.
|
281
281
|
def remove_subscription_from_group(subscription_id)
|
282
282
|
new_api_call_builder
|
283
283
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|