merge_accounting_client 1.0.0

data/docs/PurchaseOrdersApi.md

@@ -0,0 +1,181 @@
+# MergeAccountingClient::PurchaseOrdersApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**purchase_orders_list**](PurchaseOrdersApi.md#purchase_orders_list) | **GET** /purchase-orders |  |
+| [**purchase_orders_retrieve**](PurchaseOrdersApi.md#purchase_orders_retrieve) | **GET** /purchase-orders/{id} |  |
+
+
+## purchase_orders_list
+
+> <PaginatedPurchaseOrderList> purchase_orders_list(x_account_token, opts)
+
+
+
+Returns a list of `PurchaseOrder` 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::PurchaseOrdersApi.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: 'delivery_address', # 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.purchase_orders_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PurchaseOrdersApi->purchase_orders_list: #{e}"
+end
+```
+
+#### Using the purchase_orders_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedPurchaseOrderList>, Integer, Hash)> purchase_orders_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.purchase_orders_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedPurchaseOrderList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PurchaseOrdersApi->purchase_orders_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
+
+[**PaginatedPurchaseOrderList**](PaginatedPurchaseOrderList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## purchase_orders_retrieve
+
+> <PurchaseOrder> purchase_orders_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `PurchaseOrder` 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::PurchaseOrdersApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'delivery_address', # 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.purchase_orders_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PurchaseOrdersApi->purchase_orders_retrieve: #{e}"
+end
+```
+
+#### Using the purchase_orders_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PurchaseOrder>, Integer, Hash)> purchase_orders_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.purchase_orders_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PurchaseOrder>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PurchaseOrdersApi->purchase_orders_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
+
+[**PurchaseOrder**](PurchaseOrder.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RegenerateKeyApi.md

@@ -0,0 +1,79 @@
+# MergeAccountingClient::RegenerateKeyApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**regenerate_key_create**](RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key |  |
+
+
+## regenerate_key_create
+
+> <RemoteKey> regenerate_key_create(remote_key_for_regeneration_request)
+
+
+
+Exchange remote keys.
+
+### 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::RegenerateKeyApi.new
+remote_key_for_regeneration_request = MergeAccountingClient::RemoteKeyForRegenerationRequest.new({name: 'Remote Deployment Key 1'}) # RemoteKeyForRegenerationRequest | 
+
+begin
+  
+  result = api_instance.regenerate_key_create(remote_key_for_regeneration_request)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create: #{e}"
+end
+```
+
+#### Using the regenerate_key_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteKey>, Integer, Hash)> regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.regenerate_key_create_with_http_info(remote_key_for_regeneration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteKey>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling RegenerateKeyApi->regenerate_key_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_key_for_regeneration_request** | [**RemoteKeyForRegenerationRequest**](RemoteKeyForRegenerationRequest.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/RemoteData.md

@@ -0,0 +1,20 @@
+# MergeAccountingClient::RemoteData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::RemoteData.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/RemoteDataRequest.md

@@ -0,0 +1,20 @@
+# MergeAccountingClient::RemoteDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** |  |  |
+| **data** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::RemoteDataRequest.new(
+  path: null,
+  data: null
+)
+```
+

data/docs/RemoteKey.md

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

data/docs/RemoteKeyForRegenerationRequest.md

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

data/docs/RemoteResponse.md

@@ -0,0 +1,26 @@
+# MergeAccountingClient::RemoteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **method** | **String** |  |  |
+| **path** | **String** |  |  |
+| **status** | **Integer** |  |  |
+| **response** | [**Hash<String, AnyType>**](AnyType.md) |  |  |
+| **headers** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::RemoteResponse.new(
+  method: GET,
+  path: /scooters,
+  status: 200,
+  response: {"scooters":[{"company":"Lime","model":"Gen 2.5"},{"company":"Bird","model":"Bird Zero"}]},
+  headers: {"EXTRA-HEADER":"value","Authorization":"<redacted>"}
+)
+```
+

data/docs/ReportItem.md

@@ -0,0 +1,24 @@
+# MergeAccountingClient::ReportItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **name** | **String** | The report item's name. | [optional] |
+| **value** | **Float** | The report item's value. | [optional] |
+| **sub_items** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::ReportItem.new(
+  remote_id: 10299,
+  name: Revenue,
+  value: 1000,
+  sub_items: [{"remote_id":"10300","name":"Revenue - San Francisco","value":500,"sub_items":[]},{"remote_id":"10301","name":"Revenue - New York","value":500,"sub_items":[]}]
+)
+```
+

data/docs/RequestFormatEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::RequestFormatEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::RequestFormatEnum.new()
+```
+

data/docs/StateEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::StateEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::StateEnum.new()
+```
+

data/docs/Status7d1Enum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::Status7d1Enum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Status7d1Enum.new()
+```
+

data/docs/SyncStatus.md

@@ -0,0 +1,28 @@
+# MergeAccountingClient::SyncStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **model_name** | **String** |  |  |
+| **model_id** | **String** |  |  |
+| **last_sync_start** | **Time** |  |  |
+| **next_sync_start** | **Time** |  |  |
+| **status** | [**SyncStatusStatusEnum**](SyncStatusStatusEnum.md) |  |  |
+| **is_initial_sync** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::SyncStatus.new(
+  model_name: Candidate,
+  model_id: ats.Candidate,
+  last_sync_start: 2021-03-30T19:44:18.695973Z,
+  next_sync_start: 2021-03-30T20:44:18.662942Z,
+  status: SYNCING,
+  is_initial_sync: true
+)
+```
+

data/docs/SyncStatusApi.md

@@ -0,0 +1,85 @@
+# MergeAccountingClient::SyncStatusApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sync_status_list**](SyncStatusApi.md#sync_status_list) | **GET** /sync-status |  |
+
+
+## sync_status_list
+
+> <PaginatedSyncStatusList> sync_status_list(x_account_token, opts)
+
+
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `SYNCING`
+
+### 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::SyncStatusApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  
+  result = api_instance.sync_status_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_list: #{e}"
+end
+```
+
+#### Using the sync_status_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedSyncStatusList>, Integer, Hash)> sync_status_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.sync_status_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedSyncStatusList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling SyncStatusApi->sync_status_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+
+### Return type
+
+[**PaginatedSyncStatusList**](PaginatedSyncStatusList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SyncStatusStatusEnum.md

@@ -0,0 +1,15 @@
+# MergeAccountingClient::SyncStatusStatusEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::SyncStatusStatusEnum.new()
+```
+

data/docs/TaxRate.md

@@ -0,0 +1,28 @@
+# MergeAccountingClient::TaxRate
+
+## 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] |
+| **description** | **String** | The tax rate's description. | [optional] |
+| **total_tax_rate** | **Float** | The tax rate's total tax rate. | [optional] |
+| **effective_tax_rate** | **Float** | The tax rate's effective tax rate. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::TaxRate.new(
+  id: b82302de-852e-4e60-b050-edf9da3b7c02,
+  remote_id: 039111,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  description: Sales Tax,
+  total_tax_rate: 15.0,
+  effective_tax_rate: 15.0
+)
+```
+