merge_accounting_client 1.0.9 → 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 +18 -4
- data/docs/Account.md +3 -1
- data/docs/AccountIntegration.md +4 -2
- data/docs/AccountingAttachment.md +3 -1
- data/docs/AccountingPeriod.md +30 -0
- data/docs/AccountingPeriodStatusEnum.md +15 -0
- data/docs/AccountingPeriodsApi.md +167 -0
- data/docs/AccountingPhoneNumber.md +2 -0
- data/docs/Address.md +2 -0
- data/docs/AddressRequest.md +34 -0
- data/docs/AuditLogEvent.md +32 -0
- data/docs/AuditTrailApi.md +91 -0
- data/docs/BalanceSheet.md +3 -1
- data/docs/CashFlowStatement.md +3 -1
- data/docs/CompanyInfo.md +3 -1
- data/docs/Contact.md +4 -2
- data/docs/ContactRequest.md +1 -1
- data/docs/ContactsApi.md +4 -0
- data/docs/CreditNote.md +8 -2
- data/docs/CreditNoteLineItem.md +6 -0
- data/docs/CreditNotesApi.md +2 -2
- data/docs/EndUserDetailsRequest.md +1 -1
- data/docs/EventTypeEnum.md +15 -0
- data/docs/Expense.md +10 -2
- data/docs/ExpenseLine.md +8 -0
- data/docs/ExpenseLineRequest.md +2 -0
- data/docs/ExpenseRequest.md +7 -1
- data/docs/IncomeStatement.md +3 -1
- data/docs/Invoice.md +11 -1
- data/docs/InvoiceLineItem.md +5 -1
- data/docs/InvoiceRequest.md +4 -0
- data/docs/InvoiceStatusEnum.md +15 -0
- data/docs/InvoicesApi.md +2 -2
- data/docs/Issue.md +1 -1
- data/docs/Item.md +3 -1
- data/docs/JournalEntriesApi.md +2 -2
- data/docs/JournalEntry.md +9 -1
- data/docs/JournalEntryRequest.md +4 -0
- data/docs/JournalLine.md +10 -0
- 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 +7 -1
- data/docs/PaymentLineItem.md +32 -0
- data/docs/PaymentLineItemRequest.md +30 -0
- data/docs/PaymentRequest.md +4 -0
- data/docs/PurchaseOrder.md +9 -3
- data/docs/PurchaseOrderLineItem.md +6 -0
- data/docs/PurchaseOrderRequest.md +2 -0
- data/docs/PurchaseOrdersApi.md +2 -2
- data/docs/ReportItem.md +2 -0
- data/docs/RoleEnum.md +15 -0
- data/docs/SyncStatusApi.md +1 -1
- data/docs/TaxRate.md +3 -1
- data/docs/TrackingCategory.md +3 -1
- data/docs/Transaction.md +7 -3
- data/docs/TransactionLineItem.md +6 -0
- data/docs/VendorCredit.md +6 -2
- data/docs/VendorCreditLine.md +6 -0
- data/docs/VendorCreditsApi.md +2 -2
- data/lib/merge_accounting_client/api/accounting_periods_api.rb +167 -0
- data/lib/merge_accounting_client/api/audit_trail_api.rb +95 -0
- data/lib/merge_accounting_client/api/contacts_api.rb +6 -0
- data/lib/merge_accounting_client/api/credit_notes_api.rb +2 -2
- data/lib/merge_accounting_client/api/expenses_api.rb +2 -2
- data/lib/merge_accounting_client/api/invoices_api.rb +2 -2
- data/lib/merge_accounting_client/api/journal_entries_api.rb +2 -2
- data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
- data/lib/merge_accounting_client/api/payments_api.rb +2 -2
- data/lib/merge_accounting_client/api/purchase_orders_api.rb +2 -2
- data/lib/merge_accounting_client/api/sync_status_api.rb +2 -2
- data/lib/merge_accounting_client/api/transactions_api.rb +2 -2
- data/lib/merge_accounting_client/api/vendor_credits_api.rb +2 -2
- data/lib/merge_accounting_client/configuration.rb +4 -0
- data/lib/merge_accounting_client/models/account.rb +12 -3
- data/lib/merge_accounting_client/models/account_integration.rb +15 -4
- data/lib/merge_accounting_client/models/account_request.rb +1 -1
- data/lib/merge_accounting_client/models/accounting_attachment.rb +11 -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 +10 -1
- data/lib/merge_accounting_client/models/address.rb +10 -1
- data/lib/merge_accounting_client/models/address_request.rb +311 -0
- data/lib/merge_accounting_client/models/audit_log_event.rb +356 -0
- data/lib/merge_accounting_client/models/balance_sheet.rb +11 -2
- data/lib/merge_accounting_client/models/cash_flow_statement.rb +11 -2
- data/lib/merge_accounting_client/models/company_info.rb +12 -3
- data/lib/merge_accounting_client/models/contact.rb +13 -4
- data/lib/merge_accounting_client/models/contact_request.rb +2 -2
- data/lib/merge_accounting_client/models/credit_note.rb +35 -3
- data/lib/merge_accounting_client/models/credit_note_line_item.rb +29 -1
- data/lib/merge_accounting_client/models/end_user_details_request.rb +1 -1
- data/lib/merge_accounting_client/models/event_type_enum.rb +67 -0
- data/lib/merge_accounting_client/models/expense.rb +45 -3
- data/lib/merge_accounting_client/models/expense_line.rb +40 -1
- data/lib/merge_accounting_client/models/expense_line_request.rb +12 -1
- data/lib/merge_accounting_client/models/expense_request.rb +35 -2
- data/lib/merge_accounting_client/models/income_statement.rb +11 -2
- data/lib/merge_accounting_client/models/invoice.rb +55 -1
- data/lib/merge_accounting_client/models/invoice_line_item.rb +20 -1
- data/lib/merge_accounting_client/models/invoice_request.rb +23 -1
- data/lib/merge_accounting_client/models/invoice_status_enum.rb +49 -0
- data/lib/merge_accounting_client/models/item.rb +11 -2
- data/lib/merge_accounting_client/models/journal_entry.rb +60 -2
- data/lib/merge_accounting_client/models/journal_entry_request.rb +38 -1
- data/lib/merge_accounting_client/models/journal_line.rb +51 -1
- 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 +34 -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 +24 -1
- data/lib/merge_accounting_client/models/purchase_order.rb +49 -3
- data/lib/merge_accounting_client/models/purchase_order_line_item.rb +29 -1
- data/lib/merge_accounting_client/models/purchase_order_request.rb +12 -1
- data/lib/merge_accounting_client/models/report_item.rb +10 -1
- data/lib/merge_accounting_client/models/role_enum.rb +49 -0
- data/lib/merge_accounting_client/models/tax_rate.rb +11 -2
- data/lib/merge_accounting_client/models/tracking_category.rb +12 -3
- data/lib/merge_accounting_client/models/transaction.rb +23 -3
- data/lib/merge_accounting_client/models/transaction_line_item.rb +29 -1
- data/lib/merge_accounting_client/models/vendor_credit.rb +23 -3
- data/lib/merge_accounting_client/models/vendor_credit_line.rb +29 -1
- data/lib/merge_accounting_client/version.rb +1 -1
- data/lib/merge_accounting_client.rb +13 -9
- data/spec/api/accounting_periods_api_spec.rb +63 -0
- data/spec/api/audit_trail_api_spec.rb +51 -0
- data/spec/api/contacts_api_spec.rb +2 -0
- data/spec/api/linked_accounts_api_spec.rb +1 -1
- data/spec/api/sync_status_api_spec.rb +1 -1
- data/spec/models/account_integration_spec.rb +6 -0
- data/spec/models/account_spec.rb +6 -0
- data/spec/models/accounting_attachment_spec.rb +6 -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 +6 -0
- data/spec/models/address_request_spec.rb +82 -0
- data/spec/models/address_spec.rb +6 -0
- data/spec/models/audit_log_event_spec.rb +76 -0
- data/spec/models/balance_sheet_spec.rb +6 -0
- data/spec/models/cash_flow_statement_spec.rb +6 -0
- data/spec/models/company_info_spec.rb +6 -0
- data/spec/models/contact_spec.rb +6 -0
- data/spec/models/credit_note_line_item_spec.rb +18 -0
- data/spec/models/credit_note_spec.rb +18 -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 +24 -0
- data/spec/models/expense_request_spec.rb +18 -0
- data/spec/models/expense_spec.rb +24 -0
- data/spec/models/income_statement_spec.rb +6 -0
- data/spec/models/invoice_line_item_spec.rb +12 -0
- data/spec/models/invoice_request_spec.rb +12 -0
- data/spec/models/invoice_spec.rb +30 -0
- data/spec/models/invoice_status_enum_spec.rb +28 -0
- data/spec/models/item_spec.rb +6 -0
- data/spec/models/journal_entry_request_spec.rb +12 -0
- data/spec/models/journal_entry_spec.rb +24 -0
- data/spec/models/journal_line_request_spec.rb +12 -0
- data/spec/models/journal_line_spec.rb +30 -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 +12 -0
- data/spec/models/payment_spec.rb +18 -0
- data/spec/models/purchase_order_line_item_spec.rb +18 -0
- data/spec/models/purchase_order_request_spec.rb +6 -0
- data/spec/models/purchase_order_spec.rb +18 -0
- data/spec/models/report_item_spec.rb +6 -0
- data/spec/models/role_enum_spec.rb +28 -0
- data/spec/models/tax_rate_spec.rb +6 -0
- data/spec/models/tracking_category_spec.rb +6 -0
- data/spec/models/transaction_line_item_spec.rb +18 -0
- data/spec/models/transaction_spec.rb +12 -0
- data/spec/models/vendor_credit_line_spec.rb +18 -0
- data/spec/models/vendor_credit_spec.rb +12 -0
- metadata +204 -152
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 13739efe5e3de6ee34f4ec419b330adbe24ddc7dec14148b0453b8a496811c6b
|
4
|
+
data.tar.gz: 5d6eb87cb197638aea402d51a06169abe2862cc56af4247feded1336678e080f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 07f8eac95ffc4637ff08596403394d653b50d0b974df00ff25263e22f8ae2caeb17a77a400a8b9286dccfdd731587bec710ba043fbf8a6a11669729d03ab3bd3
|
7
|
+
data.tar.gz: 58b0f586b52aa141302e9899e946532de48035c69ee0b0436b6bc33ad0443c23b78d3cf3d4b0a1441c993645ee06abd19241b9a4dcc9f371c6099c1c194e2ba2
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The unified API for building rich integrations with multiple Accounting & Financ
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0
|
10
|
-
- Package version: 1.0
|
10
|
+
- Package version: 1.1.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build merge_accounting_client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./merge_accounting_client-1.0.
|
27
|
+
gem install ./merge_accounting_client-1.1.0.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./merge_accounting_client-1.0.
|
30
|
+
(for development, run `gem install --dev ./merge_accounting_client-1.1.0.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'merge_accounting_client', '~> 1.0
|
36
|
+
gem 'merge_accounting_client', '~> 1.1.0'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -85,6 +85,8 @@ Class | Method | HTTP request | Description
|
|
85
85
|
------------ | ------------- | ------------- | -------------
|
86
86
|
*MergeAccountingClient::AccountDetailsApi* | [**account_details_retrieve**](docs/AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details |
|
87
87
|
*MergeAccountingClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} |
|
88
|
+
*MergeAccountingClient::AccountingPeriodsApi* | [**accounting_periods_list**](docs/AccountingPeriodsApi.md#accounting_periods_list) | **GET** /accounting-periods |
|
89
|
+
*MergeAccountingClient::AccountingPeriodsApi* | [**accounting_periods_retrieve**](docs/AccountingPeriodsApi.md#accounting_periods_retrieve) | **GET** /accounting-periods/{id} |
|
88
90
|
*MergeAccountingClient::AccountsApi* | [**accounts_create**](docs/AccountsApi.md#accounts_create) | **POST** /accounts |
|
89
91
|
*MergeAccountingClient::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts |
|
90
92
|
*MergeAccountingClient::AccountsApi* | [**accounts_meta_post_retrieve**](docs/AccountsApi.md#accounts_meta_post_retrieve) | **GET** /accounts/meta/post |
|
@@ -96,6 +98,7 @@ Class | Method | HTTP request | Description
|
|
96
98
|
*MergeAccountingClient::AttachmentsApi* | [**attachments_list**](docs/AttachmentsApi.md#attachments_list) | **GET** /attachments |
|
97
99
|
*MergeAccountingClient::AttachmentsApi* | [**attachments_meta_post_retrieve**](docs/AttachmentsApi.md#attachments_meta_post_retrieve) | **GET** /attachments/meta/post |
|
98
100
|
*MergeAccountingClient::AttachmentsApi* | [**attachments_retrieve**](docs/AttachmentsApi.md#attachments_retrieve) | **GET** /attachments/{id} |
|
101
|
+
*MergeAccountingClient::AuditTrailApi* | [**audit_trail_list**](docs/AuditTrailApi.md#audit_trail_list) | **GET** /audit-trail |
|
99
102
|
*MergeAccountingClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions |
|
100
103
|
*MergeAccountingClient::BalanceSheetsApi* | [**balance_sheets_list**](docs/BalanceSheetsApi.md#balance_sheets_list) | **GET** /balance-sheets |
|
101
104
|
*MergeAccountingClient::BalanceSheetsApi* | [**balance_sheets_retrieve**](docs/BalanceSheetsApi.md#balance_sheets_retrieve) | **GET** /balance-sheets/{id} |
|
@@ -176,11 +179,15 @@ Class | Method | HTTP request | Description
|
|
176
179
|
- [MergeAccountingClient::AccountingAttachmentEndpointRequest](docs/AccountingAttachmentEndpointRequest.md)
|
177
180
|
- [MergeAccountingClient::AccountingAttachmentRequest](docs/AccountingAttachmentRequest.md)
|
178
181
|
- [MergeAccountingClient::AccountingAttachmentResponse](docs/AccountingAttachmentResponse.md)
|
182
|
+
- [MergeAccountingClient::AccountingPeriod](docs/AccountingPeriod.md)
|
183
|
+
- [MergeAccountingClient::AccountingPeriodStatusEnum](docs/AccountingPeriodStatusEnum.md)
|
179
184
|
- [MergeAccountingClient::AccountingPhoneNumber](docs/AccountingPhoneNumber.md)
|
180
185
|
- [MergeAccountingClient::AccountingPhoneNumberRequest](docs/AccountingPhoneNumberRequest.md)
|
181
186
|
- [MergeAccountingClient::Address](docs/Address.md)
|
187
|
+
- [MergeAccountingClient::AddressRequest](docs/AddressRequest.md)
|
182
188
|
- [MergeAccountingClient::AddressTypeEnum](docs/AddressTypeEnum.md)
|
183
189
|
- [MergeAccountingClient::AsyncPassthroughReciept](docs/AsyncPassthroughReciept.md)
|
190
|
+
- [MergeAccountingClient::AuditLogEvent](docs/AuditLogEvent.md)
|
184
191
|
- [MergeAccountingClient::AvailableActions](docs/AvailableActions.md)
|
185
192
|
- [MergeAccountingClient::BalanceSheet](docs/BalanceSheet.md)
|
186
193
|
- [MergeAccountingClient::CashFlowStatement](docs/CashFlowStatement.md)
|
@@ -208,6 +215,7 @@ Class | Method | HTTP request | Description
|
|
208
215
|
- [MergeAccountingClient::EncodingEnum](docs/EncodingEnum.md)
|
209
216
|
- [MergeAccountingClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
|
210
217
|
- [MergeAccountingClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
|
218
|
+
- [MergeAccountingClient::EventTypeEnum](docs/EventTypeEnum.md)
|
211
219
|
- [MergeAccountingClient::Expense](docs/Expense.md)
|
212
220
|
- [MergeAccountingClient::ExpenseEndpointRequest](docs/ExpenseEndpointRequest.md)
|
213
221
|
- [MergeAccountingClient::ExpenseLine](docs/ExpenseLine.md)
|
@@ -222,6 +230,7 @@ Class | Method | HTTP request | Description
|
|
222
230
|
- [MergeAccountingClient::InvoiceLineItemRequest](docs/InvoiceLineItemRequest.md)
|
223
231
|
- [MergeAccountingClient::InvoiceRequest](docs/InvoiceRequest.md)
|
224
232
|
- [MergeAccountingClient::InvoiceResponse](docs/InvoiceResponse.md)
|
233
|
+
- [MergeAccountingClient::InvoiceStatusEnum](docs/InvoiceStatusEnum.md)
|
225
234
|
- [MergeAccountingClient::InvoiceTypeEnum](docs/InvoiceTypeEnum.md)
|
226
235
|
- [MergeAccountingClient::Issue](docs/Issue.md)
|
227
236
|
- [MergeAccountingClient::IssueStatusEnum](docs/IssueStatusEnum.md)
|
@@ -247,6 +256,8 @@ Class | Method | HTTP request | Description
|
|
247
256
|
- [MergeAccountingClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
|
248
257
|
- [MergeAccountingClient::PaginatedAccountList](docs/PaginatedAccountList.md)
|
249
258
|
- [MergeAccountingClient::PaginatedAccountingAttachmentList](docs/PaginatedAccountingAttachmentList.md)
|
259
|
+
- [MergeAccountingClient::PaginatedAccountingPeriodList](docs/PaginatedAccountingPeriodList.md)
|
260
|
+
- [MergeAccountingClient::PaginatedAuditLogEventList](docs/PaginatedAuditLogEventList.md)
|
250
261
|
- [MergeAccountingClient::PaginatedBalanceSheetList](docs/PaginatedBalanceSheetList.md)
|
251
262
|
- [MergeAccountingClient::PaginatedCashFlowStatementList](docs/PaginatedCashFlowStatementList.md)
|
252
263
|
- [MergeAccountingClient::PaginatedCompanyInfoList](docs/PaginatedCompanyInfoList.md)
|
@@ -268,6 +279,8 @@ Class | Method | HTTP request | Description
|
|
268
279
|
- [MergeAccountingClient::PaginatedVendorCreditList](docs/PaginatedVendorCreditList.md)
|
269
280
|
- [MergeAccountingClient::Payment](docs/Payment.md)
|
270
281
|
- [MergeAccountingClient::PaymentEndpointRequest](docs/PaymentEndpointRequest.md)
|
282
|
+
- [MergeAccountingClient::PaymentLineItem](docs/PaymentLineItem.md)
|
283
|
+
- [MergeAccountingClient::PaymentLineItemRequest](docs/PaymentLineItemRequest.md)
|
271
284
|
- [MergeAccountingClient::PaymentRequest](docs/PaymentRequest.md)
|
272
285
|
- [MergeAccountingClient::PaymentResponse](docs/PaymentResponse.md)
|
273
286
|
- [MergeAccountingClient::PostingStatusEnum](docs/PostingStatusEnum.md)
|
@@ -285,6 +298,7 @@ Class | Method | HTTP request | Description
|
|
285
298
|
- [MergeAccountingClient::ReportItem](docs/ReportItem.md)
|
286
299
|
- [MergeAccountingClient::RequestFormatEnum](docs/RequestFormatEnum.md)
|
287
300
|
- [MergeAccountingClient::ResponseTypeEnum](docs/ResponseTypeEnum.md)
|
301
|
+
- [MergeAccountingClient::RoleEnum](docs/RoleEnum.md)
|
288
302
|
- [MergeAccountingClient::SelectiveSyncConfigurationsUsageEnum](docs/SelectiveSyncConfigurationsUsageEnum.md)
|
289
303
|
- [MergeAccountingClient::Status7d1Enum](docs/Status7d1Enum.md)
|
290
304
|
- [MergeAccountingClient::SyncStatus](docs/SyncStatus.md)
|
data/docs/Account.md
CHANGED
@@ -16,7 +16,8 @@
|
|
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] |
|
20
21
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
21
22
|
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
22
23
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
@@ -40,6 +41,7 @@ instance = MergeAccountingClient::Account.new(
|
|
40
41
|
parent_account: 22d92d6c-22f9-11ed-861d-0242ac120002,
|
41
42
|
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
42
43
|
remote_was_deleted: null,
|
44
|
+
created_at: 2021-09-15T00:00Z,
|
43
45
|
modified_at: 2021-10-16T00:00Z,
|
44
46
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
45
47
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
data/docs/AccountIntegration.md
CHANGED
@@ -5,13 +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
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
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] |
|
15
16
|
|
16
17
|
## Example
|
17
18
|
|
@@ -26,7 +27,8 @@ instance = MergeAccountingClient::AccountIntegration.new(
|
|
26
27
|
color: null,
|
27
28
|
slug: null,
|
28
29
|
is_in_beta: null,
|
29
|
-
api_endpoints_to_documentation_urls: null
|
30
|
+
api_endpoints_to_documentation_urls: null,
|
31
|
+
webhook_setup_guide_url: null
|
30
32
|
)
|
31
33
|
```
|
32
34
|
|
@@ -9,7 +9,8 @@
|
|
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] |
|
13
14
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
14
15
|
| **field_mappings** | [**Hash<String, AnyType>**](AnyType.md) | | [optional][readonly] |
|
15
16
|
| **remote_data** | [**Array<RemoteData>**](RemoteData.md) | | [optional][readonly] |
|
@@ -26,6 +27,7 @@ instance = MergeAccountingClient::AccountingAttachment.new(
|
|
26
27
|
file_url: https://merge-brand.s3.amazonaws.com/20210315/rect-logo-270x80%402x.png,
|
27
28
|
company: 595c8f97-2ac4-45b7-b000-41bdf43240b5,
|
28
29
|
remote_was_deleted: null,
|
30
|
+
created_at: 2021-09-15T00:00Z,
|
29
31
|
modified_at: 2021-10-16T00:00Z,
|
30
32
|
field_mappings: {"organization_defined_targets":{"custom_key":"custom_value"},"linked_account_defined_targets":{"custom_key":"custom_value"}},
|
31
33
|
remote_data: [{"path":"/actions","data":["Varies by platform"]}]
|
@@ -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,7 @@
|
|
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] |
|
9
10
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
10
11
|
|
11
12
|
## Example
|
@@ -16,6 +17,7 @@ require 'merge_accounting_client'
|
|
16
17
|
instance = MergeAccountingClient::AccountingPhoneNumber.new(
|
17
18
|
number: +3198675309,
|
18
19
|
type: Mobile,
|
20
|
+
created_at: 2021-09-15T00:00Z,
|
19
21
|
modified_at: 2021-10-16T00:00Z
|
20
22
|
)
|
21
23
|
```
|
data/docs/Address.md
CHANGED
@@ -12,6 +12,7 @@
|
|
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] |
|
15
16
|
| **modified_at** | **Time** | This is the datetime that this object was last updated by Merge | [optional][readonly] |
|
16
17
|
|
17
18
|
## Example
|
@@ -28,6 +29,7 @@ instance = MergeAccountingClient::Address.new(
|
|
28
29
|
country_subdivision: NY,
|
29
30
|
country: US,
|
30
31
|
zip_code: 10027,
|
32
|
+
created_at: 2021-09-15T00:00Z,
|
31
33
|
modified_at: 2021-10-16T00:00Z
|
32
34
|
)
|
33
35
|
```
|
@@ -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,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
|
+
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# MergeAccountingClient::AuditTrailApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.merge.dev/api/accounting/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**audit_trail_list**](AuditTrailApi.md#audit_trail_list) | **GET** /audit-trail | |
|
8
|
+
|
9
|
+
|
10
|
+
## audit_trail_list
|
11
|
+
|
12
|
+
> <PaginatedAuditLogEventList> audit_trail_list(opts)
|
13
|
+
|
14
|
+
|
15
|
+
|
16
|
+
Gets a list of audit trail events.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'merge_accounting_client'
|
23
|
+
# setup authorization
|
24
|
+
MergeAccountingClient.configure do |config|
|
25
|
+
# Configure API key authorization: tokenAuth
|
26
|
+
config.api_key['tokenAuth'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
# config.api_key_prefix['tokenAuth'] = 'Bearer'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = MergeAccountingClient::AuditTrailApi.new
|
32
|
+
opts = {
|
33
|
+
cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
|
34
|
+
end_date: 'end_date_example', # String | If included, will only include audit trail events that occured before this time
|
35
|
+
event_type: 'event_type_example', # String | If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`
|
36
|
+
page_size: 56, # Integer | Number of results to return per page.
|
37
|
+
start_date: 'start_date_example', # String | If included, will only include audit trail events that occured after this time
|
38
|
+
user_email: 'user_email_example' # String | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
|
39
|
+
}
|
40
|
+
|
41
|
+
begin
|
42
|
+
|
43
|
+
result = api_instance.audit_trail_list(opts)
|
44
|
+
p result
|
45
|
+
rescue MergeAccountingClient::ApiError => e
|
46
|
+
puts "Error when calling AuditTrailApi->audit_trail_list: #{e}"
|
47
|
+
end
|
48
|
+
```
|
49
|
+
|
50
|
+
#### Using the audit_trail_list_with_http_info variant
|
51
|
+
|
52
|
+
This returns an Array which contains the response data, status code and headers.
|
53
|
+
|
54
|
+
> <Array(<PaginatedAuditLogEventList>, Integer, Hash)> audit_trail_list_with_http_info(opts)
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
begin
|
58
|
+
|
59
|
+
data, status_code, headers = api_instance.audit_trail_list_with_http_info(opts)
|
60
|
+
p status_code # => 2xx
|
61
|
+
p headers # => { ... }
|
62
|
+
p data # => <PaginatedAuditLogEventList>
|
63
|
+
rescue MergeAccountingClient::ApiError => e
|
64
|
+
puts "Error when calling AuditTrailApi->audit_trail_list_with_http_info: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
| Name | Type | Description | Notes |
|
71
|
+
| ---- | ---- | ----------- | ----- |
|
72
|
+
| **cursor** | **String** | The pagination cursor value. | [optional] |
|
73
|
+
| **end_date** | **String** | If included, will only include audit trail events that occured before this time | [optional] |
|
74
|
+
| **event_type** | **String** | If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT` | [optional] |
|
75
|
+
| **page_size** | **Integer** | Number of results to return per page. | [optional] |
|
76
|
+
| **start_date** | **String** | If included, will only include audit trail events that occured after this time | [optional] |
|
77
|
+
| **user_email** | **String** | If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. | [optional] |
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**PaginatedAuditLogEventList**](PaginatedAuditLogEventList.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[tokenAuth](../README.md#tokenAuth)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: Not defined
|
90
|
+
- **Accept**: application/json
|
91
|
+
|