merge_accounting_client 1.0.0

data/docs/EndUserDetailsRequest.md

@@ -0,0 +1,28 @@
+# MergeAccountingClient::EndUserDetailsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_email_address** | **String** |  |  |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_origin_id** | **String** |  |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |  |  |
+| **integration** | **String** | The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see https://www.merge.dev/docs/basics/integration-metadata | [optional] |
+| **link_expiry_mins** | **Integer** | An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30 | [optional][default to 30] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::EndUserDetailsRequest.new(
+  end_user_email_address: null,
+  end_user_organization_name: null,
+  end_user_origin_id: null,
+  categories: null,
+  integration: null,
+  link_expiry_mins: null
+)
+```
+

data/docs/ErrorValidationProblem.md

@@ -0,0 +1,24 @@
+# MergeAccountingClient::ErrorValidationProblem
+
+## 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::ErrorValidationProblem.new(
+  source: null,
+  title: Missing Required Field,
+  detail: custom_fields is a required field on model.,
+  problem_type: MISSING_REQUIRED_FIELD
+)
+```
+

data/docs/Expense.md

@@ -0,0 +1,38 @@
+# MergeAccountingClient::Expense
+
+## 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] |
+| **transaction_date** | **Time** | When the transaction occurred. | [optional] |
+| **remote_created_at** | **Time** | When the expense was created. | [optional] |
+| **account** | **String** |  | [optional] |
+| **contact** | **String** |  | [optional] |
+| **total_amount** | **Float** | The expense's total amount. | [optional] |
+| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The expense's currency. | [optional] |
+| **memo** | **String** | The expense's private note. | [optional] |
+| **lines** | [**Array<ExpenseLine>**](ExpenseLine.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Expense.new(
+  id: ecbe05ac-62a3-46c5-ab31-4b478b37d1b4,
+  remote_id: 088899,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  transaction_date: null,
+  remote_created_at: 2020-03-31T00:00Z,
+  account: 9d892439-5fab-4dbb-8bd8-34f7f96c7912,
+  contact: 3d263469-51a1-4766-9205-f6c997826be1,
+  total_amount: 10000.0,
+  currency: USD,
+  memo: New employee supplies,
+  lines: [{"remote_id":"121222","net_amount":25.54,"trackingCategory":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","item":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","account":"2a56344a-a491-11ec-b909-0242ac120002","description":"MacBook Pro"},{"remote_id":"121223","net_amount":10,"trackingCategory":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","item":"b38c59b0-a9d7-4740-b1ee-5436c6751e3d","account":"2a56344a-a491-11ec-b909-0242ac120002","description":"Desk Lamp"}]
+)
+```
+

data/docs/ExpenseLine.md

@@ -0,0 +1,28 @@
+# MergeAccountingClient::ExpenseLine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **item** | **String** | The line's item. | [optional] |
+| **net_amount** | **Float** | The line's net amount. | [optional] |
+| **tracking_category** | **String** |  | [optional] |
+| **account** | **String** |  | [optional] |
+| **description** | **String** | The line item's description. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::ExpenseLine.new(
+  remote_id: 121222,
+  item: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
+  net_amount: 25.54,
+  tracking_category: b38c59b0-a9d7-4740-b1ee-5436c6751e3d,
+  account: 2a56344a-a491-11ec-b909-0242ac120002,
+  description: MacBook Pro
+)
+```
+

data/docs/ExpensesApi.md

@@ -0,0 +1,181 @@
+# MergeAccountingClient::ExpensesApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**expenses_list**](ExpensesApi.md#expenses_list) | **GET** /expenses |  |
+| [**expenses_retrieve**](ExpensesApi.md#expenses_retrieve) | **GET** /expenses/{id} |  |
+
+
+## expenses_list
+
+> <PaginatedExpenseList> expenses_list(x_account_token, opts)
+
+
+
+Returns a list of `Expense` 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::ExpensesApi.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.
+  expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  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.expenses_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ExpensesApi->expenses_list: #{e}"
+end
+```
+
+#### Using the expenses_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedExpenseList>, Integer, Hash)> expenses_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.expenses_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedExpenseList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ExpensesApi->expenses_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] |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [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
+
+[**PaginatedExpenseList**](PaginatedExpenseList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## expenses_retrieve
+
+> <Expense> expenses_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Expense` 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::ExpensesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'account', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+  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.expenses_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ExpensesApi->expenses_retrieve: #{e}"
+end
+```
+
+#### Using the expenses_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Expense>, Integer, Hash)> expenses_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.expenses_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Expense>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ExpensesApi->expenses_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **id** | [**String**](.md) |  |  |
+| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
+| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
+
+### Return type
+
+[**Expense**](Expense.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ForceResyncApi.md

@@ -0,0 +1,79 @@
+# MergeAccountingClient::ForceResyncApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sync_status_resync_create**](ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync |  |
+
+
+## sync_status_resync_create
+
+> <SyncStatus> sync_status_resync_create(x_account_token)
+
+
+
+Force re-sync of all models. This is only available for organizations on Merge's Grow and Expand plans.
+
+### 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::ForceResyncApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.sync_status_resync_create(x_account_token)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create: #{e}"
+end
+```
+
+#### Using the sync_status_resync_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SyncStatus>, Integer, Hash)> sync_status_resync_create_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_resync_create_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SyncStatus>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling ForceResyncApi->sync_status_resync_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**SyncStatus**](SyncStatus.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeAccountingClient::GenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_key_create**](GenerateKeyApi.md#generate_key_create) | **POST** /generate-key |  |
+
+
+## generate_key_create
+
+> <RemoteKey> generate_key_create(generate_remote_key_request)
+
+
+
+Create a remote key.
+
+### 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::GenerateKeyApi.new
+generate_remote_key_request = MergeAccountingClient::GenerateRemoteKeyRequest.new({name: 'Remote Deployment Key 1'}) # GenerateRemoteKeyRequest | 
+
+begin
+  
+  result = api_instance.generate_key_create(generate_remote_key_request)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create: #{e}"
+end
+```
+
+#### Using the generate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> generate_key_create_with_http_info(generate_remote_key_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.generate_key_create_with_http_info(generate_remote_key_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling GenerateKeyApi->generate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **generate_remote_key_request** | [**GenerateRemoteKeyRequest**](GenerateRemoteKeyRequest.md) |  |  |
+
+### Return type
+
+[**RemoteKey**](RemoteKey.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/GenerateRemoteKeyRequest.md

@@ -0,0 +1,18 @@
+# MergeAccountingClient::GenerateRemoteKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::GenerateRemoteKeyRequest.new(
+  name: Remote Deployment Key 1
+)
+```
+

data/docs/IncomeStatement.md

@@ -0,0 +1,42 @@
+# MergeAccountingClient::IncomeStatement
+
+## 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 income statement's name. | [optional] |
+| **start_period** | **Time** | The income statement's start period. | [optional] |
+| **end_period** | **Time** | The income statement's end period. | [optional] |
+| **income** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **cost_of_sales** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **gross_profit** | **Float** | The income statement's gross profit. | [optional] |
+| **operating_expenses** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **net_operating_income** | **Float** | The income statement's net operating profit. | [optional] |
+| **non_operating_expenses** | [**Array<ReportItem>**](ReportItem.md) |  | [optional][readonly] |
+| **net_income** | **Float** | The income statement's net income. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::IncomeStatement.new(
+  id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  remote_id: 1342348,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  name: IncomeStatement,
+  start_period: null,
+  end_period: null,
+  income: [{"remote_id":"10299","name":"Total Income","value":325.0,"sub_items":[{"remote_id":"10200","name":"Landscaping Services","value":425,"sub_items":null},{"remote_id":"10201","name":"Pest Control Services","value":-100,"sub_items":null}]}],
+  cost_of_sales: [{"remote_id":"10299","name":"Total COGS","value":25.0,"sub_items":[{"remote_id":"10200","name":"Supplies","value":10,"sub_items":null}]}],
+  gross_profit: 300.0,
+  operating_expenses: [{"remote_id":"10299","name":"Total Operating Expenses","value":100.0,"sub_items":null}],
+  net_operating_income: 200.0,
+  non_operating_expenses: [{"remote_id":"10299","name":"Total Non-Operating Expenses","value":100.0,"sub_items":null}],
+  net_income: 100.0
+)
+```
+