merge_accounting_client 1.0.0

data/docs/PaginatedSyncStatusList.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::PaginatedSyncStatusList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<SyncStatus>**](SyncStatus.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PaginatedSyncStatusList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedTaxRateList.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::PaginatedTaxRateList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<TaxRate>**](TaxRate.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PaginatedTaxRateList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedTrackingCategoryList.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::PaginatedTrackingCategoryList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<TrackingCategory>**](TrackingCategory.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PaginatedTrackingCategoryList.new(
+  _next: cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw,
+  previous: cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ,
+  results: null
+)
+```
+

data/docs/PaginatedWebhookReceiverList.md

@@ -0,0 +1,22 @@
+# MergeAccountingClient::PaginatedWebhookReceiverList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_next** | **String** |  | [optional] |
+| **previous** | **String** |  | [optional] |
+| **results** | [**Array<WebhookReceiver>**](WebhookReceiver.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PaginatedWebhookReceiverList.new(
+  _next: null,
+  previous: null,
+  results: null
+)
+```
+

data/docs/PassthroughApi.md

@@ -0,0 +1,81 @@
+# MergeAccountingClient::PassthroughApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**passthrough_create**](PassthroughApi.md#passthrough_create) | **POST** /passthrough |  |
+
+
+## passthrough_create
+
+> <RemoteResponse> passthrough_create(x_account_token, data_passthrough_request)
+
+
+
+Pull data from an endpoint not currently supported by Merge.
+
+### 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::PassthroughApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+data_passthrough_request = MergeAccountingClient::DataPassthroughRequest.new({method: MergeAccountingClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest | 
+
+begin
+  
+  result = api_instance.passthrough_create(x_account_token, data_passthrough_request)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create: #{e}"
+end
+```
+
+#### Using the passthrough_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RemoteResponse>, Integer, Hash)> passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.passthrough_create_with_http_info(x_account_token, data_passthrough_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RemoteResponse>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PassthroughApi->passthrough_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) |  |  |
+
+### Return type
+
+[**RemoteResponse**](RemoteResponse.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/Payment.md

@@ -0,0 +1,32 @@
+# MergeAccountingClient::Payment
+
+## 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** | The payment's transaction date. | [optional] |
+| **contact** | **String** |  | [optional] |
+| **account** | **String** |  | [optional] |
+| **total_amount** | **Float** | The payment's total amount. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's payment entry was updated. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Payment.new(
+  id: b26fd49a-cbae-470a-a8f8-bcbc119e0390,
+  remote_id: 987300,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  transaction_date: 2020-03-31T00:00Z,
+  contact: 5b3c1341-a20f-4e51-b72c-f3830a16c97b,
+  account: d6e687d6-0c36-48a1-8114-35324b5cb38f,
+  total_amount: 50.0,
+  remote_updated_at: 2020-03-31T00:00Z
+)
+```
+

data/docs/PaymentsApi.md

@@ -0,0 +1,185 @@
+# MergeAccountingClient::PaymentsApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**payments_list**](PaymentsApi.md#payments_list) | **GET** /payments |  |
+| [**payments_retrieve**](PaymentsApi.md#payments_retrieve) | **GET** /payments/{id} |  |
+
+
+## payments_list
+
+> <PaginatedPaymentList> payments_list(x_account_token, opts)
+
+
+
+Returns a list of `Payment` 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::PaymentsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  account_id: 'account_id_example', # String | If provided, will only return payments for this account.
+  contact_id: 'contact_id_example', # String | If provided, will only return payments for this contact.
+  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.payments_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PaymentsApi->payments_list: #{e}"
+end
+```
+
+#### Using the payments_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedPaymentList>, Integer, Hash)> payments_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.payments_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedPaymentList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PaymentsApi->payments_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **account_id** | **String** | If provided, will only return payments for this account. | [optional] |
+| **contact_id** | **String** | If provided, will only return payments for this contact. | [optional] |
+| **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
+
+[**PaginatedPaymentList**](PaginatedPaymentList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payments_retrieve
+
+> <Payment> payments_retrieve(x_account_token, id, opts)
+
+
+
+Returns a `Payment` 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::PaymentsApi.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.payments_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PaymentsApi->payments_retrieve: #{e}"
+end
+```
+
+#### Using the payments_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Payment>, Integer, Hash)> payments_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.payments_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Payment>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PaymentsApi->payments_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
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PhoneNumbersApi.md

@@ -0,0 +1,85 @@
+# MergeAccountingClient::PhoneNumbersApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**phone_numbers_retrieve**](PhoneNumbersApi.md#phone_numbers_retrieve) | **GET** /phone-numbers/{id} |  |
+
+
+## phone_numbers_retrieve
+
+> <AccountingPhoneNumber> phone_numbers_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `AccountingPhoneNumber` 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::PhoneNumbersApi.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.phone_numbers_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->phone_numbers_retrieve: #{e}"
+end
+```
+
+#### Using the phone_numbers_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountingPhoneNumber>, Integer, Hash)> phone_numbers_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.phone_numbers_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountingPhoneNumber>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->phone_numbers_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
+
+[**AccountingPhoneNumber**](AccountingPhoneNumber.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PurchaseOrder.md

@@ -0,0 +1,40 @@
+# MergeAccountingClient::PurchaseOrder
+
+## 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] |
+| **status** | [**PurchaseOrderStatusEnum**](PurchaseOrderStatusEnum.md) | The purchase order's status. | [optional] |
+| **issue_date** | **Time** | The purchase order's issue date. | [optional] |
+| **delivery_date** | **Time** | The purchase order's delivery date. | [optional] |
+| **delivery_address** | **String** | The purchase order's delivery address. | [optional] |
+| **total_amount** | **Float** | The purchase order's total amount. | [optional] |
+| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The purchase order's currency. | [optional] |
+| **line_items** | [**Array<PurchaseOrderLineItem>**](PurchaseOrderLineItem.md) |  | [optional][readonly] |
+| **remote_created_at** | **Time** | When the third party's purchase order note was created. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's purchase order note was updated. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PurchaseOrder.new(
+  id: 0048ea5b-911e-4dff-9364-92070dea62ff,
+  remote_id: 239741,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  status: SUBMITTED,
+  issue_date: null,
+  delivery_date: 2020-04-15T00:00Z,
+  delivery_address: null,
+  total_amount: 260.0,
+  currency: USD,
+  line_items: [{"description":"Pickleball paddles","unit_price":25.0,"quantity":10.0,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae"},{"description":"Pickleball Balls","unit_price":1.0,"quantity":10.0,"item":"249c9faa-3045-4a31-953b-8f22d3613301"}],
+  remote_created_at: 2020-03-31T00:00Z,
+  remote_updated_at: 2020-03-31T00:00Z
+)
+```
+

data/docs/PurchaseOrderLineItem.md

@@ -0,0 +1,24 @@
+# MergeAccountingClient::PurchaseOrderLineItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | The line item's description. | [optional] |
+| **unit_price** | **Float** | The line item's unit price. | [optional] |
+| **quantity** | **Float** | The line item's quantity. | [optional] |
+| **item** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::PurchaseOrderLineItem.new(
+  description: Pickleball paddles,
+  unit_price: 25.0,
+  quantity: 10.0,
+  item: 0958cbc6-6040-430a-848e-aafacbadf4ae
+)
+```
+

data/docs/PurchaseOrderStatusEnum.md

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