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.
Files changed (180) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +53 -29
  3. data/bf_ruby2-1.2016.229.gem +0 -0
  4. data/docs/AccountsApi.md +82 -31
  5. data/docs/AddChargeToAccountResponse.md +9 -0
  6. data/docs/AddChargeToAccountResponsePagedMetadata.md +14 -0
  7. data/docs/AddChargesToAccountAPIRequest.md +17 -0
  8. data/docs/AddressesApi.md +4 -4
  9. data/docs/AmendmentsApi.md +13 -13
  10. data/docs/AnalyticsApi.md +15 -15
  11. data/docs/AuditlogsApi.md +5 -5
  12. data/docs/BatchUpdatePricingComponentValuesRequest.md +9 -0
  13. data/docs/ChargesApi.md +56 -8
  14. data/docs/ClientsApi.md +6 -6
  15. data/docs/ConfigurationsApi.md +6 -6
  16. data/docs/CouponbookApi.md +11 -11
  17. data/docs/CouponbookdefinitionApi.md +8 -8
  18. data/docs/CoupondefinitionApi.md +7 -7
  19. data/docs/CouponinstanceApi.md +12 -12
  20. data/docs/CouponmodifierApi.md +9 -9
  21. data/docs/CouponruleApi.md +6 -6
  22. data/docs/CouponsApi.md +10 -10
  23. data/docs/CreateSubscriptionChargeAmendment.md +0 -1
  24. data/docs/CreateSubscriptionRequest.md +2 -0
  25. data/docs/CreditnotesApi.md +7 -7
  26. data/docs/CybersourcetokensApi.md +7 -7
  27. data/docs/DunninglinesApi.md +8 -8
  28. data/docs/EmailprovidersApi.md +5 -5
  29. data/docs/EmailsApi.md +1 -1
  30. data/docs/EmailsubscriptionsApi.md +7 -7
  31. data/docs/FixedtermdefinitionsApi.md +4 -4
  32. data/docs/FixedtermsApi.md +2 -2
  33. data/docs/Invoice.md +3 -0
  34. data/docs/InvoicesApi.md +63 -63
  35. data/docs/MetadataApi.md +6 -6
  36. data/docs/NestedChargeRequest.md +19 -0
  37. data/docs/NotificationsApi.md +6 -6
  38. data/docs/OrganizationsApi.md +9 -9
  39. data/docs/PasswordsApi.md +2 -2
  40. data/docs/PaymentmethodsApi.md +10 -10
  41. data/docs/PaymentmethodsubscriptionlinksApi.md +3 -3
  42. data/docs/PaymentsApi.md +9 -9
  43. data/docs/PeriodsApi.md +2 -2
  44. data/docs/PermissionsApi.md +8 -8
  45. data/docs/PricingcalculatorApi.md +6 -6
  46. data/docs/PricingcomponentsApi.md +8 -8
  47. data/docs/PricingcomponenttiersApi.md +7 -7
  48. data/docs/PricingcomponentvaluechangesApi.md +7 -7
  49. data/docs/PricingcomponentvaluesApi.md +7 -7
  50. data/docs/ProductrateplansApi.md +27 -27
  51. data/docs/ProductsApi.md +17 -17
  52. data/docs/ProfilesApi.md +6 -6
  53. data/docs/QuotesApi.md +2 -2
  54. data/docs/RecalculateChargeBatchRequest.md +12 -0
  55. data/docs/RecalculateChargeBatchResponse.md +11 -0
  56. data/docs/RecalculateChargeBatchResponsePagedMetadata.md +14 -0
  57. data/docs/ReceiptsApi.md +6 -6
  58. data/docs/RefundsApi.md +9 -9
  59. data/docs/RolesApi.md +8 -8
  60. data/docs/SearchApi.md +1 -1
  61. data/docs/SingleRecalculateChargeRequest.md +15 -0
  62. data/docs/Subscription.md +1 -0
  63. data/docs/SubscriptionsApi.md +153 -102
  64. data/docs/SynchAppConfigsApi.md +6 -6
  65. data/docs/SynchConfigsApi.md +8 -8
  66. data/docs/SynchJobsApi.md +10 -10
  67. data/docs/TaxationlinksApi.md +8 -8
  68. data/docs/TaxationstrategiesApi.md +11 -11
  69. data/docs/TimeApi.md +1 -1
  70. data/docs/TokenizationApi.md +6 -6
  71. data/docs/UnitofmeasureApi.md +6 -6
  72. data/docs/UpdatePricingComponentValueChangeResult.md +19 -0
  73. data/docs/UpdatePricingComponentValueRequest.md +10 -0
  74. data/docs/UpdatePricingComponentValueResponse.md +9 -0
  75. data/docs/UpdatePricingComponentValueResponsePagedMetadata.md +14 -0
  76. data/docs/UsageApi.md +7 -7
  77. data/docs/UsageperiodsApi.md +3 -3
  78. data/docs/UsageroundingstrategiesApi.md +6 -6
  79. data/docs/UsagesessionsApi.md +6 -6
  80. data/docs/UsernamesApi.md +2 -2
  81. data/docs/UsersApi.md +16 -16
  82. data/docs/VaultedgatewaysApi.md +22 -22
  83. data/docs/WebhooksApi.md +10 -10
  84. data/lib/bf_ruby2.rb +13 -0
  85. data/lib/bf_ruby2/api/accounts_api.rb +92 -31
  86. data/lib/bf_ruby2/api/addresses_api.rb +4 -4
  87. data/lib/bf_ruby2/api/amendments_api.rb +13 -13
  88. data/lib/bf_ruby2/api/analytics_api.rb +15 -15
  89. data/lib/bf_ruby2/api/auditlogs_api.rb +5 -5
  90. data/lib/bf_ruby2/api/charges_api.rb +65 -8
  91. data/lib/bf_ruby2/api/clients_api.rb +6 -6
  92. data/lib/bf_ruby2/api/configurations_api.rb +6 -6
  93. data/lib/bf_ruby2/api/couponbook_api.rb +11 -11
  94. data/lib/bf_ruby2/api/couponbookdefinition_api.rb +8 -8
  95. data/lib/bf_ruby2/api/coupondefinition_api.rb +7 -7
  96. data/lib/bf_ruby2/api/couponinstance_api.rb +12 -12
  97. data/lib/bf_ruby2/api/couponmodifier_api.rb +9 -9
  98. data/lib/bf_ruby2/api/couponrule_api.rb +6 -6
  99. data/lib/bf_ruby2/api/coupons_api.rb +10 -10
  100. data/lib/bf_ruby2/api/creditnotes_api.rb +7 -7
  101. data/lib/bf_ruby2/api/cybersourcetokens_api.rb +7 -7
  102. data/lib/bf_ruby2/api/dunninglines_api.rb +8 -8
  103. data/lib/bf_ruby2/api/emailproviders_api.rb +5 -5
  104. data/lib/bf_ruby2/api/emails_api.rb +1 -1
  105. data/lib/bf_ruby2/api/emailsubscriptions_api.rb +7 -7
  106. data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +4 -4
  107. data/lib/bf_ruby2/api/fixedterms_api.rb +2 -2
  108. data/lib/bf_ruby2/api/invoices_api.rb +63 -63
  109. data/lib/bf_ruby2/api/metadata_api.rb +6 -6
  110. data/lib/bf_ruby2/api/notifications_api.rb +6 -6
  111. data/lib/bf_ruby2/api/organizations_api.rb +9 -9
  112. data/lib/bf_ruby2/api/passwords_api.rb +2 -2
  113. data/lib/bf_ruby2/api/paymentmethods_api.rb +10 -10
  114. data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +3 -3
  115. data/lib/bf_ruby2/api/payments_api.rb +9 -9
  116. data/lib/bf_ruby2/api/periods_api.rb +2 -2
  117. data/lib/bf_ruby2/api/permissions_api.rb +8 -8
  118. data/lib/bf_ruby2/api/pricingcalculator_api.rb +6 -6
  119. data/lib/bf_ruby2/api/pricingcomponents_api.rb +8 -8
  120. data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +7 -7
  121. data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +7 -7
  122. data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +7 -7
  123. data/lib/bf_ruby2/api/productrateplans_api.rb +27 -27
  124. data/lib/bf_ruby2/api/products_api.rb +17 -17
  125. data/lib/bf_ruby2/api/profiles_api.rb +6 -6
  126. data/lib/bf_ruby2/api/quotes_api.rb +2 -2
  127. data/lib/bf_ruby2/api/receipts_api.rb +6 -6
  128. data/lib/bf_ruby2/api/refunds_api.rb +9 -9
  129. data/lib/bf_ruby2/api/roles_api.rb +8 -8
  130. data/lib/bf_ruby2/api/search_api.rb +1 -1
  131. data/lib/bf_ruby2/api/subscriptions_api.rb +163 -102
  132. data/lib/bf_ruby2/api/synch_app_configs_api.rb +6 -6
  133. data/lib/bf_ruby2/api/synch_configs_api.rb +8 -8
  134. data/lib/bf_ruby2/api/synch_jobs_api.rb +10 -10
  135. data/lib/bf_ruby2/api/taxationlinks_api.rb +8 -8
  136. data/lib/bf_ruby2/api/taxationstrategies_api.rb +11 -11
  137. data/lib/bf_ruby2/api/time_api.rb +1 -1
  138. data/lib/bf_ruby2/api/tokenization_api.rb +6 -6
  139. data/lib/bf_ruby2/api/unitofmeasure_api.rb +6 -6
  140. data/lib/bf_ruby2/api/usage_api.rb +7 -7
  141. data/lib/bf_ruby2/api/usageperiods_api.rb +3 -3
  142. data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +6 -6
  143. data/lib/bf_ruby2/api/usagesessions_api.rb +6 -6
  144. data/lib/bf_ruby2/api/usernames_api.rb +2 -2
  145. data/lib/bf_ruby2/api/users_api.rb +16 -16
  146. data/lib/bf_ruby2/api/vaultedgateways_api.rb +22 -22
  147. data/lib/bf_ruby2/api/webhooks_api.rb +10 -10
  148. data/lib/bf_ruby2/models/add_charge_to_account_response.rb +212 -0
  149. data/lib/bf_ruby2/models/add_charge_to_account_response_paged_metadata.rb +269 -0
  150. data/lib/bf_ruby2/models/add_charges_to_account_api_request.rb +337 -0
  151. data/lib/bf_ruby2/models/batch_update_pricing_component_values_request.rb +244 -0
  152. data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +1 -24
  153. data/lib/bf_ruby2/models/create_subscription_request.rb +24 -4
  154. data/lib/bf_ruby2/models/invoice.rb +32 -1
  155. data/lib/bf_ruby2/models/nested_charge_request.rb +343 -0
  156. data/lib/bf_ruby2/models/recalculate_charge_batch_request.rb +279 -0
  157. data/lib/bf_ruby2/models/recalculate_charge_batch_response.rb +234 -0
  158. data/lib/bf_ruby2/models/recalculate_charge_batch_response_paged_metadata.rb +269 -0
  159. data/lib/bf_ruby2/models/single_recalculate_charge_request.rb +317 -0
  160. data/lib/bf_ruby2/models/subscription.rb +11 -1
  161. data/lib/bf_ruby2/models/update_pricing_component_value_change_result.rb +367 -0
  162. data/lib/bf_ruby2/models/update_pricing_component_value_request.rb +253 -0
  163. data/lib/bf_ruby2/models/update_pricing_component_value_response.rb +210 -0
  164. data/lib/bf_ruby2/models/update_pricing_component_value_response_paged_metadata.rb +269 -0
  165. data/lib/bf_ruby2/version.rb +1 -1
  166. data/spec/models/add_charge_to_account_response_paged_metadata_spec.rb +89 -0
  167. data/spec/models/add_charge_to_account_response_spec.rb +59 -0
  168. data/spec/models/add_charges_to_account_api_request_spec.rb +115 -0
  169. data/spec/models/batch_update_pricing_component_values_request_spec.rb +63 -0
  170. data/spec/models/nested_charge_request_spec.rb +123 -0
  171. data/spec/models/recalculate_charge_batch_request_spec.rb +81 -0
  172. data/spec/models/recalculate_charge_batch_response_paged_metadata_spec.rb +89 -0
  173. data/spec/models/recalculate_charge_batch_response_spec.rb +71 -0
  174. data/spec/models/single_recalculate_charge_request_spec.rb +103 -0
  175. data/spec/models/update_pricing_component_value_change_result_spec.rb +131 -0
  176. data/spec/models/update_pricing_component_value_request_spec.rb +69 -0
  177. data/spec/models/update_pricing_component_value_response_paged_metadata_spec.rb +89 -0
  178. data/spec/models/update_pricing_component_value_response_spec.rb +59 -0
  179. metadata +54 -2
  180. data/setup.scratch.rb +0 -33
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1ec31b77a322f4e9708be65b37e76e6aa009ec67
4
- data.tar.gz: 1940333b1ca47b474c863b48f930a9f75484015a
3
+ metadata.gz: 4e8e96312f12f4e97cabf52cf8e26305d7ee37df
4
+ data.tar.gz: 7e31f532b26fe9a04b2a2360e250a164350c839b
5
5
  SHA512:
