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.
Files changed (182) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -4
  3. data/docs/Account.md +3 -1
  4. data/docs/AccountIntegration.md +4 -2
  5. data/docs/AccountingAttachment.md +3 -1
  6. data/docs/AccountingPeriod.md +30 -0
  7. data/docs/AccountingPeriodStatusEnum.md +15 -0
  8. data/docs/AccountingPeriodsApi.md +167 -0
  9. data/docs/AccountingPhoneNumber.md +2 -0
  10. data/docs/Address.md +2 -0
  11. data/docs/AddressRequest.md +34 -0
  12. data/docs/AuditLogEvent.md +32 -0
  13. data/docs/AuditTrailApi.md +91 -0
  14. data/docs/BalanceSheet.md +3 -1
  15. data/docs/CashFlowStatement.md +3 -1
  16. data/docs/CompanyInfo.md +3 -1
  17. data/docs/Contact.md +4 -2
  18. data/docs/ContactRequest.md +1 -1
  19. data/docs/ContactsApi.md +4 -0
  20. data/docs/CreditNote.md +8 -2
  21. data/docs/CreditNoteLineItem.md +6 -0
  22. data/docs/CreditNotesApi.md +2 -2
  23. data/docs/EndUserDetailsRequest.md +1 -1
  24. data/docs/EventTypeEnum.md +15 -0
  25. data/docs/Expense.md +10 -2
  26. data/docs/ExpenseLine.md +8 -0
  27. data/docs/ExpenseLineRequest.md +2 -0
  28. data/docs/ExpenseRequest.md +7 -1
  29. data/docs/IncomeStatement.md +3 -1
  30. data/docs/Invoice.md +11 -1
  31. data/docs/InvoiceLineItem.md +5 -1
  32. data/docs/InvoiceRequest.md +4 -0
  33. data/docs/InvoiceStatusEnum.md +15 -0
  34. data/docs/InvoicesApi.md +2 -2
  35. data/docs/Issue.md +1 -1
  36. data/docs/Item.md +3 -1
  37. data/docs/JournalEntriesApi.md +2 -2
  38. data/docs/JournalEntry.md +9 -1
  39. data/docs/JournalEntryRequest.md +4 -0
  40. data/docs/JournalLine.md +10 -0
  41. data/docs/JournalLineRequest.md +4 -0
  42. data/docs/LinkedAccountsApi.md +2 -2
  43. data/docs/MetaResponse.md +2 -2
  44. data/docs/PaginatedAccountingPeriodList.md +22 -0
  45. data/docs/PaginatedAuditLogEventList.md +22 -0
  46. data/docs/Payment.md +7 -1
  47. data/docs/PaymentLineItem.md +32 -0
  48. data/docs/PaymentLineItemRequest.md +30 -0
  49. data/docs/PaymentRequest.md +4 -0
  50. data/docs/PurchaseOrder.md +9 -3
  51. data/docs/PurchaseOrderLineItem.md +6 -0
  52. data/docs/PurchaseOrderRequest.md +2 -0
  53. data/docs/PurchaseOrdersApi.md +2 -2
  54. data/docs/ReportItem.md +2 -0
  55. data/docs/RoleEnum.md +15 -0
  56. data/docs/SyncStatusApi.md +1 -1
  57. data/docs/TaxRate.md +3 -1
  58. data/docs/TrackingCategory.md +3 -1
  59. data/docs/Transaction.md +7 -3
  60. data/docs/TransactionLineItem.md +6 -0
  61. data/docs/VendorCredit.md +6 -2
  62. data/docs/VendorCreditLine.md +6 -0
  63. data/docs/VendorCreditsApi.md +2 -2
  64. data/lib/merge_accounting_client/api/accounting_periods_api.rb +167 -0
  65. data/lib/merge_accounting_client/api/audit_trail_api.rb +95 -0
  66. data/lib/merge_accounting_client/api/contacts_api.rb +6 -0
  67. data/lib/merge_accounting_client/api/credit_notes_api.rb +2 -2
  68. data/lib/merge_accounting_client/api/expenses_api.rb +2 -2
  69. data/lib/merge_accounting_client/api/invoices_api.rb +2 -2
  70. data/lib/merge_accounting_client/api/journal_entries_api.rb +2 -2
  71. data/lib/merge_accounting_client/api/linked_accounts_api.rb +3 -3
  72. data/lib/merge_accounting_client/api/payments_api.rb +2 -2
  73. data/lib/merge_accounting_client/api/purchase_orders_api.rb +2 -2
  74. data/lib/merge_accounting_client/api/sync_status_api.rb +2 -2
  75. data/lib/merge_accounting_client/api/transactions_api.rb +2 -2
  76. data/lib/merge_accounting_client/api/vendor_credits_api.rb +2 -2
  77. data/lib/merge_accounting_client/configuration.rb +4 -0
  78. data/lib/merge_accounting_client/models/account.rb +12 -3
  79. data/lib/merge_accounting_client/models/account_integration.rb +15 -4
  80. data/lib/merge_accounting_client/models/account_request.rb +1 -1
  81. data/lib/merge_accounting_client/models/accounting_attachment.rb +11 -2
  82. data/lib/merge_accounting_client/models/accounting_period.rb +296 -0
  83. data/lib/merge_accounting_client/models/accounting_period_status_enum.rb +45 -0
  84. data/lib/merge_accounting_client/models/accounting_phone_number.rb +10 -1
  85. data/lib/merge_accounting_client/models/address.rb +10 -1
  86. data/lib/merge_accounting_client/models/address_request.rb +311 -0
  87. data/lib/merge_accounting_client/models/audit_log_event.rb +356 -0
  88. data/lib/merge_accounting_client/models/balance_sheet.rb +11 -2
  89. data/lib/merge_accounting_client/models/cash_flow_statement.rb +11 -2
  90. data/lib/merge_accounting_client/models/company_info.rb +12 -3
  91. data/lib/merge_accounting_client/models/contact.rb +13 -4
  92. data/lib/merge_accounting_client/models/contact_request.rb +2 -2
  93. data/lib/merge_accounting_client/models/credit_note.rb +35 -3
  94. data/lib/merge_accounting_client/models/credit_note_line_item.rb +29 -1
  95. data/lib/merge_accounting_client/models/end_user_details_request.rb +1 -1
  96. data/lib/merge_accounting_client/models/event_type_enum.rb +67 -0
  97. data/lib/merge_accounting_client/models/expense.rb +45 -3
  98. data/lib/merge_accounting_client/models/expense_line.rb +40 -1
  99. data/lib/merge_accounting_client/models/expense_line_request.rb +12 -1
  100. data/lib/merge_accounting_client/models/expense_request.rb +35 -2
  101. data/lib/merge_accounting_client/models/income_statement.rb +11 -2
  102. data/lib/merge_accounting_client/models/invoice.rb +55 -1
  103. data/lib/merge_accounting_client/models/invoice_line_item.rb +20 -1
  104. data/lib/merge_accounting_client/models/invoice_request.rb +23 -1
  105. data/lib/merge_accounting_client/models/invoice_status_enum.rb +49 -0
  106. data/lib/merge_accounting_client/models/item.rb +11 -2
  107. data/lib/merge_accounting_client/models/journal_entry.rb +60 -2
  108. data/lib/merge_accounting_client/models/journal_entry_request.rb +38 -1
  109. data/lib/merge_accounting_client/models/journal_line.rb +51 -1
  110. data/lib/merge_accounting_client/models/journal_line_request.rb +23 -1
  111. data/lib/merge_accounting_client/models/paginated_accounting_period_list.rb +240 -0
  112. data/lib/merge_accounting_client/models/paginated_audit_log_event_list.rb +240 -0
  113. data/lib/merge_accounting_client/models/payment.rb +34 -2
  114. data/lib/merge_accounting_client/models/payment_line_item.rb +308 -0
  115. data/lib/merge_accounting_client/models/payment_line_item_request.rb +319 -0
  116. data/lib/merge_accounting_client/models/payment_request.rb +24 -1
  117. data/lib/merge_accounting_client/models/purchase_order.rb +49 -3
  118. data/lib/merge_accounting_client/models/purchase_order_line_item.rb +29 -1
  119. data/lib/merge_accounting_client/models/purchase_order_request.rb +12 -1
  120. data/lib/merge_accounting_client/models/report_item.rb +10 -1
  121. data/lib/merge_accounting_client/models/role_enum.rb +49 -0
  122. data/lib/merge_accounting_client/models/tax_rate.rb +11 -2
  123. data/lib/merge_accounting_client/models/tracking_category.rb +12 -3
  124. data/lib/merge_accounting_client/models/transaction.rb +23 -3
  125. data/lib/merge_accounting_client/models/transaction_line_item.rb +29 -1
  126. data/lib/merge_accounting_client/models/vendor_credit.rb +23 -3
  127. data/lib/merge_accounting_client/models/vendor_credit_line.rb +29 -1
  128. data/lib/merge_accounting_client/version.rb +1 -1
  129. data/lib/merge_accounting_client.rb +13 -9
  130. data/spec/api/accounting_periods_api_spec.rb +63 -0
  131. data/spec/api/audit_trail_api_spec.rb +51 -0
  132. data/spec/api/contacts_api_spec.rb +2 -0
  133. data/spec/api/linked_accounts_api_spec.rb +1 -1
  134. data/spec/api/sync_status_api_spec.rb +1 -1
  135. data/spec/models/account_integration_spec.rb +6 -0
  136. data/spec/models/account_spec.rb +6 -0
  137. data/spec/models/accounting_attachment_spec.rb +6 -0
  138. data/spec/models/accounting_period_spec.rb +70 -0
  139. data/spec/models/accounting_period_status_enum_spec.rb +28 -0
  140. data/spec/models/accounting_phone_number_spec.rb +6 -0
  141. data/spec/models/address_request_spec.rb +82 -0
  142. data/spec/models/address_spec.rb +6 -0
  143. data/spec/models/audit_log_event_spec.rb +76 -0
  144. data/spec/models/balance_sheet_spec.rb +6 -0
  145. data/spec/models/cash_flow_statement_spec.rb +6 -0
  146. data/spec/models/company_info_spec.rb +6 -0
  147. data/spec/models/contact_spec.rb +6 -0
  148. data/spec/models/credit_note_line_item_spec.rb +18 -0
  149. data/spec/models/credit_note_spec.rb +18 -0
  150. data/spec/models/event_type_enum_spec.rb +28 -0
  151. data/spec/models/expense_line_request_spec.rb +6 -0
  152. data/spec/models/expense_line_spec.rb +24 -0
  153. data/spec/models/expense_request_spec.rb +18 -0
  154. data/spec/models/expense_spec.rb +24 -0
  155. data/spec/models/income_statement_spec.rb +6 -0
  156. data/spec/models/invoice_line_item_spec.rb +12 -0
  157. data/spec/models/invoice_request_spec.rb +12 -0
  158. data/spec/models/invoice_spec.rb +30 -0
  159. data/spec/models/invoice_status_enum_spec.rb +28 -0
  160. data/spec/models/item_spec.rb +6 -0
  161. data/spec/models/journal_entry_request_spec.rb +12 -0
  162. data/spec/models/journal_entry_spec.rb +24 -0
  163. data/spec/models/journal_line_request_spec.rb +12 -0
  164. data/spec/models/journal_line_spec.rb +30 -0
  165. data/spec/models/paginated_accounting_period_list_spec.rb +46 -0
  166. data/spec/models/paginated_audit_log_event_list_spec.rb +46 -0
  167. data/spec/models/payment_line_item_request_spec.rb +70 -0
  168. data/spec/models/payment_line_item_spec.rb +76 -0
  169. data/spec/models/payment_request_spec.rb +12 -0
  170. data/spec/models/payment_spec.rb +18 -0
  171. data/spec/models/purchase_order_line_item_spec.rb +18 -0
  172. data/spec/models/purchase_order_request_spec.rb +6 -0
  173. data/spec/models/purchase_order_spec.rb +18 -0
  174. data/spec/models/report_item_spec.rb +6 -0
  175. data/spec/models/role_enum_spec.rb +28 -0
  176. data/spec/models/tax_rate_spec.rb +6 -0
  177. data/spec/models/tracking_category_spec.rb +6 -0
  178. data/spec/models/transaction_line_item_spec.rb +18 -0
  179. data/spec/models/transaction_spec.rb +12 -0
  180. data/spec/models/vendor_credit_line_spec.rb +18 -0
  181. data/spec/models/vendor_credit_spec.rb +12 -0
  182. metadata +204 -152
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 518b3d7fce2496b36f8504c872a0057095c15cdcf5274d254ad7e431963928e1
4
- data.tar.gz: d2a2bc91725813146eca6f7fb4bfc5eeceb5f6f44d758807e256d570738bf267
3
+ metadata.gz: 13739efe5e3de6ee34f4ec419b330adbe24ddc7dec14148b0453b8a496811c6b
4
+ data.tar.gz: 5d6eb87cb197638aea402d51a06169abe2862cc56af4247feded1336678e080f
5
5
  SHA512:
