bf_ruby2 1.2016.229

data/docs/RolesApi.md

@@ -0,0 +1,327 @@
+# BillForward::RolesApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_role**](RolesApi.md#create_role) | **POST** /roles | Create a new role.
+[**get_all_roles**](RolesApi.md#get_all_roles) | **GET** /roles | Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order.
+[**get_role_by_id**](RolesApi.md#get_role_by_id) | **GET** /roles/{role} | Retrieves a single role, specified by the ID parameter.
+[**remove_permission_from_role**](RolesApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | Revokes a particular permission
+[**revoke_role**](RolesApi.md#revoke_role) | **DELETE** /roles/{role} | Revokes a role
+[**update_role**](RolesApi.md#update_role) | **PUT** /roles | Update a role.
+
+
+# **create_role**
+> RolePagedMetadata create_role(role_request)
+
+Create a new role.
+
+{\"nickname\":\"Create a new role\",\"request\":\"createRoleRequest.html\",\"response\":\"createRoleResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+role_request = BillForward::BillingEntityBase.new # BillingEntityBase | 
+
+
+begin
+  #Create a new role.
+  result = api_instance.create_role(role_request)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->create_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_request** | [**BillingEntityBase**](BillingEntityBase.md)|  | 
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **get_all_roles**
+> RolePagedMetadata get_all_roles(opts)
+
+Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order.
+
+{\"nickname\":\"Retrieve all roles\",\"response\":\"getRoleAll.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | 
+  offset: 0, # Integer | The offset from the first subscription to return.
+  records: 10, # Integer | The maximum number of subscriptions 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.
+  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
+}
+
+begin
+  #Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order.
+  result = api_instance.get_all_roles(opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->get_all_roles: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organizations** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+ **offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
+ **records** | **Integer**| The maximum number of subscriptions 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]
+ **include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_role_by_id**
+> RolePagedMetadata get_role_by_id(role, opts)
+
+Retrieves a single role, specified by the ID parameter.
+
+{\"nickname\":\"Retrieve a role\",\"response\":\"getRoleByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+role = "role_example" # String | ID or name of the role.
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | 
+  include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
+}
+
+begin
+  #Retrieves a single role, specified by the ID parameter.
+  result = api_instance.get_role_by_id(role, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->get_role_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | **String**| ID or name of the role. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+ **include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **remove_permission_from_role**
+> RolePagedMetadata remove_permission_from_role(role, resource, action, opts)
+
+Revokes a particular permission
+
+{\"nickname\":\"Remove Permission from role\",\"response\":\"removePermissionFromGroup.html\",\"request\":\"removePermissionFromGroupRequest.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+role = "role_example" # String | ID or name of the role.
+
+resource = "resource_example" # String | 
+
+action = "action_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | 
+}
+
+begin
+  #Revokes a particular permission
+  result = api_instance.remove_permission_from_role(role, resource, action, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->remove_permission_from_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | **String**| ID or name of the role. | 
+ **resource** | **String**|  | 
+ **action** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **revoke_role**
+> RolePagedMetadata revoke_role(role, opts)
+
+Revokes a role
+
+{\"nickname\":\"Revoke role\",\"response\":\"revokeRole.html\",\"request\":\"revokeRoleRequest.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+role = "role_example" # String | ID or name of the role.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | 
+}
+
+begin
+  #Revokes a role
+  result = api_instance.revoke_role(role, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->revoke_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | **String**| ID or name of the role. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **update_role**
+> RolePagedMetadata update_role(role_request)
+
+Update a role.
+
+{\"nickname\":\"Update a role\",\"request\":\"updateRoleRequest.html\",\"response\":\"updateRoleResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::RolesApi.new
+
+role_request = BillForward::UpdateRoleRequest.new # UpdateRoleRequest | 
+
+
+begin
+  #Update a role.
+  result = api_instance.update_role(role_request)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling RolesApi->update_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role_request** | [**UpdateRoleRequest**](UpdateRoleRequest.md)|  | 
+
+### Return type
+
+[**RolePagedMetadata**](RolePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+

data/docs/RuleSatisfaction.md

@@ -0,0 +1,11 @@
+# BillForward::RuleSatisfaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**satisfied** | **BOOLEAN** |  | [optional] [default to false]
+**broken_rules** | [**Array<CouponRule>**](CouponRule.md) |  | [optional] 
+**coupon_instance_being_initialised** | **BOOLEAN** |  | [optional] [default to false]
+**new_user** | **BOOLEAN** |  | [optional] [default to false]
+
+

data/docs/SearchApi.md

@@ -0,0 +1,70 @@
+# BillForward::SearchApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**perform_search**](SearchApi.md#perform_search) | **GET** /search/{query-string} | Returns the results of the global search specified by the query-string.
+
+
+# **perform_search**
+> SearchResultPagedMetadata perform_search(query_string, opts)
+
+Returns the results of the global search specified by the query-string.
+
+{\"nickname\":\"Search an organizations data\",\"response\":\"getSearchByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::SearchApi.new
+
+query_string = "query_string_example" # String | The query string used to search.
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+  types: ["types_example"], # Array<String> | A list of entities which will be checked when searching
+  offset: 0, # Integer | The starting index of the search results.
+  records: 10, # Integer | The number of search results to return.
+  wildcard: false, # BOOLEAN | Toggle if we search for full words or whether a wildcard is used.
+  entity: false # BOOLEAN | Is an entity returned with the search results.
+}
+
+begin
+  #Returns the results of the global search specified by the query-string.
+  result = api_instance.perform_search(query_string, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling SearchApi->perform_search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_string** | **String**| The query string used to search. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+ **types** | [**Array&lt;String&gt;**](String.md)| A list of entities which will be checked when searching | [optional] 
+ **offset** | **Integer**| The starting index of the search results. | [optional] [default to 0]
+ **records** | **Integer**| The number of search results to return. | [optional] [default to 10]
+ **wildcard** | **BOOLEAN**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false]
+ **entity** | **BOOLEAN**| Is an entity returned with the search results. | [optional] [default to false]
+
+### Return type
+
+[**SearchResultPagedMetadata**](SearchResultPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+

data/docs/SearchResultPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::SearchResultPagedMetadata
+
+## 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<BillingEntityBase>**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+

data/docs/ServiceEndAmendment.md

@@ -0,0 +1,19 @@
+# BillForward::ServiceEndAmendment
+
+## 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/StripeACHTokenPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::StripeACHTokenPagedMetadata
+
+## 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<MutableBillingEntity>**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+

data/docs/StripeAuthCaptureRequest.md

@@ -0,0 +1,20 @@
+# BillForward::StripeAuthCaptureRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**account_id** | **String** | {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} | [optional] 
+**gateway** | **String** | {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} | [optional] 
+**company_name** | **String** | {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] 
+**email** | **String** | {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] 
+**first_name** | **String** | {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] 
+**last_name** | **String** | {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] 
+**mobile** | **String** | {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] 
+**default_payment_method** | **BOOLEAN** | {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} | [optional] [default to false]
+**organization_id** | **String** | {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] 
+**stripe_token** | **String** | {\"description\":\"Single-use token <a href=\\\"https://stripe.com/docs/stripe.js\\\">provided by Stripe's client-side card capture SDK</a>, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault — precursory to linking a BillForward PaymentMethod to that tokenized card.\",\"verbs\":[\"POST\"]} | 
+**card_id** | **String** | {\"description\":\"ID of the captured Card in Stripe. This can be provided as well as — or instead of — the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.\",\"verbs\":[\"POST\"]} | [optional] 
+**customer_id** | **String** |  | [optional] 
+
+

data/docs/StripeObject.md

@@ -0,0 +1,7 @@
+# BillForward::StripeObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/StripeTokenPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::StripeTokenPagedMetadata
+
+## 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<MutableBillingEntity>**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+

data/docs/Subscription.md

@@ -0,0 +1,47 @@
+# BillForward::Subscription
+
+## 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] 
+**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } | [optional] 
+**id** | **String** | {\"description\":\"\",\"verbs\":[\"GET\"]} | 
+**version_id** | **String** | {\"description\":\"\",\"verbs\":[\"GET\"]} | [optional] 
+**crm_id** | **String** | {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] 
+**account_id** | **String** | {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | 
+**organization_id** | **String** | {\"description\":\"Organization associated with the subscription.\",\"verbs\":[]} | 
+**product_id** | **String** | {\"description\":\"\",\"verbs\":[\"GET\"]} | 
+**product_rate_plan_id** | **String** | {\"description\":\"Identifier of the rate-plan being billed for.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**parent_id** | **String** | {\"description\":\"\",\"verbs\":[\"GET\"]} | [optional] 
+**name** | **String** | {\"description\":\"User definable friendly name for the subscription.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**description** | **String** | {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] 
+**type** | **String** | {\"default\":\"dependent on product\", \"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**state** | **String** | {\"PUT_description\":\"A <span class=\\\"label label-default\\\">Provisioned</span> subscription can be updated to either <span class=\\\"label label-default\\\">Trial</span> or <span class=\\\"label label-default\\\">AwaitingPayment</span>, this will start the subscription. Any updates to the state of a non-<span class=\\\"label label-default\\\">Provisioned</span> will be ignored. To cancel or otherwise amend a subscription please use the explict amendment calls.\", \"description\":\"A <span class=\\\"label label-default\\\">Provisioned</span> subscription will not begin until marked as <span class=\\\"label label-default\\\">Trial</span> or <span class=\\\"label label-default\\\">AwaitingPayment</span>. Trial subscriptions transition to <span class=\\\"label label-default\\\">AwaitingPayment</span> when the trial period is over. On subscription renewal the state becomes <span class=\\\"label label-default\\\">AwaitingPayment</span>. Once outstanding invoices are paid the state changes to <span class=\\\"label label-default\\\">Paid</span>. A subscription is set as either <span class=\\\"label label-default\\\">Failed</span> or left as <span class=\\\"label label-default\\\">AwaitingPayment</span>, depending on the rate-plan configuration. If a subscription is non-recurring or fixed-term and ends naturally, it will be marked as <span class=\\\"label label-default\\\">Expired</span>. If all payment attempts have failed a subscription is marked as <span class=\\\"label label-default\\\">Cancelled</span> if it has been manually ended. Once a subscription is marked as <span class=\\\"label label-default\\\">Failed</span>, <span class=\\\"label label-default\\\">Expired</span>, or <span class=\\\"label label-default\\\">Cancelled</span> no invoices other than a final invoice will be issued. Note: Updating account card details will not lead to BillForward automatically retrying payment, manual payment attempts can be made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | 
+**current_period_start** | **DateTime** | {\"description\":\"Start of the current invoice period. At the end of this period, a new new invoice will be generated\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**current_period_end** | **DateTime** | {\"description\":\"End of the current period invoiced for. This can be manually updated to extend trials or delay invoice generation.\",\"verbs\":[\"PUT\",\"GET\"]} | [optional] 
+**contract_start** | **DateTime** | {\"description\":\"start of the contracted period.  This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} | [optional] 
+**subscription_end** | **DateTime** | {\"description\":\"When a subscription will end. This may be in the future if the cancellation is at the end of the current period.\",\"verbs\":[\"GET\"]} | [optional] 
+**current_period_end_explicit** | **DateTime** | {\"description\":\"Override for the initial subscription period. Allows periods to align to a date or time regardless of purchase date/time.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] 
+**initial_period_start** | **DateTime** | {\"description\":\"Start of the first successful period\",\"verbs\":[\"GET\"]} | 
+**successful_periods** | **Integer** | {\"description\":\"Number of paid-for periods billing, excluding trials, since the subscription started.\",\"verbs\":[\"GET\"]} | [optional] 
+**total_periods** | **Integer** | {\"description\":\"Total number of subscription periods.\",\"verbs\":[\"GET\"]} | [optional] 
+**trial_end** | **DateTime** | {\"description\":\"The end time of the trial period, if one existed\",\"verbs\":[\"GET\"]} | 
+**dunning** | **BOOLEAN** | {  \"default\":\"false\", \"description\":\"Are there outstanding invoices which are currently in dunning.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to false]
+**locked** | **String** | {\"description\":\"If the subscription is locked, it will not be processed by the system\",\"verbs\":[]} | [optional] 
+**managed_by** | **String** | {\"description\":\"Which system is responsible for managing the subscription.\",\"verbs\":[]} | [optional] 
+**version_start** | **DateTime** | {\"description\":\"When the current version of the subscription started.\",\"verbs\":[\"GET\"]} | 
+**version_end** | **DateTime** | {\"description\":\"When the current version of the subscription ended, null indicates current version.\",\"verbs\":[\"GET\"]} | [optional] 
+**version_number** | **Integer** | {\"description\":\"Incremental version number of the subscription, starts at 1.\",\"verbs\":[\"GET\"]} | 
+**credit_enabled** | **BOOLEAN** | {  \"default\":\"true\", \"description\":\"Can credit-notes be used to pay outstanding invoices for this subscription.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to false]
+**aggregate_all_subscriptions_on_account** | **BOOLEAN** | {  \"default\":\"true\", \"description\":\"Whether the subscription will aggregate all other subscriptions on the account.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to false]
+**pricing_component_values** | [**Array<PricingComponentValue>**](PricingComponentValue.md) | {\"description\":\"The quantities for each pricing component of the rate-plan. Values should be set for all pricing components of the rate-plan apart from the usage components. Usage components should be added when the usage is known, this is often after the end of the current billing cycle.\",\"verbs\":[\"GET\", \"POST\"]} | [optional] 
+**payment_method_subscription_links** | [**Array<PaymentMethodSubscriptionLink>**](PaymentMethodSubscriptionLink.md) |  | [optional] 
+**fixed_terms** | [**Array<FixedTerm>**](FixedTerm.md) | {\"description\":\"List of fixed terms that have been or are applied to the subscription\",\"verbs\":[\"GET\"]} | [optional] 
+**current_time** | **DateTime** | {\"description\":\"The current time — from the point of view of the subscription.\",\"verbs\":[\"GET\"]} | 
+**time_offset** | **Integer** | {\"description\":\"How far in the future is the entity (in seconds) compared to the BillForward server's time.\",\"verbs\":[\"GET\"]} | [optional] 
+**payment_terms** | **Integer** |  | [optional] 
+**failed_payment_behaviour** | **String** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] 
+
+

data/docs/SubscriptionCancellationPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::SubscriptionCancellationPagedMetadata
+
+## 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<MutableBillingEntity>**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+

data/docs/SubscriptionCharge.md

@@ -0,0 +1,32 @@
+# BillForward::SubscriptionCharge
+
+## 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\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} | [optional] 
+**crm_id** | **String** | {\"description\":\"Customer-relationship-management ID of the charge.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] 
+**account_id** | **String** | {\"description\":\"ID of the account owning the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] 
+**subscription_id** | **String** | {\"description\":\"ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] 
+**subscription_version_id** | **String** | {\"description\":\"Version ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] 
+**invoice_id** | **String** | {\"description\":\"ID of the invoice to which this charge applies (if the charge targets a specific invoice).\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**name** | **String** | {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | [optional] 
+**description** | **String** | {\"description\":\"Description given to the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | [optional] 
+**amount** | **Float** | {\"description\":\"Monetary amount of the charge — including any tax applied to the final amount.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**amount_excluding_tax** | **Float** | {\"description\":\"Monetary amount of the charge — excluding any tax applied to the final amount.\",\"verbs\":[\"GET\"]} | [optional] 
+**currency** | **String** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } | [optional] 
+**period_start** | **DateTime** | {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**period_end** | **DateTime** | {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] 
+**type** | **String** | {\"description\":\"A type describing the nature of the charge.\",\"verbs\":[\"POST\",\"GET\"]} | 
+**invoicing_type** | **String** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"The strategy for how this charge will raise invoices.<br><span class=\\\"label label-default\\\">Immediate</span> — Generate straight-away an invoice containing this charge.<br><span class=\\\"label label-default\\\">Aggregated</span> — Add this charge to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | 
+**state** | **String** | {\"default\":\"<span class=\\\"label label-default\\\">Pending</span>\",\"description\":\"The current state of the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | 
+**charge_type** | **String** | {\"default\":\"<span class=\\\"label label-default\\\">Debit</span>\",\"description\":\"Whether this charge represents money given to or taken from the customer.<br><span class=\\\"label label-default\\\">Credit</span> — This is a charge for money given to the customer.<br><span class=\\\"label label-default\\\">Debit</span> — This is a charge for money taken from the customer.\",\"verbs\":[\"POST\",\"GET\"]} | 
+**calculation** | **String** | {\"default\":\"(Empty string)\",\"description\":\"A human-readable explanation of how the value of the charge was calculated.\",\"verbs\":[\"GET\"]} | [optional] 
+**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> — Outstanding credit is returned to the accounts credit pool.<br><span class=\\\"label label-default\\\">Discard</span> — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} | 
+**trial** | **BOOLEAN** | {\"default\":\"false\",\"description\":\"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)<br>Whether the charge was created for a subscription whilst in a trial period.<br><span class=\\\"label label-default\\\">false</span> — This is a non-trial charge, so funds will be sought from the customer.<br><span class=\\\"label label-default\\\">true</span> — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to false]
+**version_id** | **String** | {\"description\":\"The version ID of the charge.\",\"verbs\":[\"GET\"]} | [optional] 
+**version_number** | **Integer** | {\"description\":\"The version number of the charge. The first version of a charge is version number 1.\",\"verbs\":[\"GET\"]} | 
+
+