merge_accounting_client 1.0.0

data/docs/TaxRatesApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::TaxRatesApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tax_rates_list**](TaxRatesApi.md#tax_rates_list) | **GET** /tax-rates |  |
+| [**tax_rates_retrieve**](TaxRatesApi.md#tax_rates_retrieve) | **GET** /tax-rates/{id} |  |
+
+
+## tax_rates_list
+
+> <PaginatedTaxRateList> tax_rates_list(x_account_token, opts)
+
+
+
+Returns a list of `TaxRate` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::TaxRatesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.tax_rates_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TaxRatesApi->tax_rates_list: #{e}"
+end
+```
+
+#### Using the tax_rates_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTaxRateList>, Integer, Hash)> tax_rates_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tax_rates_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTaxRateList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TaxRatesApi->tax_rates_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedTaxRateList**](PaginatedTaxRateList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tax_rates_retrieve
+
+> <TaxRate> tax_rates_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `TaxRate` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::TaxRatesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.tax_rates_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TaxRatesApi->tax_rates_retrieve: #{e}"
+end
+```
+
+#### Using the tax_rates_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TaxRate>, Integer, Hash)> tax_rates_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tax_rates_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TaxRate>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TaxRatesApi->tax_rates_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**TaxRate**](TaxRate.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TrackingCategoriesApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::TrackingCategoriesApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**tracking_categories_list**](TrackingCategoriesApi.md#tracking_categories_list) | **GET** /tracking-categories |  |
+| [**tracking_categories_retrieve**](TrackingCategoriesApi.md#tracking_categories_retrieve) | **GET** /tracking-categories/{id} |  |
+
+
+## tracking_categories_list
+
+> <PaginatedTrackingCategoryList> tracking_categories_list(x_account_token, opts)
+
+
+
+Returns a list of `TrackingCategory` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::TrackingCategoriesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  include_deleted_data: true, # Boolean | Whether to include data that was deleted in the third-party service.
+  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
+  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
+}
+
+begin
+  
+  result = api_instance.tracking_categories_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TrackingCategoriesApi->tracking_categories_list: #{e}"
+end
+```
+
+#### Using the tracking_categories_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedTrackingCategoryList>, Integer, Hash)> tracking_categories_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tracking_categories_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTrackingCategoryList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TrackingCategoriesApi->tracking_categories_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
+| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **include_deleted_data** | **Boolean** | Whether to include data that was deleted in the third-party service. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
+| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **remote_id** | **String** | The API provider&#39;s ID for the given object. | [optional] |
+
+### Return type
+
+[**PaginatedTrackingCategoryList**](PaginatedTrackingCategoryList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tracking_categories_retrieve
+
+> <TrackingCategory> tracking_categories_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `TrackingCategory` object with the given `id`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::TrackingCategoriesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
+}
+
+begin
+  
+  result = api_instance.tracking_categories_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TrackingCategoriesApi->tracking_categories_retrieve: #{e}"
+end
+```
+
+#### Using the tracking_categories_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TrackingCategory>, Integer, Hash)> tracking_categories_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.tracking_categories_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TrackingCategory>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling TrackingCategoriesApi->tracking_categories_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**TrackingCategory**](TrackingCategory.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TrackingCategory.md

@@ -0,0 +1,26 @@
+# MergeAccountingClient::TrackingCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **name** | **String** | The tracking category's name. | [optional] |
+| **status** | [**Status7d1Enum**](Status7d1Enum.md) | The tracking category's status. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::TrackingCategory.new(
+  id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4,
+  remote_id: 948201,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  name: Marketing Department,
+  status: ACTIVE
+)
+```
+

data/docs/ValidationProblemSource.md

@@ -0,0 +1,18 @@
+# MergeAccountingClient::ValidationProblemSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pointer** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::ValidationProblemSource.new(
+  pointer: null
+)
+```
+

data/docs/WarningValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeAccountingClient::WarningValidationProblem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | [**ValidationProblemSource**](ValidationProblemSource.md) |  | [optional] |
+| **title** | **String** |  |  |
+| **detail** | **String** |  |  |
+| **problem_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::WarningValidationProblem.new(
+  source: null,
+  title: Unrecognized Field,
+  detail: An unrecognized field, age, was passed in with request data.,
+  problem_type: UNRECOGNIZED_FIELD
+)
+```
+

data/docs/WebhookReceiver.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::WebhookReceiver
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::WebhookReceiver.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+

data/docs/WebhookReceiverRequest.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::WebhookReceiverRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **is_active** | **Boolean** |  |  |
+| **key** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::WebhookReceiverRequest.new(
+  event: null,
+  is_active: null,
+  key: null
+)
+```
+

data/docs/WebhookReceiversApi.md

@@ -0,0 +1,155 @@
+# MergeAccountingClient::WebhookReceiversApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**webhook_receivers_create**](WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers |  |
+| [**webhook_receivers_list**](WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers |  |
+
+
+## webhook_receivers_create
+
+> <WebhookReceiver> webhook_receivers_create(webhook_receiver_request)
+
+
+
+Creates a `WebhookReceiver` object with the given values.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::WebhookReceiversApi.new
+webhook_receiver_request = MergeAccountingClient::WebhookReceiverRequest.new({event: 'event_example', is_active: false}) # WebhookReceiverRequest | 
+
+begin
+  
+  result = api_instance.webhook_receivers_create(webhook_receiver_request)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create: #{e}"
+end
+```
+
+#### Using the webhook_receivers_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookReceiver>, Integer, Hash)> webhook_receivers_create_with_http_info(webhook_receiver_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_create_with_http_info(webhook_receiver_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookReceiver>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_receiver_request** | [**WebhookReceiverRequest**](WebhookReceiverRequest.md) |  |  |
+
+### Return type
+
+[**WebhookReceiver**](WebhookReceiver.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## webhook_receivers_list
+
+> <PaginatedWebhookReceiverList> webhook_receivers_list(opts)
+
+
+
+Returns a list of `WebhookReceiver` objects.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_accounting_client'
+# setup authorization
+MergeAccountingClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeAccountingClient::WebhookReceiversApi.new
+opts = {
+  cursor: 56, # Integer | The pagination cursor value.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  
+  result = api_instance.webhook_receivers_list(opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list: #{e}"
+end
+```
+
+#### Using the webhook_receivers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedWebhookReceiverList>, Integer, Hash)> webhook_receivers_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.webhook_receivers_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedWebhookReceiverList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling WebhookReceiversApi->webhook_receivers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **Integer** | The pagination cursor value. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+
+### Return type
+
+[**PaginatedWebhookReceiverList**](PaginatedWebhookReceiverList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+