merge_crm_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6065881a9e8e2b63553cf029a9801cf271f572df3177f7cd893d7adf0cc9c1ac
+  data.tar.gz: 6926061992d1506875ec4e0d07f1c635dd9ea64b8c6e78d9f56f47d43632afe7
+SHA512:
+  metadata.gz: 7e86dfdb7d343f73b6d0ae111da6449dbbdaa24c4df596a6f30dba204c55d6e1022d5f656d1244d2bb2299b48f6d2af6df3a68784a8c59a5e20c6331d1d323ee
+  data.tar.gz: 9fda8573fc669b382c863610e3d42856b24227782e3b8bc005893955058c9ad1006a28338972006532f3f48b74bfc4ad9b77f5c85c2ab26c0e210afbd3cf7ce4

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE.md

@@ -0,0 +1,16 @@
+_Last updated: April 21, 2022_
+
+**Merge SDK & Code Snippets License**
+
+Merge makes available to Customers various software development kits ("**SDKs**") and code snippets ("**Snippets**") (together, the "**Merge Assets**") to assist with Merge Integrations and making connections to their Customer Application. Merge Assets are deemed Software under the MSA (defined below). All terms applicable to Software under the MSA apply with equal force and effect to the Merge Assets under this Merge SDK and Code Snippets License ("**License**").
+
+"**Customer**" means a person or entity that uses any of the Merge Assets. By using any Merge Asset, Customer agrees to the terms of this License.
+
+"**MSA**" for the purpose of this License means: (a) for Merge "Launch" Customers, the Subscriber Agreement (available at: [https://merge.dev/subscriber-agreement](https://merge.dev/subscriber-agreement)); and (b) for Merge "Growth" and/or "Expand" Customers, Merge's Master Services Agreement (available at [https://merge.dev/msa](https://merge.dev/msa)), unless Merge and Customer have entered into a separate written agreement governing the Customer's use of the Service. Customer's use of any Merge Asset will be governed by the applicable MSA as well as the additional terms of this License. Capitalized terms used but not defined herein shall have the meaning as set forth in the MSA. In the event of any inconsistency between the terms of the MSA and this License, the terms of the MSA will prevail.
+
+Merge reserves the right to modify or update this License in its sole discretion, the effective date of such updates and/or modifications will be the earlier of: (i) 30 days from the date of such update or modification; or (ii) Customer's continued use of any Merge Asset.
+
+1. **SDK and Snippets License**. Customer's right to access and use the Service under Section 1 of the MSA is extended to include use of the Merge Assets but solely during the Term and subject to the terms of the MSA.
+2. **Use with the Service Only**. Customer may use the Merge Assets but only in connections with the Service and Merge Integrations. Any other use of the Merge Assets requires Merge's prior written consent.
+3. **Limitations**. Customer's use of the Merge Assets may be subject to bandwidth limitations that Merge may impose from time to time during the Subscription. Merge will make commercially reasonable efforts to notify Customer of such limitations in advance via the location where Customer gained access to the applicable Merge Asset(s).
+4. **Merge Assets & Intellectual Property Rights**. Any modifications or derivatives (together, "**Asset Derivatives**") made by Customer to the Merge Assets are deemed "works made for hire" as that term is defined in the United States Copyright Act and are the sole property of Merge. To the extent that ownership of any Asset Derivative does not by operation of law vest in Merge, Customer hereby assigns to Merge all right, title and interest in and to the Asset Derivative, including all related intellectual property rights. Asset Derivatives will be governed by the terms of this License.

data/README.md

@@ -0,0 +1,236 @@
+# merge_crm_client
+
+MergeCRMClient - the Ruby gem for the Merge CRM API
+
+The unified API for building rich integrations with multiple CRM platforms.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.merge.dev/](https://www.merge.dev/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build merge_crm_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./merge_crm_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./merge_crm_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'merge_crm_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/merge-api/merge-crm-ruby, then add the following in the Gemfile:
+
+    gem 'merge_crm_client', :git => 'https://github.com/merge-api/merge-crm-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'merge_crm_client'
+
+# Setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::AccountDetailsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  result = api_instance.account_details_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Exception when calling AccountDetailsApi->account_details_retrieve: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MergeCRMClient::AccountDetailsApi* | [**account_details_retrieve**](docs/AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details | 
+*MergeCRMClient::AccountTokenApi* | [**account_token_retrieve**](docs/AccountTokenApi.md#account_token_retrieve) | **GET** /account-token/{public_token} | 
+*MergeCRMClient::AccountsApi* | [**accounts_create**](docs/AccountsApi.md#accounts_create) | **POST** /accounts | 
+*MergeCRMClient::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | 
+*MergeCRMClient::AccountsApi* | [**accounts_meta_post_retrieve**](docs/AccountsApi.md#accounts_meta_post_retrieve) | **GET** /accounts/meta/post | 
+*MergeCRMClient::AccountsApi* | [**accounts_retrieve**](docs/AccountsApi.md#accounts_retrieve) | **GET** /accounts/{id} | 
+*MergeCRMClient::AvailableActionsApi* | [**available_actions_retrieve**](docs/AvailableActionsApi.md#available_actions_retrieve) | **GET** /available-actions | 
+*MergeCRMClient::ContactsApi* | [**contacts_create**](docs/ContactsApi.md#contacts_create) | **POST** /contacts | 
+*MergeCRMClient::ContactsApi* | [**contacts_list**](docs/ContactsApi.md#contacts_list) | **GET** /contacts | 
+*MergeCRMClient::ContactsApi* | [**contacts_meta_post_retrieve**](docs/ContactsApi.md#contacts_meta_post_retrieve) | **GET** /contacts/meta/post | 
+*MergeCRMClient::ContactsApi* | [**contacts_retrieve**](docs/ContactsApi.md#contacts_retrieve) | **GET** /contacts/{id} | 
+*MergeCRMClient::DeleteAccountApi* | [**delete_account_create**](docs/DeleteAccountApi.md#delete_account_create) | **POST** /delete-account | 
+*MergeCRMClient::EngagementTypesApi* | [**engagement_types_list**](docs/EngagementTypesApi.md#engagement_types_list) | **GET** /engagement-types | 
+*MergeCRMClient::EngagementTypesApi* | [**engagement_types_retrieve**](docs/EngagementTypesApi.md#engagement_types_retrieve) | **GET** /engagement-types/{id} | 
+*MergeCRMClient::EngagementsApi* | [**engagements_create**](docs/EngagementsApi.md#engagements_create) | **POST** /engagements | 
+*MergeCRMClient::EngagementsApi* | [**engagements_list**](docs/EngagementsApi.md#engagements_list) | **GET** /engagements | 
+*MergeCRMClient::EngagementsApi* | [**engagements_meta_post_retrieve**](docs/EngagementsApi.md#engagements_meta_post_retrieve) | **GET** /engagements/meta/post | 
+*MergeCRMClient::EngagementsApi* | [**engagements_retrieve**](docs/EngagementsApi.md#engagements_retrieve) | **GET** /engagements/{id} | 
+*MergeCRMClient::ForceResyncApi* | [**sync_status_resync_create**](docs/ForceResyncApi.md#sync_status_resync_create) | **POST** /sync-status/resync | 
+*MergeCRMClient::GenerateKeyApi* | [**generate_key_create**](docs/GenerateKeyApi.md#generate_key_create) | **POST** /generate-key | 
+*MergeCRMClient::IssuesApi* | [**issues_list**](docs/IssuesApi.md#issues_list) | **GET** /issues | 
+*MergeCRMClient::IssuesApi* | [**issues_retrieve**](docs/IssuesApi.md#issues_retrieve) | **GET** /issues/{id} | 
+*MergeCRMClient::LeadsApi* | [**leads_create**](docs/LeadsApi.md#leads_create) | **POST** /leads | 
+*MergeCRMClient::LeadsApi* | [**leads_list**](docs/LeadsApi.md#leads_list) | **GET** /leads | 
+*MergeCRMClient::LeadsApi* | [**leads_meta_post_retrieve**](docs/LeadsApi.md#leads_meta_post_retrieve) | **GET** /leads/meta/post | 
+*MergeCRMClient::LeadsApi* | [**leads_retrieve**](docs/LeadsApi.md#leads_retrieve) | **GET** /leads/{id} | 
+*MergeCRMClient::LinkTokenApi* | [**link_token_create**](docs/LinkTokenApi.md#link_token_create) | **POST** /link-token | 
+*MergeCRMClient::LinkedAccountsApi* | [**linked_accounts_list**](docs/LinkedAccountsApi.md#linked_accounts_list) | **GET** /linked-accounts | 
+*MergeCRMClient::NotesApi* | [**notes_create**](docs/NotesApi.md#notes_create) | **POST** /notes | 
+*MergeCRMClient::NotesApi* | [**notes_list**](docs/NotesApi.md#notes_list) | **GET** /notes | 
+*MergeCRMClient::NotesApi* | [**notes_meta_post_retrieve**](docs/NotesApi.md#notes_meta_post_retrieve) | **GET** /notes/meta/post | 
+*MergeCRMClient::NotesApi* | [**notes_retrieve**](docs/NotesApi.md#notes_retrieve) | **GET** /notes/{id} | 
+*MergeCRMClient::OpportunitiesApi* | [**opportunities_create**](docs/OpportunitiesApi.md#opportunities_create) | **POST** /opportunities | 
+*MergeCRMClient::OpportunitiesApi* | [**opportunities_list**](docs/OpportunitiesApi.md#opportunities_list) | **GET** /opportunities | 
+*MergeCRMClient::OpportunitiesApi* | [**opportunities_meta_post_retrieve**](docs/OpportunitiesApi.md#opportunities_meta_post_retrieve) | **GET** /opportunities/meta/post | 
+*MergeCRMClient::OpportunitiesApi* | [**opportunities_retrieve**](docs/OpportunitiesApi.md#opportunities_retrieve) | **GET** /opportunities/{id} | 
+*MergeCRMClient::PassthroughApi* | [**passthrough_create**](docs/PassthroughApi.md#passthrough_create) | **POST** /passthrough | 
+*MergeCRMClient::RegenerateKeyApi* | [**regenerate_key_create**](docs/RegenerateKeyApi.md#regenerate_key_create) | **POST** /regenerate-key | 
+*MergeCRMClient::StagesApi* | [**stages_list**](docs/StagesApi.md#stages_list) | **GET** /stages | 
+*MergeCRMClient::StagesApi* | [**stages_retrieve**](docs/StagesApi.md#stages_retrieve) | **GET** /stages/{id} | 
+*MergeCRMClient::SyncStatusApi* | [**sync_status_list**](docs/SyncStatusApi.md#sync_status_list) | **GET** /sync-status | 
+*MergeCRMClient::TasksApi* | [**tasks_list**](docs/TasksApi.md#tasks_list) | **GET** /tasks | 
+*MergeCRMClient::TasksApi* | [**tasks_retrieve**](docs/TasksApi.md#tasks_retrieve) | **GET** /tasks/{id} | 
+*MergeCRMClient::UsersApi* | [**users_list**](docs/UsersApi.md#users_list) | **GET** /users | 
+*MergeCRMClient::UsersApi* | [**users_retrieve**](docs/UsersApi.md#users_retrieve) | **GET** /users/{id} | 
+*MergeCRMClient::WebhookReceiversApi* | [**webhook_receivers_create**](docs/WebhookReceiversApi.md#webhook_receivers_create) | **POST** /webhook-receivers | 
+*MergeCRMClient::WebhookReceiversApi* | [**webhook_receivers_list**](docs/WebhookReceiversApi.md#webhook_receivers_list) | **GET** /webhook-receivers | 
+
+
+## Documentation for Models
+
+ - [MergeCRMClient::Account](docs/Account.md)
+ - [MergeCRMClient::AccountDetails](docs/AccountDetails.md)
+ - [MergeCRMClient::AccountDetailsAndActions](docs/AccountDetailsAndActions.md)
+ - [MergeCRMClient::AccountDetailsAndActionsIntegration](docs/AccountDetailsAndActionsIntegration.md)
+ - [MergeCRMClient::AccountDetailsAndActionsStatusEnum](docs/AccountDetailsAndActionsStatusEnum.md)
+ - [MergeCRMClient::AccountIntegration](docs/AccountIntegration.md)
+ - [MergeCRMClient::AccountRequest](docs/AccountRequest.md)
+ - [MergeCRMClient::AccountToken](docs/AccountToken.md)
+ - [MergeCRMClient::ActivityTypeEnum](docs/ActivityTypeEnum.md)
+ - [MergeCRMClient::Address](docs/Address.md)
+ - [MergeCRMClient::AddressRequest](docs/AddressRequest.md)
+ - [MergeCRMClient::AddressTypeEnum](docs/AddressTypeEnum.md)
+ - [MergeCRMClient::AvailableActions](docs/AvailableActions.md)
+ - [MergeCRMClient::CRMAccountEndpointRequest](docs/CRMAccountEndpointRequest.md)
+ - [MergeCRMClient::CRMAccountResponse](docs/CRMAccountResponse.md)
+ - [MergeCRMClient::CRMContactEndpointRequest](docs/CRMContactEndpointRequest.md)
+ - [MergeCRMClient::CRMContactResponse](docs/CRMContactResponse.md)
+ - [MergeCRMClient::CategoriesEnum](docs/CategoriesEnum.md)
+ - [MergeCRMClient::CategoryEnum](docs/CategoryEnum.md)
+ - [MergeCRMClient::Contact](docs/Contact.md)
+ - [MergeCRMClient::ContactRequest](docs/ContactRequest.md)
+ - [MergeCRMClient::CountryEnum](docs/CountryEnum.md)
+ - [MergeCRMClient::DataPassthroughRequest](docs/DataPassthroughRequest.md)
+ - [MergeCRMClient::DebugModeLog](docs/DebugModeLog.md)
+ - [MergeCRMClient::DebugModelLogSummary](docs/DebugModelLogSummary.md)
+ - [MergeCRMClient::DirectionEnum](docs/DirectionEnum.md)
+ - [MergeCRMClient::EmailAddress](docs/EmailAddress.md)
+ - [MergeCRMClient::EmailAddressRequest](docs/EmailAddressRequest.md)
+ - [MergeCRMClient::EncodingEnum](docs/EncodingEnum.md)
+ - [MergeCRMClient::EndUserDetailsRequest](docs/EndUserDetailsRequest.md)
+ - [MergeCRMClient::Engagement](docs/Engagement.md)
+ - [MergeCRMClient::EngagementEndpointRequest](docs/EngagementEndpointRequest.md)
+ - [MergeCRMClient::EngagementRequest](docs/EngagementRequest.md)
+ - [MergeCRMClient::EngagementResponse](docs/EngagementResponse.md)
+ - [MergeCRMClient::EngagementType](docs/EngagementType.md)
+ - [MergeCRMClient::ErrorValidationProblem](docs/ErrorValidationProblem.md)
+ - [MergeCRMClient::GenerateRemoteKeyRequest](docs/GenerateRemoteKeyRequest.md)
+ - [MergeCRMClient::Issue](docs/Issue.md)
+ - [MergeCRMClient::IssueStatusEnum](docs/IssueStatusEnum.md)
+ - [MergeCRMClient::Lead](docs/Lead.md)
+ - [MergeCRMClient::LeadEndpointRequest](docs/LeadEndpointRequest.md)
+ - [MergeCRMClient::LeadRequest](docs/LeadRequest.md)
+ - [MergeCRMClient::LeadResponse](docs/LeadResponse.md)
+ - [MergeCRMClient::LinkToken](docs/LinkToken.md)
+ - [MergeCRMClient::LinkedAccountStatus](docs/LinkedAccountStatus.md)
+ - [MergeCRMClient::MetaResponse](docs/MetaResponse.md)
+ - [MergeCRMClient::MethodEnum](docs/MethodEnum.md)
+ - [MergeCRMClient::ModelOperation](docs/ModelOperation.md)
+ - [MergeCRMClient::MultipartFormFieldRequest](docs/MultipartFormFieldRequest.md)
+ - [MergeCRMClient::Note](docs/Note.md)
+ - [MergeCRMClient::NoteEndpointRequest](docs/NoteEndpointRequest.md)
+ - [MergeCRMClient::NoteRequest](docs/NoteRequest.md)
+ - [MergeCRMClient::NoteResponse](docs/NoteResponse.md)
+ - [MergeCRMClient::Opportunity](docs/Opportunity.md)
+ - [MergeCRMClient::OpportunityEndpointRequest](docs/OpportunityEndpointRequest.md)
+ - [MergeCRMClient::OpportunityRequest](docs/OpportunityRequest.md)
+ - [MergeCRMClient::OpportunityResponse](docs/OpportunityResponse.md)
+ - [MergeCRMClient::OpportunityStatusEnum](docs/OpportunityStatusEnum.md)
+ - [MergeCRMClient::PaginatedAccountDetailsAndActionsList](docs/PaginatedAccountDetailsAndActionsList.md)
+ - [MergeCRMClient::PaginatedAccountList](docs/PaginatedAccountList.md)
+ - [MergeCRMClient::PaginatedContactList](docs/PaginatedContactList.md)
+ - [MergeCRMClient::PaginatedEngagementList](docs/PaginatedEngagementList.md)
+ - [MergeCRMClient::PaginatedEngagementTypeList](docs/PaginatedEngagementTypeList.md)
+ - [MergeCRMClient::PaginatedIssueList](docs/PaginatedIssueList.md)
+ - [MergeCRMClient::PaginatedLeadList](docs/PaginatedLeadList.md)
+ - [MergeCRMClient::PaginatedNoteList](docs/PaginatedNoteList.md)
+ - [MergeCRMClient::PaginatedOpportunityList](docs/PaginatedOpportunityList.md)
+ - [MergeCRMClient::PaginatedStageList](docs/PaginatedStageList.md)
+ - [MergeCRMClient::PaginatedSyncStatusList](docs/PaginatedSyncStatusList.md)
+ - [MergeCRMClient::PaginatedTaskList](docs/PaginatedTaskList.md)
+ - [MergeCRMClient::PaginatedUserList](docs/PaginatedUserList.md)
+ - [MergeCRMClient::PhoneNumber](docs/PhoneNumber.md)
+ - [MergeCRMClient::PhoneNumberRequest](docs/PhoneNumberRequest.md)
+ - [MergeCRMClient::RemoteData](docs/RemoteData.md)
+ - [MergeCRMClient::RemoteKey](docs/RemoteKey.md)
+ - [MergeCRMClient::RemoteKeyForRegenerationRequest](docs/RemoteKeyForRegenerationRequest.md)
+ - [MergeCRMClient::RemoteResponse](docs/RemoteResponse.md)
+ - [MergeCRMClient::RequestFormatEnum](docs/RequestFormatEnum.md)
+ - [MergeCRMClient::Stage](docs/Stage.md)
+ - [MergeCRMClient::SyncStatus](docs/SyncStatus.md)
+ - [MergeCRMClient::SyncStatusStatusEnum](docs/SyncStatusStatusEnum.md)
+ - [MergeCRMClient::Task](docs/Task.md)
+ - [MergeCRMClient::TaskStatusEnum](docs/TaskStatusEnum.md)
+ - [MergeCRMClient::User](docs/User.md)
+ - [MergeCRMClient::ValidationProblemSource](docs/ValidationProblemSource.md)
+ - [MergeCRMClient::WarningValidationProblem](docs/WarningValidationProblem.md)
+ - [MergeCRMClient::WebhookReceiver](docs/WebhookReceiver.md)
+ - [MergeCRMClient::WebhookReceiverRequest](docs/WebhookReceiverRequest.md)
+
+
+## Documentation for Authorization
+
+
+### tokenAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

@@ -0,0 +1,46 @@
+# MergeCRMClient::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **owner** | **String** |  | [optional] |
+| **name** | **String** | The account's name. | [optional] |
+| **description** | **String** | The account's description. | [optional] |
+| **industry** | **String** | The account's industry. | [optional] |
+| **website** | **String** | The account's website. | [optional] |
+| **number_of_employees** | **Integer** | The account's number of employees. | [optional] |
+| **addresses** | [**Array<Address>**](Address.md) |  | [optional][readonly] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional][readonly] |
+| **last_activity_at** | **Time** | When the account's last activity  occurred. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's account was updated. | [optional] |
+| **remote_created_at** | **Time** | When the third party's account was created. | [optional] |
+| **remote_data** | [**Array<RemoteData>**](RemoteData.md) |  | [optional][readonly] |
+| **remote_was_deleted** | **Boolean** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::Account.new(
+  id: 0958cbc6-6040-430a-848e-aafacbadf4ae,
+  remote_id: 19202938,
+  owner: 0258cbc6-6020-430a-848e-aafacbadf4ae,
+  name: Merge API,
+  description: One API for all integrations,
+  industry: API's,
+  website: https://merge.dev/,
+  number_of_employees: 276000,
+  addresses: [{"street_1":"50 Bowling Green Dr","street_2":"Golden Gate Park","city":"San Francisco","state":"CA","postal_code":"94122","country":"USA","address_type":"Shipping"}],
+  phone_numbers: [{"phone_number":"+16788879833","phone_number_type":"Mobile"}],
+  last_activity_at: 2022-02-10T00:00Z,
+  remote_updated_at: 2022-01-09T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  remote_data: [{"path":"/accounts","data":["Varies by platform"]}],
+  remote_was_deleted: null
+)
+```
+

data/docs/AccountDetails.md

@@ -0,0 +1,36 @@
+# MergeCRMClient::AccountDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **integration** | **String** |  | [optional][readonly] |
+| **integration_slug** | **String** |  | [optional][readonly] |
+| **category** | [**CategoryEnum**](CategoryEnum.md) |  | [optional] |
+| **end_user_origin_id** | **String** |  | [optional][readonly] |
+| **end_user_organization_name** | **String** |  | [optional][readonly] |
+| **end_user_email_address** | **String** |  | [optional][readonly] |
+| **status** | **String** |  | [optional][readonly] |
+| **webhook_listener_url** | **String** |  | [optional][readonly] |
+| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountDetails.new(
+  id: 0496d4c2-42e6-4072-80b3-7b69bfdc76fd,
+  integration: BambooHR,
+  integration_slug: bamboohr,
+  category: hris,
+  end_user_origin_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
+  end_user_organization_name: Waystar Royco,
+  end_user_email_address: kendall.roy@waystar-royco.com,
+  status: COMPLETE,
+  webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
+  is_duplicate: true
+)
+```
+

data/docs/AccountDetailsAndActions.md

@@ -0,0 +1,36 @@
+# MergeCRMClient::AccountDetailsAndActions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **category** | [**CategoryEnum**](CategoryEnum.md) |  | [optional] |
+| **status** | [**AccountDetailsAndActionsStatusEnum**](AccountDetailsAndActionsStatusEnum.md) |  |  |
+| **status_detail** | **String** |  | [optional] |
+| **end_user_origin_id** | **String** |  | [optional] |
+| **end_user_organization_name** | **String** |  |  |
+| **end_user_email_address** | **String** |  |  |
+| **webhook_listener_url** | **String** |  |  |
+| **is_duplicate** | **Boolean** | Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets. | [optional] |
+| **integration** | [**AccountDetailsAndActionsIntegration**](AccountDetailsAndActionsIntegration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountDetailsAndActions.new(
+  id: e59b1821-f85c-4e28-a6b3-1804156f3563,
+  category: hris,
+  status: COMPLETE,
+  status_detail: null,
+  end_user_origin_id: 3ac95cde-6c7f-4eef-afec-be710b42308d,
+  end_user_organization_name: Foo Bar, LLC,
+  end_user_email_address: hradmin@foobar.dev,
+  webhook_listener_url: https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4,
+  is_duplicate: true,
+  integration: null
+)
+```
+

data/docs/AccountDetailsAndActionsIntegration.md

@@ -0,0 +1,32 @@
+# MergeCRMClient::AccountDetailsAndActionsIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) |  |  |
+| **image** | **String** |  | [optional] |
+| **square_image** | **String** |  | [optional] |
+| **color** | **String** |  |  |
+| **slug** | **String** |  |  |
+| **passthrough_available** | **Boolean** |  |  |
+| **available_model_operations** | [**Array<ModelOperation>**](ModelOperation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountDetailsAndActionsIntegration.new(
+  name: null,
+  categories: null,
+  image: null,
+  square_image: null,
+  color: null,
+  slug: null,
+  passthrough_available: null,
+  available_model_operations: null
+)
+```
+

data/docs/AccountDetailsAndActionsStatusEnum.md

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

data/docs/AccountDetailsApi.md

@@ -0,0 +1,79 @@
+# MergeCRMClient::AccountDetailsApi
+
+All URIs are relative to *https://api.merge.dev/api/crm/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**account_details_retrieve**](AccountDetailsApi.md#account_details_retrieve) | **GET** /account-details |  |
+
+
+## account_details_retrieve
+
+> <AccountDetails> account_details_retrieve(x_account_token)
+
+
+
+Get details for a linked account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'merge_crm_client'
+# setup authorization
+MergeCRMClient.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['tokenAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['tokenAuth'] = 'Bearer'
+end
+
+api_instance = MergeCRMClient::AccountDetailsApi.new
+x_account_token = 'x_account_token_example' # String | Token identifying the end user.
+
+begin
+  
+  result = api_instance.account_details_retrieve(x_account_token)
+  p result
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountDetailsApi->account_details_retrieve: #{e}"
+end
+```
+
+#### Using the account_details_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountDetails>, Integer, Hash)> account_details_retrieve_with_http_info(x_account_token)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.account_details_retrieve_with_http_info(x_account_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountDetails>
+rescue MergeCRMClient::ApiError => e
+  puts "Error when calling AccountDetailsApi->account_details_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_account_token** | **String** | Token identifying the end user. |  |
+
+### Return type
+
+[**AccountDetails**](AccountDetails.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountIntegration.md

@@ -0,0 +1,28 @@
+# MergeCRMClient::AccountIntegration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Company name. |  |
+| **categories** | [**Array<CategoriesEnum>**](CategoriesEnum.md) | Category or categories this integration belongs to. Multiple categories should be comma separated.<br/><br>Example: For [ats, hris], enter <i>ats,hris</i> | [optional] |
+| **image** | **String** | Company logo in rectangular shape. <b>Upload an image with a clear background.</b> | [optional] |
+| **square_image** | **String** | Company logo in square shape. <b>Upload an image with a white background.</b> | [optional] |
+| **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] |
+| **slug** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountIntegration.new(
+  name: null,
+  categories: null,
+  image: null,
+  square_image: null,
+  color: null,
+  slug: null
+)
+```
+

data/docs/AccountRequest.md

@@ -0,0 +1,40 @@
+# MergeCRMClient::AccountRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote_id** | **String** | The third-party API ID of the matching object. | [optional] |
+| **owner** | **String** |  | [optional] |
+| **name** | **String** | The account's name. | [optional] |
+| **description** | **String** | The account's description. | [optional] |
+| **industry** | **String** | The account's industry. | [optional] |
+| **website** | **String** | The account's website. | [optional] |
+| **number_of_employees** | **Integer** | The account's number of employees. | [optional] |
+| **last_activity_at** | **Time** | When the account's last activity  occurred. | [optional] |
+| **remote_updated_at** | **Time** | When the third party's account was updated. | [optional] |
+| **remote_created_at** | **Time** | When the third party's account was created. | [optional] |
+| **integration_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+| **linked_account_params** | [**Hash<String, AnyType>**](AnyType.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountRequest.new(
+  remote_id: 19202938,
+  owner: 0258cbc6-6020-430a-848e-aafacbadf4ae,
+  name: Merge API,
+  description: One API for all integrations,
+  industry: API's,
+  website: https://merge.dev/,
+  number_of_employees: 276000,
+  last_activity_at: 2022-02-10T00:00Z,
+  remote_updated_at: 2022-01-09T00:00Z,
+  remote_created_at: 2021-11-10T00:00Z,
+  integration_params: null,
+  linked_account_params: null
+)
+```
+

data/docs/AccountToken.md

@@ -0,0 +1,20 @@
+# MergeCRMClient::AccountToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_token** | **String** |  |  |
+| **integration** | [**AccountIntegration**](AccountIntegration.md) |  |  |
+
+## Example
+
+```ruby
+require 'merge_crm_client'
+
+instance = MergeCRMClient::AccountToken.new(
+  account_token: T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB,
+  integration: null
+)
+```
+