bf_ruby2 1.2016.229

data/docs/EmailprovidersApi.md

@@ -0,0 +1,221 @@
+# BillForward::EmailprovidersApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_email_provider**](EmailprovidersApi.md#create_email_provider) | **POST** /email-providers | Create an email provider.
+[**delete**](EmailprovidersApi.md#delete) | **DELETE** /email-providers/{email-provider-ID} | Deletes a single email provider, specified by id or name parameter.
+[**get_all_email_providers**](EmailprovidersApi.md#get_all_email_providers) | **GET** /email-providers | Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order.
+[**get_email_by_provider_id**](EmailprovidersApi.md#get_email_by_provider_id) | **GET** /email-providers/{email-provider-ID} | Retrieves a single email provider, specified by the version-ID parameter.
+
+
+# **create_email_provider**
+> EmailProviderPagedMetadata create_email_provider(request)
+
+Create an email provider.
+
+{\"nickname\":\"Create an email provider\",\"request\":\"createEmailProviderRequest.html\",\"response\":\"creatEmailProviderResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailprovidersApi.new
+
+request = BillForward::BillingEntityBase.new # BillingEntityBase | .
+
+
+begin
+  #Create an email provider.
+  result = api_instance.create_email_provider(request)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailprovidersApi->create_email_provider: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | 
+
+### Return type
+
+[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **delete**
+> EmailProviderPagedMetadata delete(email_provider_id, opts)
+
+Deletes a single email provider, specified by id or name parameter.
+
+{ \"nickname\" : \"delete\",\"response\" : \"deleteEmailProvider.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailprovidersApi.new
+
+email_provider_id = "email_provider_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Deletes a single email provider, specified by id or name parameter.
+  result = api_instance.delete(email_provider_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailprovidersApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_provider_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_all_email_providers**
+> EmailProviderPagedMetadata get_all_email_providers(opts)
+
+Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order.
+
+{\"nickname\":\"Get all email providers\",\"response\":\"getEmailProvidersAll.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailprovidersApi.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 email-provider to return.
+  records: 10, # Integer | The maximum number of email-provider 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 | Include deleted email-providers
+}
+
+begin
+  #Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order.
+  result = api_instance.get_all_email_providers(opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailprovidersApi->get_all_email_providers: #{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 email-provider to return. | [optional] [default to 0]
+ **records** | **Integer**| The maximum number of email-provider 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**| Include deleted email-providers | [optional] [default to false]
+
+### Return type
+
+[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_email_by_provider_id**
+> EmailProviderPagedMetadata get_email_by_provider_id(email_provider_id, opts)
+
+Retrieves a single email provider, specified by the version-ID parameter.
+
+{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailProviderByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailprovidersApi.new
+
+email_provider_id = "email_provider_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+  include_retired: false # BOOLEAN | Include deleted email-providers
+}
+
+begin
+  #Retrieves a single email provider, specified by the version-ID parameter.
+  result = api_instance.get_email_by_provider_id(email_provider_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailprovidersApi->get_email_by_provider_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_provider_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+ **include_retired** | **BOOLEAN**| Include deleted email-providers | [optional] [default to false]
+
+### Return type
+
+[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+

data/docs/EmailsApi.md

@@ -0,0 +1,164 @@
+# BillForward::EmailsApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_email_by_id**](EmailsApi.md#get_email_by_id) | **GET** /emails/{email-ID} | Retrieves a single invoice, specified by the version-ID parameter.
+[**get_email_html_by_id**](EmailsApi.md#get_email_html_by_id) | **GET** /emails/{email-ID}.html | Retrieves a single invoice, specified by the version-ID parameter.
+[**get_email_text_by_id**](EmailsApi.md#get_email_text_by_id) | **GET** /emails/{email-ID}.txt | Retrieves a single invoice, specified by the version-ID parameter.
+
+
+# **get_email_by_id**
+> EmailPagedMetadata get_email_by_id(email_id, opts)
+
+Retrieves a single invoice, specified by the version-ID parameter.
+
+{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsApi.new
+
+email_id = "email_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Retrieves a single invoice, specified by the version-ID parameter.
+  result = api_instance.get_email_by_id(email_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsApi->get_email_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**EmailPagedMetadata**](EmailPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json, text/xml
+
+
+
+# **get_email_html_by_id**
+> String get_email_html_by_id(email_id, opts)
+
+Retrieves a single invoice, specified by the version-ID parameter.
+
+{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsApi.new
+
+email_id = "email_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Retrieves a single invoice, specified by the version-ID parameter.
+  result = api_instance.get_email_html_by_id(email_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsApi->get_email_html_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: text/html
+
+
+
+# **get_email_text_by_id**
+> String get_email_text_by_id(email_id, opts)
+
+Retrieves a single invoice, specified by the version-ID parameter.
+
+{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsApi.new
+
+email_id = "email_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Retrieves a single invoice, specified by the version-ID parameter.
+  result = api_instance.get_email_text_by_id(email_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsApi->get_email_text_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: text/plain
+
+
+

data/docs/EmailsubscriptionsApi.md

@@ -0,0 +1,273 @@
+# BillForward::EmailsubscriptionsApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_email_subscription**](EmailsubscriptionsApi.md#create_email_subscription) | **POST** /email-subscriptions | Create an email subscription.
+[**delete_email_subscription_by_type**](EmailsubscriptionsApi.md#delete_email_subscription_by_type) | **DELETE** /email-subscriptions/type={type} | Unsubscribe from the email specified by the type parameter.
+[**get_all_email_subscriptions**](EmailsubscriptionsApi.md#get_all_email_subscriptions) | **GET** /email-subscriptions | Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order.
+[**get_email_subscription_by_id**](EmailsubscriptionsApi.md#get_email_subscription_by_id) | **GET** /email-subscriptions/{email-subscription-id} | Retrieves a single email subscription, specified by ID.
+[**update_email_subscription**](EmailsubscriptionsApi.md#update_email_subscription) | **PUT** /email-subscriptions | Update an email subscription.
+
+
+# **create_email_subscription**
+> EmailSubscriptionPagedMetadata create_email_subscription(request)
+
+Create an email subscription.
+
+{\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsubscriptionsApi.new
+
+request = BillForward::BillingEntityBase.new # BillingEntityBase | .
+
+
+begin
+  #Create an email subscription.
+  result = api_instance.create_email_subscription(request)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsubscriptionsApi->create_email_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | 
+
+### Return type
+
+[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **delete_email_subscription_by_type**
+> EmailSubscriptionPagedMetadata delete_email_subscription_by_type(type, opts)
+
+Unsubscribe from the email specified by the type parameter.
+
+{ \"nickname\" : \"Unsubscribe\",\"response\" : \"unsubscribeEmail.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsubscriptionsApi.new
+
+type = "type_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Unsubscribe from the email specified by the type parameter.
+  result = api_instance.delete_email_subscription_by_type(type, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsubscriptionsApi->delete_email_subscription_by_type: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json, text/xml
+
+
+
+# **get_all_email_subscriptions**
+> EmailSubscriptionPagedMetadata get_all_email_subscriptions(state, type, opts)
+
+Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order.
+
+{\"nickname\":\"Get all email subscriptions\",\"response\":\"getEmailSubscriptionsAll.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsubscriptionsApi.new
+
+state = "state_example" # String | Constrains search to Email Subscriptions of a specific state.
+
+type = "type_example" # String | Constrains search to Email Subscriptions of a specific type
+
+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 email-subscription to return.
+  records: 10, # Integer | The maximum number of email-subscription 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 email-subscriptions. By default 10 values are returned. Records are returned in natural order.
+  result = api_instance.get_all_email_subscriptions(state, type, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsubscriptionsApi->get_all_email_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | **String**| Constrains search to Email Subscriptions of a specific state. | 
+ **type** | **String**| Constrains search to Email Subscriptions of a specific type | 
+ **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 email-subscription to return. | [optional] [default to 0]
+ **records** | **Integer**| The maximum number of email-subscription 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
+
+[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_email_subscription_by_id**
+> EmailSubscriptionPagedMetadata get_email_subscription_by_id(email_subscription_id, opts)
+
+Retrieves a single email subscription, specified by ID.
+
+{ \"nickname\" : \"Retrieve by ID\",\"response\" : \"getEmailSubscriptionByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsubscriptionsApi.new
+
+email_subscription_id = "email_subscription_id_example" # String | 
+
+opts = { 
+  organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+  include_retired: false # BOOLEAN | Include deleted email-subscriptions
+}
+
+begin
+  #Retrieves a single email subscription, specified by ID.
+  result = api_instance.get_email_subscription_by_id(email_subscription_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsubscriptionsApi->get_email_subscription_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email_subscription_id** | **String**|  | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+ **include_retired** | **BOOLEAN**| Include deleted email-subscriptions | [optional] [default to false]
+
+### Return type
+
+[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **update_email_subscription**
+> EmailSubscriptionPagedMetadata update_email_subscription(request)
+
+Update an email subscription.
+
+{\"nickname\":\"Update EmailSubscription\",\"request\":\"updateEmailSubscriptionRequest.html\",\"response\":\"updateEmailSubscriptionResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::EmailsubscriptionsApi.new
+
+request = BillForward::BillingEntityBase.new # BillingEntityBase | .
+
+
+begin
+  #Update an email subscription.
+  result = api_instance.update_email_subscription(request)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling EmailsubscriptionsApi->update_email_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | 
+
+### Return type
+
+[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+

data/docs/EndTrialAmendment.md

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

@@ -0,0 +1,15 @@
+# BillForward::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**type** | **String** |  | 
+**livemode** | **BOOLEAN** |  | [default to false]
+**created** | **Integer** |  | 
+**data** | [**EventData**](EventData.md) |  | 
+**request** | **String** |  | 
+**user_id** | **String** |  | 
+**pending_webhooks** | **Integer** |  | 
+
+

data/docs/EventData.md

@@ -0,0 +1,9 @@
+# BillForward::EventData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**previous_attributes** | **Hash<String, Object>** |  | 
+**object** | [**StripeObject**](StripeObject.md) |  | 
+
+