merge_accounting_client 1.0.8 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +238 -224
- data/docs/Account.md +5 -1
- data/docs/AccountIntegration.md +8 -2
- data/docs/AccountingAttachment.md +5 -1
- data/docs/AccountingPeriod.md +30 -0
- data/docs/AccountingPeriodStatusEnum.md +15 -0
- data/docs/AccountingPeriodsApi.md +167 -0
- data/docs/AccountingPhoneNumber.md +5 -1
- data/docs/AccountsApi.md +4 -4
- data/docs/Address.md +6 -2
- data/docs/AddressRequest.md +34 -0
- data/docs/AsyncPassthroughApi.md +155 -0
- data/docs/AsyncPassthroughReciept.md +18 -0
- data/docs/AttachmentsApi.md +4 -4
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BalanceSheet.md +5 -1
- data/docs/BalanceSheetsApi.md +4 -4
- data/docs/CashFlowStatement.md +5 -1
- data/docs/CashFlowStatementsApi.md +4 -4
- data/docs/CompanyInfo.md +6 -2
- data/docs/CompanyInfoApi.md +4 -4
- data/docs/Contact.md +6 -2
- data/docs/ContactRequest.md +1 -1
- data/docs/ContactsApi.md +8 -4
- data/docs/CreditNote.md +14 -2
- data/docs/CreditNoteLineItem.md +9 -1
- data/docs/CreditNotesApi.md +6 -6
- data/docs/DeleteAccountApi.md +9 -9
- data/docs/EndUserDetailsRequest.md +2 -2
- data/docs/EventTypeEnum.md +15 -0
- data/docs/Expense.md +14 -2
- data/docs/ExpenseLine.md +11 -1
- data/docs/ExpenseLineRequest.md +2 -0
- data/docs/ExpenseRequest.md +9 -1
- data/docs/ExpensesApi.md +4 -4
- data/docs/ForceResyncApi.md +1 -1
- data/docs/IncomeStatement.md +5 -1
- data/docs/IncomeStatementsApi.md +4 -4
- data/docs/Invoice.md +18 -4
- data/docs/InvoiceLineItem.md +7 -1
- data/docs/InvoiceRequest.md +7 -1
- data/docs/InvoiceStatusEnum.md +15 -0
- data/docs/InvoicesApi.md +6 -6
- data/docs/Issue.md +2 -2
- data/docs/IssuesApi.md +6 -6
- data/docs/Item.md +5 -1
- data/docs/ItemsApi.md +4 -4
- data/docs/JournalEntriesApi.md +6 -6
- data/docs/JournalEntry.md +13 -1
- data/docs/JournalEntryRequest.md +4 -0
- data/docs/JournalLine.md +13 -1
- data/docs/JournalLineRequest.md +4 -0
- data/docs/LinkedAccountsApi.md +2 -2
- data/docs/MetaResponse.md +2 -2
- data/docs/PaginatedAccountingPeriodList.md +22 -0
- data/docs/PaginatedAuditLogEventList.md +22 -0
- data/docs/Payment.md +11 -1
- data/docs/PaymentLineItem.md +32 -0
- data/docs/PaymentLineItemRequest.md +30 -0
- data/docs/PaymentRequest.md +6 -0
- data/docs/PaymentsApi.md +4 -4
- data/docs/PurchaseOrder.md +13 -3
- data/docs/PurchaseOrderLineItem.md +9 -1
- data/docs/PurchaseOrderRequest.md +2 -0
- data/docs/PurchaseOrdersApi.md +6 -6
- data/docs/RemoteData.md +1 -1
- data/docs/ReportItem.md +5 -1
- data/docs/RoleEnum.md +15 -0
- data/docs/SyncStatus.md +1 -1
- data/docs/SyncStatusApi.md +15 -11
- data/docs/TaxRate.md +5 -1
- data/docs/TaxRatesApi.md +4 -4
- data/docs/TrackingCategoriesApi.md +4 -4
- data/docs/TrackingCategory.md +5 -1
- data/docs/Transaction.md +9 -3
- data/docs/TransactionLineItem.md +9 -1
- data/docs/TransactionsApi.md +4 -4
- data/docs/VendorCredit.md +10 -2
- data/docs/VendorCreditLine.md +9 -1
- data/docs/VendorCreditsApi.md +6 -6
- data/git_push.sh +58 -0
- data/lib/merge_accounting_client/api/accounting_periods_api.rb +167 -0
- data/lib/merge_accounting_client/api/accounts_api.rb +4 -4
- data/lib/merge_accounting_client/api/async_passthrough_api.rb +160 -0
- data/lib/merge_accounting_client/api/attachments_api.rb +4 -4
- data/lib/merge_accounting_client/api/audit_trail_api.rb +95 -0
- data/lib/merge_accounting_client/api/balance_sheets_api.rb +4 -4
- data/lib/merge_accounting_client/api/cash_flow_statements_api.rb +4 -4
- data/lib/merge_accounting_client/api/company_info_api.rb +4 -4
- data/lib/merge_accounting_client/api/contacts_api.rb +10 -4
- data/lib/merge_accounting_client/api/credit_notes_api.rb +6 -6
- data/lib/merge_accounting_client/api/delete_account_api.rb +7 -7
- data/lib/merge_accounting_client/api/expenses_api.rb +6 -6
- data/lib/merge_accounting_client/api/force_resync_api.rb +2 -2
- data/lib/merge_accounting_client/api/income_statements_api.rb +4 -4
- data/lib/merge_accounting_client/api/invoices_api.rb +6 -6
- data/lib/merge_accounting_client/api/issues_api.rb +6 -6
- data/lib/merge_accounting_client/api/items_api.rb +4 -4
- data/lib/merge_accounting_client/api/journal_entries_api.rb +6 -6
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_accounting_client/api/payments_api.rb +6 -6
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +6 -6
- data/lib/merge_accounting_client/api/sync_status_api.rb +2 -2
- data/lib/merge_accounting_client/api/tax_rates_api.rb +4 -4
- data/lib/merge_accounting_client/api/tracking_categories_api.rb +4 -4
- data/lib/merge_accounting_client/api/transactions_api.rb +6 -6
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +6 -6
- data/lib/merge_accounting_client/configuration.rb +4 -0
- data/lib/merge_accounting_client/models/account.rb +22 -3
- data/lib/merge_accounting_client/models/account_integration.rb +37 -4
- data/lib/merge_accounting_client/models/account_request.rb +1 -1
- data/lib/merge_accounting_client/models/accounting_attachment.rb +21 -2
- data/lib/merge_accounting_client/models/accounting_period.rb +296 -0
- data/lib/merge_accounting_client/models/accounting_period_status_enum.rb +45 -0
- data/lib/merge_accounting_client/models/accounting_phone_number.rb +24 -5
- data/lib/merge_accounting_client/models/address.rb +24 -5
- data/lib/merge_accounting_client/models/address_request.rb +311 -0
- data/lib/merge_accounting_client/models/async_passthrough_reciept.rb +223 -0
- data/lib/merge_accounting_client/models/audit_log_event.rb +356 -0
- data/lib/merge_accounting_client/models/balance_sheet.rb +21 -2
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +21 -2
- data/lib/merge_accounting_client/models/company_info.rb +22 -3
- data/lib/merge_accounting_client/models/contact.rb +23 -4
- data/lib/merge_accounting_client/models/contact_request.rb +2 -2
- data/lib/merge_accounting_client/models/credit_note.rb +84 -3
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +43 -5
- data/lib/merge_accounting_client/models/end_user_details_request.rb +2 -2
- data/lib/merge_accounting_client/models/event_type_enum.rb +67 -0
- data/lib/merge_accounting_client/models/expense.rb +66 -3
- data/lib/merge_accounting_client/models/expense_line.rb +54 -5
- data/lib/merge_accounting_client/models/expense_line_request.rb +12 -1
- data/lib/merge_accounting_client/models/expense_request.rb +46 -2
- data/lib/merge_accounting_client/models/income_statement.rb +21 -2
- data/lib/merge_accounting_client/models/invoice.rb +84 -9
- data/lib/merge_accounting_client/models/invoice_line_item.rb +31 -2
- data/lib/merge_accounting_client/models/invoice_line_item_request.rb +1 -1
- data/lib/merge_accounting_client/models/invoice_request.rb +35 -2
- data/lib/merge_accounting_client/models/invoice_status_enum.rb +49 -0
- data/lib/merge_accounting_client/models/issue.rb +1 -0
- data/lib/merge_accounting_client/models/item.rb +21 -2
- data/lib/merge_accounting_client/models/journal_entry.rb +81 -2
- data/lib/merge_accounting_client/models/journal_entry_request.rb +38 -1
- data/lib/merge_accounting_client/models/journal_line.rb +65 -5
- data/lib/merge_accounting_client/models/journal_line_request.rb +23 -1
- data/lib/merge_accounting_client/models/paginated_accounting_period_list.rb +240 -0
- data/lib/merge_accounting_client/models/paginated_audit_log_event_list.rb +240 -0
- data/lib/merge_accounting_client/models/payment.rb +55 -2
- data/lib/merge_accounting_client/models/payment_line_item.rb +308 -0
- data/lib/merge_accounting_client/models/payment_line_item_request.rb +319 -0
- data/lib/merge_accounting_client/models/payment_request.rb +35 -1
- data/lib/merge_accounting_client/models/purchase_order.rb +70 -3
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +43 -5
- data/lib/merge_accounting_client/models/purchase_order_request.rb +12 -1
- data/lib/merge_accounting_client/models/remote_data.rb +3 -4
- data/lib/merge_accounting_client/models/report_item.rb +24 -5
- data/lib/merge_accounting_client/models/role_enum.rb +49 -0
- data/lib/merge_accounting_client/models/sync_status_status_enum.rb +1 -1
- data/lib/merge_accounting_client/models/tax_rate.rb +21 -2
- data/lib/merge_accounting_client/models/tracking_category.rb +22 -3
- data/lib/merge_accounting_client/models/transaction.rb +33 -3
- data/lib/merge_accounting_client/models/transaction_line_item.rb +43 -5
- data/lib/merge_accounting_client/models/vendor_credit.rb +44 -3
- data/lib/merge_accounting_client/models/vendor_credit_line.rb +43 -5
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +15 -7
- data/spec/api/accounting_periods_api_spec.rb +63 -0
- data/spec/api/accounts_api_spec.rb +2 -2
- data/spec/api/async_passthrough_api_spec.rb +59 -0
- data/spec/api/attachments_api_spec.rb +2 -2
- data/spec/api/audit_trail_api_spec.rb +51 -0
- data/spec/api/balance_sheets_api_spec.rb +2 -2
- data/spec/api/cash_flow_statements_api_spec.rb +2 -2
- data/spec/api/company_info_api_spec.rb +2 -2
- data/spec/api/contacts_api_spec.rb +4 -2
- data/spec/api/credit_notes_api_spec.rb +2 -2
- data/spec/api/delete_account_api_spec.rb +2 -2
- data/spec/api/expenses_api_spec.rb +2 -2
- data/spec/api/force_resync_api_spec.rb +1 -1
- data/spec/api/income_statements_api_spec.rb +2 -2
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/issues_api_spec.rb +3 -3
- data/spec/api/items_api_spec.rb +2 -2
- data/spec/api/journal_entries_api_spec.rb +2 -2
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +2 -2
- data/spec/api/purchase_orders_api_spec.rb +2 -2
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/api/tax_rates_api_spec.rb +2 -2
- data/spec/api/tracking_categories_api_spec.rb +2 -2
- data/spec/api/transactions_api_spec.rb +2 -2
- data/spec/api/vendor_credits_api_spec.rb +2 -2
- data/spec/models/account_integration_spec.rb +18 -0
- data/spec/models/account_spec.rb +12 -0
- data/spec/models/accounting_attachment_spec.rb +12 -0
- data/spec/models/accounting_period_spec.rb +70 -0
- data/spec/models/accounting_period_status_enum_spec.rb +28 -0
- data/spec/models/accounting_phone_number_spec.rb +12 -0
- data/spec/models/address_request_spec.rb +82 -0
- data/spec/models/address_spec.rb +12 -0
- data/spec/models/async_passthrough_reciept_spec.rb +34 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/balance_sheet_spec.rb +12 -0
- data/spec/models/cash_flow_statement_spec.rb +12 -0
- data/spec/models/company_info_spec.rb +12 -0
- data/spec/models/contact_spec.rb +12 -0
- data/spec/models/credit_note_line_item_spec.rb +24 -0
- data/spec/models/credit_note_spec.rb +36 -0
- data/spec/models/event_type_enum_spec.rb +28 -0
- data/spec/models/expense_line_request_spec.rb +6 -0
- data/spec/models/expense_line_spec.rb +30 -0
- data/spec/models/expense_request_spec.rb +24 -0
- data/spec/models/expense_spec.rb +36 -0
- data/spec/models/income_statement_spec.rb +12 -0
- data/spec/models/invoice_line_item_spec.rb +18 -0
- data/spec/models/invoice_request_spec.rb +18 -0
- data/spec/models/invoice_spec.rb +43 -1
- data/spec/models/invoice_status_enum_spec.rb +28 -0
- data/spec/models/item_spec.rb +12 -0
- data/spec/models/journal_entry_request_spec.rb +12 -0
- data/spec/models/journal_entry_spec.rb +36 -0
- data/spec/models/journal_line_request_spec.rb +12 -0
- data/spec/models/journal_line_spec.rb +36 -0
- data/spec/models/paginated_accounting_period_list_spec.rb +46 -0
- data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
- data/spec/models/payment_line_item_request_spec.rb +70 -0
- data/spec/models/payment_line_item_spec.rb +76 -0
- data/spec/models/payment_request_spec.rb +18 -0
- data/spec/models/payment_spec.rb +30 -0
- data/spec/models/purchase_order_line_item_spec.rb +24 -0
- data/spec/models/purchase_order_request_spec.rb +6 -0
- data/spec/models/purchase_order_spec.rb +30 -0
- data/spec/models/report_item_spec.rb +12 -0
- data/spec/models/role_enum_spec.rb +28 -0
- data/spec/models/tax_rate_spec.rb +12 -0
- data/spec/models/tracking_category_spec.rb +12 -0
- data/spec/models/transaction_line_item_spec.rb +24 -0
- data/spec/models/transaction_spec.rb +18 -0
- data/spec/models/vendor_credit_line_spec.rb +24 -0
- data/spec/models/vendor_credit_spec.rb +24 -0
- metadata +211 -150
data/docs/Account.md
CHANGED
@@ -16,7 +16,9 @@
|
|
16
16
|
| **account_number** | **String** | The account's number. | [optional] |
|
17
17
|
| **parent_account** | **String** | ID of the parent account. | [optional] |
|
18
18
|
| **company** | **String** | The company the account belongs to. | [optional] |
|
19
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
19
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
20
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
21
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
20
22
|
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
21
23
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
22
24
|
|
@@ -39,6 +41,8 @@ instance = MergeAccountingClient::Account.new(
|
|
39
41
|
parent_account: 22d92d6c-22f9-11ed-861d-0242ac120002,
|
40
42
|
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
41
43
|
remote_was_deleted: null,
|
44
|
+
created_at: 2021-09-15T00:00Z,
|
45
|
+
modified_at: 2021-10-16T00:00Z,
|
42
46
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
43
47
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
44
48
|
)
|
data/docs/AccountIntegration.md
CHANGED
@@ -5,11 +5,14 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | Company name. | |
|
8
|
-
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]. | [optional] |
|
8
|
+
| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris]. | [optional][readonly] |
|
9
9
|
| **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
|
10
10
|
| **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
|
11
11
|
| **color** | **String** | The color of this integration used for buttons and text throughout the app and landing pages. <b>Choose a darker, saturated color.</b> | [optional] |
|
12
12
|
| **slug** | **String** | | [optional][readonly] |
|
13
|
+
| **is_in_beta** | **Boolean** | If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag. | [optional] |
|
14
|
+
| **api_endpoints_to_documentation_urls** | [**Hash<String, AnyType>**](AnyType.md) | Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []} | [optional] |
|
15
|
+
| **webhook_setup_guide_url** | **String** | Setup guide URL for third party webhook creation. Exposed in Merge Docs. | [optional] |
|
13
16
|
|
14
17
|
## Example
|
15
18
|
|
@@ -22,7 +25,10 @@ instance = MergeAccountingClient::AccountIntegration.new(
|
|
22
25
|
image: null,
|
23
26
|
square_image: null,
|
24
27
|
color: null,
|
25
|
-
slug: null
|
28
|
+
slug: null,
|
29
|
+
is_in_beta: null,
|
30
|
+
api_endpoints_to_documentation_urls: null,
|
31
|
+
webhook_setup_guide_url: null
|
26
32
|
)
|
27
33
|
```
|
28
34
|
|
@@ -9,7 +9,9 @@
|
|
9
9
|
| **file_name** | **String** | The attachment's name. | [optional] |
|
10
10
|
| **file_url** | **String** | The attachment's url. | [optional] |
|
11
11
|
| **company** | **String** | The company the accounting attachment belongs to. | [optional] |
|
12
|
-
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted
|
12
|
+
| **remote_was_deleted** | **Boolean** | Indicates whether or not this object has been deleted in the third party platform. | [optional][readonly] |
|
13
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
14
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
13
15
|
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
14
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
15
17
|
|
@@ -25,6 +27,8 @@ instance = MergeAccountingClient::AccountingAttachment.new(
|
|
25
27
|
file_url: https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png,
|
26
28
|
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
27
29
|
remote_was_deleted: null,
|
30
|
+
created_at: 2021-09-15T00:00Z,
|
31
|
+
modified_at: 2021-10-16T00:00Z,
|
28
32
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
29
33
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
30
34
|
)
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# MergeAccountingClient::AccountingPeriod
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **start_date** | **Time** | Beginning date of the period | [optional] |
|
8
|
+
| **end_date** | **Time** | End date of the period | [optional] |
|
9
|
+
| **status** | [**AccountingPeriodStatusEnum**](AccountingPeriodStatusEnum.md) | | [optional] |
|
10
|
+
| **name** | **String** | Name of the accounting period. | [optional] |
|
11
|
+
| **id** | **String** | | [optional][readonly] |
|
12
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
13
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'merge_accounting_client'
|
19
|
+
|
20
|
+
instance = MergeAccountingClient::AccountingPeriod.new(
|
21
|
+
start_date: 2020-03-31T00:00Z,
|
22
|
+
end_date: null,
|
23
|
+
status: ACTIVE,
|
24
|
+
name: April 2020 Financials,
|
25
|
+
id: null,
|
26
|
+
created_at: 2021-09-15T00:00Z,
|
27
|
+
modified_at: 2021-10-16T00:00Z
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# MergeAccountingClient::AccountingPeriodStatusEnum
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'merge_accounting_client'
|
12
|
+
|
13
|
+
instance = MergeAccountingClient::AccountingPeriodStatusEnum.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,167 @@
|
|
1
|
+
# MergeAccountingClient::AccountingPeriodsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**accounting_periods_list**](AccountingPeriodsApi.md#accounting_periods_list) | **GET** /accounting-periods | |
|
8
|
+
| [**accounting_periods_retrieve**](AccountingPeriodsApi.md#accounting_periods_retrieve) | **GET** /accounting-periods/{id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## accounting_periods_list
|
12
|
+
|
13
|
+
> <PaginatedAccountingPeriodList> accounting_periods_list(x_account_token, opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Returns a list of `AccountingPeriod` 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::AccountingPeriodsApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
opts = {
|
35
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
36
|
+
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
37
|
+
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
38
|
+
page_size: 56 # Integer | Number of results to return per page.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.accounting_periods_list(x_account_token, opts)
|
44
|
+
p result
|
45
|
+
rescue MergeAccountingClient::ApiError => e
|
46
|
+
puts "Error when calling AccountingPeriodsApi->accounting_periods_list: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the accounting_periods_list_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<PaginatedAccountingPeriodList>, Integer, Hash)> accounting_periods_list_with_http_info(x_account_token, opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.accounting_periods_list_with_http_info(x_account_token, opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <PaginatedAccountingPeriodList>
|
63
|
+
rescue MergeAccountingClient::ApiError => e
|
64
|
+
puts "Error when calling AccountingPeriodsApi->accounting_periods_list_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
73
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
74
|
+
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
75
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
76
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
77
|
+
|
78
|
+
### Return type
|
79
|
+
|
80
|
+
[**PaginatedAccountingPeriodList**](PaginatedAccountingPeriodList.md)
|
81
|
+
|
82
|
+
### Authorization
|
83
|
+
|
84
|
+
[tokenAuth](../README.md#tokenAuth)
|
85
|
+
|
86
|
+
### HTTP request headers
|
87
|
+
|
88
|
+
- **Content-Type**: Not defined
|
89
|
+
- **Accept**: application/json
|
90
|
+
|
91
|
+
|
92
|
+
## accounting_periods_retrieve
|
93
|
+
|
94
|
+
> <AccountingPeriod> accounting_periods_retrieve(x_account_token, id, opts)
|
95
|
+
|
96
|
+
|
97
|
+
|
98
|
+
Returns an `AccountingPeriod` object with the given `id`.
|
99
|
+
|
100
|
+
### Examples
|
101
|
+
|
102
|
+
```ruby
|
103
|
+
require 'time'
|
104
|
+
require 'merge_accounting_client'
|
105
|
+
# setup authorization
|
106
|
+
MergeAccountingClient.configure do |config|
|
107
|
+
# Configure API key authorization: tokenAuth
|
108
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
109
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
110
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = MergeAccountingClient::AccountingPeriodsApi.new
|
114
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
115
|
+
id = TODO # String |
|
116
|
+
opts = {
|
117
|
+
include_remote_data: true # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
118
|
+
}
|
119
|
+
|
120
|
+
begin
|
121
|
+
|
122
|
+
result = api_instance.accounting_periods_retrieve(x_account_token, id, opts)
|
123
|
+
p result
|
124
|
+
rescue MergeAccountingClient::ApiError => e
|
125
|
+
puts "Error when calling AccountingPeriodsApi->accounting_periods_retrieve: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
#### Using the accounting_periods_retrieve_with_http_info variant
|
130
|
+
|
131
|
+
This returns an Array which contains the response data, status code and headers.
|
132
|
+
|
133
|
+
> <Array(<AccountingPeriod>, Integer, Hash)> accounting_periods_retrieve_with_http_info(x_account_token, id, opts)
|
134
|
+
|
135
|
+
```ruby
|
136
|
+
begin
|
137
|
+
|
138
|
+
data, status_code, headers = api_instance.accounting_periods_retrieve_with_http_info(x_account_token, id, opts)
|
139
|
+
p status_code # => 2xx
|
140
|
+
p headers # => { ... }
|
141
|
+
p data # => <AccountingPeriod>
|
142
|
+
rescue MergeAccountingClient::ApiError => e
|
143
|
+
puts "Error when calling AccountingPeriodsApi->accounting_periods_retrieve_with_http_info: #{e}"
|
144
|
+
end
|
145
|
+
```
|
146
|
+
|
147
|
+
### Parameters
|
148
|
+
|
149
|
+
| Name | Type | Description | Notes |
|
150
|
+
| ---- | ---- | ----------- | ----- |
|
151
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
152
|
+
| **id** | [**String**](.md) | | |
|
153
|
+
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**AccountingPeriod**](AccountingPeriod.md)
|
158
|
+
|
159
|
+
### Authorization
|
160
|
+
|
161
|
+
[tokenAuth](../README.md#tokenAuth)
|
162
|
+
|
163
|
+
### HTTP request headers
|
164
|
+
|
165
|
+
- **Content-Type**: Not defined
|
166
|
+
- **Accept**: application/json
|
167
|
+
|
@@ -6,6 +6,8 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **number** | **String** | The phone number. | [optional] |
|
8
8
|
| **type** | **String** | The phone number's type. | [optional] |
|
9
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
10
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
9
11
|
|
10
12
|
## Example
|
11
13
|
|
@@ -14,7 +16,9 @@ require 'merge_accounting_client'
|
|
14
16
|
|
15
17
|
instance = MergeAccountingClient::AccountingPhoneNumber.new(
|
16
18
|
number: +3198675309,
|
17
|
-
type: Mobile
|
19
|
+
type: Mobile,
|
20
|
+
created_at: 2021-09-15T00:00Z,
|
21
|
+
modified_at: 2021-10-16T00:00Z
|
18
22
|
)
|
19
23
|
```
|
20
24
|
|
data/docs/AccountsApi.md
CHANGED
@@ -120,8 +120,8 @@ opts = {
|
|
120
120
|
expand: 'company', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
|
121
121
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
122
122
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
123
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
124
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
123
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
124
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
125
125
|
page_size: 56, # Integer | Number of results to return per page.
|
126
126
|
remote_fields: 'classification', # String | Deprecated. Use show_enum_origins.
|
127
127
|
remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
|
@@ -167,8 +167,8 @@ end
|
|
167
167
|
| **expand** | **String** | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. | [optional] |
|
168
168
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
169
169
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
170
|
-
| **modified_after** | **Time** | If provided,
|
171
|
-
| **modified_before** | **Time** | If provided,
|
170
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
171
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
172
172
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
173
173
|
| **remote_fields** | **String** | Deprecated. Use show_enum_origins. | [optional] |
|
174
174
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
data/docs/Address.md
CHANGED
@@ -12,6 +12,8 @@
|
|
12
12
|
| **country_subdivision** | **String** | The address's state or region. | [optional] |
|
13
13
|
| **country** | [**CountryEnum**](CountryEnum.md) | The address's country. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
|
14
14
|
| **zip_code** | **String** | The address's zip code. | [optional] |
|
15
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
16
|
+
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
15
17
|
|
16
18
|
## Example
|
17
19
|
|
@@ -25,8 +27,10 @@ instance = MergeAccountingClient::Address.new(
|
|
25
27
|
city: New York,
|
26
28
|
state: NY,
|
27
29
|
country_subdivision: NY,
|
28
|
-
country:
|
29
|
-
zip_code: 10027
|
30
|
+
country: US,
|
31
|
+
zip_code: 10027,
|
32
|
+
created_at: 2021-09-15T00:00Z,
|
33
|
+
modified_at: 2021-10-16T00:00Z
|
30
34
|
)
|
31
35
|
```
|
32
36
|
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# MergeAccountingClient::AddressRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**AddressTypeEnum**](AddressTypeEnum.md) | The address type. * `BILLING` - BILLING * `SHIPPING` - SHIPPING | [optional] |
|
8
|
+
| **street_1** | **String** | Line 1 of the address's street. | [optional] |
|
9
|
+
| **street_2** | **String** | Line 2 of the address's street. | [optional] |
|
10
|
+
| **city** | **String** | The address's city. | [optional] |
|
11
|
+
| **country_subdivision** | **String** | The address's state or region. | [optional] |
|
12
|
+
| **country** | [**CountryEnum**](CountryEnum.md) | The address's country. * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `CV` - Cabo Verde * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo (the Democratic Republic of the) * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czechia * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `SZ` - Eswatini * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Laos * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia (Federated States of) * `MD` - Moldova * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `KP` - North Korea * `MK` - North Macedonia * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russia * `RW` - Rwanda * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `KR` - South Korea * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SE` - Sweden * `CH` - Switzerland * `SY` - Syria * `TW` - Taiwan * `TJ` - Tajikistan * `TZ` - Tanzania * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `UM` - United States Minor Outlying Islands * `US` - United States of America * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela * `VN` - Vietnam * `VG` - Virgin Islands (British) * `VI` - Virgin Islands (U.S.) * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe | [optional] |
|
13
|
+
| **zip_code** | **String** | The address's zip code. | [optional] |
|
14
|
+
| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
15
|
+
| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'merge_accounting_client'
|
21
|
+
|
22
|
+
instance = MergeAccountingClient::AddressRequest.new(
|
23
|
+
type: SHIPPING,
|
24
|
+
street_1: 2920 Broadway,
|
25
|
+
street_2: 2nd Floor,
|
26
|
+
city: New York,
|
27
|
+
country_subdivision: NY,
|
28
|
+
country: US,
|
29
|
+
zip_code: 10027,
|
30
|
+
integration_params: {"unique_integration_field":"unique_integration_field_value"},
|
31
|
+
linked_account_params: {"unique_linked_account_field":"unique_linked_account_field_value"}
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,155 @@
|
|
1
|
+
# MergeAccountingClient::AsyncPassthroughApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**async_passthrough_create**](AsyncPassthroughApi.md#async_passthrough_create) | **POST** /async-passthrough | |
|
8
|
+
| [**async_passthrough_retrieve**](AsyncPassthroughApi.md#async_passthrough_retrieve) | **GET** /async-passthrough/{async_passthrough_receipt_id} | |
|
9
|
+
|
10
|
+
|
11
|
+
## async_passthrough_create
|
12
|
+
|
13
|
+
> <AsyncPassthroughReciept> async_passthrough_create(x_account_token, data_passthrough_request)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
Asynchronously pull data from an endpoint not currently supported by Merge.
|
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::AsyncPassthroughApi.new
|
33
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
34
|
+
data_passthrough_request = MergeAccountingClient::DataPassthroughRequest.new({method: MergeAccountingClient::MethodEnum::GET, path: '/scooters'}) # DataPassthroughRequest |
|
35
|
+
|
36
|
+
begin
|
37
|
+
|
38
|
+
result = api_instance.async_passthrough_create(x_account_token, data_passthrough_request)
|
39
|
+
p result
|
40
|
+
rescue MergeAccountingClient::ApiError => e
|
41
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the async_passthrough_create_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<AsyncPassthroughReciept>, Integer, Hash)> async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
|
54
|
+
data, status_code, headers = api_instance.async_passthrough_create_with_http_info(x_account_token, data_passthrough_request)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <AsyncPassthroughReciept>
|
58
|
+
rescue MergeAccountingClient::ApiError => e
|
59
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_create_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
68
|
+
| **data_passthrough_request** | [**DataPassthroughRequest**](DataPassthroughRequest.md) | | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**AsyncPassthroughReciept**](AsyncPassthroughReciept.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[tokenAuth](../README.md#tokenAuth)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## async_passthrough_retrieve
|
85
|
+
|
86
|
+
> <RemoteResponse> async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
Retrieves data from earlier async-passthrough POST request
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'merge_accounting_client'
|
97
|
+
# setup authorization
|
98
|
+
MergeAccountingClient.configure do |config|
|
99
|
+
# Configure API key authorization: tokenAuth
|
100
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
102
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = MergeAccountingClient::AsyncPassthroughApi.new
|
106
|
+
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
|
107
|
+
async_passthrough_receipt_id = TODO # String |
|
108
|
+
|
109
|
+
begin
|
110
|
+
|
111
|
+
result = api_instance.async_passthrough_retrieve(x_account_token, async_passthrough_receipt_id)
|
112
|
+
p result
|
113
|
+
rescue MergeAccountingClient::ApiError => e
|
114
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve: #{e}"
|
115
|
+
end
|
116
|
+
```
|
117
|
+
|
118
|
+
#### Using the async_passthrough_retrieve_with_http_info variant
|
119
|
+
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
121
|
+
|
122
|
+
> <Array(<RemoteResponse>, Integer, Hash)> async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
123
|
+
|
124
|
+
```ruby
|
125
|
+
begin
|
126
|
+
|
127
|
+
data, status_code, headers = api_instance.async_passthrough_retrieve_with_http_info(x_account_token, async_passthrough_receipt_id)
|
128
|
+
p status_code # => 2xx
|
129
|
+
p headers # => { ... }
|
130
|
+
p data # => <RemoteResponse>
|
131
|
+
rescue MergeAccountingClient::ApiError => e
|
132
|
+
puts "Error when calling AsyncPassthroughApi->async_passthrough_retrieve_with_http_info: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
| Name | Type | Description | Notes |
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
140
|
+
| **x_account_token** | **String** | Token identifying the end user. | |
|
141
|
+
| **async_passthrough_receipt_id** | [**String**](.md) | | |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
[**RemoteResponse**](RemoteResponse.md)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
[tokenAuth](../README.md#tokenAuth)
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# MergeAccountingClient::AsyncPassthroughReciept
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **async_passthrough_receipt_id** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'merge_accounting_client'
|
13
|
+
|
14
|
+
instance = MergeAccountingClient::AsyncPassthroughReciept.new(
|
15
|
+
async_passthrough_receipt_id: fd29020f-2695-445e-922e-dcd5e81903fd
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/AttachmentsApi.md
CHANGED
@@ -119,8 +119,8 @@ opts = {
|
|
119
119
|
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
120
120
|
include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
|
121
121
|
include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
|
122
|
-
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
123
|
-
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided,
|
122
|
+
modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
|
123
|
+
modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
|
124
124
|
page_size: 56, # Integer | Number of results to return per page.
|
125
125
|
remote_id: 'remote_id_example' # String | The API provider's ID for the given object.
|
126
126
|
}
|
@@ -163,8 +163,8 @@ end
|
|
163
163
|
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
164
164
|
| **include_deleted_data** | **Boolean** | Whether to include data that was marked as deleted by third party webhooks. | [optional] |
|
165
165
|
| **include_remote_data** | **Boolean** | Whether to include the original data Merge fetched from the third-party to produce these models. | [optional] |
|
166
|
-
| **modified_after** | **Time** | If provided,
|
167
|
-
| **modified_before** | **Time** | If provided,
|
166
|
+
| **modified_after** | **Time** | If provided, only objects synced by Merge after this date time will be returned. | [optional] |
|
167
|
+
| **modified_before** | **Time** | If provided, only objects synced by Merge before this date time will be returned. | [optional] |
|
168
168
|
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
169
169
|
| **remote_id** | **String** | The API provider's ID for the given object. | [optional] |
|
170
170
|
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# MergeAccountingClient::AuditLogEvent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional][readonly] |
|
8
|
+
| **user_name** | **String** | The User's full name at the time of this Event occurring. | [optional] |
|
9
|
+
| **user_email** | **String** | The User's email at the time of this Event occurring. | [optional] |
|
10
|
+
| **role** | [**RoleEnum**](RoleEnum.md) | Designates the role of the user (or SYSTEM/API if action not taken by a user) at the time of this Event occurring. * `ADMIN` - ADMIN * `DEVELOPER` - DEVELOPER * `MEMBER` - MEMBER * `API` - API * `SYSTEM` - SYSTEM * `MERGE_TEAM` - MERGE_TEAM | |
|
11
|
+
| **ip_address** | **String** | | |
|
12
|
+
| **event_type** | [**EventTypeEnum**](EventTypeEnum.md) | Designates the type of event that occurred. * `CREATED_REMOTE_PRODUCTION_API_KEY` - CREATED_REMOTE_PRODUCTION_API_KEY * `DELETED_REMOTE_PRODUCTION_API_KEY` - DELETED_REMOTE_PRODUCTION_API_KEY * `CREATED_TEST_API_KEY` - CREATED_TEST_API_KEY * `DELETED_TEST_API_KEY` - DELETED_TEST_API_KEY * `REGENERATED_PRODUCTION_API_KEY` - REGENERATED_PRODUCTION_API_KEY * `INVITED_USER` - INVITED_USER * `TWO_FACTOR_AUTH_ENABLED` - TWO_FACTOR_AUTH_ENABLED * `TWO_FACTOR_AUTH_DISABLED` - TWO_FACTOR_AUTH_DISABLED * `DELETED_LINKED_ACCOUNT` - DELETED_LINKED_ACCOUNT * `CREATED_DESTINATION` - CREATED_DESTINATION * `DELETED_DESTINATION` - DELETED_DESTINATION * `CHANGED_SCOPES` - CHANGED_SCOPES * `CHANGED_PERSONAL_INFORMATION` - CHANGED_PERSONAL_INFORMATION * `CHANGED_ORGANIZATION_SETTINGS` - CHANGED_ORGANIZATION_SETTINGS * `ENABLED_INTEGRATION` - ENABLED_INTEGRATION * `DISABLED_INTEGRATION` - DISABLED_INTEGRATION * `ENABLED_CATEGORY` - ENABLED_CATEGORY * `DISABLED_CATEGORY` - DISABLED_CATEGORY * `CHANGED_PASSWORD` - CHANGED_PASSWORD * `RESET_PASSWORD` - RESET_PASSWORD * `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT * `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION` - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` - DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT | |
|
13
|
+
| **event_description** | **String** | | |
|
14
|
+
| **created_at** | **Time** | | [optional][readonly] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'merge_accounting_client'
|
20
|
+
|
21
|
+
instance = MergeAccountingClient::AuditLogEvent.new(
|
22
|
+
id: b5ceea2a-7171-47ce-8090-165cfce5572c,
|
23
|
+
user_name: Gil Feig,
|
24
|
+
user_email: hello@merge.dev,
|
25
|
+
role: ADMIN,
|
26
|
+
ip_address: 192.0.2.123,
|
27
|
+
event_type: CHANGED_SCOPES,
|
28
|
+
event_description: Organization-wide Scopes for model hris.Employee updated from Read to Read+Write,
|
29
|
+
created_at: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|