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.
- 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/create_invoice_payment.rb +17 -3
- data/lib/advanced_billing/models/customer.rb +29 -2
- data/lib/advanced_billing/models/customer_attributes.rb +16 -0
- data/lib/advanced_billing/models/invoice_payment.rb +24 -1
- data/lib/advanced_billing/models/list_products_filter.rb +12 -2
- data/lib/advanced_billing/models/update_subscription.rb +25 -1
- metadata +2 -2
@@ -44,7 +44,7 @@ module AdvancedBilling
|
|
44
44
|
# @param [ResourceType] resource_type Required parameter: the resource type
|
45
45
|
# to which the metafields belong
|
46
46
|
# @param [CreateMetafieldsRequest] body Optional parameter: Example:
|
47
|
-
# @return [Array[Metafield]] response from the API call
|
47
|
+
# @return [Array[Metafield]] response from the API call.
|
48
48
|
def create_metafields(resource_type,
|
49
49
|
body: nil)
|
50
50
|
new_api_call_builder
|
@@ -89,7 +89,7 @@ module AdvancedBilling
|
|
89
89
|
# Use in query `per_page=200`.
|
90
90
|
# @param [SortingDirection] direction Optional parameter: Controls the order
|
91
91
|
# in which results are returned. Use in query `direction=asc`.
|
92
|
-
# @return [ListMetafieldsResponse] response from the API call
|
92
|
+
# @return [ListMetafieldsResponse] response from the API call.
|
93
93
|
def list_metafields(options = {})
|
94
94
|
new_api_call_builder
|
95
95
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -115,7 +115,7 @@ module AdvancedBilling
|
|
115
115
|
# @param [ResourceType] resource_type Required parameter: the resource type
|
116
116
|
# to which the metafields belong
|
117
117
|
# @param [UpdateMetafieldsRequest] body Optional parameter: Example:
|
118
|
-
# @return [Array[Metafield]] response from the API call
|
118
|
+
# @return [Array[Metafield]] response from the API call.
|
119
119
|
def update_metafield(resource_type,
|
120
120
|
body: nil)
|
121
121
|
new_api_call_builder
|
@@ -149,7 +149,7 @@ module AdvancedBilling
|
|
149
149
|
# to which the metafields belong
|
150
150
|
# @param [String] name Optional parameter: The name of the metafield to be
|
151
151
|
# deleted
|
152
|
-
# @return [void] response from the API call
|
152
|
+
# @return [void] response from the API call.
|
153
153
|
def delete_metafield(resource_type,
|
154
154
|
name: nil)
|
155
155
|
new_api_call_builder
|
@@ -202,7 +202,7 @@ module AdvancedBilling
|
|
202
202
|
# @param [Integer] resource_id Required parameter: The Advanced Billing id
|
203
203
|
# of the customer or the subscription for which the metadata applies
|
204
204
|
# @param [CreateMetadataRequest] body Optional parameter: Example:
|
205
|
-
# @return [Array[Metadata]] response from the API call
|
205
|
+
# @return [Array[Metadata]] response from the API call.
|
206
206
|
def create_metadata(resource_type,
|
207
207
|
resource_id,
|
208
208
|
body: nil)
|
@@ -252,7 +252,7 @@ module AdvancedBilling
|
|
252
252
|
# many records to fetch in each request. Default value is 20. The maximum
|
253
253
|
# allowed values is 200; any per_page value over 200 will be changed to 200.
|
254
254
|
# Use in query `per_page=200`.
|
255
|
-
# @return [PaginatedMetadata] response from the API call
|
255
|
+
# @return [PaginatedMetadata] response from the API call.
|
256
256
|
def list_metadata(options = {})
|
257
257
|
new_api_call_builder
|
258
258
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -281,7 +281,7 @@ module AdvancedBilling
|
|
281
281
|
# @param [Integer] resource_id Required parameter: The Advanced Billing id
|
282
282
|
# of the customer or the subscription for which the metadata applies
|
283
283
|
# @param [UpdateMetadataRequest] body Optional parameter: Example:
|
284
|
-
# @return [Array[Metadata]] response from the API call
|
284
|
+
# @return [Array[Metadata]] response from the API call.
|
285
285
|
def update_metadata(resource_type,
|
286
286
|
resource_id,
|
287
287
|
body: nil)
|
@@ -338,7 +338,7 @@ module AdvancedBilling
|
|
338
338
|
# @param [Array[String]] names Optional parameter: Names of fields to be
|
339
339
|
# removed. Use in query:
|
340
340
|
# `names[]=field1&names[]=my-field&names[]=another-field`.
|
341
|
-
# @return [void] response from the API call
|
341
|
+
# @return [void] response from the API call.
|
342
342
|
def delete_metadata(resource_type,
|
343
343
|
resource_id,
|
344
344
|
name: nil,
|
@@ -417,7 +417,7 @@ module AdvancedBilling
|
|
417
417
|
# `resource_ids[]=122&resource_ids[]=123&resource_ids[]=124`.
|
418
418
|
# @param [SortingDirection] direction Optional parameter: Controls the order
|
419
419
|
# in which results are returned. Use in query `direction=asc`.
|
420
|
-
# @return [PaginatedMetadata] response from the API call
|
420
|
+
# @return [PaginatedMetadata] response from the API call.
|
421
421
|
def list_metadata_for_resource_type(options = {})
|
422
422
|
new_api_call_builder
|
423
423
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -42,7 +42,7 @@ module AdvancedBilling
|
|
42
42
|
# Locale](https://maxio.zendesk.com/hc/en-us/articles/24286672013709-Custome
|
43
43
|
# r-Locale)
|
44
44
|
# @param [CreateCustomerRequest] body Optional parameter: Example:
|
45
|
-
# @return [CustomerResponse] response from the API call
|
45
|
+
# @return [CustomerResponse] response from the API call.
|
46
46
|
def create_customer(body: nil)
|
47
47
|
new_api_call_builder
|
48
48
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -112,7 +112,7 @@ module AdvancedBilling
|
|
112
112
|
# be used. If provided, this parameter will be used instead of end_date.
|
113
113
|
# @param [String] q Optional parameter: A search query by which to filter
|
114
114
|
# customers (can be an email, an ID, a reference, organization)
|
115
|
-
# @return [Array[CustomerResponse]] response from the API call
|
115
|
+
# @return [Array[CustomerResponse]] response from the API call.
|
116
116
|
def list_customers(options = {})
|
117
117
|
new_api_call_builder
|
118
118
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -140,7 +140,7 @@ module AdvancedBilling
|
|
140
140
|
# Billing-generated Customer ID.
|
141
141
|
# @param [Integer] id Required parameter: The Advanced Billing id of the
|
142
142
|
# customer
|
143
|
-
# @return [CustomerResponse] response from the API call
|
143
|
+
# @return [CustomerResponse] response from the API call.
|
144
144
|
def read_customer(id)
|
145
145
|
new_api_call_builder
|
146
146
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -161,7 +161,7 @@ module AdvancedBilling
|
|
161
161
|
# @param [Integer] id Required parameter: The Advanced Billing id of the
|
162
162
|
# customer
|
163
163
|
# @param [UpdateCustomerRequest] body Optional parameter: Example:
|
164
|
-
# @return [CustomerResponse] response from the API call
|
164
|
+
# @return [CustomerResponse] response from the API call.
|
165
165
|
def update_customer(id,
|
166
166
|
body: nil)
|
167
167
|
new_api_call_builder
|
@@ -192,7 +192,7 @@ module AdvancedBilling
|
|
192
192
|
# This method allows you to delete the Customer.
|
193
193
|
# @param [Integer] id Required parameter: The Advanced Billing id of the
|
194
194
|
# customer
|
195
|
-
# @return [void] response from the API call
|
195
|
+
# @return [void] response from the API call.
|
196
196
|
def delete_customer(id)
|
197
197
|
new_api_call_builder
|
198
198
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -210,7 +210,7 @@ module AdvancedBilling
|
|
210
210
|
# Use this method to return the customer object if you have the unique
|
211
211
|
# **Reference ID (Your App)** value handy. It will return a single match.
|
212
212
|
# @param [String] reference Required parameter: Customer reference
|
213
|
-
# @return [CustomerResponse] response from the API call
|
213
|
+
# @return [CustomerResponse] response from the API call.
|
214
214
|
def read_customer_by_reference(reference)
|
215
215
|
new_api_call_builder
|
216
216
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -229,7 +229,7 @@ module AdvancedBilling
|
|
229
229
|
# This method lists all subscriptions that belong to a customer.
|
230
230
|
# @param [Integer] customer_id Required parameter: The Chargify id of the
|
231
231
|
# customer
|
232
|
-
# @return [Array[SubscriptionResponse]] response from the API call
|
232
|
+
# @return [Array[SubscriptionResponse]] response from the API call.
|
233
233
|
def list_customer_subscriptions(customer_id)
|
234
234
|
new_api_call_builder
|
235
235
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -17,7 +17,7 @@ module AdvancedBilling
|
|
17
17
|
# @param [String] price_point_id Required parameter: ID or Handle for the
|
18
18
|
# Price Point belonging to the Component
|
19
19
|
# @param [CreateSegmentRequest] body Optional parameter: Example:
|
20
|
-
# @return [SegmentResponse] response from the API call
|
20
|
+
# @return [SegmentResponse] response from the API call.
|
21
21
|
def create_segment(component_id,
|
22
22
|
price_point_id,
|
23
23
|
body: nil)
|
@@ -73,7 +73,7 @@ module AdvancedBilling
|
|
73
73
|
# Use in query `per_page=200`.
|
74
74
|
# @param [ListSegmentsFilter] filter Optional parameter: Filter to use for
|
75
75
|
# List Segments for a Price Point operation
|
76
|
-
# @return [ListSegmentsResponse] response from the API call
|
76
|
+
# @return [ListSegmentsResponse] response from the API call.
|
77
77
|
def list_segments_for_price_point(options = {})
|
78
78
|
new_api_call_builder
|
79
79
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -114,7 +114,7 @@ module AdvancedBilling
|
|
114
114
|
# Price Point belonging to the Component
|
115
115
|
# @param [Float] id Required parameter: The ID of the Segment
|
116
116
|
# @param [UpdateSegmentRequest] body Optional parameter: Example:
|
117
|
-
# @return [SegmentResponse] response from the API call
|
117
|
+
# @return [SegmentResponse] response from the API call.
|
118
118
|
def update_segment(component_id,
|
119
119
|
price_point_id,
|
120
120
|
id,
|
@@ -158,7 +158,7 @@ module AdvancedBilling
|
|
158
158
|
# @param [String] price_point_id Required parameter: ID or Handle of the
|
159
159
|
# Price Point belonging to the Component
|
160
160
|
# @param [Float] id Required parameter: The ID of the Segment
|
161
|
-
# @return [void] response from the API call
|
161
|
+
# @return [void] response from the API call.
|
162
162
|
def delete_segment(component_id,
|
163
163
|
price_point_id,
|
164
164
|
id)
|
@@ -201,7 +201,7 @@ module AdvancedBilling
|
|
201
201
|
# @param [String] price_point_id Required parameter: ID or Handle for the
|
202
202
|
# Price Point belonging to the Component
|
203
203
|
# @param [BulkCreateSegments] body Optional parameter: Example:
|
204
|
-
# @return [ListSegmentsResponse] response from the API call
|
204
|
+
# @return [ListSegmentsResponse] response from the API call.
|
205
205
|
def bulk_create_segments(component_id,
|
206
206
|
price_point_id,
|
207
207
|
body: nil)
|
@@ -246,7 +246,7 @@ module AdvancedBilling
|
|
246
246
|
# @param [String] price_point_id Required parameter: ID or Handle for the
|
247
247
|
# Price Point belonging to the Component
|
248
248
|
# @param [BulkUpdateSegments] body Optional parameter: Example:
|
249
|
-
# @return [ListSegmentsResponse] response from the API call
|
249
|
+
# @return [ListSegmentsResponse] response from the API call.
|
250
250
|
def bulk_update_segments(component_id,
|
251
251
|
price_point_id,
|
252
252
|
body: nil)
|
@@ -106,7 +106,7 @@ module AdvancedBilling
|
|
106
106
|
# components with a timestamp at or before exact time provided in query. You
|
107
107
|
# can specify timezone in query - otherwise your site's time zone will be
|
108
108
|
# used. If provided, this parameter will be used instead of end_date.
|
109
|
-
# @return [Array[EventResponse]] response from the API call
|
109
|
+
# @return [Array[EventResponse]] response from the API call.
|
110
110
|
def list_events(options = {})
|
111
111
|
new_api_call_builder
|
112
112
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -157,7 +157,7 @@ module AdvancedBilling
|
|
157
157
|
# @param [Array[EventType]] filter Optional parameter: You can pass multiple
|
158
158
|
# event keys after comma. Use in query
|
159
159
|
# `filter=signup_success,payment_success`.
|
160
|
-
# @return [Array[EventResponse]] response from the API call
|
160
|
+
# @return [Array[EventResponse]] response from the API call.
|
161
161
|
def list_subscription_events(options = {})
|
162
162
|
new_api_call_builder
|
163
163
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -203,7 +203,7 @@ module AdvancedBilling
|
|
203
203
|
# @param [Array[EventType]] filter Optional parameter: You can pass multiple
|
204
204
|
# event keys after comma. Use in query
|
205
205
|
# `filter=signup_success,payment_success`.
|
206
|
-
# @return [CountResponse] response from the API call
|
206
|
+
# @return [CountResponse] response from the API call.
|
207
207
|
def read_events_count(options = {})
|
208
208
|
new_api_call_builder
|
209
209
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -15,7 +15,7 @@ module AdvancedBilling
|
|
15
15
|
# ```
|
16
16
|
# https://subdomain.chargify.com/dashboard
|
17
17
|
# ```
|
18
|
-
# @return [SiteSummary] response from the API call
|
18
|
+
# @return [SiteSummary] response from the API call.
|
19
19
|
def read_site_stats
|
20
20
|
new_api_call_builder
|
21
21
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -35,7 +35,7 @@ module AdvancedBilling
|
|
35
35
|
# ISO8601 format to request MRR for a historic time
|
36
36
|
# @param [Integer] subscription_id Optional parameter: submit the id of a
|
37
37
|
# subscription in order to limit results
|
38
|
-
# @return [MRRResponse] response from the API call
|
38
|
+
# @return [MRRResponse] response from the API call.
|
39
39
|
def read_mrr(at_time: nil,
|
40
40
|
subscription_id: nil)
|
41
41
|
warn 'Endpoint read_mrr in InsightsController is deprecated'
|
@@ -91,7 +91,7 @@ module AdvancedBilling
|
|
91
91
|
# Use in query `per_page=20`.
|
92
92
|
# @param [SortingDirection] direction Optional parameter: Controls the order
|
93
93
|
# in which results are returned. Use in query `direction=asc`.
|
94
|
-
# @return [ListMRRResponse] response from the API call
|
94
|
+
# @return [ListMRRResponse] response from the API call.
|
95
95
|
def list_mrr_movements(options = {})
|
96
96
|
warn 'Endpoint list_mrr_movements in InsightsController is deprecated'
|
97
97
|
new_api_call_builder
|
@@ -131,7 +131,7 @@ module AdvancedBilling
|
|
131
131
|
# @param [Direction] direction Optional parameter: Controls the order in
|
132
132
|
# which results are returned. Records are ordered by subscription_id in
|
133
133
|
# ascending order by default. Use in query `direction=desc`.
|
134
|
-
# @return [SubscriptionMRRResponse] response from the API call
|
134
|
+
# @return [SubscriptionMRRResponse] response from the API call.
|
135
135
|
def list_mrr_per_subscription(options = {})
|
136
136
|
warn 'Endpoint list_mrr_per_subscription in InsightsController is deprec'\
|
137
137
|
'ated'
|
@@ -16,7 +16,7 @@ module AdvancedBilling
|
|
16
16
|
# @param [String] uid Required parameter: The unique identifier for the
|
17
17
|
# invoice, this does not refer to the public facing invoice number.
|
18
18
|
# @param [RefundInvoiceRequest] body Optional parameter: Example:
|
19
|
-
# @return [Invoice] response from the API call
|
19
|
+
# @return [Invoice] response from the API call.
|
20
20
|
def refund_invoice(uid,
|
21
21
|
body: nil)
|
22
22
|
new_api_call_builder
|
@@ -116,7 +116,7 @@ module AdvancedBilling
|
|
116
116
|
# Use in query `product_ids=23,34`.
|
117
117
|
# @param [InvoiceSortField] sort Optional parameter: Allows specification of
|
118
118
|
# the order of the returned list. Use in query `sort=total_amount`.
|
119
|
-
# @return [ListInvoicesResponse] response from the API call
|
119
|
+
# @return [ListInvoicesResponse] response from the API call.
|
120
120
|
def list_invoices(options = {})
|
121
121
|
new_api_call_builder
|
122
122
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -167,7 +167,7 @@ module AdvancedBilling
|
|
167
167
|
# ```
|
168
168
|
# @param [String] uid Required parameter: The unique identifier for the
|
169
169
|
# invoice, this does not refer to the public facing invoice number.
|
170
|
-
# @return [Invoice] response from the API call
|
170
|
+
# @return [Invoice] response from the API call.
|
171
171
|
def read_invoice(uid)
|
172
172
|
new_api_call_builder
|
173
173
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -236,7 +236,7 @@ module AdvancedBilling
|
|
236
236
|
# @param [Array[InvoiceEventType]] event_types Optional parameter: Filter
|
237
237
|
# results by event_type. Supply a comma separated list of event types
|
238
238
|
# (listed above). Use in query: `event_types=void_invoice,void_remainder`.
|
239
|
-
# @return [ListInvoiceEventsResponse] response from the API call
|
239
|
+
# @return [ListInvoiceEventsResponse] response from the API call.
|
240
240
|
def list_invoice_events(options = {})
|
241
241
|
new_api_call_builder
|
242
242
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -308,7 +308,7 @@ module AdvancedBilling
|
|
308
308
|
# @param [String] uid Required parameter: The unique identifier for the
|
309
309
|
# invoice, this does not refer to the public facing invoice number.
|
310
310
|
# @param [CreateInvoicePaymentRequest] body Optional parameter: Example:
|
311
|
-
# @return [Invoice] response from the API call
|
311
|
+
# @return [Invoice] response from the API call.
|
312
312
|
def record_payment_for_invoice(uid,
|
313
313
|
body: nil)
|
314
314
|
new_api_call_builder
|
@@ -361,7 +361,7 @@ module AdvancedBilling
|
|
361
361
|
# must be greater or equal to invoices payment amount sum.
|
362
362
|
# @param [CreateMultiInvoicePaymentRequest] body Optional parameter:
|
363
363
|
# Example:
|
364
|
-
# @return [MultiInvoicePaymentResponse] response from the API call
|
364
|
+
# @return [MultiInvoicePaymentResponse] response from the API call.
|
365
365
|
def record_payment_for_multiple_invoices(body: nil)
|
366
366
|
new_api_call_builder
|
367
367
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -411,7 +411,7 @@ module AdvancedBilling
|
|
411
411
|
# refunds data
|
412
412
|
# @param [TrueClass | FalseClass] applications Optional parameter: Include
|
413
413
|
# applications data
|
414
|
-
# @return [ListCreditNotesResponse] response from the API call
|
414
|
+
# @return [ListCreditNotesResponse] response from the API call.
|
415
415
|
def list_credit_notes(options = {})
|
416
416
|
new_api_call_builder
|
417
417
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -436,7 +436,7 @@ module AdvancedBilling
|
|
436
436
|
# Use this endpoint to retrieve the details for a credit note.
|
437
437
|
# @param [String] uid Required parameter: The unique identifier of the
|
438
438
|
# credit note
|
439
|
-
# @return [CreditNote] response from the API call
|
439
|
+
# @return [CreditNote] response from the API call.
|
440
440
|
def read_credit_note(uid)
|
441
441
|
new_api_call_builder
|
442
442
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -464,7 +464,7 @@ module AdvancedBilling
|
|
464
464
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
465
465
|
# the subscription
|
466
466
|
# @param [RecordPaymentRequest] body Optional parameter: Example:
|
467
|
-
# @return [RecordPaymentResponse] response from the API call
|
467
|
+
# @return [RecordPaymentResponse] response from the API call.
|
468
468
|
def record_payment_for_subscription(subscription_id,
|
469
469
|
body: nil)
|
470
470
|
new_api_call_builder
|
@@ -509,7 +509,7 @@ module AdvancedBilling
|
|
509
509
|
# also be reopened.
|
510
510
|
# @param [String] uid Required parameter: The unique identifier for the
|
511
511
|
# invoice, this does not refer to the public facing invoice number.
|
512
|
-
# @return [Invoice] response from the API call
|
512
|
+
# @return [Invoice] response from the API call.
|
513
513
|
def reopen_invoice(uid)
|
514
514
|
new_api_call_builder
|
515
515
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -539,7 +539,7 @@ module AdvancedBilling
|
|
539
539
|
# @param [String] uid Required parameter: The unique identifier for the
|
540
540
|
# invoice, this does not refer to the public facing invoice number.
|
541
541
|
# @param [VoidInvoiceRequest] body Optional parameter: Example:
|
542
|
-
# @return [Invoice] response from the API call
|
542
|
+
# @return [Invoice] response from the API call.
|
543
543
|
def void_invoice(uid,
|
544
544
|
body: nil)
|
545
545
|
new_api_call_builder
|
@@ -585,7 +585,7 @@ module AdvancedBilling
|
|
585
585
|
# Use in query `per_page=200`.
|
586
586
|
# @param [Direction] direction Optional parameter: Sort direction of the
|
587
587
|
# returned segments.
|
588
|
-
# @return [ConsolidatedInvoice] response from the API call
|
588
|
+
# @return [ConsolidatedInvoice] response from the API call.
|
589
589
|
def list_consolidated_invoice_segments(options = {})
|
590
590
|
new_api_call_builder
|
591
591
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -772,7 +772,7 @@ module AdvancedBilling
|
|
772
772
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
773
773
|
# the subscription
|
774
774
|
# @param [CreateInvoiceRequest] body Optional parameter: Example:
|
775
|
-
# @return [InvoiceResponse] response from the API call
|
775
|
+
# @return [InvoiceResponse] response from the API call.
|
776
776
|
def create_invoice(subscription_id,
|
777
777
|
body: nil)
|
778
778
|
new_api_call_builder
|
@@ -814,7 +814,7 @@ module AdvancedBilling
|
|
814
814
|
# @param [String] uid Required parameter: The unique identifier for the
|
815
815
|
# invoice, this does not refer to the public facing invoice number.
|
816
816
|
# @param [SendInvoiceRequest] body Optional parameter: Example:
|
817
|
-
# @return [void] response from the API call
|
817
|
+
# @return [void] response from the API call.
|
818
818
|
def send_invoice(uid,
|
819
819
|
body: nil)
|
820
820
|
new_api_call_builder
|
@@ -845,7 +845,7 @@ module AdvancedBilling
|
|
845
845
|
# differences are calculated on the application side.
|
846
846
|
# @param [String] uid Required parameter: The unique identifier for the
|
847
847
|
# invoice, this does not refer to the public facing invoice number.
|
848
|
-
# @return [CustomerChangesPreviewResponse] response from the API call
|
848
|
+
# @return [CustomerChangesPreviewResponse] response from the API call.
|
849
849
|
def preview_customer_information_changes(uid)
|
850
850
|
new_api_call_builder
|
851
851
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -877,7 +877,7 @@ module AdvancedBilling
|
|
877
877
|
# differences are calculated on the application side.
|
878
878
|
# @param [String] uid Required parameter: The unique identifier for the
|
879
879
|
# invoice, this does not refer to the public facing invoice number.
|
880
|
-
# @return [Invoice] response from the API call
|
880
|
+
# @return [Invoice] response from the API call.
|
881
881
|
def update_customer_information(uid)
|
882
882
|
new_api_call_builder
|
883
883
|
.request(new_request_builder(HttpMethodEnum::PUT,
|
@@ -931,7 +931,7 @@ module AdvancedBilling
|
|
931
931
|
# @param [String] uid Required parameter: The unique identifier for the
|
932
932
|
# invoice, this does not refer to the public facing invoice number.
|
933
933
|
# @param [IssueInvoiceRequest] body Optional parameter: Example:
|
934
|
-
# @return [Invoice] response from the API call
|
934
|
+
# @return [Invoice] response from the API call.
|
935
935
|
def issue_invoice(uid,
|
936
936
|
body: nil)
|
937
937
|
new_api_call_builder
|
@@ -24,7 +24,7 @@ module AdvancedBilling
|
|
24
24
|
# `product_price_point_id` is not passed in, the product's default price
|
25
25
|
# point will be used.
|
26
26
|
# @param [CreateOfferRequest] body Optional parameter: Example:
|
27
|
-
# @return [OfferResponse] response from the API call
|
27
|
+
# @return [OfferResponse] response from the API call.
|
28
28
|
def create_offer(body: nil)
|
29
29
|
new_api_call_builder
|
30
30
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -59,7 +59,7 @@ module AdvancedBilling
|
|
59
59
|
# Use in query `per_page=200`.
|
60
60
|
# @param [TrueClass | FalseClass] include_archived Optional parameter:
|
61
61
|
# Include archived products. Use in query: `include_archived=true`.
|
62
|
-
# @return [ListOffersResponse] response from the API call
|
62
|
+
# @return [ListOffersResponse] response from the API call.
|
63
63
|
def list_offers(options = {})
|
64
64
|
new_api_call_builder
|
65
65
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -80,7 +80,7 @@ module AdvancedBilling
|
|
80
80
|
# different than list all offers for a site, as it requires an `offer_id`.
|
81
81
|
# @param [Integer] offer_id Required parameter: The Chargify id of the
|
82
82
|
# offer
|
83
|
-
# @return [OfferResponse] response from the API call
|
83
|
+
# @return [OfferResponse] response from the API call.
|
84
84
|
def read_offer(offer_id)
|
85
85
|
new_api_call_builder
|
86
86
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -101,7 +101,7 @@ module AdvancedBilling
|
|
101
101
|
# archive the correct item.
|
102
102
|
# @param [Integer] offer_id Required parameter: The Chargify id of the
|
103
103
|
# offer
|
104
|
-
# @return [void] response from the API call
|
104
|
+
# @return [void] response from the API call.
|
105
105
|
def archive_offer(offer_id)
|
106
106
|
new_api_call_builder
|
107
107
|
.request(new_request_builder(HttpMethodEnum::PUT,
|
@@ -120,7 +120,7 @@ module AdvancedBilling
|
|
120
120
|
# order to un-archive the correct item.
|
121
121
|
# @param [Integer] offer_id Required parameter: The Chargify id of the
|
122
122
|
# offer
|
123
|
-
# @return [void] response from the API call
|
123
|
+
# @return [void] response from the API call.
|
124
124
|
def unarchive_offer(offer_id)
|
125
125
|
new_api_call_builder
|
126
126
|
.request(new_request_builder(HttpMethodEnum::PUT,
|
@@ -325,7 +325,7 @@ module AdvancedBilling
|
|
325
325
|
# account and mandate will be created in your current vault. If the
|
326
326
|
# customer, bank account, and mandate already exist in your vault, follow
|
327
327
|
# the Import example to link the payment profile into Advanced Billing.
|
328
|
-
# @return [PaymentProfileResponse] response from the API call
|
328
|
+
# @return [PaymentProfileResponse] response from the API call.
|
329
329
|
def create_payment_profile(body: nil)
|
330
330
|
new_api_call_builder
|
331
331
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -365,7 +365,7 @@ module AdvancedBilling
|
|
365
365
|
# Use in query `per_page=200`.
|
366
366
|
# @param [Integer] customer_id Optional parameter: The ID of the customer
|
367
367
|
# for which you wish to list payment profiles
|
368
|
-
# @return [Array[PaymentProfileResponse]] response from the API call
|
368
|
+
# @return [Array[PaymentProfileResponse]] response from the API call.
|
369
369
|
def list_payment_profiles(options = {})
|
370
370
|
new_api_call_builder
|
371
371
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -418,7 +418,7 @@ module AdvancedBilling
|
|
418
418
|
# ```
|
419
419
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
420
420
|
# the payment profile
|
421
|
-
# @return [PaymentProfileResponse] response from the API call
|
421
|
+
# @return [PaymentProfileResponse] response from the API call.
|
422
422
|
def read_payment_profile(payment_profile_id)
|
423
423
|
new_api_call_builder
|
424
424
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -483,7 +483,7 @@ module AdvancedBilling
|
|
483
483
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
484
484
|
# the payment profile
|
485
485
|
# @param [UpdatePaymentProfileRequest] body Optional parameter: Example:
|
486
|
-
# @return [PaymentProfileResponse] response from the API call
|
486
|
+
# @return [PaymentProfileResponse] response from the API call.
|
487
487
|
def update_payment_profile(payment_profile_id,
|
488
488
|
body: nil)
|
489
489
|
new_api_call_builder
|
@@ -516,7 +516,7 @@ module AdvancedBilling
|
|
516
516
|
# 422 and error message will be returned.
|
517
517
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
518
518
|
# the payment profile
|
519
|
-
# @return [void] response from the API call
|
519
|
+
# @return [void] response from the API call.
|
520
520
|
def delete_unused_payment_profile(payment_profile_id)
|
521
521
|
new_api_call_builder
|
522
522
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
@@ -552,7 +552,7 @@ module AdvancedBilling
|
|
552
552
|
# the subscription
|
553
553
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
554
554
|
# the payment profile
|
555
|
-
# @return [void] response from the API call
|
555
|
+
# @return [void] response from the API call.
|
556
556
|
def delete_subscriptions_payment_profile(subscription_id,
|
557
557
|
payment_profile_id)
|
558
558
|
new_api_call_builder
|
@@ -577,7 +577,7 @@ module AdvancedBilling
|
|
577
577
|
# bank account in the system.
|
578
578
|
# @param [BankAccountVerificationRequest] body Optional parameter:
|
579
579
|
# Example:
|
580
|
-
# @return [BankAccountResponse] response from the API call
|
580
|
+
# @return [BankAccountResponse] response from the API call.
|
581
581
|
def verify_bank_account(bank_account_id,
|
582
582
|
body: nil)
|
583
583
|
new_api_call_builder
|
@@ -612,7 +612,7 @@ module AdvancedBilling
|
|
612
612
|
# group
|
613
613
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
614
614
|
# the payment profile
|
615
|
-
# @return [void] response from the API call
|
615
|
+
# @return [void] response from the API call.
|
616
616
|
def delete_subscription_group_payment_profile(uid,
|
617
617
|
payment_profile_id)
|
618
618
|
new_api_call_builder
|
@@ -639,7 +639,7 @@ module AdvancedBilling
|
|
639
639
|
# the subscription
|
640
640
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
641
641
|
# the payment profile
|
642
|
-
# @return [PaymentProfileResponse] response from the API call
|
642
|
+
# @return [PaymentProfileResponse] response from the API call.
|
643
643
|
def change_subscription_default_payment_profile(subscription_id,
|
644
644
|
payment_profile_id)
|
645
645
|
new_api_call_builder
|
@@ -677,7 +677,7 @@ module AdvancedBilling
|
|
677
677
|
# group
|
678
678
|
# @param [Integer] payment_profile_id Required parameter: The Chargify id of
|
679
679
|
# the payment profile
|
680
|
-
# @return [PaymentProfileResponse] response from the API call
|
680
|
+
# @return [PaymentProfileResponse] response from the API call.
|
681
681
|
def change_subscription_group_default_payment_profile(uid,
|
682
682
|
payment_profile_id)
|
683
683
|
new_api_call_builder
|
@@ -712,7 +712,7 @@ module AdvancedBilling
|
|
712
712
|
# NjAzNDI0-overview).
|
713
713
|
# @param [String] chargify_token Required parameter: Advanced Billing
|
714
714
|
# Token
|
715
|
-
# @return [GetOneTimeTokenRequest] response from the API call
|
715
|
+
# @return [GetOneTimeTokenRequest] response from the API call.
|
716
716
|
def read_one_time_token(chargify_token)
|
717
717
|
new_api_call_builder
|
718
718
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -749,7 +749,7 @@ module AdvancedBilling
|
|
749
749
|
# encounter errors during the request process.
|
750
750
|
# @param [Integer] subscription_id Required parameter: The Chargify id of
|
751
751
|
# the subscription
|
752
|
-
# @return [void] response from the API call
|
752
|
+
# @return [void] response from the API call.
|
753
753
|
def send_request_update_payment_email(subscription_id)
|
754
754
|
new_api_call_builder
|
755
755
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -49,7 +49,7 @@ module AdvancedBilling
|
|
49
49
|
# @param [ListProductsInclude] include Optional parameter: Allows including
|
50
50
|
# additional data in the response. Use in query
|
51
51
|
# `include=prepaid_product_price_point`.
|
52
|
-
# @return [Array[ProductResponse]] response from the API call
|
52
|
+
# @return [Array[ProductResponse]] response from the API call.
|
53
53
|
def list_products_for_product_family(options = {})
|
54
54
|
new_api_call_builder
|
55
55
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -89,7 +89,7 @@ module AdvancedBilling
|
|
89
89
|
# [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-
|
90
90
|
# Families).
|
91
91
|
# @param [CreateProductFamilyRequest] body Optional parameter: Example:
|
92
|
-
# @return [ProductFamilyResponse] response from the API call
|
92
|
+
# @return [ProductFamilyResponse] response from the API call.
|
93
93
|
def create_product_family(body: nil)
|
94
94
|
new_api_call_builder
|
95
95
|
.request(new_request_builder(HttpMethodEnum::POST,
|
@@ -132,7 +132,7 @@ module AdvancedBilling
|
|
132
132
|
# products with a timestamp at or before exact time provided in query. You
|
133
133
|
# can specify timezone in query - otherwise your site's time zone will be
|
134
134
|
# used. If provided, this parameter will be used instead of end_date.
|
135
|
-
# @return [Array[ProductFamilyResponse]] response from the API call
|
135
|
+
# @return [Array[ProductFamilyResponse]] response from the API call.
|
136
136
|
def list_product_families(options = {})
|
137
137
|
new_api_call_builder
|
138
138
|
.request(new_request_builder(HttpMethodEnum::GET,
|
@@ -158,7 +158,7 @@ module AdvancedBilling
|
|
158
158
|
# `handle:my-family` format.
|
159
159
|
# @param [Integer] id Required parameter: The Advanced Billing id of the
|
160
160
|
# product family
|
161
|
-
# @return [ProductFamilyResponse] response from the API call
|
161
|
+
# @return [ProductFamilyResponse] response from the API call.
|
162
162
|
def read_product_family(id)
|
163
163
|
new_api_call_builder
|
164
164
|
.request(new_request_builder(HttpMethodEnum::GET,
|