merge_accounting_client 1.0.0

data/docs/InvoicesApi.md

@@ -0,0 +1,337 @@
+# MergeAccountingClient::InvoicesApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**invoices_create**](InvoicesApi.md#invoices_create) | **POST** /invoices |  |
+| [**invoices_list**](InvoicesApi.md#invoices_list) | **GET** /invoices |  |
+| [**invoices_meta_post_retrieve**](InvoicesApi.md#invoices_meta_post_retrieve) | **GET** /invoices/meta/post |  |
+| [**invoices_retrieve**](InvoicesApi.md#invoices_retrieve) | **GET** /invoices/{id} |  |
+
+
+## invoices_create
+
+> <InvoiceResponse> invoices_create(x_account_token, invoice_endpoint_request, opts)
+
+
+
+Creates an `Invoice` 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::InvoicesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+invoice_endpoint_request = MergeAccountingClient::InvoiceEndpointRequest.new({model: MergeAccountingClient::InvoiceRequest.new}) # InvoiceEndpointRequest | 
+opts = {
+  is_debug_mode: true, # Boolean | Whether to include debug fields (such as log file links) in the response.
+  run_async: true # Boolean | Whether or not third-party updates should be run asynchronously.
+}
+
+begin
+  
+  result = api_instance.invoices_create(x_account_token, invoice_endpoint_request, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_create: #{e}"
+end
+```
+
+#### Using the invoices_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvoiceResponse>, Integer, Hash)> invoices_create_with_http_info(x_account_token, invoice_endpoint_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.invoices_create_with_http_info(x_account_token, invoice_endpoint_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvoiceResponse>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **invoice_endpoint_request** | [**InvoiceEndpointRequest**](InvoiceEndpointRequest.md) |  |  |
+| **is_debug_mode** | **Boolean** | Whether to include debug fields (such as log file links) in the response. | [optional] |
+| **run_async** | **Boolean** | Whether or not third-party updates should be run asynchronously. | [optional] |
+
+### Return type
+
+[**InvoiceResponse**](InvoiceResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## invoices_list
+
+> <PaginatedInvoiceList> invoices_list(x_account_token, opts)
+
+
+
+Returns a list of `Invoice` 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::InvoicesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+opts = {
+  contact_id: 'contact_id_example', # String | If provided, will only return invoices 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: 'contact', # 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.
+  type: 'type_example' # String | If provided, will only return Invoices with this type
+}
+
+begin
+  
+  result = api_instance.invoices_list(x_account_token, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_list: #{e}"
+end
+```
+
+#### Using the invoices_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedInvoiceList>, Integer, Hash)> invoices_list_with_http_info(x_account_token, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.invoices_list_with_http_info(x_account_token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedInvoiceList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+| **contact_id** | **String** | If provided, will only return invoices 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] |
+| **type** | **String** | If provided, will only return Invoices with this type | [optional] |
+
+### Return type
+
+[**PaginatedInvoiceList**](PaginatedInvoiceList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invoices_meta_post_retrieve
+
+> <MetaResponse> invoices_meta_post_retrieve(x_account_token)
+
+
+
+Returns metadata for `Invoice` POSTs.
+
+### 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::InvoicesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.invoices_meta_post_retrieve(x_account_token)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_meta_post_retrieve: #{e}"
+end
+```
+
+#### Using the invoices_meta_post_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MetaResponse>, Integer, Hash)> invoices_meta_post_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.invoices_meta_post_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MetaResponse>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_meta_post_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**MetaResponse**](MetaResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invoices_retrieve
+
+> <Invoice> invoices_retrieve(x_account_token, id, opts)
+
+
+
+Returns an `Invoice` 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::InvoicesApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+id = TODO # String | 
+opts = {
+  expand: 'contact', # 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.invoices_retrieve(x_account_token, id, opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_retrieve: #{e}"
+end
+```
+
+#### Using the invoices_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Invoice>, Integer, Hash)> invoices_retrieve_with_http_info(x_account_token, id, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.invoices_retrieve_with_http_info(x_account_token, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Invoice>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling InvoicesApi->invoices_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
+
+[**Invoice**](Invoice.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Issue.md

@@ -0,0 +1,30 @@
+# MergeAccountingClient::Issue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **status** | [**IssueStatusEnum**](IssueStatusEnum.md) |  | [optional] |
+| **error_description** | **String** |  |  |
+| **end_user** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional][readonly] |
+| **first_incident_time** | **Time** |  | [optional] |
+| **last_incident_time** | **Time** |  | [optional] |
+| **is_muted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Issue.new(
+  id: null,
+  status: null,
+  error_description: null,
+  end_user: null,
+  first_incident_time: null,
+  last_incident_time: null,
+  is_muted: null
+)
+```
+

data/docs/IssueStatusEnum.md

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

data/docs/IssuesApi.md

@@ -0,0 +1,177 @@
+# MergeAccountingClient::IssuesApi
+
+All URIs are relative to *https://api.merge.dev/api/accounting/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**issues_list**](IssuesApi.md#issues_list) | **GET** /issues |  |
+| [**issues_retrieve**](IssuesApi.md#issues_retrieve) | **GET** /issues/{id} |  |
+
+
+## issues_list
+
+> <PaginatedIssueList> issues_list(opts)
+
+
+
+Gets issues.
+
+### 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::IssuesApi.new
+opts = {
+  account_token: 'account_token_example', # String | 
+  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
+  end_date: 'end_date_example', # String | If included, will only include issues whose most recent action occurred before this time
+  end_user_organization_name: 'end_user_organization_name_example', # String | 
+  first_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
+  first_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
+  include_muted: 'include_muted_example', # String | If True, will include muted issues
+  integration_name: 'integration_name_example', # String | 
+  last_incident_time_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was after this datetime.
+  last_incident_time_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return issues whose first incident time was before this datetime.
+  page_size: 56, # Integer | Number of results to return per page.
+  start_date: 'start_date_example', # String | If included, will only include issues whose most recent action occurred after this time
+  status: 'ONGOING' # String | 
+}
+
+begin
+  
+  result = api_instance.issues_list(opts)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list: #{e}"
+end
+```
+
+#### Using the issues_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedIssueList>, Integer, Hash)> issues_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedIssueList>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** |  | [optional] |
+| **cursor** | **String** | The pagination cursor value. | [optional] |
+| **end_date** | **String** | If included, will only include issues whose most recent action occurred before this time | [optional] |
+| **end_user_organization_name** | **String** |  | [optional] |
+| **first_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
+| **first_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
+| **include_muted** | **String** | If True, will include muted issues | [optional] |
+| **integration_name** | **String** |  | [optional] |
+| **last_incident_time_after** | **Time** | If provided, will only return issues whose first incident time was after this datetime. | [optional] |
+| **last_incident_time_before** | **Time** | If provided, will only return issues whose first incident time was before this datetime. | [optional] |
+| **page_size** | **Integer** | Number of results to return per page. | [optional] |
+| **start_date** | **String** | If included, will only include issues whose most recent action occurred after this time | [optional] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**PaginatedIssueList**](PaginatedIssueList.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## issues_retrieve
+
+> <Issue> issues_retrieve(id)
+
+
+
+Get a specific issue.
+
+### 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::IssuesApi.new
+id = TODO # String | 
+
+begin
+  
+  result = api_instance.issues_retrieve(id)
+  p result
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve: #{e}"
+end
+```
+
+#### Using the issues_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Issue>, Integer, Hash)> issues_retrieve_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.issues_retrieve_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Issue>
+rescue MergeAccountingClient::ApiError => e
+  puts "Error when calling IssuesApi->issues_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | [**String**](.md) |  |  |
+
+### Return type
+
+[**Issue**](Issue.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Item.md

@@ -0,0 +1,36 @@
+# MergeAccountingClient::Item
+
+## 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 item's name. | [optional] |
+| **status** | [**Status7d1Enum**](Status7d1Enum.md) | The item's status. | [optional] |
+| **unit_price** | **Float** | The item's unit price. | [optional] |
+| **purchase_price** | **Float** | The item's purchase price. | [optional] |
+| **purchase_account** | **String** |  | [optional] |
+| **sales_account** | **String** |  | [optional] |
+| **remote_updated_at** | **Time** | When the third party's item note was updated. | [optional] |
+
+## Example
+
+```ruby
+require 'merge_accounting_client'
+
+instance = MergeAccountingClient::Item.new(
+  id: d2f972d0-2526-434b-9409-4c3b468e08f0,
+  remote_id: 12374,
+  remote_data: [{"path":"/actions","data":["Varies by platform"]}],
+  name: Pickleball Paddle,
+  status: ACTIVE,
+  unit_price: 10.0,
+  purchase_price: 25.0,
+  purchase_account: 9871b4a9-f5d2-4f3b-a66b-dfedbed42c46,
+  sales_account: 3872b4c9-f5d2-4f3b-a66b-dfedbed42c49,
+  remote_updated_at: 2020-03-31T00:00Z
+)
+```
+