6
- metadata.gz: 17b1f50a053335307cd27e7f8ae2b52c853dcf242422c9df20fdb64fd7e99b4c6dd72a71ba5196e29a10568e8b30b1209767ca461981e1df52c11af249473bcf
7
- data.tar.gz: 96cfea971581d036f3b45ef19e322cdafca9097c10a4b9ce5170b4f91382a08a991c165ab42a83ddfc10370bca5976fc9e8421e0b7511a57f79e68fd55235c9d
6
+ metadata.gz: e7c82e7621eae5acd571bcb4a23f4cccac4b339c544ae942472fefef963f18adc882817da38a9c089c52cf96a4418bcb18fa880f1136775c57fd5dd960c56f05
7
+ data.tar.gz: bff6110be127f2f119170a54040be6af625ad0c9d4d61898f938ffd382b4287a18635f7c5b6abaa2d057fdbdaf14529256640705250b0b8e77d870686ffbca89
data/README.md CHANGED
@@ -1,49 +1,47 @@
1
- # bf_ruby2
1
+ # BillForward Ruby SDK
2
2
 
3
- BillForward - the Ruby gem for the BillForward REST API
3
+ This repository holds `bf_ruby2`: the Ruby gem for the BillForward REST API.
4
+
5
+ We have also a legacy SDK, [`bf-ruby`](https://github.com/billforward/bf-ruby) (now deprecated). Prefer `bf_ruby2`; it supports (as a result of machine-generation) a far broader surface of BillForward's API, with a more formal schema and more documention. It is the Ruby SDK that we intend to maintain moving forwards.
4
6
 
5
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
6
8
 
7
- - `swagger.json` dump: 1
9
+ - `swagger.json` dump: ae95e7f7a41b19adcd02533305664cd3cc75c629
8
10
  - `swagger-codegen` version: v2.2.1 nightly, [commit `1587caf9a673173fd0813032bd12deeaa80121c1`](https://github.com/swagger-api/swagger-codegen/tree/1587caf9a673173fd0813032bd12deeaa80121c1)
9
- - Package version: 1.2016.229
11
+ - Package version: 1.2016.230
10
12
  - Build date: `2016-08-17T14:52:17.039-07:00`
11
13
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
12
14
 
13
15
  ## Installation
14
16
 
15
- ### Build a gem
16
-
17
- To build the Ruby code into a gem:
18
-
19
- ```shell
20
- gem build bf_ruby2.gemspec
21
- ```
17
+ ### From RubyGems mirror
22
18
 
23
- Then either install the gem locally:
19
+ Add the [`bf_ruby2` gem](https://rubygems.org/gems/bf_ruby2) to your application's Gemfile and run `bundle`:
24
20
 
25
- ```shell
26
- gem install ./bf_ruby2-1.2016.229.gem
21
+ ```ruby
22
+ source 'https://rubygems.org'
23
+ gem 'bf_ruby2', '~> 1.2016.230'
27
24
  ```
28
25
 
29
- (for development, run `gem install --dev ./bf_ruby2-1.2016.229.gem` to install the development dependencies)
30
-
31
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
26
+ ### Install from Git
32
27
 
33
- Finally add this to the Gemfile:
28
+ If the Ruby gem is hosted at a git repository: https://github.com/billforward/bf-ruby2, then add the following in the Gemfile:
34
29
 
35
30
  ```ruby
36
- gem 'bf_ruby2', '~> 1.2016.229'
31
+ gem 'bf_ruby2', :git => 'git@github.com:billforward/bf-ruby2.git'
37
32
  ```
38
33
 
39
- ### Install from Git
34
+ ### Build from source
40
35
 
41
- If the Ruby gem is hosted at a git repository: https://github.com/billforward/bf-ruby2, then add the following in the Gemfile:
36
+ To build the Ruby code into a gem:
42
37
 
43
- ```ruby
44
- gem 'bf_ruby2', :git => 'git@github.com:billforward/bf-ruby2.git'
38
+ ```shell
39
+ gem build bf_ruby2.gemspec
40
+ gem install ./bf_ruby2-1.2016.230.gem
45
41
  ```
46
42
 
43
+ Developers should instead run `gem install --dev ./bf_ruby2-1.2016.230.gem`, to install development dependencies.
44
+
47
45
  ### Include the Ruby code directly
48
46
 
49
47
  Include the Ruby code directly using `-I` as follows:
@@ -52,9 +50,16 @@ Include the Ruby code directly using `-I` as follows:
52
50
  ruby -Ilib script.rb
53
51
  ```
54
52
 
55
- ## Getting Started
53
+ ## Usage
54
+
55
+ ### Getting Credentials
56
+ You will need an API token. First log into your [Sandbox account](https://app-sandbox.billforward.net/#/login/) ([register](https://app-sandbox.billforward.net/#/register/) if necessary).
57
+
58
+ Then [generate an API token](https://app-sandbox.billforward.net/#/setup/personal/api-keys).
56
59
 
57
- Please follow the [installation](#installation) procedure and then run the following code:
60
+ ### Invocation
61
+
62
+ Here is an example which demonstrates POSTing a JSON request to our API, and handling the result. The example adds credit to an Account.
58
63
 
59
64
  ```ruby
60
65
  # Load the gem
@@ -69,7 +74,10 @@ BillForward::Configuration.default.debugging = false
69
74
  # your BillForward private token
70
75
  access_token = "EXAMPLE38-1136-4646-a552-fa2728da66b6"
71
76
 
72
- api_instance = BillForward::AccountsApi.new
77
+ client = BillForward::ApiClient.new
78
+ client.default_headers.merge! 'Authorization' => "Bearer #{access_token}"
79
+
80
+ api_instance = BillForward::AccountsApi.new client
73
81
 
74
82
  account_id = "ACC-23A086A2-F460-470E-85C5-BB52CD55"
75
83
 
@@ -115,7 +123,7 @@ Minor revision is determined by [days since start of year](http://www.wolframalp
115
123
 
116
124
  If you publish twice in a day, it becomes day.1, day.2 and so on.
117
125
 
118
- Please find-and-replace all references to `1.2016.229` in this README, to the latest version.
126
+ Please find-and-replace all references to `1.2016.230` in this README, to the latest version.
119
127
 
120
128
  Build the gemspec locally:
121
129
 
@@ -126,15 +134,16 @@ gem build bf_ruby2.gemspec
126
134
  Then publish the resulting gem:
127
135
 
128
136
  ```bash
129
- gem push bf_ruby2-1.2016.229.gem
137
+ gem push bf_ruby2-1.2016.230.gem
130
138
  ```
131
139
 
132
140
  ## Documentation for API Endpoints
133
141
 
134
- All URIs are relative to *https://api-sandbox.billforward.net:443/v1*
142
+ All URIs are relative to *https://localhost:8080/RestAPI*
135
143
 
136
144
  Class | Method | HTTP request | Description
137
145
  ------------ | ------------- | ------------- | -------------
146
+ *BillForward::AccountsApi* | [**add_charge_to_account**](docs/AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | Create a manual invoice.
138
147
  *BillForward::AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account.
139
148
  *BillForward::AccountsApi* | [**add_permission_to_account**](docs/AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account
140
149
  *BillForward::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create an Account.
@@ -182,6 +191,7 @@ Class | Method | HTTP request | Description
182
191
  *BillForward::AuditlogsApi* | [**get_audit_entry_by_entity_id**](docs/AuditlogsApi.md#get_audit_entry_by_entity_id) | **GET** /audit-logs/entity/{entity-ID} | Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order.
183
192
  *BillForward::AuditlogsApi* | [**get_audit_entry_by_entity_type**](docs/AuditlogsApi.md#get_audit_entry_by_entity_type) | **GET** /audit-logs/entity-type/{entity-type} | Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order.
184
193
  *BillForward::AuditlogsApi* | [**get_audit_entry_by_id**](docs/AuditlogsApi.md#get_audit_entry_by_id) | **GET** /audit-logs/{audit-ID} | Returns a single audit-log entry, specified by the audit-ID parameter.
194
+ *BillForward::ChargesApi* | [**batch_recalculate_subscription_charge**](docs/ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | Recalculate a batch of charges.
185
195
  *BillForward::ChargesApi* | [**get_all_subscription_charges**](docs/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.
186
196
  *BillForward::ChargesApi* | [**get_subscription_charge_by_account_id**](docs/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.
187
197
  *BillForward::ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | Retrieves a single charge, specified by the charge-id parameter.
@@ -489,6 +499,7 @@ Class | Method | HTTP request | Description
489
499
  *BillForward::SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state
490
500
  *BillForward::SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data.
491
501
  *BillForward::SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
502
+ *BillForward::SubscriptionsApi* | [**set_pricing_component_value_on_subscription_batch_update**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
492
503
  *BillForward::SubscriptionsApi* | [**set_pricing_component_value_on_subscription_v2**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_v2) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | Upgrades/downgrades this subscription to some new value for the specified pricing-component.
493
504
  *BillForward::SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription.
494
505
  *BillForward::SubscriptionsApi* | [**update_subscription_v2**](docs/SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2).
@@ -598,6 +609,9 @@ Class | Method | HTTP request | Description
598
609
  - [BillForward::AccountPagedMetadata](docs/AccountPagedMetadata.md)
599
610
  - [BillForward::AccountPaymentsResultPagedMetadata](docs/AccountPaymentsResultPagedMetadata.md)
600
611
  - [BillForward::AddChargeRequest](docs/AddChargeRequest.md)
612
+ - [BillForward::AddChargeToAccountResponse](docs/AddChargeToAccountResponse.md)
613
+ - [BillForward::AddChargeToAccountResponsePagedMetadata](docs/AddChargeToAccountResponsePagedMetadata.md)
614
+ - [BillForward::AddChargesToAccountAPIRequest](docs/AddChargesToAccountAPIRequest.md)
601
615
  - [BillForward::AddCouponCodeRequest](docs/AddCouponCodeRequest.md)
602
616
  - [BillForward::AddPaymentMethodRequest](docs/AddPaymentMethodRequest.md)
603
617
  - [BillForward::AddTaxationStrategyRequest](docs/AddTaxationStrategyRequest.md)
@@ -616,6 +630,7 @@ Class | Method | HTTP request | Description
616
630
  - [BillForward::BFPermission](docs/BFPermission.md)
617
631
  - [BillForward::BFPermissionPagedMetadata](docs/BFPermissionPagedMetadata.md)
618
632
  - [BillForward::BankAccountVerificationPagedMetadata](docs/BankAccountVerificationPagedMetadata.md)
633
+ - [BillForward::BatchUpdatePricingComponentValuesRequest](docs/BatchUpdatePricingComponentValuesRequest.md)
619
634
  - [BillForward::BillforwardManagedPaymentsResultPagedMetadata](docs/BillforwardManagedPaymentsResultPagedMetadata.md)
620
635
  - [BillForward::BillingEntityBase](docs/BillingEntityBase.md)
621
636
  - [BillForward::BraintreeAuthCaptureRequest](docs/BraintreeAuthCaptureRequest.md)
@@ -708,6 +723,7 @@ Class | Method | HTTP request | Description
708
723
  - [BillForward::MigrationRequest](docs/MigrationRequest.md)
709
724
  - [BillForward::ModelAlias](docs/ModelAlias.md)
710
725
  - [BillForward::MutableBillingEntity](docs/MutableBillingEntity.md)
726
+ - [BillForward::NestedChargeRequest](docs/NestedChargeRequest.md)
711
727
  - [BillForward::Notification](docs/Notification.md)
712
728
  - [BillForward::NotificationPagedMetadata](docs/NotificationPagedMetadata.md)
713
729
  - [BillForward::Organization](docs/Organization.md)
@@ -755,6 +771,9 @@ Class | Method | HTTP request | Description
755
771
  - [BillForward::ProfilePagedMetadata](docs/ProfilePagedMetadata.md)
756
772
  - [BillForward::QuoteRequest](docs/QuoteRequest.md)
757
773
  - [BillForward::QuoteRequestValue](docs/QuoteRequestValue.md)
774
+ - [BillForward::RecalculateChargeBatchRequest](docs/RecalculateChargeBatchRequest.md)
775
+ - [BillForward::RecalculateChargeBatchResponse](docs/RecalculateChargeBatchResponse.md)
776
+ - [BillForward::RecalculateChargeBatchResponsePagedMetadata](docs/RecalculateChargeBatchResponsePagedMetadata.md)
758
777
  - [BillForward::RecalculateChargeRequest](docs/RecalculateChargeRequest.md)
759
778
  - [BillForward::Receipt](docs/Receipt.md)
760
779
  - [BillForward::ReceiptPagedMetadata](docs/ReceiptPagedMetadata.md)
@@ -770,6 +789,7 @@ Class | Method | HTTP request | Description
770
789
  - [BillForward::RuleSatisfaction](docs/RuleSatisfaction.md)
771
790
  - [BillForward::SearchResultPagedMetadata](docs/SearchResultPagedMetadata.md)
772
791
  - [BillForward::ServiceEndAmendment](docs/ServiceEndAmendment.md)
792
+ - [BillForward::SingleRecalculateChargeRequest](docs/SingleRecalculateChargeRequest.md)
773
793
  - [BillForward::StripeACHTokenPagedMetadata](docs/StripeACHTokenPagedMetadata.md)
774
794
  - [BillForward::StripeAuthCaptureRequest](docs/StripeAuthCaptureRequest.md)
775
795
  - [BillForward::StripeObject](docs/StripeObject.md)
@@ -800,6 +820,10 @@ Class | Method | HTTP request | Description
800
820
  - [BillForward::UnitOfMeasurePagedMetadata](docs/UnitOfMeasurePagedMetadata.md)
801
821
  - [BillForward::UpdateAddressRequest](docs/UpdateAddressRequest.md)
802
822
  - [BillForward::UpdateComponentValueAmendment](docs/UpdateComponentValueAmendment.md)
823
+ - [BillForward::UpdatePricingComponentValueChangeResult](docs/UpdatePricingComponentValueChangeResult.md)
824
+ - [BillForward::UpdatePricingComponentValueRequest](docs/UpdatePricingComponentValueRequest.md)
825
+ - [BillForward::UpdatePricingComponentValueResponse](docs/UpdatePricingComponentValueResponse.md)
826
+ - [BillForward::UpdatePricingComponentValueResponsePagedMetadata](docs/UpdatePricingComponentValueResponsePagedMetadata.md)
803
827
  - [BillForward::UpdateProfileRequest](docs/UpdateProfileRequest.md)
804
828
  - [BillForward::UpdateRoleRequest](docs/UpdateRoleRequest.md)
805
829
  - [BillForward::UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md)
data/bf_ruby2-1.2016.229.gem ADDED
Binary file
data/docs/AccountsApi.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
+ [**add_charge_to_account**](AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | Create a manual invoice.
7
8
  [**add_credit_note_to_account**](AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account.
8
9
  [**add_permission_to_account**](AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account
9
10
  [**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create an Account.
@@ -24,6 +25,56 @@ Method | HTTP request | Description
24
25
  [**upsert_metadata_for_account**](AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
25
26
 
26
27
 
28
+ # **add_charge_to_account**
29
+ > AddChargeToAccountResponsePagedMetadata add_charge_to_account(account_id, request)
30
+
31
+ Create a manual invoice.
32
+
33
+ {\"nickname\":\"Create a manual invoice\",\"request\":\"addChargeToAccountRequest.html\",\"response\":\"addChargeToAccountResponse.html\"}
34
+
35
+ ### Example
36
+ ```ruby
37
+ # load the gem
38
+ require 'bf_ruby2'
39
+
40
+ api_instance = BillForward::AccountsApi.new
41
+
42
+ account_id = "account_id_example" # String | ID of the account.
43
+
44
+ request = BillForward::AddChargesToAccountAPIRequest.new # AddChargesToAccountAPIRequest | The charge request
45
+
46
+
47
+ begin
48
+ #Create a manual invoice.
49
+ result = api_instance.add_charge_to_account(account_id, request)
50
+ p result
51
+ rescue BillForward::ApiError => e
52
+ puts "Exception when calling AccountsApi->add_charge_to_account: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+ Name | Type | Description | Notes
59
+ ------------- | ------------- | ------------- | -------------
60
+ **account_id** | **String**| ID of the account. |
61
+ **request** | [**AddChargesToAccountAPIRequest**](AddChargesToAccountAPIRequest.md)| The charge request |
62
+
63
+ ### Return type
64
+
65
+ [**AddChargeToAccountResponsePagedMetadata**](AddChargeToAccountResponsePagedMetadata.md)
66
+
67
+ ### Authorization
68
+
69
+ No authorization required
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: application/json; charset=utf-8
74
+ - **Accept**: application/json; charset=utf-8
75
+
76
+
77
+
27
78
  # **add_credit_note_to_account**
28
79
  > CreditNotePagedMetadata add_credit_note_to_account(account_id, credit_note)
29
80
 
@@ -69,8 +120,8 @@ No authorization required
69
120
 
70
121
  ### HTTP request headers
71
122
 
72
- - **Content-Type**: application/json
73
- - **Accept**: application/json
123
+ - **Content-Type**: application/json; charset=utf-8
124
+ - **Accept**: application/json; charset=utf-8
74
125
 
75
126
 
76
127
 
@@ -123,8 +174,8 @@ No authorization required
123
174
 
124
175
  ### HTTP request headers
125
176
 
126
- - **Content-Type**: application/json
127
- - **Accept**: application/json
177
+ - **Content-Type**: application/json; charset=utf-8
178
+ - **Accept**: application/json; charset=utf-8
128
179
 
129
180
 
130
181
 
@@ -170,8 +221,8 @@ No authorization required
170
221
 
171
222
  ### HTTP request headers
172
223
 
173
- - **Content-Type**: application/json
174
- - **Accept**: text/xml, application/xml, application/json
224
+ - **Content-Type**: application/json; charset=utf-8
225
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
175
226
 
176
227
 
177
228
 
@@ -223,8 +274,8 @@ No authorization required
223
274
 
224
275
  ### HTTP request headers
225
276
 
226
- - **Content-Type**: text/plain, application/json
227
- - **Accept**: application/json
277
+ - **Content-Type**: text/plain, application/json; charset=utf-8
278
+ - **Accept**: application/json; charset=utf-8
228
279
 
229
280
 
230
281
 
@@ -274,8 +325,8 @@ No authorization required
274
325
 
275
326
  ### HTTP request headers
276
327
 
277
- - **Content-Type**: text/plain, application/json
278
- - **Accept**: application/json
328
+ - **Content-Type**: text/plain, application/json; charset=utf-8
329
+ - **Accept**: application/json; charset=utf-8
279
330
 
280
331
 
281
332
 
@@ -325,8 +376,8 @@ No authorization required
325
376
 
326
377
  ### HTTP request headers
327
378
 
328
- - **Content-Type**: text/plain, application/json
329
- - **Accept**: application/json
379
+ - **Content-Type**: text/plain, application/json; charset=utf-8
380
+ - **Accept**: application/json; charset=utf-8
330
381
 
331
382
 
332
383
 
@@ -390,7 +441,7 @@ No authorization required
390
441
  ### HTTP request headers
391
442
 
392
443
  - **Content-Type**: Not defined
393
- - **Accept**: text/plain, application/json
444
+ - **Accept**: text/plain, application/json; charset=utf-8
394
445
 
395
446
 
396
447
 
@@ -454,7 +505,7 @@ No authorization required
454
505
  ### HTTP request headers
455
506
 
456
507
  - **Content-Type**: Not defined
457
- - **Accept**: text/plain, application/json
508
+ - **Accept**: text/plain, application/json; charset=utf-8
458
509
 
459
510
 
460
511
 
@@ -514,8 +565,8 @@ No authorization required
514
565
 
515
566
  ### HTTP request headers
516
567
 
517
- - **Content-Type**: text/plain, application/json
518
- - **Accept**: application/json
568
+ - **Content-Type**: text/plain, application/json; charset=utf-8
569
+ - **Accept**: application/json; charset=utf-8
519
570
 
520
571
 
521
572
 
@@ -579,7 +630,7 @@ No authorization required
579
630
  ### HTTP request headers
580
631
 
581
632
  - **Content-Type**: Not defined
582
- - **Accept**: text/plain, application/json
633
+ - **Accept**: text/plain, application/json; charset=utf-8
583
634
 
584
635
 
585
636
 
@@ -639,8 +690,8 @@ No authorization required
639
690
 
640
691
  ### HTTP request headers
641
692
 
642
- - **Content-Type**: text/plain, application/json
643
- - **Accept**: application/json
693
+ - **Content-Type**: text/plain, application/json; charset=utf-8
694
+ - **Accept**: application/json; charset=utf-8
644
695
 
645
696
 
646
697
 
@@ -690,8 +741,8 @@ No authorization required
690
741
 
691
742
  ### HTTP request headers
692
743
 
693
- - **Content-Type**: text/plain, application/json
694
- - **Accept**: application/json
744
+ - **Content-Type**: text/plain, application/json; charset=utf-8
745
+ - **Accept**: application/json; charset=utf-8
695
746
 
696
747
 
697
748
 
@@ -752,7 +803,7 @@ No authorization required
752
803
  ### HTTP request headers
753
804
 
754
805
  - **Content-Type**: text/plain
755
- - **Accept**: application/json
806
+ - **Accept**: application/json; charset=utf-8
756
807
 
757
808
 
758
809
 
@@ -805,8 +856,8 @@ No authorization required
805
856
 
806
857
  ### HTTP request headers
807
858
 
808
- - **Content-Type**: text/plain, application/json
809
- - **Accept**: application/json
859
+ - **Content-Type**: text/plain, application/json; charset=utf-8
860
+ - **Accept**: application/json; charset=utf-8
810
861
 
811
862
 
812
863
 
@@ -860,7 +911,7 @@ No authorization required
860
911
  ### HTTP request headers
861
912
 
862
913
  - **Content-Type**: text/plain
863
- - **Accept**: application/json
914
+ - **Accept**: application/json; charset=utf-8
864
915
 
865
916
 
866
917
 
@@ -913,8 +964,8 @@ No authorization required
913
964
 
914
965
  ### HTTP request headers
915
966
 
916
- - **Content-Type**: application/json
917
- - **Accept**: application/json
967
+ - **Content-Type**: application/json; charset=utf-8
968
+ - **Accept**: application/json; charset=utf-8
918
969
 
919
970
 
920
971
 
@@ -960,8 +1011,8 @@ No authorization required
960
1011
 
961
1012
  ### HTTP request headers
962
1013
 
963
- - **Content-Type**: application/json
964
- - **Accept**: text/xml, application/xml, application/json
1014
+ - **Content-Type**: application/json; charset=utf-8
1015
+ - **Accept**: text/xml, application/xml, application/json; charset=utf-8
965
1016
 
966
1017
 
967
1018
 
@@ -1014,8 +1065,8 @@ No authorization required
1014
1065
 
1015
1066
  ### HTTP request headers
1016
1067
 
1017
- - **Content-Type**: application/json
1018
- - **Accept**: application/json
1068
+ - **Content-Type**: application/json; charset=utf-8
1069
+ - **Accept**: application/json; charset=utf-8
1019
1070
 
1020
1071
 
1021
1072