6
- metadata.gz: f005f4c033e66fcafabe076686835991475d4698889d92e213f5475dc4356d1c97e1aea38ac6f506095395e121030c7ba4bdc72f015465dfdae0c1a82701ccca
7
- data.tar.gz: 0c4bc7cf9d32d27ae28ef6de832a2a5e516c79c8d9639da75e5b87fe977f21e3fc7fa11da29b01e38ab8e2c0785cb6b6f4bee3a4cd0858888ba58448993dee08
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.9
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.9.gem
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.9.gem` to install the development dependencies)
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.9'
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 by third party webhooks. | [optional][readonly] |
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"]}]
@@ -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 by third party webhooks. | [optional][readonly] |
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&#39;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&#39;s state or region. | [optional] |
13
13
  | **country** | [**CountryEnum**](CountryEnum.md) | The address&#39;s country. * &#x60;AF&#x60; - Afghanistan * &#x60;AX&#x60; - Åland Islands * &#x60;AL&#x60; - Albania * &#x60;DZ&#x60; - Algeria * &#x60;AS&#x60; - American Samoa * &#x60;AD&#x60; - Andorra * &#x60;AO&#x60; - Angola * &#x60;AI&#x60; - Anguilla * &#x60;AQ&#x60; - Antarctica * &#x60;AG&#x60; - Antigua and Barbuda * &#x60;AR&#x60; - Argentina * &#x60;AM&#x60; - Armenia * &#x60;AW&#x60; - Aruba * &#x60;AU&#x60; - Australia * &#x60;AT&#x60; - Austria * &#x60;AZ&#x60; - Azerbaijan * &#x60;BS&#x60; - Bahamas * &#x60;BH&#x60; - Bahrain * &#x60;BD&#x60; - Bangladesh * &#x60;BB&#x60; - Barbados * &#x60;BY&#x60; - Belarus * &#x60;BE&#x60; - Belgium * &#x60;BZ&#x60; - Belize * &#x60;BJ&#x60; - Benin * &#x60;BM&#x60; - Bermuda * &#x60;BT&#x60; - Bhutan * &#x60;BO&#x60; - Bolivia * &#x60;BQ&#x60; - Bonaire, Sint Eustatius and Saba * &#x60;BA&#x60; - Bosnia and Herzegovina * &#x60;BW&#x60; - Botswana * &#x60;BV&#x60; - Bouvet Island * &#x60;BR&#x60; - Brazil * &#x60;IO&#x60; - British Indian Ocean Territory * &#x60;BN&#x60; - Brunei * &#x60;BG&#x60; - Bulgaria * &#x60;BF&#x60; - Burkina Faso * &#x60;BI&#x60; - Burundi * &#x60;CV&#x60; - Cabo Verde * &#x60;KH&#x60; - Cambodia * &#x60;CM&#x60; - Cameroon * &#x60;CA&#x60; - Canada * &#x60;KY&#x60; - Cayman Islands * &#x60;CF&#x60; - Central African Republic * &#x60;TD&#x60; - Chad * &#x60;CL&#x60; - Chile * &#x60;CN&#x60; - China * &#x60;CX&#x60; - Christmas Island * &#x60;CC&#x60; - Cocos (Keeling) Islands * &#x60;CO&#x60; - Colombia * &#x60;KM&#x60; - Comoros * &#x60;CG&#x60; - Congo * &#x60;CD&#x60; - Congo (the Democratic Republic of the) * &#x60;CK&#x60; - Cook Islands * &#x60;CR&#x60; - Costa Rica * &#x60;CI&#x60; - Côte d&#39;Ivoire * &#x60;HR&#x60; - Croatia * &#x60;CU&#x60; - Cuba * &#x60;CW&#x60; - Curaçao * &#x60;CY&#x60; - Cyprus * &#x60;CZ&#x60; - Czechia * &#x60;DK&#x60; - Denmark * &#x60;DJ&#x60; - Djibouti * &#x60;DM&#x60; - Dominica * &#x60;DO&#x60; - Dominican Republic * &#x60;EC&#x60; - Ecuador * &#x60;EG&#x60; - Egypt * &#x60;SV&#x60; - El Salvador * &#x60;GQ&#x60; - Equatorial Guinea * &#x60;ER&#x60; - Eritrea * &#x60;EE&#x60; - Estonia * &#x60;SZ&#x60; - Eswatini * &#x60;ET&#x60; - Ethiopia * &#x60;FK&#x60; - Falkland Islands (Malvinas) * &#x60;FO&#x60; - Faroe Islands * &#x60;FJ&#x60; - Fiji * &#x60;FI&#x60; - Finland * &#x60;FR&#x60; - France * &#x60;GF&#x60; - French Guiana * &#x60;PF&#x60; - French Polynesia * &#x60;TF&#x60; - French Southern Territories * &#x60;GA&#x60; - Gabon * &#x60;GM&#x60; - Gambia * &#x60;GE&#x60; - Georgia * &#x60;DE&#x60; - Germany * &#x60;GH&#x60; - Ghana * &#x60;GI&#x60; - Gibraltar * &#x60;GR&#x60; - Greece * &#x60;GL&#x60; - Greenland * &#x60;GD&#x60; - Grenada * &#x60;GP&#x60; - Guadeloupe * &#x60;GU&#x60; - Guam * &#x60;GT&#x60; - Guatemala * &#x60;GG&#x60; - Guernsey * &#x60;GN&#x60; - Guinea * &#x60;GW&#x60; - Guinea-Bissau * &#x60;GY&#x60; - Guyana * &#x60;HT&#x60; - Haiti * &#x60;HM&#x60; - Heard Island and McDonald Islands * &#x60;VA&#x60; - Holy See * &#x60;HN&#x60; - Honduras * &#x60;HK&#x60; - Hong Kong * &#x60;HU&#x60; - Hungary * &#x60;IS&#x60; - Iceland * &#x60;IN&#x60; - India * &#x60;ID&#x60; - Indonesia * &#x60;IR&#x60; - Iran * &#x60;IQ&#x60; - Iraq * &#x60;IE&#x60; - Ireland * &#x60;IM&#x60; - Isle of Man * &#x60;IL&#x60; - Israel * &#x60;IT&#x60; - Italy * &#x60;JM&#x60; - Jamaica * &#x60;JP&#x60; - Japan * &#x60;JE&#x60; - Jersey * &#x60;JO&#x60; - Jordan * &#x60;KZ&#x60; - Kazakhstan * &#x60;KE&#x60; - Kenya * &#x60;KI&#x60; - Kiribati * &#x60;KW&#x60; - Kuwait * &#x60;KG&#x60; - Kyrgyzstan * &#x60;LA&#x60; - Laos * &#x60;LV&#x60; - Latvia * &#x60;LB&#x60; - Lebanon * &#x60;LS&#x60; - Lesotho * &#x60;LR&#x60; - Liberia * &#x60;LY&#x60; - Libya * &#x60;LI&#x60; - Liechtenstein * &#x60;LT&#x60; - Lithuania * &#x60;LU&#x60; - Luxembourg * &#x60;MO&#x60; - Macao * &#x60;MG&#x60; - Madagascar * &#x60;MW&#x60; - Malawi * &#x60;MY&#x60; - Malaysia * &#x60;MV&#x60; - Maldives * &#x60;ML&#x60; - Mali * &#x60;MT&#x60; - Malta * &#x60;MH&#x60; - Marshall Islands * &#x60;MQ&#x60; - Martinique * &#x60;MR&#x60; - Mauritania * &#x60;MU&#x60; - Mauritius * &#x60;YT&#x60; - Mayotte * &#x60;MX&#x60; - Mexico * &#x60;FM&#x60; - Micronesia (Federated States of) * &#x60;MD&#x60; - Moldova * &#x60;MC&#x60; - Monaco * &#x60;MN&#x60; - Mongolia * &#x60;ME&#x60; - Montenegro * &#x60;MS&#x60; - Montserrat * &#x60;MA&#x60; - Morocco * &#x60;MZ&#x60; - Mozambique * &#x60;MM&#x60; - Myanmar * &#x60;NA&#x60; - Namibia * &#x60;NR&#x60; - Nauru * &#x60;NP&#x60; - Nepal * &#x60;NL&#x60; - Netherlands * &#x60;NC&#x60; - New Caledonia * &#x60;NZ&#x60; - New Zealand * &#x60;NI&#x60; - Nicaragua * &#x60;NE&#x60; - Niger * &#x60;NG&#x60; - Nigeria * &#x60;NU&#x60; - Niue * &#x60;NF&#x60; - Norfolk Island * &#x60;KP&#x60; - North Korea * &#x60;MK&#x60; - North Macedonia * &#x60;MP&#x60; - Northern Mariana Islands * &#x60;NO&#x60; - Norway * &#x60;OM&#x60; - Oman * &#x60;PK&#x60; - Pakistan * &#x60;PW&#x60; - Palau * &#x60;PS&#x60; - Palestine, State of * &#x60;PA&#x60; - Panama * &#x60;PG&#x60; - Papua New Guinea * &#x60;PY&#x60; - Paraguay * &#x60;PE&#x60; - Peru * &#x60;PH&#x60; - Philippines * &#x60;PN&#x60; - Pitcairn * &#x60;PL&#x60; - Poland * &#x60;PT&#x60; - Portugal * &#x60;PR&#x60; - Puerto Rico * &#x60;QA&#x60; - Qatar * &#x60;RE&#x60; - Réunion * &#x60;RO&#x60; - Romania * &#x60;RU&#x60; - Russia * &#x60;RW&#x60; - Rwanda * &#x60;BL&#x60; - Saint Barthélemy * &#x60;SH&#x60; - Saint Helena, Ascension and Tristan da Cunha * &#x60;KN&#x60; - Saint Kitts and Nevis * &#x60;LC&#x60; - Saint Lucia * &#x60;MF&#x60; - Saint Martin (French part) * &#x60;PM&#x60; - Saint Pierre and Miquelon * &#x60;VC&#x60; - Saint Vincent and the Grenadines * &#x60;WS&#x60; - Samoa * &#x60;SM&#x60; - San Marino * &#x60;ST&#x60; - Sao Tome and Principe * &#x60;SA&#x60; - Saudi Arabia * &#x60;SN&#x60; - Senegal * &#x60;RS&#x60; - Serbia * &#x60;SC&#x60; - Seychelles * &#x60;SL&#x60; - Sierra Leone * &#x60;SG&#x60; - Singapore * &#x60;SX&#x60; - Sint Maarten (Dutch part) * &#x60;SK&#x60; - Slovakia * &#x60;SI&#x60; - Slovenia * &#x60;SB&#x60; - Solomon Islands * &#x60;SO&#x60; - Somalia * &#x60;ZA&#x60; - South Africa * &#x60;GS&#x60; - South Georgia and the South Sandwich Islands * &#x60;KR&#x60; - South Korea * &#x60;SS&#x60; - South Sudan * &#x60;ES&#x60; - Spain * &#x60;LK&#x60; - Sri Lanka * &#x60;SD&#x60; - Sudan * &#x60;SR&#x60; - Suriname * &#x60;SJ&#x60; - Svalbard and Jan Mayen * &#x60;SE&#x60; - Sweden * &#x60;CH&#x60; - Switzerland * &#x60;SY&#x60; - Syria * &#x60;TW&#x60; - Taiwan * &#x60;TJ&#x60; - Tajikistan * &#x60;TZ&#x60; - Tanzania * &#x60;TH&#x60; - Thailand * &#x60;TL&#x60; - Timor-Leste * &#x60;TG&#x60; - Togo * &#x60;TK&#x60; - Tokelau * &#x60;TO&#x60; - Tonga * &#x60;TT&#x60; - Trinidad and Tobago * &#x60;TN&#x60; - Tunisia * &#x60;TR&#x60; - Turkey * &#x60;TM&#x60; - Turkmenistan * &#x60;TC&#x60; - Turks and Caicos Islands * &#x60;TV&#x60; - Tuvalu * &#x60;UG&#x60; - Uganda * &#x60;UA&#x60; - Ukraine * &#x60;AE&#x60; - United Arab Emirates * &#x60;GB&#x60; - United Kingdom * &#x60;UM&#x60; - United States Minor Outlying Islands * &#x60;US&#x60; - United States of America * &#x60;UY&#x60; - Uruguay * &#x60;UZ&#x60; - Uzbekistan * &#x60;VU&#x60; - Vanuatu * &#x60;VE&#x60; - Venezuela * &#x60;VN&#x60; - Vietnam * &#x60;VG&#x60; - Virgin Islands (British) * &#x60;VI&#x60; - Virgin Islands (U.S.) * &#x60;WF&#x60; - Wallis and Futuna * &#x60;EH&#x60; - Western Sahara * &#x60;YE&#x60; - Yemen * &#x60;ZM&#x60; - Zambia * &#x60;ZW&#x60; - Zimbabwe | [optional] |
14
14
  | **zip_code** | **String** | The address&#39;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. * &#x60;BILLING&#x60; - BILLING * &#x60;SHIPPING&#x60; - SHIPPING | [optional] |
8
+ | **street_1** | **String** | Line 1 of the address&#39;s street. | [optional] |
9
+ | **street_2** | **String** | Line 2 of the address&#39;s street. | [optional] |
10
+ | **city** | **String** | The address&#39;s city. | [optional] |
11
+ | **country_subdivision** | **String** | The address&#39;s state or region. | [optional] |
12
+ | **country** | [**CountryEnum**](CountryEnum.md) | The address&#39;s country. * &#x60;AF&#x60; - Afghanistan * &#x60;AX&#x60; - Åland Islands * &#x60;AL&#x60; - Albania * &#x60;DZ&#x60; - Algeria * &#x60;AS&#x60; - American Samoa * &#x60;AD&#x60; - Andorra * &#x60;AO&#x60; - Angola * &#x60;AI&#x60; - Anguilla * &#x60;AQ&#x60; - Antarctica * &#x60;AG&#x60; - Antigua and Barbuda * &#x60;AR&#x60; - Argentina * &#x60;AM&#x60; - Armenia * &#x60;AW&#x60; - Aruba * &#x60;AU&#x60; - Australia * &#x60;AT&#x60; - Austria * &#x60;AZ&#x60; - Azerbaijan * &#x60;BS&#x60; - Bahamas * &#x60;BH&#x60; - Bahrain * &#x60;BD&#x60; - Bangladesh * &#x60;BB&#x60; - Barbados * &#x60;BY&#x60; - Belarus * &#x60;BE&#x60; - Belgium * &#x60;BZ&#x60; - Belize * &#x60;BJ&#x60; - Benin * &#x60;BM&#x60; - Bermuda * &#x60;BT&#x60; - Bhutan * &#x60;BO&#x60; - Bolivia * &#x60;BQ&#x60; - Bonaire, Sint Eustatius and Saba * &#x60;BA&#x60; - Bosnia and Herzegovina * &#x60;BW&#x60; - Botswana * &#x60;BV&#x60; - Bouvet Island * &#x60;BR&#x60; - Brazil * &#x60;IO&#x60; - British Indian Ocean Territory * &#x60;BN&#x60; - Brunei * &#x60;BG&#x60; - Bulgaria * &#x60;BF&#x60; - Burkina Faso * &#x60;BI&#x60; - Burundi * &#x60;CV&#x60; - Cabo Verde * &#x60;KH&#x60; - Cambodia * &#x60;CM&#x60; - Cameroon * &#x60;CA&#x60; - Canada * &#x60;KY&#x60; - Cayman Islands * &#x60;CF&#x60; - Central African Republic * &#x60;TD&#x60; - Chad * &#x60;CL&#x60; - Chile * &#x60;CN&#x60; - China * &#x60;CX&#x60; - Christmas Island * &#x60;CC&#x60; - Cocos (Keeling) Islands * &#x60;CO&#x60; - Colombia * &#x60;KM&#x60; - Comoros * &#x60;CG&#x60; - Congo * &#x60;CD&#x60; - Congo (the Democratic Republic of the) * &#x60;CK&#x60; - Cook Islands * &#x60;CR&#x60; - Costa Rica * &#x60;CI&#x60; - Côte d&#39;Ivoire * &#x60;HR&#x60; - Croatia * &#x60;CU&#x60; - Cuba * &#x60;CW&#x60; - Curaçao * &#x60;CY&#x60; - Cyprus * &#x60;CZ&#x60; - Czechia * &#x60;DK&#x60; - Denmark * &#x60;DJ&#x60; - Djibouti * &#x60;DM&#x60; - Dominica * &#x60;DO&#x60; - Dominican Republic * &#x60;EC&#x60; - Ecuador * &#x60;EG&#x60; - Egypt * &#x60;SV&#x60; - El Salvador * &#x60;GQ&#x60; - Equatorial Guinea * &#x60;ER&#x60; - Eritrea * &#x60;EE&#x60; - Estonia * &#x60;SZ&#x60; - Eswatini * &#x60;ET&#x60; - Ethiopia * &#x60;FK&#x60; - Falkland Islands (Malvinas) * &#x60;FO&#x60; - Faroe Islands * &#x60;FJ&#x60; - Fiji * &#x60;FI&#x60; - Finland * &#x60;FR&#x60; - France * &#x60;GF&#x60; - French Guiana * &#x60;PF&#x60; - French Polynesia * &#x60;TF&#x60; - French Southern Territories * &#x60;GA&#x60; - Gabon * &#x60;GM&#x60; - Gambia * &#x60;GE&#x60; - Georgia * &#x60;DE&#x60; - Germany * &#x60;GH&#x60; - Ghana * &#x60;GI&#x60; - Gibraltar * &#x60;GR&#x60; - Greece * &#x60;GL&#x60; - Greenland * &#x60;GD&#x60; - Grenada * &#x60;GP&#x60; - Guadeloupe * &#x60;GU&#x60; - Guam * &#x60;GT&#x60; - Guatemala * &#x60;GG&#x60; - Guernsey * &#x60;GN&#x60; - Guinea * &#x60;GW&#x60; - Guinea-Bissau * &#x60;GY&#x60; - Guyana * &#x60;HT&#x60; - Haiti * &#x60;HM&#x60; - Heard Island and McDonald Islands * &#x60;VA&#x60; - Holy See * &#x60;HN&#x60; - Honduras * &#x60;HK&#x60; - Hong Kong * &#x60;HU&#x60; - Hungary * &#x60;IS&#x60; - Iceland * &#x60;IN&#x60; - India * &#x60;ID&#x60; - Indonesia * &#x60;IR&#x60; - Iran * &#x60;IQ&#x60; - Iraq * &#x60;IE&#x60; - Ireland * &#x60;IM&#x60; - Isle of Man * &#x60;IL&#x60; - Israel * &#x60;IT&#x60; - Italy * &#x60;JM&#x60; - Jamaica * &#x60;JP&#x60; - Japan * &#x60;JE&#x60; - Jersey * &#x60;JO&#x60; - Jordan * &#x60;KZ&#x60; - Kazakhstan * &#x60;KE&#x60; - Kenya * &#x60;KI&#x60; - Kiribati * &#x60;KW&#x60; - Kuwait * &#x60;KG&#x60; - Kyrgyzstan * &#x60;LA&#x60; - Laos * &#x60;LV&#x60; - Latvia * &#x60;LB&#x60; - Lebanon * &#x60;LS&#x60; - Lesotho * &#x60;LR&#x60; - Liberia * &#x60;LY&#x60; - Libya * &#x60;LI&#x60; - Liechtenstein * &#x60;LT&#x60; - Lithuania * &#x60;LU&#x60; - Luxembourg * &#x60;MO&#x60; - Macao * &#x60;MG&#x60; - Madagascar * &#x60;MW&#x60; - Malawi * &#x60;MY&#x60; - Malaysia * &#x60;MV&#x60; - Maldives * &#x60;ML&#x60; - Mali * &#x60;MT&#x60; - Malta * &#x60;MH&#x60; - Marshall Islands * &#x60;MQ&#x60; - Martinique * &#x60;MR&#x60; - Mauritania * &#x60;MU&#x60; - Mauritius * &#x60;YT&#x60; - Mayotte * &#x60;MX&#x60; - Mexico * &#x60;FM&#x60; - Micronesia (Federated States of) * &#x60;MD&#x60; - Moldova * &#x60;MC&#x60; - Monaco * &#x60;MN&#x60; - Mongolia * &#x60;ME&#x60; - Montenegro * &#x60;MS&#x60; - Montserrat * &#x60;MA&#x60; - Morocco * &#x60;MZ&#x60; - Mozambique * &#x60;MM&#x60; - Myanmar * &#x60;NA&#x60; - Namibia * &#x60;NR&#x60; - Nauru * &#x60;NP&#x60; - Nepal * &#x60;NL&#x60; - Netherlands * &#x60;NC&#x60; - New Caledonia * &#x60;NZ&#x60; - New Zealand * &#x60;NI&#x60; - Nicaragua * &#x60;NE&#x60; - Niger * &#x60;NG&#x60; - Nigeria * &#x60;NU&#x60; - Niue * &#x60;NF&#x60; - Norfolk Island * &#x60;KP&#x60; - North Korea * &#x60;MK&#x60; - North Macedonia * &#x60;MP&#x60; - Northern Mariana Islands * &#x60;NO&#x60; - Norway * &#x60;OM&#x60; - Oman * &#x60;PK&#x60; - Pakistan * &#x60;PW&#x60; - Palau * &#x60;PS&#x60; - Palestine, State of * &#x60;PA&#x60; - Panama * &#x60;PG&#x60; - Papua New Guinea * &#x60;PY&#x60; - Paraguay * &#x60;PE&#x60; - Peru * &#x60;PH&#x60; - Philippines * &#x60;PN&#x60; - Pitcairn * &#x60;PL&#x60; - Poland * &#x60;PT&#x60; - Portugal * &#x60;PR&#x60; - Puerto Rico * &#x60;QA&#x60; - Qatar * &#x60;RE&#x60; - Réunion * &#x60;RO&#x60; - Romania * &#x60;RU&#x60; - Russia * &#x60;RW&#x60; - Rwanda * &#x60;BL&#x60; - Saint Barthélemy * &#x60;SH&#x60; - Saint Helena, Ascension and Tristan da Cunha * &#x60;KN&#x60; - Saint Kitts and Nevis * &#x60;LC&#x60; - Saint Lucia * &#x60;MF&#x60; - Saint Martin (French part) * &#x60;PM&#x60; - Saint Pierre and Miquelon * &#x60;VC&#x60; - Saint Vincent and the Grenadines * &#x60;WS&#x60; - Samoa * &#x60;SM&#x60; - San Marino * &#x60;ST&#x60; - Sao Tome and Principe * &#x60;SA&#x60; - Saudi Arabia * &#x60;SN&#x60; - Senegal * &#x60;RS&#x60; - Serbia * &#x60;SC&#x60; - Seychelles * &#x60;SL&#x60; - Sierra Leone * &#x60;SG&#x60; - Singapore * &#x60;SX&#x60; - Sint Maarten (Dutch part) * &#x60;SK&#x60; - Slovakia * &#x60;SI&#x60; - Slovenia * &#x60;SB&#x60; - Solomon Islands * &#x60;SO&#x60; - Somalia * &#x60;ZA&#x60; - South Africa * &#x60;GS&#x60; - South Georgia and the South Sandwich Islands * &#x60;KR&#x60; - South Korea * &#x60;SS&#x60; - South Sudan * &#x60;ES&#x60; - Spain * &#x60;LK&#x60; - Sri Lanka * &#x60;SD&#x60; - Sudan * &#x60;SR&#x60; - Suriname * &#x60;SJ&#x60; - Svalbard and Jan Mayen * &#x60;SE&#x60; - Sweden * &#x60;CH&#x60; - Switzerland * &#x60;SY&#x60; - Syria * &#x60;TW&#x60; - Taiwan * &#x60;TJ&#x60; - Tajikistan * &#x60;TZ&#x60; - Tanzania * &#x60;TH&#x60; - Thailand * &#x60;TL&#x60; - Timor-Leste * &#x60;TG&#x60; - Togo * &#x60;TK&#x60; - Tokelau * &#x60;TO&#x60; - Tonga * &#x60;TT&#x60; - Trinidad and Tobago * &#x60;TN&#x60; - Tunisia * &#x60;TR&#x60; - Turkey * &#x60;TM&#x60; - Turkmenistan * &#x60;TC&#x60; - Turks and Caicos Islands * &#x60;TV&#x60; - Tuvalu * &#x60;UG&#x60; - Uganda * &#x60;UA&#x60; - Ukraine * &#x60;AE&#x60; - United Arab Emirates * &#x60;GB&#x60; - United Kingdom * &#x60;UM&#x60; - United States Minor Outlying Islands * &#x60;US&#x60; - United States of America * &#x60;UY&#x60; - Uruguay * &#x60;UZ&#x60; - Uzbekistan * &#x60;VU&#x60; - Vanuatu * &#x60;VE&#x60; - Venezuela * &#x60;VN&#x60; - Vietnam * &#x60;VG&#x60; - Virgin Islands (British) * &#x60;VI&#x60; - Virgin Islands (U.S.) * &#x60;WF&#x60; - Wallis and Futuna * &#x60;EH&#x60; - Western Sahara * &#x60;YE&#x60; - Yemen * &#x60;ZM&#x60; - Zambia * &#x60;ZW&#x60; - Zimbabwe | [optional] |
13
+ | **zip_code** | **String** | The address&#39;s zip code. | [optional] |
14
+ | **integration_params** | [**Hash&lt;String, AnyType&gt;**](AnyType.md) | | [optional] |
15
+ | **linked_account_params** | [**Hash&lt;String, AnyType&gt;**](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: {&quot;unique_integration_field&quot;:&quot;unique_integration_field_value&quot;},
31
+ linked_account_params: {&quot;unique_linked_account_field&quot;:&quot;unique_linked_account_field_value&quot;}
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&#39;s full name at the time of this Event occurring. | [optional] |
9
+ | **user_email** | **String** | The User&#39;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. * &#x60;ADMIN&#x60; - ADMIN * &#x60;DEVELOPER&#x60; - DEVELOPER * &#x60;MEMBER&#x60; - MEMBER * &#x60;API&#x60; - API * &#x60;SYSTEM&#x60; - SYSTEM * &#x60;MERGE_TEAM&#x60; - MERGE_TEAM | |
11
+ | **ip_address** | **String** | | |
12
+ | **event_type** | [**EventTypeEnum**](EventTypeEnum.md) | Designates the type of event that occurred. * &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60; - CREATED_REMOTE_PRODUCTION_API_KEY * &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60; - DELETED_REMOTE_PRODUCTION_API_KEY * &#x60;CREATED_TEST_API_KEY&#x60; - CREATED_TEST_API_KEY * &#x60;DELETED_TEST_API_KEY&#x60; - DELETED_TEST_API_KEY * &#x60;REGENERATED_PRODUCTION_API_KEY&#x60; - REGENERATED_PRODUCTION_API_KEY * &#x60;INVITED_USER&#x60; - INVITED_USER * &#x60;TWO_FACTOR_AUTH_ENABLED&#x60; - TWO_FACTOR_AUTH_ENABLED * &#x60;TWO_FACTOR_AUTH_DISABLED&#x60; - TWO_FACTOR_AUTH_DISABLED * &#x60;DELETED_LINKED_ACCOUNT&#x60; - DELETED_LINKED_ACCOUNT * &#x60;CREATED_DESTINATION&#x60; - CREATED_DESTINATION * &#x60;DELETED_DESTINATION&#x60; - DELETED_DESTINATION * &#x60;CHANGED_SCOPES&#x60; - CHANGED_SCOPES * &#x60;CHANGED_PERSONAL_INFORMATION&#x60; - CHANGED_PERSONAL_INFORMATION * &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60; - CHANGED_ORGANIZATION_SETTINGS * &#x60;ENABLED_INTEGRATION&#x60; - ENABLED_INTEGRATION * &#x60;DISABLED_INTEGRATION&#x60; - DISABLED_INTEGRATION * &#x60;ENABLED_CATEGORY&#x60; - ENABLED_CATEGORY * &#x60;DISABLED_CATEGORY&#x60; - DISABLED_CATEGORY * &#x60;CHANGED_PASSWORD&#x60; - CHANGED_PASSWORD * &#x60;RESET_PASSWORD&#x60; - RESET_PASSWORD * &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60; - ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60; - ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT * &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60; - DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION * &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60; - 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: &#x60;CREATED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;DELETED_REMOTE_PRODUCTION_API_KEY&#x60;, &#x60;CREATED_TEST_API_KEY&#x60;, &#x60;DELETED_TEST_API_KEY&#x60;, &#x60;REGENERATED_PRODUCTION_API_KEY&#x60;, &#x60;INVITED_USER&#x60;, &#x60;TWO_FACTOR_AUTH_ENABLED&#x60;, &#x60;TWO_FACTOR_AUTH_DISABLED&#x60;, &#x60;DELETED_LINKED_ACCOUNT&#x60;, &#x60;CREATED_DESTINATION&#x60;, &#x60;DELETED_DESTINATION&#x60;, &#x60;CHANGED_SCOPES&#x60;, &#x60;CHANGED_PERSONAL_INFORMATION&#x60;, &#x60;CHANGED_ORGANIZATION_SETTINGS&#x60;, &#x60;ENABLED_INTEGRATION&#x60;, &#x60;DISABLED_INTEGRATION&#x60;, &#x60;ENABLED_CATEGORY&#x60;, &#x60;DISABLED_CATEGORY&#x60;, &#x60;CHANGED_PASSWORD&#x60;, &#x60;RESET_PASSWORD&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION&#x60;, &#x60;DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT&#x60; | [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&#39;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
+