bf_ruby2 1.2016.229

data/docs/RefundsApi.md

@@ -0,0 +1,432 @@
+# BillForward::RefundsApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_refund**](RefundsApi.md#create_refund) | **POST** /refunds | <p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p>
+[**get_all_refunds**](RefundsApi.md#get_all_refunds) | **GET** /refunds | Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order
+[**get_refund_by_id**](RefundsApi.md#get_refund_by_id) | **GET** /refunds/{refund-ID} | Returns a single refund, specified by the ID parameter.
+[**get_refund_for_original_payment**](RefundsApi.md#get_refund_for_original_payment) | **GET** /refunds/original-payment/{payment-ID} | Returns a refund for the original payment.
+[**get_refund_for_refund_payment**](RefundsApi.md#get_refund_for_refund_payment) | **GET** /refunds/refund-payment/{payment-ID} | Returns a refund for the refund payment.
+[**get_refund_for_refunded_invoice**](RefundsApi.md#get_refund_for_refunded_invoice) | **GET** /refunds/invoice/{invoice-ID} | Returns a refund for the refund payment.
+[**get_refunds_as_csv**](RefundsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | Retrieves refunds in CSV format.
+[**update_refund**](RefundsApi.md#update_refund) | **PUT** /refunds | Update a refund
+
+
+# **create_refund**
+> RefundPagedMetadata create_refund(refund)
+
+<p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p>
+
+{\"nickname\":\"Create a new refund\",\"request\":\"createRefundRequest.html\",\"response\":\"createRefundResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+refund = BillForward::Refund.new # Refund | The refund object to be created.
+
+
+begin
+  #<p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p>
+  result = api_instance.create_refund(refund)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->create_refund: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund** | [**Refund**](Refund.md)| The refund object to be created. | 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **get_all_refunds**
+> RefundPagedMetadata get_all_refunds(opts)
+
+Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order
+
+{\"nickname\":\"Get all refunds\",\"response\":\"getRefundsAll.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+  offset: 0, # Integer | The offset from the first refund to return.
+  records: 10, # Integer | The maximum number of refunds to return.
+  order_by: "created", # String | Specify a field used to order the result set.
+  order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
+}
+
+begin
+  #Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order
+  result = api_instance.get_all_refunds(opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_all_refunds: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+ **offset** | **Integer**| The offset from the first refund to return. | [optional] [default to 0]
+ **records** | **Integer**| The maximum number of refunds to return. | [optional] [default to 10]
+ **order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
+ **order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_refund_by_id**
+> RefundPagedMetadata get_refund_by_id(refund_id, opts)
+
+Returns a single refund, specified by the ID parameter.
+
+{\"nickname\":\"Retrieve an existing refund\",\"response\":\"getRefundByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+refund_id = "refund_id_example" # String | ID of the Refund.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns a single refund, specified by the ID parameter.
+  result = api_instance.get_refund_by_id(refund_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund_id** | **String**| ID of the Refund. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_refund_for_original_payment**
+> RefundPagedMetadata get_refund_for_original_payment(payment_id, opts)
+
+Returns a refund for the original payment.
+
+{\"nickname\":\"Retrieve by originating payment\",\"response\":\"getRefundsByPayment.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+payment_id = "payment_id_example" # String | ID of the Payment.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns a refund for the original payment.
+  result = api_instance.get_refund_for_original_payment(payment_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund_for_original_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_id** | **String**| ID of the Payment. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_refund_for_refund_payment**
+> RefundPagedMetadata get_refund_for_refund_payment(payment_id, opts)
+
+Returns a refund for the refund payment.
+
+{\"nickname\":\"Retrieve by refund payment\",\"response\":\"getRefundsByPayment.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+payment_id = "payment_id_example" # String | ID of the Payment.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns a refund for the refund payment.
+  result = api_instance.get_refund_for_refund_payment(payment_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund_for_refund_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_id** | **String**| ID of the Payment. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_refund_for_refunded_invoice**
+> RefundPagedMetadata get_refund_for_refunded_invoice(invoice_id, opts)
+
+Returns a refund for the refund payment.
+
+{\"nickname\":\"Retrieve by invoice\",\"response\":\"getRefundsByInvoice.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+invoice_id = "invoice_id_example" # String | ID of the Invoice.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns a refund for the refund payment.
+  result = api_instance.get_refund_for_refunded_invoice(invoice_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund_for_refunded_invoice: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invoice_id** | **String**| ID of the Invoice. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_refunds_as_csv**
+> RefundPagedMetadata get_refunds_as_csv(completed_start, completed_end, opts)
+
+Retrieves refunds in CSV format.
+
+{ \"nickname\":\"Refunds CSV\",\"response\":\"refunds.csv\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+completed_start = "completed_start_example" # String | The UTC DateTime specifying the start of the interval within which refunds were completed.
+
+completed_end = "completed_end_example" # String | The UTC DateTime specifying the end of the interval within which refunds were completed.
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+  offset: 56, # Integer | The offset from the first refund to return.
+  records: 56, # Integer | The maximum number of refunds to return.
+  order_by: "created", # String | Specify a field used to order the result set.
+  order: "DESC" # String | The direction of any ordering, either ASC or DESC.
+}
+
+begin
+  #Retrieves refunds in CSV format.
+  result = api_instance.get_refunds_as_csv(completed_start, completed_end, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->get_refunds_as_csv: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **completed_start** | **String**| The UTC DateTime specifying the start of the interval within which refunds were completed. | 
+ **completed_end** | **String**| The UTC DateTime specifying the end of the interval within which refunds were completed. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+ **offset** | **Integer**| The offset from the first refund to return. | [optional] 
+ **records** | **Integer**| The maximum number of refunds to return. | [optional] 
+ **order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
+ **order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+
+# **update_refund**
+> RefundPagedMetadata update_refund(refund)
+
+Update a refund
+
+{\"nickname\":\"Update a refund\",\"request\":\"updateRefundRequest.html\",\"response\":\"updateRefundResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RefundsApi.new
+
+refund = BillForward::Refund.new # Refund | The refund object to be update.
+
+
+begin
+  #Update a refund
+  result = api_instance.update_refund(refund)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RefundsApi->update_refund: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **refund** | [**Refund**](Refund.md)| The refund object to be update. | 
+
+### Return type
+
+[**RefundPagedMetadata**](RefundPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+

data/docs/ResumeRequest.md

@@ -0,0 +1,10 @@
+# BillForward::ResumeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**resume** | **DateTime** | {\"default\":\"(Resume immediately)\",\"description\":\"Schedules the resumption to be actioned at some future time.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**dry_run** | **BOOLEAN** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to false]
+
+

data/docs/ResumeSubscriptionAmendment.md

@@ -0,0 +1,19 @@
+# BillForward::ResumeSubscriptionAmendment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] 
+**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] 
+**type** | **String** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | 
+**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] 
+**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] 
+**subscription_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**amendment_type** | **String** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | 
+**actioning_time** | **DateTime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**actioned_time** | **DateTime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] 
+**state** | **String** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | 
+**deleted** | **BOOLEAN** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to false]
+
+

data/docs/RevenueAttribution.md

@@ -0,0 +1,31 @@
+# BillForward::RevenueAttribution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period_start** | **DateTime** | {\"description\":\"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**period_end** | **DateTime** | {\"description\":\"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] 
+**id** | **String** | {\"description\":\"ID of the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] 
+**organization_id** | **String** | {\"description\":\"ID of the organization associated with the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**invoice_id** | **String** | {\"description\":\"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**invoice_version_id** | **String** | {\"description\":\"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**aggregated_invoice_id** | **String** | {\"description\":\"ID of the invoice to which this RevenueAttribution's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**aggregated_invoice_line_id** | **String** | {\"description\":\"ID of the invoice line whose debt this RevenueAttribution describes.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**currency** | **String** | {\"description\":\"The currency of the Invoice from which this RevenueAttribution was raised — specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**nominal_amount** | **Float** | {\"description\":\"The amount paid — through credit or otherwise — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**actual_amount** | **Float** | {\"description\":\"The amount paid — through real money — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**pricing_component_id** | **String** | {\"description\":\"ID of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**pricing_component_name** | **String** | {\"description\":\"Name of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_rate_plan_id** | **String** | {\"description\":\"ID of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_rate_plan_name** | **String** | {\"description\":\"Internal name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_rate_plan_name_public** | **String** | {\"description\":\"Public name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_id** | **String** | {\"description\":\"ID of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_name** | **String** | {\"description\":\"Internal name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**product_name_public** | **String** | {\"description\":\"Public name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**aggregated_subscription_id** | **String** | {\"description\":\"ID of the Subscription with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**subscription_id** | **String** | {\"description\":\"Consistent ID of the Subscription which pays for this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**account_id** | **String** | {\"description\":\"ID of the Account with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+
+

data/docs/RevenueAttributionPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::RevenueAttributionPagedMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**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\"]} | 
+**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**results** | [**Array<RevenueAttribution>**](RevenueAttribution.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+

data/docs/ReviveSubscriptionRequest.md

@@ -0,0 +1,8 @@
+# BillForward::ReviveSubscriptionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_id** | **String** |  | 
+
+

data/docs/Role.md

@@ -0,0 +1,19 @@
+# BillForward::Role
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] 
+**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] 
+**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] 
+**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] 
+**name** | **String** | { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] 
+**description** | **String** | { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] 
+**revoked** | **DateTime** | { \"description\" : \"If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] 
+**deleted** | **BOOLEAN** | { \"default\" : \"false\", \"description\" : \"If a role is deleted any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to false]
+**default_role** | **BOOLEAN** | { \"default\" : \"false\", \"description\" : \"If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to false]
+**default_returned** | **BOOLEAN** | { \"default\" : \"false\", \"description\" : \"When returning the list of roles for an account, this indicates if the role was returned due to defaulting.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to false]
+**permissions** | [**Array<BFPermission>**](BFPermission.md) | { \"description\" : \"List of permissions in this role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] 
+
+

data/docs/RolePagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::RolePagedMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**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\"]} | 
+**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**results** | [**Array<Role>**](Role.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+