bf_ruby2 1.2016.229 → 1.2016.230
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +53 -29
- data/bf_ruby2-1.2016.229.gem +0 -0
- data/docs/AccountsApi.md +82 -31
- data/docs/AddChargeToAccountResponse.md +9 -0
- data/docs/AddChargeToAccountResponsePagedMetadata.md +14 -0
- data/docs/AddChargesToAccountAPIRequest.md +17 -0
- data/docs/AddressesApi.md +4 -4
- data/docs/AmendmentsApi.md +13 -13
- data/docs/AnalyticsApi.md +15 -15
- data/docs/AuditlogsApi.md +5 -5
- data/docs/BatchUpdatePricingComponentValuesRequest.md +9 -0
- data/docs/ChargesApi.md +56 -8
- data/docs/ClientsApi.md +6 -6
- data/docs/ConfigurationsApi.md +6 -6
- data/docs/CouponbookApi.md +11 -11
- data/docs/CouponbookdefinitionApi.md +8 -8
- data/docs/CoupondefinitionApi.md +7 -7
- data/docs/CouponinstanceApi.md +12 -12
- data/docs/CouponmodifierApi.md +9 -9
- data/docs/CouponruleApi.md +6 -6
- data/docs/CouponsApi.md +10 -10
- data/docs/CreateSubscriptionChargeAmendment.md +0 -1
- data/docs/CreateSubscriptionRequest.md +2 -0
- data/docs/CreditnotesApi.md +7 -7
- data/docs/CybersourcetokensApi.md +7 -7
- data/docs/DunninglinesApi.md +8 -8
- data/docs/EmailprovidersApi.md +5 -5
- data/docs/EmailsApi.md +1 -1
- data/docs/EmailsubscriptionsApi.md +7 -7
- data/docs/FixedtermdefinitionsApi.md +4 -4
- data/docs/FixedtermsApi.md +2 -2
- data/docs/Invoice.md +3 -0
- data/docs/InvoicesApi.md +63 -63
- data/docs/MetadataApi.md +6 -6
- data/docs/NestedChargeRequest.md +19 -0
- data/docs/NotificationsApi.md +6 -6
- data/docs/OrganizationsApi.md +9 -9
- data/docs/PasswordsApi.md +2 -2
- data/docs/PaymentmethodsApi.md +10 -10
- data/docs/PaymentmethodsubscriptionlinksApi.md +3 -3
- data/docs/PaymentsApi.md +9 -9
- data/docs/PeriodsApi.md +2 -2
- data/docs/PermissionsApi.md +8 -8
- data/docs/PricingcalculatorApi.md +6 -6
- data/docs/PricingcomponentsApi.md +8 -8
- data/docs/PricingcomponenttiersApi.md +7 -7
- data/docs/PricingcomponentvaluechangesApi.md +7 -7
- data/docs/PricingcomponentvaluesApi.md +7 -7
- data/docs/ProductrateplansApi.md +27 -27
- data/docs/ProductsApi.md +17 -17
- data/docs/ProfilesApi.md +6 -6
- data/docs/QuotesApi.md +2 -2
- data/docs/RecalculateChargeBatchRequest.md +12 -0
- data/docs/RecalculateChargeBatchResponse.md +11 -0
- data/docs/RecalculateChargeBatchResponsePagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +6 -6
- data/docs/RefundsApi.md +9 -9
- data/docs/RolesApi.md +8 -8
- data/docs/SearchApi.md +1 -1
- data/docs/SingleRecalculateChargeRequest.md +15 -0
- data/docs/Subscription.md +1 -0
- data/docs/SubscriptionsApi.md +153 -102
- data/docs/SynchAppConfigsApi.md +6 -6
- data/docs/SynchConfigsApi.md +8 -8
- data/docs/SynchJobsApi.md +10 -10
- data/docs/TaxationlinksApi.md +8 -8
- data/docs/TaxationstrategiesApi.md +11 -11
- data/docs/TimeApi.md +1 -1
- data/docs/TokenizationApi.md +6 -6
- data/docs/UnitofmeasureApi.md +6 -6
- data/docs/UpdatePricingComponentValueChangeResult.md +19 -0
- data/docs/UpdatePricingComponentValueRequest.md +10 -0
- data/docs/UpdatePricingComponentValueResponse.md +9 -0
- data/docs/UpdatePricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/UsageApi.md +7 -7
- data/docs/UsageperiodsApi.md +3 -3
- data/docs/UsageroundingstrategiesApi.md +6 -6
- data/docs/UsagesessionsApi.md +6 -6
- data/docs/UsernamesApi.md +2 -2
- data/docs/UsersApi.md +16 -16
- data/docs/VaultedgatewaysApi.md +22 -22
- data/docs/WebhooksApi.md +10 -10
- data/lib/bf_ruby2.rb +13 -0
- data/lib/bf_ruby2/api/accounts_api.rb +92 -31
- data/lib/bf_ruby2/api/addresses_api.rb +4 -4
- data/lib/bf_ruby2/api/amendments_api.rb +13 -13
- data/lib/bf_ruby2/api/analytics_api.rb +15 -15
- data/lib/bf_ruby2/api/auditlogs_api.rb +5 -5
- data/lib/bf_ruby2/api/charges_api.rb +65 -8
- data/lib/bf_ruby2/api/clients_api.rb +6 -6
- data/lib/bf_ruby2/api/configurations_api.rb +6 -6
- data/lib/bf_ruby2/api/couponbook_api.rb +11 -11
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +8 -8
- data/lib/bf_ruby2/api/coupondefinition_api.rb +7 -7
- data/lib/bf_ruby2/api/couponinstance_api.rb +12 -12
- data/lib/bf_ruby2/api/couponmodifier_api.rb +9 -9
- data/lib/bf_ruby2/api/couponrule_api.rb +6 -6
- data/lib/bf_ruby2/api/coupons_api.rb +10 -10
- data/lib/bf_ruby2/api/creditnotes_api.rb +7 -7
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +7 -7
- data/lib/bf_ruby2/api/dunninglines_api.rb +8 -8
- data/lib/bf_ruby2/api/emailproviders_api.rb +5 -5
- data/lib/bf_ruby2/api/emails_api.rb +1 -1
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +7 -7
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +4 -4
- data/lib/bf_ruby2/api/fixedterms_api.rb +2 -2
- data/lib/bf_ruby2/api/invoices_api.rb +63 -63
- data/lib/bf_ruby2/api/metadata_api.rb +6 -6
- data/lib/bf_ruby2/api/notifications_api.rb +6 -6
- data/lib/bf_ruby2/api/organizations_api.rb +9 -9
- data/lib/bf_ruby2/api/passwords_api.rb +2 -2
- data/lib/bf_ruby2/api/paymentmethods_api.rb +10 -10
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +3 -3
- data/lib/bf_ruby2/api/payments_api.rb +9 -9
- data/lib/bf_ruby2/api/periods_api.rb +2 -2
- data/lib/bf_ruby2/api/permissions_api.rb +8 -8
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +6 -6
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +8 -8
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +7 -7
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +7 -7
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +7 -7
- data/lib/bf_ruby2/api/productrateplans_api.rb +27 -27
- data/lib/bf_ruby2/api/products_api.rb +17 -17
- data/lib/bf_ruby2/api/profiles_api.rb +6 -6
- data/lib/bf_ruby2/api/quotes_api.rb +2 -2
- data/lib/bf_ruby2/api/receipts_api.rb +6 -6
- data/lib/bf_ruby2/api/refunds_api.rb +9 -9
- data/lib/bf_ruby2/api/roles_api.rb +8 -8
- data/lib/bf_ruby2/api/search_api.rb +1 -1
- data/lib/bf_ruby2/api/subscriptions_api.rb +163 -102
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +6 -6
- data/lib/bf_ruby2/api/synch_configs_api.rb +8 -8
- data/lib/bf_ruby2/api/synch_jobs_api.rb +10 -10
- data/lib/bf_ruby2/api/taxationlinks_api.rb +8 -8
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +11 -11
- data/lib/bf_ruby2/api/time_api.rb +1 -1
- data/lib/bf_ruby2/api/tokenization_api.rb +6 -6
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +6 -6
- data/lib/bf_ruby2/api/usage_api.rb +7 -7
- data/lib/bf_ruby2/api/usageperiods_api.rb +3 -3
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +6 -6
- data/lib/bf_ruby2/api/usagesessions_api.rb +6 -6
- data/lib/bf_ruby2/api/usernames_api.rb +2 -2
- data/lib/bf_ruby2/api/users_api.rb +16 -16
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +22 -22
- data/lib/bf_ruby2/api/webhooks_api.rb +10 -10
- data/lib/bf_ruby2/models/add_charge_to_account_response.rb +212 -0
- data/lib/bf_ruby2/models/add_charge_to_account_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charges_to_account_api_request.rb +337 -0
- data/lib/bf_ruby2/models/batch_update_pricing_component_values_request.rb +244 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +1 -24
- data/lib/bf_ruby2/models/create_subscription_request.rb +24 -4
- data/lib/bf_ruby2/models/invoice.rb +32 -1
- data/lib/bf_ruby2/models/nested_charge_request.rb +343 -0
- data/lib/bf_ruby2/models/recalculate_charge_batch_request.rb +279 -0
- data/lib/bf_ruby2/models/recalculate_charge_batch_response.rb +234 -0
- data/lib/bf_ruby2/models/recalculate_charge_batch_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/single_recalculate_charge_request.rb +317 -0
- data/lib/bf_ruby2/models/subscription.rb +11 -1
- data/lib/bf_ruby2/models/update_pricing_component_value_change_result.rb +367 -0
- data/lib/bf_ruby2/models/update_pricing_component_value_request.rb +253 -0
- data/lib/bf_ruby2/models/update_pricing_component_value_response.rb +210 -0
- data/lib/bf_ruby2/models/update_pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +1 -1
- data/spec/models/add_charge_to_account_response_paged_metadata_spec.rb +89 -0
- data/spec/models/add_charge_to_account_response_spec.rb +59 -0
- data/spec/models/add_charges_to_account_api_request_spec.rb +115 -0
- data/spec/models/batch_update_pricing_component_values_request_spec.rb +63 -0
- data/spec/models/nested_charge_request_spec.rb +123 -0
- data/spec/models/recalculate_charge_batch_request_spec.rb +81 -0
- data/spec/models/recalculate_charge_batch_response_paged_metadata_spec.rb +89 -0
- data/spec/models/recalculate_charge_batch_response_spec.rb +71 -0
- data/spec/models/single_recalculate_charge_request_spec.rb +103 -0
- data/spec/models/update_pricing_component_value_change_result_spec.rb +131 -0
- data/spec/models/update_pricing_component_value_request_spec.rb +69 -0
- data/spec/models/update_pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/update_pricing_component_value_response_spec.rb +59 -0
- metadata +54 -2
- data/setup.scratch.rb +0 -33
@@ -0,0 +1,9 @@
|
|
1
|
+
# BillForward::AddChargeToAccountResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**charges** | [**Array<SubscriptionCharge>**](SubscriptionCharge.md) | {\"description\":\"Charges created \",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
7
|
+
**invoice** | [**Invoice**](Invoice.md) | {\"description\":\"The invoice raised for the charges \",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# BillForward::AddChargeToAccountResponsePagedMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
12
|
+
**results** | [**Array<AddChargeToAccountResponse>**](AddChargeToAccountResponse.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# BillForward::AddChargesToAccountAPIRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | {\"description\":\"Friendly name given to any Invoice immediately produced when adding charges.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
7
|
+
**purchase_order** | **String** | {\"description\":\"Purchase order associated with any Invoice immediately produced when adding charges.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
8
|
+
**description** | **String** | {\"description\":\"Description to apply to any Invoice immediately produced when adding charges\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
9
|
+
**currency** | **String** | {\"description\":\"Currency of the charges raised, specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"GET\"]} | [optional]
|
10
|
+
**payment_terms** | **Integer** | {\"description\":\"Defines the 'payment terms' for any Invoice generated as a result of this action. Number of days after the issued date that the invoice is due. Payment will be attempted regardless of the payment terms. Payment terms are all Net.\",\"verbs\":[\"GET\"]} | [optional]
|
11
|
+
**remaining_credit_behaviour** | **String** | {\"default\":\"<span class=\\\"label label-default\\\">Rollover</span>\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge.<br><span class=\\\"label label-default\\\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\\\"label label-default\\\">Discard</span> &mdash; Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
12
|
+
**invoice_state** | **String** | {\"default\":\"Pending\",\"description\":\"Stipulates the state of the resulting adhoc invoice if the invoicing type is Immediate\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
13
|
+
**charges** | [**Array<NestedChargeRequest>**](NestedChargeRequest.md) | {\"description\":\"The charges which shall be added to the Account.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
14
|
+
**dry_run** | **BOOLEAN** | {\"default\":\"false\",\"description\":\"Calculate the effects of adding charges to an Account, but do not actually persist any changes.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
15
|
+
**void_on_failure** | **BOOLEAN** | {\"default\":true,\"description\":\"If we have created an adhoc invoice and it has had an unsuccessful payment attempt, should we void it\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
16
|
+
|
17
|
+
|
data/docs/AddressesApi.md
CHANGED
@@ -50,8 +50,8 @@ No authorization required
|
|
50
50
|
|
51
51
|
### HTTP request headers
|
52
52
|
|
53
|
-
- **Content-Type**: application/json
|
54
|
-
- **Accept**: text/xml, application/xml, application/json
|
53
|
+
- **Content-Type**: application/json; charset=utf-8
|
54
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
55
55
|
|
56
56
|
|
57
57
|
|
@@ -97,8 +97,8 @@ No authorization required
|
|
97
97
|
|
98
98
|
### HTTP request headers
|
99
99
|
|
100
|
-
- **Content-Type**: application/json
|
101
|
-
- **Accept**: text/xml, application/xml, application/json
|
100
|
+
- **Content-Type**: application/json; charset=utf-8
|
101
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
102
102
|
|
103
103
|
|
104
104
|
|
data/docs/AmendmentsApi.md
CHANGED
@@ -59,8 +59,8 @@ No authorization required
|
|
59
59
|
|
60
60
|
### HTTP request headers
|
61
61
|
|
62
|
-
- **Content-Type**: application/json
|
63
|
-
- **Accept**: text/xml, application/xml, application/json
|
62
|
+
- **Content-Type**: application/json; charset=utf-8
|
63
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
64
64
|
|
65
65
|
|
66
66
|
|
@@ -122,7 +122,7 @@ No authorization required
|
|
122
122
|
### HTTP request headers
|
123
123
|
|
124
124
|
- **Content-Type**: Not defined
|
125
|
-
- **Accept**: application/json
|
125
|
+
- **Accept**: application/json; charset=utf-8
|
126
126
|
|
127
127
|
|
128
128
|
|
@@ -173,7 +173,7 @@ No authorization required
|
|
173
173
|
### HTTP request headers
|
174
174
|
|
175
175
|
- **Content-Type**: text/plain
|
176
|
-
- **Accept**: application/json
|
176
|
+
- **Accept**: application/json; charset=utf-8
|
177
177
|
|
178
178
|
|
179
179
|
|
@@ -232,7 +232,7 @@ No authorization required
|
|
232
232
|
### HTTP request headers
|
233
233
|
|
234
234
|
- **Content-Type**: Not defined
|
235
|
-
- **Accept**: application/json
|
235
|
+
- **Accept**: application/json; charset=utf-8
|
236
236
|
|
237
237
|
|
238
238
|
|
@@ -291,7 +291,7 @@ No authorization required
|
|
291
291
|
### HTTP request headers
|
292
292
|
|
293
293
|
- **Content-Type**: text/plain
|
294
|
-
- **Accept**: application/json
|
294
|
+
- **Accept**: application/json; charset=utf-8
|
295
295
|
|
296
296
|
|
297
297
|
|
@@ -350,7 +350,7 @@ No authorization required
|
|
350
350
|
### HTTP request headers
|
351
351
|
|
352
352
|
- **Content-Type**: text/plain
|
353
|
-
- **Accept**: application/json
|
353
|
+
- **Accept**: application/json; charset=utf-8
|
354
354
|
|
355
355
|
|
356
356
|
|
@@ -412,7 +412,7 @@ No authorization required
|
|
412
412
|
### HTTP request headers
|
413
413
|
|
414
414
|
- **Content-Type**: Not defined
|
415
|
-
- **Accept**: application/json
|
415
|
+
- **Accept**: application/json; charset=utf-8
|
416
416
|
|
417
417
|
|
418
418
|
|
@@ -474,7 +474,7 @@ No authorization required
|
|
474
474
|
### HTTP request headers
|
475
475
|
|
476
476
|
- **Content-Type**: Not defined
|
477
|
-
- **Accept**: application/json
|
477
|
+
- **Accept**: application/json; charset=utf-8
|
478
478
|
|
479
479
|
|
480
480
|
|
@@ -536,7 +536,7 @@ No authorization required
|
|
536
536
|
### HTTP request headers
|
537
537
|
|
538
538
|
- **Content-Type**: Not defined
|
539
|
-
- **Accept**: application/json
|
539
|
+
- **Accept**: application/json; charset=utf-8
|
540
540
|
|
541
541
|
|
542
542
|
|
@@ -586,7 +586,7 @@ No authorization required
|
|
586
586
|
### HTTP request headers
|
587
587
|
|
588
588
|
- **Content-Type**: text/plain
|
589
|
-
- **Accept**: application/json
|
589
|
+
- **Accept**: application/json; charset=utf-8
|
590
590
|
|
591
591
|
|
592
592
|
|
@@ -632,8 +632,8 @@ No authorization required
|
|
632
632
|
|
633
633
|
### HTTP request headers
|
634
634
|
|
635
|
-
- **Content-Type**: application/json
|
636
|
-
- **Accept**: text/xml, application/xml, application/json
|
635
|
+
- **Content-Type**: application/json; charset=utf-8
|
636
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
637
637
|
|
638
638
|
|
639
639
|
|
data/docs/AnalyticsApi.md
CHANGED
@@ -59,8 +59,8 @@ No authorization required
|
|
59
59
|
|
60
60
|
### HTTP request headers
|
61
61
|
|
62
|
-
- **Content-Type**: application/json
|
63
|
-
- **Accept**: application/json
|
62
|
+
- **Content-Type**: application/json; charset=utf-8
|
63
|
+
- **Accept**: application/json; charset=utf-8
|
64
64
|
|
65
65
|
|
66
66
|
|
@@ -122,7 +122,7 @@ No authorization required
|
|
122
122
|
### HTTP request headers
|
123
123
|
|
124
124
|
- **Content-Type**: Not defined
|
125
|
-
- **Accept**: application/json
|
125
|
+
- **Accept**: application/json; charset=utf-8
|
126
126
|
|
127
127
|
|
128
128
|
|
@@ -168,8 +168,8 @@ No authorization required
|
|
168
168
|
|
169
169
|
### HTTP request headers
|
170
170
|
|
171
|
-
- **Content-Type**: application/json
|
172
|
-
- **Accept**: application/json
|
171
|
+
- **Content-Type**: application/json; charset=utf-8
|
172
|
+
- **Accept**: application/json; charset=utf-8
|
173
173
|
|
174
174
|
|
175
175
|
|
@@ -231,7 +231,7 @@ No authorization required
|
|
231
231
|
### HTTP request headers
|
232
232
|
|
233
233
|
- **Content-Type**: Not defined
|
234
|
-
- **Accept**: application/json
|
234
|
+
- **Accept**: application/json; charset=utf-8
|
235
235
|
|
236
236
|
|
237
237
|
|
@@ -293,7 +293,7 @@ No authorization required
|
|
293
293
|
### HTTP request headers
|
294
294
|
|
295
295
|
- **Content-Type**: Not defined
|
296
|
-
- **Accept**: application/json
|
296
|
+
- **Accept**: application/json; charset=utf-8
|
297
297
|
|
298
298
|
|
299
299
|
|
@@ -355,7 +355,7 @@ No authorization required
|
|
355
355
|
### HTTP request headers
|
356
356
|
|
357
357
|
- **Content-Type**: Not defined
|
358
|
-
- **Accept**: application/json
|
358
|
+
- **Accept**: application/json; charset=utf-8
|
359
359
|
|
360
360
|
|
361
361
|
|
@@ -417,7 +417,7 @@ No authorization required
|
|
417
417
|
### HTTP request headers
|
418
418
|
|
419
419
|
- **Content-Type**: Not defined
|
420
|
-
- **Accept**: application/json
|
420
|
+
- **Accept**: application/json; charset=utf-8
|
421
421
|
|
422
422
|
|
423
423
|
|
@@ -463,8 +463,8 @@ No authorization required
|
|
463
463
|
|
464
464
|
### HTTP request headers
|
465
465
|
|
466
|
-
- **Content-Type**: application/json
|
467
|
-
- **Accept**: application/json
|
466
|
+
- **Content-Type**: application/json; charset=utf-8
|
467
|
+
- **Accept**: application/json; charset=utf-8
|
468
468
|
|
469
469
|
|
470
470
|
|
@@ -510,8 +510,8 @@ No authorization required
|
|
510
510
|
|
511
511
|
### HTTP request headers
|
512
512
|
|
513
|
-
- **Content-Type**: application/json
|
514
|
-
- **Accept**: application/json
|
513
|
+
- **Content-Type**: application/json; charset=utf-8
|
514
|
+
- **Accept**: application/json; charset=utf-8
|
515
515
|
|
516
516
|
|
517
517
|
|
@@ -573,7 +573,7 @@ No authorization required
|
|
573
573
|
### HTTP request headers
|
574
574
|
|
575
575
|
- **Content-Type**: Not defined
|
576
|
-
- **Accept**: application/json
|
576
|
+
- **Accept**: application/json; charset=utf-8
|
577
577
|
|
578
578
|
|
579
579
|
|
@@ -635,7 +635,7 @@ No authorization required
|
|
635
635
|
### HTTP request headers
|
636
636
|
|
637
637
|
- **Content-Type**: Not defined
|
638
|
-
- **Accept**: application/json
|
638
|
+
- **Accept**: application/json; charset=utf-8
|
639
639
|
|
640
640
|
|
641
641
|
|
data/docs/AuditlogsApi.md
CHANGED
@@ -65,7 +65,7 @@ No authorization required
|
|
65
65
|
### HTTP request headers
|
66
66
|
|
67
67
|
- **Content-Type**: Not defined
|
68
|
-
- **Accept**: application/json
|
68
|
+
- **Accept**: application/json; charset=utf-8
|
69
69
|
|
70
70
|
|
71
71
|
|
@@ -129,7 +129,7 @@ No authorization required
|
|
129
129
|
### HTTP request headers
|
130
130
|
|
131
131
|
- **Content-Type**: Not defined
|
132
|
-
- **Accept**: application/json
|
132
|
+
- **Accept**: application/json; charset=utf-8
|
133
133
|
|
134
134
|
|
135
135
|
|
@@ -190,7 +190,7 @@ No authorization required
|
|
190
190
|
### HTTP request headers
|
191
191
|
|
192
192
|
- **Content-Type**: text/plain
|
193
|
-
- **Accept**: application/json
|
193
|
+
- **Accept**: application/json; charset=utf-8
|
194
194
|
|
195
195
|
|
196
196
|
|
@@ -251,7 +251,7 @@ No authorization required
|
|
251
251
|
### HTTP request headers
|
252
252
|
|
253
253
|
- **Content-Type**: Not defined
|
254
|
-
- **Accept**: application/json
|
254
|
+
- **Accept**: application/json; charset=utf-8
|
255
255
|
|
256
256
|
|
257
257
|
|
@@ -302,7 +302,7 @@ No authorization required
|
|
302
302
|
### HTTP request headers
|
303
303
|
|
304
304
|
- **Content-Type**: text/plain
|
305
|
-
- **Accept**: application/json
|
305
|
+
- **Accept**: application/json; charset=utf-8
|
306
306
|
|
307
307
|
|
308
308
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# BillForward::BatchUpdatePricingComponentValuesRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**values** | [**UpdatePricingComponentValueRequest**](UpdatePricingComponentValueRequest.md) | A list of update value requests |
|
7
|
+
**issue_invoice_mode** | **String** | {\"default\":\"Immediate\",\"description\":\"How the invoice is going to be issued. <ul><li>Immediate: Every charge generated synchronously during the update will be invoiced immediately. Synchronous charges are only generated with immediate updates. This field will not effect any charge generated by an amendment.</li><li>AtPeriodEnd: All charges will be invoiced at the end of the billing period.</li></ul>\"} | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ChargesApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**batch_recalculate_subscription_charge**](ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | Recalculate a batch of charges.
|
7
8
|
[**get_all_subscription_charges**](ChargesApi.md#get_all_subscription_charges) | **GET** /charges | Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order.
|
8
9
|
[**get_subscription_charge_by_account_id**](ChargesApi.md#get_subscription_charge_by_account_id) | **GET** /charges/account/{account-ID} | Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
9
10
|
[**get_subscription_charge_by_id**](ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | Retrieves a single charge, specified by the charge-id parameter.
|
@@ -13,6 +14,53 @@ Method | HTTP request | Description
|
|
13
14
|
[**void_subscription_charge**](ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | Void the charge with the specified charge-ID.
|
14
15
|
|
15
16
|
|
17
|
+
# **batch_recalculate_subscription_charge**
|
18
|
+
> RecalculateChargeBatchResponsePagedMetadata batch_recalculate_subscription_charge(request)
|
19
|
+
|
20
|
+
Recalculate a batch of charges.
|
21
|
+
|
22
|
+
{\"nickname\":\"Batch re-calculate charges\",\"request\":\"batchRecalculateChargeRequest.html\",\"response\":\"batchRecalculateChargeResponse.html\"}
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'bf_ruby2'
|
28
|
+
|
29
|
+
api_instance = BillForward::ChargesApi.new
|
30
|
+
|
31
|
+
request = BillForward::RecalculateChargeBatchRequest.new # RecalculateChargeBatchRequest | The batch charge request.
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Recalculate a batch of charges.
|
36
|
+
result = api_instance.batch_recalculate_subscription_charge(request)
|
37
|
+
p result
|
38
|
+
rescue BillForward::ApiError => e
|
39
|
+
puts "Exception when calling ChargesApi->batch_recalculate_subscription_charge: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**request** | [**RecalculateChargeBatchRequest**](RecalculateChargeBatchRequest.md)| The batch charge request. |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**RecalculateChargeBatchResponsePagedMetadata**](RecalculateChargeBatchResponsePagedMetadata.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
No authorization required
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json; charset=utf-8
|
60
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
61
|
+
|
62
|
+
|
63
|
+
|
16
64
|
# **get_all_subscription_charges**
|
17
65
|
> SubscriptionChargePagedMetadata get_all_subscription_charges(opts)
|
18
66
|
|
@@ -67,7 +115,7 @@ No authorization required
|
|
67
115
|
### HTTP request headers
|
68
116
|
|
69
117
|
- **Content-Type**: Not defined
|
70
|
-
- **Accept**: application/json
|
118
|
+
- **Accept**: application/json; charset=utf-8
|
71
119
|
|
72
120
|
|
73
121
|
|
@@ -128,7 +176,7 @@ No authorization required
|
|
128
176
|
### HTTP request headers
|
129
177
|
|
130
178
|
- **Content-Type**: text/plain
|
131
|
-
- **Accept**: application/json
|
179
|
+
- **Accept**: application/json; charset=utf-8
|
132
180
|
|
133
181
|
|
134
182
|
|
@@ -189,7 +237,7 @@ No authorization required
|
|
189
237
|
### HTTP request headers
|
190
238
|
|
191
239
|
- **Content-Type**: text/plain
|
192
|
-
- **Accept**: application/json
|
240
|
+
- **Accept**: application/json; charset=utf-8
|
193
241
|
|
194
242
|
|
195
243
|
|
@@ -250,7 +298,7 @@ No authorization required
|
|
250
298
|
### HTTP request headers
|
251
299
|
|
252
300
|
- **Content-Type**: Not defined
|
253
|
-
- **Accept**: application/json
|
301
|
+
- **Accept**: application/json; charset=utf-8
|
254
302
|
|
255
303
|
|
256
304
|
|
@@ -301,7 +349,7 @@ No authorization required
|
|
301
349
|
### HTTP request headers
|
302
350
|
|
303
351
|
- **Content-Type**: text/plain
|
304
|
-
- **Accept**: application/json
|
352
|
+
- **Accept**: application/json; charset=utf-8
|
305
353
|
|
306
354
|
|
307
355
|
|
@@ -350,8 +398,8 @@ No authorization required
|
|
350
398
|
|
351
399
|
### HTTP request headers
|
352
400
|
|
353
|
-
- **Content-Type**: application/json
|
354
|
-
- **Accept**: text/xml, application/xml, application/json
|
401
|
+
- **Content-Type**: application/json; charset=utf-8
|
402
|
+
- **Accept**: text/xml, application/xml, application/json; charset=utf-8
|
355
403
|
|
356
404
|
|
357
405
|
|
@@ -402,7 +450,7 @@ No authorization required
|
|
402
450
|
### HTTP request headers
|
403
451
|
|
404
452
|
- **Content-Type**: Not defined
|
405
|
-
- **Accept**: application/json
|
453
|
+
- **Accept**: application/json; charset=utf-8
|
406
454
|
|
407
455
|
|
408
456
|
|