bf_ruby2 1.2016.229

data/docs/CouponsApi.md

@@ -0,0 +1,456 @@
+# BillForward::CouponsApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_coupon**](CouponsApi.md#create_coupon) | **POST** /coupons | Create a coupon.
+[**create_coupon_unique_codes**](CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | Create a list of unique coupon codes that can be applied to a subscription.
+[**get_all_coupons**](CouponsApi.md#get_all_coupons) | **GET** /coupons | Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order.
+[**get_applied_coupons**](CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | Returns a list of unique coupons which have been applied.
+[**get_available_coupon_codes_for_code**](CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription.
+[**get_coupon_code**](CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | Returns the coupon for the specified code that can be applied to a subscription.
+[**get_subscription_applications_of_coupons**](CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | Retrieves a collection of the coupons by this coupon code which have been applied.
+[**retire_coupon**](CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | <p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p>
+
+
+# **create_coupon**
+> CouponPagedMetadata create_coupon(code)
+
+Create a coupon.
+
+{\"nickname\":\"Create a new coupon\",\"request\":\"createCouponRequest.html\",\"response\":\"createCouponResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = BillForward::Coupon.new # Coupon | The coupon object to be created.
+
+
+begin
+  #Create a coupon.
+  result = api_instance.create_coupon(code)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->create_coupon: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | [**Coupon**](Coupon.md)| The coupon object to be created. | 
+
+### Return type
+
+[**CouponPagedMetadata**](CouponPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_coupon_unique_codes**
+> CouponUniqueCodesResponsePagedMetadata create_coupon_unique_codes(code, opts)
+
+Create a list of unique coupon codes that can be applied to a subscription.
+
+{ \"nickname\":\"Create unique coupon codes\",\"request\":\"createUniqueCodesRequest.html\",\"response\":\"createUniqueCodesResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | The coupon code to use in the generation of the unique codes.
+
+opts = { 
+  request: BillForward::CouponUniqueCodesRequest.new # CouponUniqueCodesRequest | The request object that specifies the number of codes to be created.
+}
+
+begin
+  #Create a list of unique coupon codes that can be applied to a subscription.
+  result = api_instance.create_coupon_unique_codes(code, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->create_coupon_unique_codes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The coupon code to use in the generation of the unique codes. | 
+ **request** | [**CouponUniqueCodesRequest**](CouponUniqueCodesRequest.md)| The request object that specifies the number of codes to be created. | [optional] 
+
+### Return type
+
+[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_all_coupons**
+> CouponPagedMetadata get_all_coupons(opts)
+
+Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order.
+
+{ \"nickname\":\"Retrieve all coupons\",\"response\":\"getCouponAll.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.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 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
+  #Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order.
+  result = api_instance.get_all_coupons(opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->get_all_coupons: #{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 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
+
+[**CouponPagedMetadata**](CouponPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_applied_coupons**
+> CouponPagedMetadata get_applied_coupons(code, opts)
+
+Returns a list of unique coupons which have been applied.
+
+{ \"nickname\":\"Retrieve used unique coupons\",\"response\":\"getAppliedCodesForCode.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | The base code to use in the generation of the unique codes.
+
+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 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
+  #Returns a list of unique coupons which have been applied.
+  result = api_instance.get_applied_coupons(code, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->get_applied_coupons: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The base code to use in the generation of the unique codes. | 
+ **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 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
+
+[**CouponPagedMetadata**](CouponPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_available_coupon_codes_for_code**
+> CouponUniqueCodesResponsePagedMetadata get_available_coupon_codes_for_code(code, opts)
+
+Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription.
+
+{ \"nickname\":\"Retrieve unused unique coupons\",\"response\":\"getAvailableCodesForCode.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | The base code to use in the generation of the unique codes.
+
+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 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
+  #Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription.
+  result = api_instance.get_available_coupon_codes_for_code(code, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->get_available_coupon_codes_for_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The base code to use in the generation of the unique codes. | 
+ **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 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
+
+[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_coupon_code**
+> CouponUniqueCodesResponsePagedMetadata get_coupon_code(code, opts)
+
+Returns the coupon for the specified code that can be applied to a subscription.
+
+{ \"nickname\":\"Retrieve coupon\",\"response\":\"getCouponByCode.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | The parent coupon code to use in the generation of the unique codes.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns the coupon for the specified code that can be applied to a subscription.
+  result = api_instance.get_coupon_code(code, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->get_coupon_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| The parent coupon code to use in the generation of the unique codes. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_subscription_applications_of_coupons**
+> SubscriptionPagedMetadata get_subscription_applications_of_coupons(code, opts)
+
+Retrieves a collection of the coupons by this coupon code which have been applied.
+
+{ \"nickname\":\"Retrieve subscriptions to which the given coupon code has been applied.\",\"response\":\"getSubscriptionApplications.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | Base code of the coupon.
+
+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 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 the coupons by this coupon code which have been applied.
+  result = api_instance.get_subscription_applications_of_coupons(code, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->get_subscription_applications_of_coupons: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| Base code of the coupon. | 
+ **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 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
+
+[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **retire_coupon**
+> CouponPagedMetadata retire_coupon(code, organizations)
+
+<p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p>
+
+{ \"nickname\":\"Retire coupon\",\"response\":\"retireCoupon.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::CouponsApi.new
+
+code = "code_example" # String | ID of the coupon to remove.
+
+organizations = ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+
+
+begin
+  #<p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p>
+  result = api_instance.retire_coupon(code, organizations)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling CouponsApi->retire_coupon: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**| ID of the coupon to remove. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | 
+
+### Return type
+
+[**CouponPagedMetadata**](CouponPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+

data/docs/CreateAccountProfileRequest.md

@@ -0,0 +1,20 @@
+# BillForward::CreateAccountProfileRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | 
+**email** | **String** | { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**first_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**last_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**company_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**logo_url** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**addresses** | [**Array<CreateProfileAddressRequest>**](CreateProfileAddressRequest.md) | { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**mobile** | **String** | { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**landline** | **String** | { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**fax** | **String** | { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**dob** | **DateTime** | { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**vat_number** | **String** | { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**additional_information** | **String** | { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+
+

data/docs/CreateAccountRequest.md

@@ -0,0 +1,13 @@
+# BillForward::CreateAccountRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile** | [**CreateAccountProfileRequest**](CreateAccountProfileRequest.md) |  | [optional] 
+**organization_id** | **String** | { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } | [optional] 
+**user_id** | **String** | { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } | [optional] 
+**aggregating_product_rate_plan_id** | **String** | { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription.  An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } | [optional] 
+**aggregating_subscription_id** | **String** | { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } | [optional] 
+**metadata** | [**DynamicMetadata**](DynamicMetadata.md) |  | [optional] 
+
+

data/docs/CreateAddressRequest.md

@@ -0,0 +1,17 @@
+# BillForward::CreateAddressRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | 
+**address_line1** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**address_line2** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**address_line3** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**city** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**province** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**country** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**postcode** | **String** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**landline** | **String** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**primary_address** | **BOOLEAN** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to false]
+
+

data/docs/CreateAggregatingComponentRequest.md

@@ -0,0 +1,10 @@
+# BillForward::CreateAggregatingComponentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**pricing_component** | **String** | {\"description\":\"Name of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} | 
+**organization_id** | **String** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] 
+
+

data/docs/CreateAggregatingSubscriptionRequest.md

@@ -0,0 +1,21 @@
+# BillForward::CreateAggregatingSubscriptionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**account_id** | **String** | {\"description\":\"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} | 
+**organization_id** | **String** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] 
+**name** | **String** | {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').\",\"verbs\":[\"POST\"]} | [optional] 
+**description** | **String** | {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show').\",\"verbs\":[\"POST\"]} | [optional] 
+**start** | **DateTime** | {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} | [optional] 
+**state** | **String** | {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.<br><span class=\\\"label label-default\\\">Provisioned</span> — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<br><span class=\\\"label label-default\\\">AwaitingPayment</span> — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} | [optional] 
+**product_rate_plan** | **String** | {\"description\":\"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request — this subscription will subscribe to that newly-created rate plan.\",\"verbs\":[\"POST\"]} | [optional] 
+**duration** | **Integer** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.\",\"verbs\":[\"POST\"]} | [optional] 
+**duration_period** | **String** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.\",\"verbs\":[\"POST\"]} | [optional] 
+**product_type** | **String** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan — either recurring or non-recurring.\",\"verbs\":[\"POST\"]} | [optional] 
+**aggregating_components** | [**Array<CreateAggregatingComponentRequest>**](CreateAggregatingComponentRequest.md) | {\"default\":\"(empty list)\",\"description\":\"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} | [optional] 
+**aggregate_all_subscriptions_on_account** | **BOOLEAN** | {\"default\":false,\"description\":\"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} | [optional] [default to false]
+**currency** | **String** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\"]} | 
+
+

data/docs/CreateProfileAddressRequest.md

@@ -0,0 +1,16 @@
+# BillForward::CreateProfileAddressRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_line1** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**address_line2** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**address_line3** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**city** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**province** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**country** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**postcode** | **String** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**landline** | **String** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] 
+**primary_address** | **BOOLEAN** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to false]
+
+

data/docs/CreateSubscriptionBatchRequest.md

@@ -0,0 +1,10 @@
+# BillForward::CreateSubscriptionBatchRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] 
+**organization_id** | **String** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscriptions should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] 
+**subscriptions** | [**Array<CreateSubscriptionRequest>**](CreateSubscriptionRequest.md) | {\"default\":\"(Empty list)\",\"description\":\"List of entities for requesting that subscriptions be created.\",\"verbs\":[\"POST\"]} | [optional] 
+
+

data/docs/CreateSubscriptionChargeAmendment.md

@@ -0,0 +1,29 @@
+# BillForward::CreateSubscriptionChargeAmendment
+
+## 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]
+**subscription_charge_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] 
+**description** | **String** | { \"description\" : \".\", \"verbs\":[\"POST\",\"GET\"] } | [optional] 
+**amount** | **Float** | { \"description\" : \"Monetary value to charge in the same currency as the subscription.\", \"verbs\":[\"POST\",\"GET\"] } | 
+**discount** | **Float** | { \"description\" : \"\", \"verbs\":[] } | [optional] 
+**type** | **String** | { \"description\" : \"\", \"default\" : \"Manual\",  \"verbs\":[] } | 
+**invoicing_type** | **String** | { \"description\" : \"<span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**tax_status** | **String** | { \"description\" : \"Whether the amount specified is <span class=\\\"label label-default\\\">inclusive</span> or <span class=\\\"label label-default\\\">exclusive</span> of tax\",  \"default\" : \"inclusive\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | 
+**subscription_charge** | [**SubscriptionCharge**](SubscriptionCharge.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] 
+**pricing_component_value_change** | [**InsertableBillingEntity**](InsertableBillingEntity.md) | { \"description\" : \"\", \"verbs\":[] } | [optional] 
+**pricing_component_id** | **String** | { \"description\" : \"\", \"verbs\":[] } | [optional] 
+
+