merge_accounting_client 1.0.1 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE.md +16 -0
- data/README.md +12 -5
- data/docs/Account.md +3 -1
- data/docs/AccountDetails.md +3 -1
- data/docs/AccountDetailsAndActions.md +2 -0
- data/docs/AccountingAttachment.md +1 -1
- data/docs/AccountsApi.md +7 -3
- data/docs/AddressesApi.md +3 -1
- data/docs/AttachmentsApi.md +2 -2
- data/docs/BalanceSheet.md +3 -1
- data/docs/BalanceSheetsApi.md +2 -2
- data/docs/CashFlowStatement.md +3 -1
- data/docs/CashFlowStatementsApi.md +2 -2
- data/docs/CategoryTypeEnum.md +15 -0
- data/docs/CompanyInfo.md +1 -1
- data/docs/CompanyInfoApi.md +2 -2
- data/docs/Contact.md +1 -1
- data/docs/ContactsApi.md +7 -3
- data/docs/CreditNote.md +7 -1
- data/docs/CreditNoteLineItem.md +38 -0
- data/docs/CreditNotesApi.md +7 -3
- data/docs/DataPassthroughRequest.md +3 -1
- data/docs/EndUserDetailsRequest.md +9 -7
- data/docs/Expense.md +1 -1
- data/docs/ExpensesApi.md +2 -2
- data/docs/IncomeStatement.md +3 -1
- data/docs/IncomeStatementsApi.md +2 -2
- data/docs/InvoiceLineItem.md +0 -2
- data/docs/InvoicesApi.md +8 -4
- data/docs/Item.md +1 -1
- data/docs/ItemsApi.md +7 -3
- data/docs/JournalEntriesApi.md +2 -2
- data/docs/JournalEntry.md +2 -0
- data/docs/JournalEntryRequest.md +2 -0
- data/docs/LinkToken.md +3 -1
- data/docs/LinkedAccountsApi.md +2 -0
- data/docs/PaginatedTransactionList.md +22 -0
- data/docs/Payment.md +1 -1
- data/docs/PaymentsApi.md +2 -2
- data/docs/PurchaseOrder.md +8 -2
- data/docs/PurchaseOrderLineItem.md +9 -1
- data/docs/PurchaseOrdersApi.md +7 -3
- data/docs/RemoteResponse.md +5 -1
- data/docs/ResponseTypeEnum.md +15 -0
- data/docs/SyncStatus.md +2 -2
- data/docs/SyncStatusApi.md +1 -1
- data/docs/TaxRate.md +1 -1
- data/docs/TaxRatesApi.md +2 -2
- data/docs/TrackingCategoriesApi.md +7 -3
- data/docs/TrackingCategory.md +3 -1
- data/docs/Transaction.md +40 -0
- data/docs/TransactionLineItem.md +34 -0
- data/docs/TransactionsApi.md +181 -0
- data/docs/VendorCredit.md +1 -1
- data/docs/VendorCreditsApi.md +2 -2
- data/lib/merge_accounting_client/api/accounts_api.rb +16 -2
- data/lib/merge_accounting_client/api/addresses_api.rb +7 -0
- data/lib/merge_accounting_client/api/attachments_api.rb +2 -2
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +2 -2
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +2 -2
- data/lib/merge_accounting_client/api/company_info_api.rb +2 -2
- data/lib/merge_accounting_client/api/contacts_api.rb +16 -2
- data/lib/merge_accounting_client/api/credit_notes_api.rb +16 -2
- data/lib/merge_accounting_client/api/expenses_api.rb +2 -2
- data/lib/merge_accounting_client/api/income_statements_api.rb +2 -2
- data/lib/merge_accounting_client/api/invoices_api.rb +17 -3
- data/lib/merge_accounting_client/api/items_api.rb +16 -2
- data/lib/merge_accounting_client/api/journal_entries_api.rb +2 -2
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -0
- data/lib/merge_accounting_client/api/payments_api.rb +2 -2
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +16 -2
- data/lib/merge_accounting_client/api/sync_status_api.rb +2 -2
- data/lib/merge_accounting_client/api/tax_rates_api.rb +2 -2
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +16 -2
- data/lib/merge_accounting_client/api/transactions_api.rb +196 -0
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +2 -2
- data/lib/merge_accounting_client/api_client.rb +3 -0
- data/lib/merge_accounting_client/models/account.rb +12 -2
- data/lib/merge_accounting_client/models/account_details.rb +15 -4
- data/lib/merge_accounting_client/models/account_details_and_actions.rb +12 -1
- data/lib/merge_accounting_client/models/account_details_and_actions_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/account_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/accounting_attachment.rb +1 -1
- data/lib/merge_accounting_client/models/address_type_enum.rb +17 -7
- data/lib/merge_accounting_client/models/balance_sheet.rb +13 -2
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +13 -2
- data/lib/merge_accounting_client/models/categories_enum.rb +17 -7
- data/lib/merge_accounting_client/models/category_enum.rb +17 -7
- data/lib/merge_accounting_client/models/category_type_enum.rb +45 -0
- data/lib/merge_accounting_client/models/classification_enum.rb +17 -7
- data/lib/merge_accounting_client/models/company_info.rb +1 -1
- data/lib/merge_accounting_client/models/contact.rb +1 -1
- data/lib/merge_accounting_client/models/country_enum.rb +17 -7
- data/lib/merge_accounting_client/models/credit_note.rb +35 -2
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +380 -0
- data/lib/merge_accounting_client/models/credit_note_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/currency_enum.rb +17 -7
- data/lib/merge_accounting_client/models/data_passthrough_request.rb +14 -5
- data/lib/merge_accounting_client/models/encoding_enum.rb +18 -7
- data/lib/merge_accounting_client/models/end_user_details_request.rb +28 -11
- data/lib/merge_accounting_client/models/expense.rb +1 -1
- data/lib/merge_accounting_client/models/income_statement.rb +13 -2
- data/lib/merge_accounting_client/models/invoice_line_item.rb +1 -13
- data/lib/merge_accounting_client/models/invoice_type_enum.rb +17 -7
- data/lib/merge_accounting_client/models/issue_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/item.rb +1 -1
- data/lib/merge_accounting_client/models/journal_entry.rb +12 -1
- data/lib/merge_accounting_client/models/journal_entry_request.rb +12 -1
- data/lib/merge_accounting_client/models/link_token.rb +13 -4
- data/lib/merge_accounting_client/models/method_enum.rb +17 -7
- data/lib/merge_accounting_client/models/paginated_transaction_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +1 -1
- data/lib/merge_accounting_client/models/purchase_order.rb +35 -2
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +83 -5
- data/lib/merge_accounting_client/models/purchase_order_status_enum.rb +17 -7
- data/lib/merge_accounting_client/models/remote_data.rb +1 -1
- data/lib/merge_accounting_client/models/remote_response.rb +27 -10
- data/lib/merge_accounting_client/models/request_format_enum.rb +17 -7
- data/lib/merge_accounting_client/models/response_type_enum.rb +45 -0
- data/lib/merge_accounting_client/models/state_enum.rb +17 -7
- data/lib/merge_accounting_client/models/status7d1_enum.rb +17 -7
- data/lib/merge_accounting_client/models/sync_status.rb +0 -10
- data/lib/merge_accounting_client/models/sync_status_status_enum.rb +18 -7
- data/lib/merge_accounting_client/models/tax_rate.rb +1 -1
- data/lib/merge_accounting_client/models/tracking_category.rb +13 -2
- data/lib/merge_accounting_client/models/transaction.rb +357 -0
- data/lib/merge_accounting_client/models/transaction_line_item.rb +359 -0
- data/lib/merge_accounting_client/models/vendor_credit.rb +1 -1
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +7 -1
- data/merge_accounting_client.gemspec +1 -1
- data/spec/api/accounts_api_spec.rb +3 -1
- data/spec/api/addresses_api_spec.rb +1 -0
- data/spec/api/attachments_api_spec.rb +1 -1
- data/spec/api/balance_sheets_api_spec.rb +1 -1
- data/spec/api/cash_flow_statements_api_spec.rb +1 -1
- data/spec/api/company_info_api_spec.rb +1 -1
- data/spec/api/contacts_api_spec.rb +3 -1
- data/spec/api/credit_notes_api_spec.rb +3 -1
- data/spec/api/expenses_api_spec.rb +1 -1
- data/spec/api/income_statements_api_spec.rb +1 -1
- data/spec/api/invoices_api_spec.rb +3 -1
- data/spec/api/items_api_spec.rb +3 -1
- data/spec/api/journal_entries_api_spec.rb +1 -1
- data/spec/api/linked_accounts_api_spec.rb +1 -0
- data/spec/api/payments_api_spec.rb +1 -1
- data/spec/api/purchase_orders_api_spec.rb +3 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tax_rates_api_spec.rb +1 -1
- data/spec/api/tracking_categories_api_spec.rb +3 -1
- data/spec/api/transactions_api_spec.rb +70 -0
- data/spec/api/vendor_credits_api_spec.rb +1 -1
- data/spec/models/account_details_and_actions_spec.rb +6 -0
- data/spec/models/account_details_spec.rb +6 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/balance_sheet_spec.rb +6 -0
- data/spec/models/cash_flow_statement_spec.rb +6 -0
- data/spec/models/category_type_enum_spec.rb +28 -0
- data/spec/models/credit_note_line_item_spec.rb +94 -0
- data/spec/models/credit_note_spec.rb +18 -0
- data/spec/models/data_passthrough_request_spec.rb +6 -0
- data/spec/models/end_user_details_request_spec.rb +6 -0
- data/spec/models/income_statement_spec.rb +6 -0
- data/spec/models/invoice_line_item_spec.rb +0 -6
- data/spec/models/journal_entry_request_spec.rb +6 -0
- data/spec/models/journal_entry_spec.rb +6 -0
- data/spec/models/link_token_spec.rb +6 -0
- data/spec/models/paginated_transaction_list_spec.rb +46 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_spec.rb +18 -0
- data/spec/models/remote_response_spec.rb +12 -0
- data/spec/models/response_type_enum_spec.rb +28 -0
- data/spec/models/tracking_category_spec.rb +6 -0
- data/spec/models/transaction_line_item_spec.rb +82 -0
- data/spec/models/transaction_spec.rb +100 -0
- metadata +136 -107
data/docs/TrackingCategory.md
CHANGED
@@ -9,7 +9,8 @@
|
|
9
9
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
10
10
|
| **name** | **String** | The tracking category's name. | [optional] |
|
11
11
|
| **status** | [**Status7d1Enum**](Status7d1Enum.md) | The tracking category's status. | [optional] |
|
12
|
-
| **
|
12
|
+
| **category_type** | [**CategoryTypeEnum**](CategoryTypeEnum.md) | The tracking category’s type. | [optional] |
|
13
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
13
14
|
|
14
15
|
## Example
|
15
16
|
|
@@ -22,6 +23,7 @@ instance = MergeAccountingClient::TrackingCategory.new(
|
|
22
23
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
23
24
|
name: Marketing Department,
|
24
25
|
status: ACTIVE,
|
26
|
+
category_type: DEPARTMENT,
|
25
27
|
remote_was_deleted: null
|
26
28
|
)
|
27
29
|
```
|
data/docs/Transaction.md
ADDED
@@ -0,0 +1,40 @@
|
|
1
|
+
# MergeAccountingClient::Transaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **transaction_type** | **String** | The type of general transaction. | [optional] |
|
9
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
10
|
+
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
11
|
+
| **number** | **String** | The transaction number. | [optional] |
|
12
|
+
| **transaction_date** | **Time** | The transaction date. | [optional] |
|
13
|
+
| **account** | **String** | The transaction's account. | [optional] |
|
14
|
+
| **contact** | **String** | The transaction's contact. | [optional] |
|
15
|
+
| **total_amount** | **String** | The transaction's total amount. | [optional] |
|
16
|
+
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The transaction's currency. | [optional] |
|
17
|
+
| **line_items** | [**Array<TransactionLineItem>**](TransactionLineItem.md) | | [optional][readonly] |
|
18
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'merge_accounting_client'
|
24
|
+
|
25
|
+
instance = MergeAccountingClient::Transaction.new(
|
26
|
+
id: 0048ea5b-911e-4dff-9364-92070dea62ff,
|
27
|
+
transaction_type: estimate,
|
28
|
+
remote_id: 239741,
|
29
|
+
remote_data: [{"path":"/actions","data":["Varies by platform"]}],
|
30
|
+
number: 122,
|
31
|
+
transaction_date: null,
|
32
|
+
account: 3e442c5d-8f51-4103-b5c9-dcee39c30a08,
|
33
|
+
contact: 2c22ce34-5c6e-4fc7-a594-7f26bb4cf78b,
|
34
|
+
total_amount: 260.0,
|
35
|
+
currency: USD,
|
36
|
+
line_items: [{"memo":"Pickleball paddles","unit_price":25.0,"quantity":10.0,"item":"0958cbc6-6040-430a-848e-aafacbadf4ae","account":"3e442c5d-8f51-4103-b5c9-dcee39c30a08","tracking_category":"f1214c24-2702-4617-b74b-3ddecfc0d384","total_line_amount":260.0,"tax_rate":"a12e7c20-1922-9df7-s75n-edfeewnn7384"},{"memo":"Pickleball Balls","unit_price":1.0,"quantity":10.0,"item":"249c9faa-3045-4a31-953b-8f22d3613301","account":"3e442c5d-8f51-4103-b5c9-dcee39c30a08","tracking_category":"f1214c24-2702-4617-b74b-3ddecfc0d384","total_line_amount":20.0,"tax_rate":"a12e7c20-1922-9df7-s75n-edfeewnn7384"}],
|
37
|
+
remote_was_deleted: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# MergeAccountingClient::TransactionLineItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **memo** | **String** | A memo attached to the line item. | [optional] |
|
8
|
+
| **unit_price** | **String** | The line item's unit price. | [optional] |
|
9
|
+
| **quantity** | **String** | The line item's quantity. | [optional] |
|
10
|
+
| **item** | **String** | | [optional] |
|
11
|
+
| **account** | **String** | The line item's account. | [optional] |
|
12
|
+
| **tracking_category** | **String** | The line's associated tracking category. | [optional] |
|
13
|
+
| **total_line_amount** | **String** | The line item's total. | [optional] |
|
14
|
+
| **tax_rate** | **String** | The line item's tax rate. | [optional] |
|
15
|
+
| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'merge_accounting_client'
|
21
|
+
|
22
|
+
instance = MergeAccountingClient::TransactionLineItem.new(
|
23
|
+
memo: Pickleball paddles,
|
24
|
+
unit_price: 25.0,
|
25
|
+
quantity: 10.0,
|
26
|
+
item: 0958cbc6-6040-430a-848e-aafacbadf4ae,
|
27
|
+
account: 2b38c085-2620-4269-b5ec-75dd9095ed2c,
|
28
|
+
tracking_category: f1214c24-2702-4617-b74b-3ddecfc0d384,
|
29
|
+
total_line_amount: 260.0,
|
30
|
+
tax_rate: null,
|
31
|
+
remote_id: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,181 @@
|
|
1
|
+
# MergeAccountingClient::TransactionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**transactions_list**](TransactionsApi.md#transactions_list) | **GET** /transactions | |
|
8
|
+
| [**transactions_retrieve**](TransactionsApi.md#transactions_retrieve) | **GET** /transactions/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## transactions_list
|
12
|
+
|
13
|
+
> <PaginatedTransactionList> transactions_list(x_account_token, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Returns a list of `Transaction` objects.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'merge_accounting_client'
|
24
|
+
# setup authorization
|
25
|
+
MergeAccountingClient.configure do |config|
|
26
|
+
# Configure API key authorization: tokenAuth
|
27
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = MergeAccountingClient::TransactionsApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
opts = {
|
35
|
+
created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
|
36
|
+
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
|
+
expand: 'line_items', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
43
|
+
page_size: 56, # Integer | Number of results to return per page.
|
44
|
+
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
|
49
|
+
result = api_instance.transactions_list(x_account_token, opts)
|
50
|
+
p result
|
51
|
+
rescue MergeAccountingClient::ApiError => e
|
52
|
+
puts "Error when calling TransactionsApi->transactions_list: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
#### Using the transactions_list_with_http_info variant
|
57
|
+
|
58
|
+
This returns an Array which contains the response data, status code and headers.
|
59
|
+
|
60
|
+
> <Array(<PaginatedTransactionList>, Integer, Hash)> transactions_list_with_http_info(x_account_token, opts)
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
begin
|
64
|
+
|
65
|
+
data, status_code, headers = api_instance.transactions_list_with_http_info(x_account_token, opts)
|
66
|
+
p status_code # => 2xx
|
67
|
+
p headers # => { ... }
|
68
|
+
p data # => <PaginatedTransactionList>
|
69
|
+
rescue MergeAccountingClient::ApiError => e
|
70
|
+
puts "Error when calling TransactionsApi->transactions_list_with_http_info: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
| Name | Type | Description | Notes |
|
77
|
+
| ---- | ---- | ----------- | ----- |
|
78
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
79
|
+
| **created_after** | **Time** | If provided, will only return objects created after this datetime. | [optional] |
|
80
|
+
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
|
+
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
|
+
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
87
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
88
|
+
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
89
|
+
|
90
|
+
### Return type
|
91
|
+
|
92
|
+
[**PaginatedTransactionList**](PaginatedTransactionList.md)
|
93
|
+
|
94
|
+
### Authorization
|
95
|
+
|
96
|
+
[tokenAuth](../README.md#tokenAuth)
|
97
|
+
|
98
|
+
### HTTP request headers
|
99
|
+
|
100
|
+
- **Content-Type**: Not defined
|
101
|
+
- **Accept**: application/json
|
102
|
+
|
103
|
+
|
104
|
+
## transactions_retrieve
|
105
|
+
|
106
|
+
> <Transaction> transactions_retrieve(x_account_token, id, opts)
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
Returns a `Transaction` object with the given `id`.
|
111
|
+
|
112
|
+
### Examples
|
113
|
+
|
114
|
+
```ruby
|
115
|
+
require 'time'
|
116
|
+
require 'merge_accounting_client'
|
117
|
+
# setup authorization
|
118
|
+
MergeAccountingClient.configure do |config|
|
119
|
+
# Configure API key authorization: tokenAuth
|
120
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
121
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
123
|
+
end
|
124
|
+
|
125
|
+
api_instance = MergeAccountingClient::TransactionsApi.new
|
126
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
127
|
+
id = TODO # String |
|
128
|
+
opts = {
|
129
|
+
expand: 'line_items', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
130
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
|
+
}
|
132
|
+
|
133
|
+
begin
|
134
|
+
|
135
|
+
result = api_instance.transactions_retrieve(x_account_token, id, opts)
|
136
|
+
p result
|
137
|
+
rescue MergeAccountingClient::ApiError => e
|
138
|
+
puts "Error when calling TransactionsApi->transactions_retrieve: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
#### Using the transactions_retrieve_with_http_info variant
|
143
|
+
|
144
|
+
This returns an Array which contains the response data, status code and headers.
|
145
|
+
|
146
|
+
> <Array(<Transaction>, Integer, Hash)> transactions_retrieve_with_http_info(x_account_token, id, opts)
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
begin
|
150
|
+
|
151
|
+
data, status_code, headers = api_instance.transactions_retrieve_with_http_info(x_account_token, id, opts)
|
152
|
+
p status_code # => 2xx
|
153
|
+
p headers # => { ... }
|
154
|
+
p data # => <Transaction>
|
155
|
+
rescue MergeAccountingClient::ApiError => e
|
156
|
+
puts "Error when calling TransactionsApi->transactions_retrieve_with_http_info: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
| Name | Type | Description | Notes |
|
163
|
+
| ---- | ---- | ----------- | ----- |
|
164
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
165
|
+
| **id** | [**String**](.md) | | |
|
166
|
+
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
167
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
[**Transaction**](Transaction.md)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[tokenAuth](../README.md#tokenAuth)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: Not defined
|
180
|
+
- **Accept**: application/json
|
181
|
+
|
data/docs/VendorCredit.md
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
| **total_amount** | **Float** | The vendor credit's total amount. | [optional] |
|
14
14
|
| **currency** | [**CurrencyEnum**](CurrencyEnum.md) | The vendor credit's currency. | [optional] |
|
15
15
|
| **lines** | [**Array<VendorCreditLine>**](VendorCreditLine.md) | | [optional][readonly] |
|
16
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
16
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted by third party webhooks. | [optional][readonly] |
|
17
17
|
|
18
18
|
## Example
|
19
19
|
|
data/docs/VendorCreditsApi.md
CHANGED
@@ -36,7 +36,7 @@ opts = {
|
|
36
36
|
created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
|
37
37
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
38
38
|
expand: 'lines', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
39
|
-
include_deleted_data: true, # Boolean | Whether to include data that was deleted
|
39
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
40
40
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
41
41
|
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified after this datetime.
|
42
42
|
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects modified before this datetime.
|
@@ -80,7 +80,7 @@ end
|
|
80
80
|
| **created_before** | **Time** | If provided, will only return objects created before this datetime. | [optional] |
|
81
81
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
82
82
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
83
|
-
| **include_deleted_data** | **Boolean** | Whether to include data that was deleted
|
83
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
84
84
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
85
85
|
| **modified_after** | **Time** | If provided, will only return objects modified after this datetime. | [optional] |
|
86
86
|
| **modified_before** | **Time** | If provided, will only return objects modified before this datetime. | [optional] |
|
@@ -25,11 +25,12 @@ module MergeAccountingClient
|
|
25
25
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
29
29
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
30
30
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
31
31
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
32
32
|
# @option opts [Integer] :page_size Number of results to return per page.
|
33
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
33
34
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
34
35
|
# @return [PaginatedAccountList]
|
35
36
|
def accounts_list(x_account_token, opts = {})
|
@@ -43,11 +44,12 @@ module MergeAccountingClient
|
|
43
44
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
45
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
46
|
# @option opts [String] :cursor The pagination cursor value.
|
46
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
47
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
47
48
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
48
49
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
49
50
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
50
51
|
# @option opts [Integer] :page_size Number of results to return per page.
|
52
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
51
53
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
52
54
|
# @return [Array<(PaginatedAccountList, Integer, Hash)>] PaginatedAccountList data, response status code and response headers
|
53
55
|
def accounts_list_with_http_info(x_account_token, opts = {})
|
@@ -58,6 +60,10 @@ module MergeAccountingClient
|
|
58
60
|
if @api_client.config.client_side_validation && x_account_token.nil?
|
59
61
|
fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AccountsApi.accounts_list"
|
60
62
|
end
|
63
|
+
allowable_values = ["classification", "classification,status", "status"]
|
64
|
+
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
65
|
+
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
66
|
+
end
|
61
67
|
# resource path
|
62
68
|
local_var_path = '/accounts'
|
63
69
|
|
@@ -71,6 +77,7 @@ module MergeAccountingClient
|
|
71
77
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
72
78
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
73
79
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
80
|
+
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
74
81
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
75
82
|
|
76
83
|
# header parameters
|
@@ -113,6 +120,7 @@ module MergeAccountingClient
|
|
113
120
|
# @param id [String]
|
114
121
|
# @param [Hash] opts the optional parameters
|
115
122
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
116
124
|
# @return [Account]
|
117
125
|
def accounts_retrieve(x_account_token, id, opts = {})
|
118
126
|
data, _status_code, _headers = accounts_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -124,6 +132,7 @@ module MergeAccountingClient
|
|
124
132
|
# @param id [String]
|
125
133
|
# @param [Hash] opts the optional parameters
|
126
134
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
135
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
127
136
|
# @return [Array<(Account, Integer, Hash)>] Account data, response status code and response headers
|
128
137
|
def accounts_retrieve_with_http_info(x_account_token, id, opts = {})
|
129
138
|
if @api_client.config.debugging
|
@@ -137,12 +146,17 @@ module MergeAccountingClient
|
|
137
146
|
if @api_client.config.client_side_validation && id.nil?
|
138
147
|
fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.accounts_retrieve"
|
139
148
|
end
|
149
|
+
allowable_values = ["classification", "classification,status", "status"]
|
150
|
+
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
151
|
+
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
152
|
+
end
|
140
153
|
# resource path
|
141
154
|
local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
142
155
|
|
143
156
|
# query parameters
|
144
157
|
query_params = opts[:query_params] || {}
|
145
158
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
159
|
+
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
146
160
|
|
147
161
|
# header parameters
|
148
162
|
header_params = opts[:header_params] || {}
|
@@ -24,6 +24,7 @@ module MergeAccountingClient
|
|
24
24
|
# @param id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
27
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
27
28
|
# @return [Address]
|
28
29
|
def addresses_retrieve(x_account_token, id, opts = {})
|
29
30
|
data, _status_code, _headers = addresses_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -35,6 +36,7 @@ module MergeAccountingClient
|
|
35
36
|
# @param id [String]
|
36
37
|
# @param [Hash] opts the optional parameters
|
37
38
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
39
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
38
40
|
# @return [Array<(Address, Integer, Hash)>] Address data, response status code and response headers
|
39
41
|
def addresses_retrieve_with_http_info(x_account_token, id, opts = {})
|
40
42
|
if @api_client.config.debugging
|
@@ -48,12 +50,17 @@ module MergeAccountingClient
|
|
48
50
|
if @api_client.config.client_side_validation && id.nil?
|
49
51
|
fail ArgumentError, "Missing the required parameter 'id' when calling AddressesApi.addresses_retrieve"
|
50
52
|
end
|
53
|
+
allowable_values = ["type"]
|
54
|
+
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
55
|
+
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
56
|
+
end
|
51
57
|
# resource path
|
52
58
|
local_var_path = '/addresses/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
53
59
|
|
54
60
|
# query parameters
|
55
61
|
query_params = opts[:query_params] || {}
|
56
62
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
63
|
+
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
57
64
|
|
58
65
|
# header parameters
|
59
66
|
header_params = opts[:header_params] || {}
|
@@ -25,7 +25,7 @@ module MergeAccountingClient
|
|
25
25
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
29
29
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
30
30
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
31
31
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -43,7 +43,7 @@ module MergeAccountingClient
|
|
43
43
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
44
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
45
|
# @option opts [String] :cursor The pagination cursor value.
|
46
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
46
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
47
47
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
48
48
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
49
49
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -25,7 +25,7 @@ module MergeAccountingClient
|
|
25
25
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
29
29
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
30
30
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
31
31
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -43,7 +43,7 @@ module MergeAccountingClient
|
|
43
43
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
44
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
45
|
# @option opts [String] :cursor The pagination cursor value.
|
46
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
46
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
47
47
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
48
48
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
49
49
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -25,7 +25,7 @@ module MergeAccountingClient
|
|
25
25
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
28
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
29
29
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
30
30
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
31
31
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -43,7 +43,7 @@ module MergeAccountingClient
|
|
43
43
|
# @option opts [Time] :created_after If provided, will only return objects created after this datetime.
|
44
44
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
45
45
|
# @option opts [String] :cursor The pagination cursor value.
|
46
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
46
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
47
47
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
48
48
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
49
49
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -26,7 +26,7 @@ module MergeAccountingClient
|
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
28
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
29
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
29
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
30
30
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
31
31
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
32
32
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -45,7 +45,7 @@ module MergeAccountingClient
|
|
45
45
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
46
46
|
# @option opts [String] :cursor The pagination cursor value.
|
47
47
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
48
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
48
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
49
49
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
50
50
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
51
51
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
@@ -26,11 +26,12 @@ module MergeAccountingClient
|
|
26
26
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
27
27
|
# @option opts [String] :cursor The pagination cursor value.
|
28
28
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
29
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
29
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
30
30
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
31
31
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
32
32
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
33
33
|
# @option opts [Integer] :page_size Number of results to return per page.
|
34
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
34
35
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
35
36
|
# @return [PaginatedContactList]
|
36
37
|
def contacts_list(x_account_token, opts = {})
|
@@ -45,11 +46,12 @@ module MergeAccountingClient
|
|
45
46
|
# @option opts [Time] :created_before If provided, will only return objects created before this datetime.
|
46
47
|
# @option opts [String] :cursor The pagination cursor value.
|
47
48
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
48
|
-
# @option opts [Boolean] :include_deleted_data Whether to include data that was deleted
|
49
|
+
# @option opts [Boolean] :include_deleted_data Whether to include data that was marked as deleted by third party webhooks.
|
49
50
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
50
51
|
# @option opts [Time] :modified_after If provided, will only return objects modified after this datetime.
|
51
52
|
# @option opts [Time] :modified_before If provided, will only return objects modified before this datetime.
|
52
53
|
# @option opts [Integer] :page_size Number of results to return per page.
|
54
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
53
55
|
# @option opts [String] :remote_id The API provider's ID for the given object.
|
54
56
|
# @return [Array<(PaginatedContactList, Integer, Hash)>] PaginatedContactList data, response status code and response headers
|
55
57
|
def contacts_list_with_http_info(x_account_token, opts = {})
|
@@ -64,6 +66,10 @@ module MergeAccountingClient
|
|
64
66
|
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
65
67
|
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
66
68
|
end
|
69
|
+
allowable_values = ["status"]
|
70
|
+
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
71
|
+
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
72
|
+
end
|
67
73
|
# resource path
|
68
74
|
local_var_path = '/contacts'
|
69
75
|
|
@@ -78,6 +84,7 @@ module MergeAccountingClient
|
|
78
84
|
query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
|
79
85
|
query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
|
80
86
|
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
87
|
+
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
81
88
|
query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
|
82
89
|
|
83
90
|
# header parameters
|
@@ -121,6 +128,7 @@ module MergeAccountingClient
|
|
121
128
|
# @param [Hash] opts the optional parameters
|
122
129
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
123
130
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
131
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
124
132
|
# @return [Contact]
|
125
133
|
def contacts_retrieve(x_account_token, id, opts = {})
|
126
134
|
data, _status_code, _headers = contacts_retrieve_with_http_info(x_account_token, id, opts)
|
@@ -133,6 +141,7 @@ module MergeAccountingClient
|
|
133
141
|
# @param [Hash] opts the optional parameters
|
134
142
|
# @option opts [String] :expand Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
135
143
|
# @option opts [Boolean] :include_remote_data Whether to include the original data Merge fetched from the third-party to produce these models.
|
144
|
+
# @option opts [String] :remote_fields Which fields should be returned in non-normalized form.
|
136
145
|
# @return [Array<(Contact, Integer, Hash)>] Contact data, response status code and response headers
|
137
146
|
def contacts_retrieve_with_http_info(x_account_token, id, opts = {})
|
138
147
|
if @api_client.config.debugging
|
@@ -150,6 +159,10 @@ module MergeAccountingClient
|
|
150
159
|
if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
|
151
160
|
fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
|
152
161
|
end
|
162
|
+
allowable_values = ["status"]
|
163
|
+
if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
|
164
|
+
fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
|
165
|
+
end
|
153
166
|
# resource path
|
154
167
|
local_var_path = '/contacts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
155
168
|
|
@@ -157,6 +170,7 @@ module MergeAccountingClient
|
|
157
170
|
query_params = opts[:query_params] || {}
|
158
171
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
159
172
|
query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
|
173
|
+
query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
|
160
174
|
|
161
175
|
# header parameters
|
162
176
|
header_params = opts[:header_params] || {}
|